- Resource: VideoContent
- VideoContentStatus
- Metadata
- GracenoteMetadata
- VideoContentSyndicationInfo
- SyndicatedVideoContentNames
- DynamicAdInsertionInfo
- VideoIngestUrlInfo
- VideoFormat
- VideoPreconditioned
- ClosedCaptionUrlInfo
- ClosedCaptionFormat
- Methods
Resource: VideoContent
The metadata of the content.
JSON representation |
---|
{ "name": string, "status": enum ( |
Fields | |
---|---|
name |
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 |
The status of the content. If this is omitted the default value will be active. |
title |
Required. The title of the content. |
updateTime |
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: |
publishTime |
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: |
duration |
Duration of the content. Duration is supported down to the millisecond level. A duration in seconds with up to nine fractional digits, ending with ' |
cuePoints[] |
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 ' |
thumbnailUrl |
Thumbnail url of the content. |
metadata |
Identifies the custom metadata of the content. |
gracenoteMetadata |
Gracenote related metadata of the content. |
syndicationMetadata |
Syndication related metadata of the content. |
dynamicAdInsertionMetadata |
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 |
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 |
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 |
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 |
Fields | |
---|---|
Union field syndication . VideoContentSyndiationMetadata can only contain one of the following. syndication can be only one of the following: |
|
canonicalVideoContent |
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 |
A collection of syndicated content |
SyndicatedVideoContentNames
The list of names of all syndicated content.
JSON representation |
---|
{ "syndicatedVideoContent": [ string ] } |
Fields | |
---|---|
syndicatedVideoContent[] |
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 ( |
Fields | |
---|---|
videoIngestUrlInfo |
A link to the master m3u8 file that is used for conditioning and playlist generation. |
mediaUpdateTime |
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: |
closedCaptionUrlInfo[] |
The URL to the closed caption/subtitle file. |
fwCaid |
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 ( |
Fields | |
---|---|
videoFormat |
The format of the video. |
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 |
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 ( |
Fields | |
---|---|
languageCode |
The IETF BCP-47 language code representing the language which the closed caption file is in. |
closedCaptionFormat |
The format of the closed caption file. |
url |
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 |
|
---|---|
|
API to create new content or update its metadata if the content already exists in Ad Manager. |