此页面由 Cloud Translation API 翻译。

Package google.ads.drx.video.v1

索引

AdBreakNotificationService（界面）
VideoContentIngestionService（界面）
AdBreak（消息）
AdBreak.BreakState（枚举）
ClosedCaptionFormat（枚举）
ClosedCaptionUrlInfo（消息）
CreateAdBreakRequest（消息）
DynamicAdInsertionInfo（消息）
GracenoteMetadata（消息）
ListAdBreaksRequest（消息）
ListAdBreaksResponse（消息）
Metadata（消息）
SyndicatedVideoContentNames（消息）
UpdateVideoContentRequest（消息）
VideoContent（消息）
VideoContentStatus（枚举）
VideoContentSyndicationInfo（消息）
VideoFormat（枚举）
VideoIngestUrlInfo（消息）
VideoPreconditioned（枚举）

AdBreakNotificationService

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

CreateAdBreak

CreateAdBreak
`rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)` 用于在直播中创建广告插播时间点的 API。授权范围需要以下 OAuth 范围之一： `https://www.googleapis.com/auth/contentingestion` `https://www.googleapis.com/auth/video-ads` 如需了解详情，请参阅 OAuth 2.0 概览。

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

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

授权范围

需要以下 OAuth 范围之一：

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

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

ListAdBreaks

ListAdBreaks
`rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)` 用于列出直播中的广告插播时间点的 API。授权范围需要以下 OAuth 范围之一： `https://www.googleapis.com/auth/contentingestion` `https://www.googleapis.com/auth/video-ads` 如需了解详情，请参阅 OAuth 2.0 概览。

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 中创建或更新视频内容及其关联的元数据。

UpdateVideoContent

UpdateVideoContent
`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 概览。

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 Manage 中用于创建广告插播的直播活动的键。 ad_break_id 是广告插播时间点的键。仅限输出。
`expected_duration`	`Duration` 必需。预期的广告插播时长。
`custom_params`	`string` 这些键值对会加入到此广告插播时间点的广告请求中，以便在 Ad Manager 中执行自定义条件定位。示例：'key1=value&key2=value2,value22'
`scte_35_cue_out`	`string` scte35 cue out 中采用 Base64 编码的数据。可以包含 splice_insert() 或 time_signal() 命令。如果
`pod_template_name`	`string` Google Ad Manager Pod 模板名称。
`break_state`	`BreakState` 广告插播的当前状态。

BreakState

广告插播的状态。

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

ClosedCaptionFormat

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

枚举
`CLOSED_CAPTION_FORMAT_UNSPECIFIED`	未指定字幕格式。
`TTML`	application/ttaf+xml
`WEB_VTT`	text/vtt

ClosedCaptionUrlInfo

一个字幕文件的元数据。

字段

字段
`language_code`	`string` IETF BCP-47 语言代码，表示字幕文件的语言。
`closed_caption_format`	`ClosedCaptionFormat` 字幕文件的格式。
`url`	`string` 字幕文件的网址。

language_code

string

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

closed_caption_format

ClosedCaptionFormat

字幕文件的格式。

url

string

字幕文件的网址。

CreateAdBreakRequest

对 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。

DynamicAdInsertionInfo

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

字段
`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”- 电影“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 中的某项内容关联，则这是识别 LiveStreamEvent 的另一种方法。其格式必须为“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` 发送以检索下一页的令牌。如果省略此字段，则不存在后续页面。

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}”，并且必须与包含此字段的内容属于同一影音平台。

syndicated_video_content[]

string

转载内容名称的重复字段。其格式必须为“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”，并且必须与包含此字段的内容属于同一影音平台。

UpdateVideoContentRequest

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

字段

字段
`video_content`	`VideoContent` 必需。内容的元数据。

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` 用于标识广告插入点。广告插入点是用时间表示的视频中可以插入广告的位置。支持精确到毫秒级的 cue 点。如果视频包含中贴片广告插播时间点，则此字段为必填字段。
`thumbnail_url`	`string` 内容的缩略图网址。
`metadata`	`Metadata` 标识内容的自定义元数据。
`gracenote_metadata`	`GracenoteMetadata` 内容与 Gracenote 相关的元数据。
`syndication_metadata`	`VideoContentSyndicationInfo` 内容的与内容联合相关的元数据。
`dynamic_ad_insertion_metadata`	`DynamicAdInsertionInfo` 内容的动态广告插播相关元数据。

VideoContentStatus

用于选择是否为内容投放定向广告的状态选项。

枚举
`ACTIVE`	将投放按内容定位的广告。
`BLOCKED`	如果状态为“已阻止”，系统将不会针对此内容投放任何广告。
`DELETED`	相应内容将在 Ad Manager 中归档。如果 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` 转载内容的集合

联合字段 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`	application/x-mpegURL
`DASH`	application/dash+xml

VideoIngestUrlInfo

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

字段

字段
`video_format`	`VideoFormat` 视频的格式。
`video_preconditioned`	`VideoPreconditioned` 指明内容是否已为插入中贴片广告而调节（也就是说，是否已在广告插播时间点处拆分了您的视频片段）。
`url`	`string` 指向 m3u8 文件的链接。

video_format

VideoFormat

视频的格式。

video_preconditioned

VideoPreconditioned

指明内容是否已为插入中贴片广告而调节（也就是说，是否已在广告插播时间点处拆分了您的视频片段）。

url

string

指向 m3u8 文件的链接。

VideoPreconditioned

视频内容的“已调整”状态。

枚举
`NO`	尚未进行条件化处理。
`YES`	视频已调节/分屏。

Package google.ads.drx.video.v1 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

索引

AdBreakNotificationService

VideoContentIngestionService

AdBreak

BreakState

ClosedCaptionFormat

ClosedCaptionUrlInfo

CreateAdBreakRequest

DynamicAdInsertionInfo

GracenoteMetadata

ListAdBreaksRequest

ListAdBreaksResponse

元数据

SyndicatedVideoContentNames

UpdateVideoContentRequest

视频内容

VideoContentStatus

VideoContentSyndicationInfo

视频格式

VideoIngestUrlInfo

VideoPreconditioned

Package google.ads.drx.video.v1