Package google.ads.drx.video.v1

索引

VideoContentIngestionService

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

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

用于创建新内容或更新其元数据（如果内容已存在于 Ad Manager 中）的 API。成功时返回内容，失败时返回 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 概览。

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

字幕文件的网址。

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' - 电影 3. “SP” - 体育赛事
gracenote_series_id

string

可选。此字段是指 Gracenote 剧集 ID。必须以“SH”为前缀。

元数据

内容的自定义元数据。

字段
key_values

map<string, Value>

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

SyndicatedVideoContentNames

所有转载内容的名称列表。

字段
syndicated_video_content[]

string

转载内容的名称的重复字段。它们必须采用“networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”格式，并且必须与包含相应字段的内容属于同一广告资源网。

UpdateVideoContentRequest

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

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

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

转载内容集合

视频格式

视频内容可采用的编码格式。

枚举
VIDEO_FORMAT_UNSPECIFIED 未指定视频格式。
HLS application/x-mpeg网址
DASH application/dash+xml

VideoIngestUrlInfo

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

字段
video_format

VideoFormat

视频的格式。
video_preconditioned

VideoPreconditioned

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

string

指向 m3u8 文件的链接。

VideoPreconditioned

视频内容的调整状态。

枚举
NO 尚未进行调理。
YES 视频已调节/拆分。