Package google.ads.drx.video.ingestion.api.v1

Index

ContentIngestionService

An API service for content ingestion that allows creating or updating video content and its associated metadata in Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API to create new content or update its metadata if the content already exists in Ad Manager. Returns the content on success or a google.rpc.Code on failure.

An example request looks like:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
           "views": 700000,
           "rating": 5.5
       }
   }
}
Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/contentingestion

For more information, see the OAuth 2.0 Overview.
UpdateVideoContentWithLinking

rpc UpdateVideoContentWithLinking(UpdateVideoContentWithLinkingRequest) returns (VideoContentWithLinking)

API to create new content or update the metadata if the content already exists in Ad Manager. Returns the content on success or a google.rpc.Code on failure.

An example request looks like:

{
   "videoContent": {
       "status": "ACTIVE",
       "title": "Best video ever",
       "updateTime": "2019-01-24T01:30:15.01Z",
       "duration": "230s",
       "cuePoints": ["55.532s", "192s"],
       "publishTime": "2019-01-24T01:30:15.01Z",
       "thumbnailUrl": "http://www.domain.com/tn.jpg",
       "metadata": {
           "keyValues": {
               "category": "sports",
               "tag": ["soccer", "messi"],
               "views": 700000,
               "rating": 5.5,
           }
       }
   },
   "linkInfo": {"parentContentId": "parent-content-id-1"}
}
Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/contentingestion

For more information, see the OAuth 2.0 Overview.

LinkInfo

Information used to indicate content linking related info.

Fields
parent_content_id

string

The content ID of the parent content from the CMS. Content with the same parent_content_id are linked together for content updates and targeting.

Metadata

Custom metadata of the content.

Fields
key_values

map<string, Value>

Identifies the custom metadata of the content as a key-value pair.

"keyValues": {
   "category": "sports",
   "tag": ["soccer", "messi"],
   "views": 700000,
   "rating": 5.5,
}

TmsMetadata

The TMS (Gracenote) metadata for the content.

Fields
tms_id

string

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

string

If the content is an episode of a series, this field refers to the series TMS ID. Should be prefixed with 'SH'. Optional.

UpdateVideoContentRequest

Request for [ContentIngestionService.UpdateVideoContentRequest][].

Fields
name

string

The resource name of the video content. VideoContent names have the form 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}' The network code in Google Ad Manager to which this content belongs. The content source ID in Google Ad Manager to which this content should belong. The CMS content ID in Ad Manager, this is a required request parameter, formed as a part of the ad request to identify which ads Ad Manager can serve against the corresponding video. This value will be used for the vid parameter on a video ad request. It can be numeric or alphanumeric.
content

VideoContent

The metadata for the content to be ingested.

UpdateVideoContentWithLinkingRequest

Request for ContentIngestionService.UpdateVideoContentWithLinking.

Fields
name

string

The resource name of the video content. VideoContent names have the form 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}' The network code in Google Ad Manager to which this content belongs. The content source ID in Google Ad Manager to which this content should belong. The CMS content ID in Ad Manager, this is a required request parameter, formed as a part of the ad request to identify which ads Ad Manager can serve against the corresponding video. This value will be used for the vid parameter on a video ad request. It can be numeric or alphanumeric.
content

VideoContentWithLinking

The metadata for the content to be ingested.

VideoContent

The metadata for the content to be ingested.

Fields
status

VideoContentStatus

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

string

Required. The title of the content.
update_time

Timestamp

Required. The last modified time of the content.
publish_time

Timestamp

The publish time of the content. This is a required field, if the video is designed to be included in Ad Rules that specifies start and end time using number of days before and after the publish time of content.
duration

Duration

Duration of the content. Duration is supported down to the millisecond level.
cue_points[]

Duration

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.
thumbnail_url

string

Thumbnail url of the content.
description
(deprecated)

string

Description of the content.
metadata

Metadata

Identifies the custom metadata of the content.
tms_metadata

TmsMetadata

The TMS info of the content.

VideoContentStatus

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

Enums
ACTIVE Active.
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.

VideoContentWithLinking

The metadata for the content to be ingested, with the linking information.

Fields
video_content

VideoContent

The metadata for the content