Package google.ads.drx.video.v1

Index

AdBreakNotificationService

An API service that allows publishers to create Ad Breaks within a live stream.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API to create an Ad Break within the live stream.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

For more information, see the OAuth 2.0 Overview.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API to list Ad Breaks within the live stream.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

For more information, see the OAuth 2.0 Overview.

VideoContentIngestionService

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"],
       }
   }
}
Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

For more information, see the OAuth 2.0 Overview.

AdBreak

Ad break metadata used to decision ads for an ad break in a live video event.

Fields
name

string

Output only. The resource name of the Ad Break. This field will have the format of "networks//assets//adBreaks/".

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

asset_key is the key of the Live Stream Event in Google Ad Manage under which the Ad Break was created.

ad_break_id is the key of the Ad Break. OUTPUT ONLY.
expected_duration

Duration

Required. Expected break duration.
custom_params

string

Key-value pairs to be included on ad requests for this break for custom criteria targeting in Ad Manager. Example: 'key1=value&key2=value2,value22'
scte_35_cue_out

string

Base 64 encoded data from the scte35 cue out. May include splice_insert() or time_signal() command. Examples: - with time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - with splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
pod_template_name

string

Google Ad Manager pod template name.
break_state

BreakState

The current state of the Ad Break.

BreakState

The state of an Ad Break.

Enums
BREAK_STATE_UNSPECIFIED The Ad Break state is unknown.
BREAK_STATE_DECISIONED Ad Break decisioning started but not yet delivered to users.
BREAK_STATE_COMPLETE Ad Break was delivered to users.

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

ClosedCaptionUrlInfo

Metadata for one closed caption file.

Fields
language_code

string

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

ClosedCaptionFormat

The format of the closed caption file.
url

string

The url to the closed caption file.

CreateAdBreakRequest

Request for AdBreakNotificationService.CreateAdBreak.

Fields
parent

string

This field identifies the LiveStreamEvent that this ad break should be associated to using the live stream asset key. It must have the format of "networks/{network_code}/assets/{asset_code}"
custom_parent

string

This field identifies the LiveStreamEvent that this ad break should be associated to using the custom asset key. It must have the format of "networks/{network_code}/customAssets/{asset_code}"
content

string

This is an alternative way to identify the LiveStreamEvent, if it's associated with a piece of content within GAM. It must have the format of "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
ad_break

AdBreak

Required. The actual ad break.
ad_break_id

string

This is the ad_break_id that users can provide through the request.

DynamicAdInsertionInfo

Information related to Dynamic Ad Insertion.

Fields
video_ingest_url_info

VideoIngestUrlInfo

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

Timestamp

The time the video file referenced in video_ingest_url_info was last modified.
closed_caption_url_info[]

ClosedCaptionUrlInfo

The URL to the closed caption/subtitle file.
fw_caid

string

Freewheel custom asset ID used for ad targeting.

GracenoteMetadata

The Gracenote metadata for the content.

Fields
gracenote_id

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
gracenote_series_id

string

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

ListAdBreaksRequest

Request for AdBreakNotificationService.ListAdBreaks.

Fields
parent

string

Optional. This field identifies the LiveStreamEvent that this ad break should be associated to using the live stream asset key. It must have the format of "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Optional. This field identifies the LiveStreamEvent that this ad break should be associated to using the custom asset key. It must have the format of "networks/{network_code}/customAssets/{asset_code}"
content

string

Optional. This is an alternative way to identify the LiveStreamEvent, if it's associated with a piece of content within GAM. It must have the format of "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
page_size

int32

Optional. The maximum number of ad breaks to return. The service may return fewer than this value. If unspecified, at most 10 ad breaks will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token

string

Optional. A page token, received from a previous ListAdBreaks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAdBreaks must match the call that provided the page token.

ListAdBreaksResponse

Response for AdBreakNotificationService.ListAdBreaks.

Fields
ad_breaks[]

AdBreak

Output only. A list of Ad Breaks that match the LiveStreamEvent requested.
next_page_token

string

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Metadata

Custom metadata of the content.

Fields
key_values

map<string, Value>

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

SyndicatedVideoContentNames

The list of names of all syndicated content.

Fields
syndicated_video_content[]

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.

UpdateVideoContentRequest

Request for [VideoContentIngestionService.UpdateVideoContentRequest][].

Fields
video_content

VideoContent

Required. The metadata of the content.

VideoContent

The metadata of the content.

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

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 specify a start and end time.
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.
metadata

Metadata

Identifies the custom metadata of the content.
gracenote_metadata

GracenoteMetadata

Gracenote related metadata of the content.
syndication_metadata

VideoContentSyndicationInfo

Syndication related metadata of the content.
dynamic_ad_insertion_metadata

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.

VideoContentSyndicationInfo

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

Fields
Union field syndication. VideoContentSyndiationMetadata can only contain one of the following. syndication can be only one of the following:
canonical_video_content

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

SyndicatedVideoContentNames

A collection of syndicated content

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

VideoIngestUrlInfo

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

Fields
video_format

VideoFormat

The format of the video.
video_preconditioned

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.

VideoPreconditioned

The conditioned state of the video content.

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