REST Resource: videoContent.networks.sources.content

  • The VideoContent resource provides metadata for video content in Google Ad Manager.

  • Key fields include name, status, title, updateTime, publishTime, duration, cuePoints, and various metadata objects.

  • The VideoContentStatus enum indicates whether content-targeted ads will be served.

  • DynamicAdInsertionInfo contains details for DAI, including video ingest URLs and closed caption information.

  • The API offers an update method to create new content or modify existing content metadata.

Resource: VideoContent

The metadata of the content.

JSON representation 
{
  "name": string,
  "status": enum (VideoContentStatus),
  "title": string,
  "updateTime": string,
  "publishTime": string,
  "duration": string,
  "cuePoints": [
    string
  ],
  "thumbnailUrl": string,
  "metadata": {
    object (Metadata)
  },
  "gracenoteMetadata": {
    object (GracenoteMetadata)
  },
  "syndicationMetadata": {
    object (VideoContentSyndicationInfo)
  },
  "dynamicAdInsertionMetadata": {
    object (DynamicAdInsertionInfo)
  }
}
Fields
name

string

Output only. The resource name of the video content. This field has the format of: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code is the network code in Google Ad Manager to which this content belongs.

content_source_id is the content source ID in Google Ad Manager to which this content should belong.

cms_content_id is the CMS content ID in Google Ad Manager, formed as a part of the ad request to identify which ads Ad Manager can serve against the corresponding video. This value can be numeric or alphanumeric.
status

enum (VideoContentStatus)

The status of the content. If this is omitted the default value will be active.
title

string

Required. The title of the content.
updateTime

string (Timestamp format)

Required. The last modified time of the content.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
publishTime

string (Timestamp format)

The publish time of the content. This is a required field, if the video is designed to be included in Ad Rules that specify a start and end time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Duration of the content. Duration is supported down to the millisecond level.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
cuePoints[]

string (Duration format)

Identifies the cue points. Cue points are places in time where an ad can be inserted in the video. Cue points are supported down to the millisecond level. This is a required field, if the video contains mid-roll ad breaks.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
thumbnailUrl

string

Thumbnail url of the content.
metadata

object (Metadata)

Identifies the custom metadata of the content.
gracenoteMetadata

object (GracenoteMetadata)

Gracenote related metadata of the content.
syndicationMetadata

object (VideoContentSyndicationInfo)

Syndication related metadata of the content.
dynamicAdInsertionMetadata

object (DynamicAdInsertionInfo)

Dynamic Ad Insertion related metadata of the content.

VideoContentStatus

Status options to serve or not to serve targeted ads for a content.

Enums
ACTIVE Content-targeted Ads will be served.
BLOCKED No ads will be served against this content if the status is BLOCKED.
DELETED The content will be archived in Ad Manager. If Ad Manager receives an ad request for a content marked as DELETED, then house ads, or ads targeted to inventory units or other targeting criteria can still serve against it. To block ads, set the status to BLOCKED.

Metadata

Custom metadata of the content.

JSON representation 
{
  "keyValues": {
    string: value,
    ...
  }
}
Fields
keyValues

map (key: string, value: value (Value format))

Identifies the custom metadata of the content as a key-value pair. Only strings or list of strings are accepted for values.

GracenoteMetadata

The Gracenote metadata for the content.

JSON representation 
{
  "gracenoteId": string,
  "gracenoteSeriesId": string
}
Fields
gracenoteId

string

Required. Refers to the Gracenote ID for the content. Must have one of these valid prefixes: 1. 'EP' - episode of a series 2. 'MV' - movie 3. 'SP' - sporting event
gracenoteSeriesId

string

Optional. This field refers to the Gracenote series ID. Must be prefixed with 'SH'.

VideoContentSyndicationInfo

The metadata for specifying relationships between canonical content and syndicated content.

JSON representation 
{

  // Union field syndication can be only one of the following:
  "canonicalVideoContent": string,
  "syndicatedVideoContentNames": {
    object (SyndicatedVideoContentNames)
  }
  // End of list of possible types for union field syndication.
}
Fields
Union field syndication. VideoContentSyndiationMetadata can only contain one of the following. syndication can be only one of the following:
canonicalVideoContent

string

The name of the canonical content. It must have the format of "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" and must belong to the same network as the content containing this field.
syndicatedVideoContentNames

object (SyndicatedVideoContentNames)

A collection of syndicated content

SyndicatedVideoContentNames

The list of names of all syndicated content.

JSON representation 
{
  "syndicatedVideoContent": [
    string
  ]
}
Fields
syndicatedVideoContent[]

string

Repeated field of the name of the syndicated content. They must have the format of "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" and must belong to the same network as the content containing this field.

DynamicAdInsertionInfo

Information related to Dynamic Ad Insertion.

JSON representation 
{
  "videoIngestUrlInfo": {
    object (VideoIngestUrlInfo)
  },
  "mediaUpdateTime": string,
  "closedCaptionUrlInfo": [
    {
      object (ClosedCaptionUrlInfo)
    }
  ],
  "fwCaid": string
}
Fields
videoIngestUrlInfo

object (VideoIngestUrlInfo)

A link to the master m3u8 file that is used for conditioning and playlist generation.
mediaUpdateTime

string (Timestamp format)

The time the video file referenced in videoIngestUrlInfo was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
closedCaptionUrlInfo[]

object (ClosedCaptionUrlInfo)

The URL to the closed caption/subtitle file.
fwCaid

string

Freewheel custom asset ID used for ad targeting.

VideoIngestUrlInfo

Metadata specifying the link to the m3u8 file that is used for conditioning and playlist generation.

JSON representation 
{
  "videoFormat": enum (VideoFormat),
  "videoPreconditioned": enum (VideoPreconditioned),
  "url": string
}
Fields
videoFormat

enum (VideoFormat)

The format of the video.
videoPreconditioned

enum (VideoPreconditioned)

To indicate whether or not the content is already conditioned for mid-roll ads, which means that your segments are already split at the time of ad breaks.
url

string

The link to the m3u8 file.

VideoFormat

The formats in which a video content may be encoded.

Enums
VIDEO_FORMAT_UNSPECIFIED Video format was not specified.
HLS application/x-mpegURL
DASH application/dash+xml

VideoPreconditioned

The conditioned state of the video content.

Enums
NO Not yet conditioned.
YES The video has been conditioned/spliited.

ClosedCaptionUrlInfo

Metadata for one closed caption file.

JSON representation 
{
  "languageCode": string,
  "closedCaptionFormat": enum (ClosedCaptionFormat),
  "url": string
}
Fields
languageCode

string

The IETF BCP-47 language code representing the language which the closed caption file is in.
closedCaptionFormat

enum (ClosedCaptionFormat)

The format of the closed caption file.
url

string

The url to the closed caption file.

ClosedCaptionFormat

The formats in which the closed caption files may be.

Enums
CLOSED_CAPTION_FORMAT_UNSPECIFIED Closed caption format was not specified.
TTML application/ttaf+xml
WEB_VTT text/vtt

Methods

update

 API to create new content or update its metadata if the content already exists in Ad Manager.