Package google.ads.drx.video.v1

索引

AdBreakNotificationService

一项 API 服务，供发布商在直播中创建广告插播时间点。

创建广告插播时间点

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

用于在直播中创建广告插播时间点的 API。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 OAuth 2.0 概览。
ListAdBreak

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

可在直播中列出广告插播时间点的 API。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 OAuth 2.0 概览。

VideoContentIngestionService

一项用于内容提取的 API 服务，可用于在 Google Ad Manager 中创建或更新视频内容及其关联的元数据。

更新视频内容

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API 来创建新内容或更新其元数据（如果 Ad Manager 中已存在该内容）。成功时返回内容，返回失败时返回 google.rpc.Code。

示例请求如下所示：

{
   "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"],
       }
   }
}
授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 OAuth 2.0 概览。

AdBreak

广告插播时间点元数据，用于决定直播活动中的广告插播时间点的广告。

字段
name

string

仅供输出。广告插播时间点的资源名称。此字段的格式为“networks//assets//adBreaks/”。

network_code 是此内容所属的 Google Ad Manager 中的广告联盟代码。

asset_key 是 Google 广告管理中的直播活动的键，创建了广告插播时间点。

ad_break_id 是广告插播时间点的键。仅限输出。
expected_duration

Duration

必需。预期的广告插播时长。
custom_params

string

这些键值对会加入到此广告插播时间点的广告请求中，供在 Ad Manager 中使用自定义条件定位。示例：“key1=value&key2=value2,value22”
scte_35_cue_out

string

从 scte35 插入结束处的 base 64 编码数据。可能包含 splice_insert() 或 time_signal() 命令。示例：- 使用 time_signal()：“/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==”- 使用 splice_insert()
pod_template_name

string

Google Ad Manager 广告连播模板名称。
break_state

BreakState

广告插播的当前状态。

BreakState

广告插播时间点的状态。

枚举
BREAK_STATE_UNSPECIFIED 广告插播状态未知。
BREAK_STATE_DECISIONED 广告插播决策已开始，但尚未发送给用户。
BREAK_STATE_COMPLETE 广告投放给用户。

字幕格式

字幕文件可能采用的格式。

枚举
CLOSED_CAPTION_FORMAT_UNSPECIFIED 未指定字幕格式。
TTML 应用/ttaf+xml
WEB_VTT 文字/浏览型转化

ClosedCaptionUrlInfo

一个字幕文件的元数据。

字段
language_code

string

表示字幕文件所用语言的 IETF BCP-47 语言代码。
closed_caption_format

ClosedCaptionFormat

字幕文件的格式。
url

string

指向字幕文件的网址。

创建 AdBreakRequest

AdBreakNotificationService.CreateAdBreak 的请求。

字段
parent

string

此字段用于标识此广告插播时间点应与使用直播活动素材资源键相关联的 LiveStreamEvent。它的格式必须为“networks/{network_code}/assets/{asset_code}”
custom_parent

string

此字段用于标识此广告插播时间点应与使用自定义素材资源键相关联的 LiveStreamEvent。它的格式必须为“networks/{network_code}/customAssets/{asset_code}”
content

string

如果 LiveStreamEvent 与 GAM 中的一段内容相关联，则可通过此方法进行识别。它的格式必须为“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”
ad_break

AdBreak

必需。实际的广告插播时间点。
ad_break_id

string

这是用户可通过请求提供的 ad_break_id。

动态广告插播信息

与动态广告插播相关的信息。

字段
video_ingest_url_info

VideoIngestUrlInfo

指向主 m3u8 文件的链接，用于调节内容和生成播放列表。
media_update_time

Timestamp

video_ingest_url_info 中引用的视频文件的上次修改时间。
closed_caption_url_info[]

ClosedCaptionUrlInfo

指向字幕文件的网址。
fw_caid

string

用于广告定位的 Freewheel 自定义素材资源 ID。

GracenoteMetadata

内容的 Gracenote 元数据。

字段
gracenote_id

string

必需。表示内容的 Gracenote ID。必须具有以下有效前缀之一：1. “EP”- 第 2 季剧集。“MV”- 电影 3。“SP”- 体育赛事
gracenote_series_id

string

可选。此字段引用 Gracenote 系列 ID。必须带有“SH”前缀。

ListAdBreaksRequest

AdBreakNotificationService.ListAdBreaks 的请求。

字段
parent

string

可选。此字段用于标识此广告插播时间点应与使用直播活动素材资源键相关联的 LiveStreamEvent。它的格式必须为“networks/{network_code}/assets/{asset_code}”
custom_parent

string

可选。此字段用于标识此广告插播时间点应与使用自定义素材资源键相关联的 LiveStreamEvent。它的格式必须为“networks/{network_code}/customAssets/{asset_code}”
content

string

可选。如果 LiveStreamEvent 与 GAM 中的一段内容相关联，则可通过此方法进行识别。它的格式必须为“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”
page_size

int32

可选。要返回的广告插播时间点数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 10 个广告插播时间点。最大值为 100；大于 100 的值将被强制转换为 100。
page_token

string

可选。从之前的 ListAdBreaks 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 ListAdBreaks 的所有其他参数必须与提供页面令牌的调用匹配。

ListAdBreaksResponse

AdBreakNotificationService.ListAdBreaks 的响应。

字段
ad_breaks[]

AdBreak

仅供输出。与所请求的 LiveStreamEvent 匹配的广告插播时间点列表。
next_page_token

string

可以作为 page_token 发送的令牌以检索下一页的令牌。如果省略此字段，则不存在后续页面。

元数据

内容的自定义元数据。

字段
key_values

map<string, Value>

将内容的自定义元数据标识为键值对。只能接受字符串或字符串列表作为值。

SyndicatedVideoContentNames

所有整合内容的名称列表。

字段
syndicated_video_content[]

string

整合内容的名称的重复字段。它们的格式必须为“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”，并且必须与包含此字段的内容属于同一网络。

更新视频内容请求

针对 [VideoContentIngestionService.UpdateVideoContentRequest][] 的请求。

字段
video_content

VideoContent

必需。内容的元数据。

视频内容

内容的元数据。

字段
name

string

仅供输出。视频内容的资源名称。此字段的格式如下：“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”

network_code 是此内容所属的 Google Ad Manager 中的广告联盟代码。

content_source_id 是指此内容所属的 Google Ad Manager 中的内容来源 ID。

cms_content_id 是 Google Ad Manager 中的 CMS 内容 ID，作为广告请求的一部分来确定 Ad Manager 可向相应视频投放哪些广告。此值可以为数字或字母数字。
status

VideoContentStatus

内容的状态。如果省略此参数，则默认值将处于有效状态。
title

string

必需。内容的标题。
update_time

Timestamp

必需。内容的上次修改时间。
publish_time

Timestamp

内容的发布时间。如果视频要求纳入到用于指定开始时间和结束时间的广告规则中，则此字段为必填字段。
duration

Duration

内容的时长。时长可精确到毫秒级。
cue_points[]

Duration

用于标识广告插入点。广告插入点是用时间表示的视频中可以插入广告的位置。广告插入点的支持将精确到毫秒级。如果视频包含广告插播时间点，则属于必填字段。
thumbnail_url

string

内容的缩略图网址。
metadata

Metadata

标识内容的自定义元数据。
gracenote_metadata

GracenoteMetadata

与内容相关的 Gracenote 元数据。
syndication_metadata

VideoContentSyndicationInfo

内容的整合相关元数据。
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

内容的动态广告插播相关元数据。

视频内容状态

用于投放内容的目标广告或不投放状态的状态选项。

枚举
ACTIVE 系统将会投放按内容定位的广告。
BLOCKED 如果状态为“已屏蔽”，系统将不会针对此类内容投放广告。
DELETED 系统会将相应内容归档。如果 Ad Manager 收到标记为“已删除”的内容的广告请求，则自家广告，或定位到广告资源单元或其他定位条件的广告仍然可以针对它投放广告。若要屏蔽广告，请将状态设置为“已屏蔽”。

VideoContentSyndicationInfo

用于指定规范内容与整合内容之间关系的元数据。

字段
联合字段 syndication。VideoContentSyndiationMetadata 只能包含以下内容之一。syndication 只能是下列其中一项：
canonical_video_content

string

规范内容的名称。它的格式必须为“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”，并且必须与包含此字段的内容属于同一网络。
syndicated_video_content_names

SyndicatedVideoContentNames

整合内容集合

视频格式

视频内容的编码格式。

枚举
VIDEO_FORMAT_UNSPECIFIED 未指定视频格式。
HLS 应用/x-mpeg网址
DASH 应用/短划线+ XML

视频网址相关信息

元数据，用于指定指向用于调节内容和生成播放列表的 m3u8 文件的链接。

字段
video_format

VideoFormat

视频的格式。
video_preconditioned

VideoPreconditioned

指明是否已针对中贴片广告调节了内容，这意味着您的细分受众群是否已在广告插播时间点处拆分了。
url

string

指向 m3u8 文件的链接。

视频已预先调节

视频内容的调节状态。

枚举
NO 尚未调节。
YES 视频已调节/拼接。