- 资源:AdGroupAd
- DisplayVideoSourceAd
- MastheadAd
- YoutubeVideoDetails
- VideoUnavailableReason
- VideoAspectRatio
- InStreamAd
- CommonInStreamAttribute
- ImageAsset
- NonSkippableAd
- BumperAd
- AudioAd
- VideoDiscoveryAd
- 缩略图
- VideoPerformanceAd
- AdUrl
- AdUrlType
- 方法
资源:AdGroupAd
与广告组关联的单个广告。
| JSON 表示法 | 
|---|
| { "name": string, "advertiserId": string, "adGroupAdId": string, "adGroupId": string, "displayName": string, "entityStatus": enum ( | 
| 字段 | |
|---|---|
| name | 
 相应广告的资源名称。 | 
| advertiserId | 
 相应广告所属广告客户的唯一 ID。 | 
| adGroupAdId | 
 广告的唯一 ID。由系统分配。 | 
| adGroupId | 
 相应广告所属的广告组的唯一 ID。 | 
| displayName | 
 广告的显示名称。 必须采用 UTF-8 编码,大小上限为 255 字节。 | 
| entityStatus | 
 广告的实体状态。 | 
| adUrls[] | 
 广告使用的网址列表。 | 
| 联合字段 ad_details。广告的详细信息。ad_details只能是下列其中一项: | |
| displayVideoSourceAd | 
 从 Display & Video 360 广告素材获取的广告的详细信息。 | 
| mastheadAd | 
 在 YouTube 首页动态中投放的广告的详细信息。 | 
| inStreamAd | 
 展示 5 秒后可跳过的插播广告的详细信息,用于实现品牌认知度或覆盖面营销目标。 | 
| nonSkippableAd | 
 不可跳过的短插播视频广告(时长介于 6-15 秒之间)的详细信息,用于实现覆盖面营销目标。 | 
| bumperAd | 
 用于提升覆盖面的不可跳过的短视频广告(时长不超过 6 秒)的详细信息。 | 
| audioAd | 
 用于实现覆盖面营销目标的音频广告的详细信息。 | 
| videoDiscoverAd | 
 宣传视频的广告的详细信息,该广告会显示在发现位置。 | 
| videoPerformanceAd | 
 行动号召视频广告系列中使用的广告的详细信息,旨在吸引用户针对业务、服务或产品采取行动。 | 
DisplayVideoSourceAd
源自 DV360 广告素材的广告。
| JSON 表示法 | 
|---|
| { "creativeId": string } | 
| 字段 | |
|---|---|
| creativeId | 
 源广告素材的 ID。 | 
MastheadAd
标头广告的详细信息。
| JSON 表示法 | 
|---|
| { "video": { object ( | 
| 字段 | |
|---|---|
| video | 
 广告所用的 YouTube 视频。 | 
| headline | 
 广告的标题。 | 
| description | 
 广告的说明。 | 
| videoAspectRatio | 
 标头广告中自动播放的 YouTube 视频的宽高比。 | 
| autoplayVideoStartMillisecond | 
 视频开始播放前的等待时长(以毫秒为单位)。 | 
| autoplayVideoDuration | 
 视频自动播放的时长。 该时长以秒为单位,最多包含九个小数位,以“ | 
| callToActionButtonLabel | 
 号召性用语按钮上的文字。 | 
| callToActionFinalUrl | 
 号召性用语按钮的目标网址。 | 
| callToActionTrackingUrl | 
 号召性用语按钮的跟踪网址。 | 
| showChannelArt | 
 是否显示在 YouTube 页面顶部显示的背景或横幅。 | 
| companionYoutubeVideos[] | 
 在桌面设备上的标头广告旁边显示的视频。不得超过两个。 | 
YoutubeVideoDetails
YouTube 视频的详细信息。
| JSON 表示法 | 
|---|
| {
  "id": string,
  "unavailableReason": enum ( | 
| 字段 | |
|---|---|
| id | 
 可在 YouTube 网页上搜索的 YouTube 视频 ID。 | 
| unavailableReason | 
 视频数据不可用的原因。 | 
VideoAspectRatio
YouTube 视频可能采用的宽高比。
| 枚举 | |
|---|---|
| VIDEO_ASPECT_RATIO_UNSPECIFIED | 未指定或未知。 | 
| VIDEO_ASPECT_RATIO_WIDESCREEN | 视频被拉伸,顶部和底部被裁剪。 | 
| VIDEO_ASPECT_RATIO_FIXED_16_9 | 视频采用固定的 16:9 宽高比。 | 
InStreamAd
插播广告的详细信息。
| JSON 表示法 | 
|---|
| {
  "commonInStreamAttribute": {
    object ( | 
| 字段 | |
|---|---|
| commonInStreamAttribute | 
 常见广告属性。 | 
| customParameters | 
 用于将自定义值传递给跟踪网址模板的自定义参数。 包含一系列  | 
CommonInStreamAttribute
插播广告、不可跳过的广告和导视广告的常见属性。
| JSON 表示法 | 
|---|
| { "displayUrl": string, "finalUrl": string, "trackingUrl": string, "actionButtonLabel": string, "actionHeadline": string, "video": { object ( | 
| 字段 | |
|---|---|
| displayUrl | 
 随广告一同展示的网页地址。 | 
| finalUrl | 
 用户点击广告后到达的网页的网址。 | 
| trackingUrl | 
 为跟踪目的而在后台加载的网址地址。 | 
| actionButtonLabel | 
 号召性用语按钮上的文字。 | 
| actionHeadline | 
 号召性用语横幅的标题。 | 
| video | 
 广告的 YouTube 视频。 | 
| companionBanner | 
 视频广告旁边显示的图片。 | 
ImageAsset
图片素材资源的元数据。
| JSON 表示法 | 
|---|
| {
  "mimeType": string,
  "fullSize": {
    object ( | 
| 字段 | |
|---|---|
| mimeType | 
 图片素材资源的 MIME 类型。 | 
| fullSize | 
 相应图片在原始大小下的元数据。 | 
| fileSize | 
 图片素材资源的文件大小(以字节为单位)。 | 
NonSkippableAd
不可跳过式广告的详细信息。
| JSON 表示法 | 
|---|
| {
  "commonInStreamAttribute": {
    object ( | 
| 字段 | |
|---|---|
| commonInStreamAttribute | 
 常见广告属性。 | 
| customParameters | 
 用于将自定义值传递给跟踪网址模板的自定义参数。 包含一系列  | 
BumperAd
导视广告的详细信息。
| JSON 表示法 | 
|---|
| {
  "commonInStreamAttribute": {
    object ( | 
| 字段 | |
|---|---|
| commonInStreamAttribute | 
 常见广告属性。 | 
AudioAd
音频广告的详细信息。
| JSON 表示法 | 
|---|
| {
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object ( | 
| 字段 | |
|---|---|
| displayUrl | 
 随广告一同展示的网页地址。 | 
| finalUrl | 
 用户点击广告后到达的网页的网址。 | 
| trackingUrl | 
 为跟踪目的而在后台加载的网址地址。 | 
| video | 
 广告的 YouTube 视频。 | 
VideoDiscoveryAd
视频发现广告的详细信息。
| JSON 表示法 | 
|---|
| { "headline": string, "description1": string, "description2": string, "video": { object ( | 
| 字段 | |
|---|---|
| headline | 
 广告的标题。 | 
| description1 | 
 广告的第一行文字。 | 
| description2 | 
 广告的第二行文字。 | 
| video | 
 广告宣传的 YouTube 视频。 | 
| thumbnail | 
 广告中使用的缩略图。 | 
缩略图
视频发现广告中可能显示的缩略图选项。
| 枚举 | |
|---|---|
| THUMBNAIL_UNSPECIFIED | 未知或未指定。 | 
| THUMBNAIL_DEFAULT | 默认缩略图,可以自动生成,也可以由用户上传。 | 
| THUMBNAIL_1 | 缩略图 1,从视频中生成。 | 
| THUMBNAIL_2 | 根据视频生成的缩略图 2。 | 
| THUMBNAIL_3 | 根据视频生成的缩略图 3。 | 
VideoPerformanceAd
视频效果广告的详细信息。
| JSON 表示法 | 
|---|
| { "finalUrl": string, "trackingUrl": string, "actionButtonLabels": [ string ], "headlines": [ string ], "longHeadlines": [ string ], "descriptions": [ string ], "displayUrlBreadcrumb1": string, "displayUrlBreadcrumb2": string, "domain": string, "videos": [ { object ( | 
| 字段 | |
|---|---|
| finalUrl | 
 用户点击广告后到达的网页的网址。 | 
| trackingUrl | 
 为跟踪目的而在后台加载的网址地址。 | 
| actionButtonLabels[] | 
 号召性用语按钮上显示的文字素材资源列表。 | 
| headlines[] | 
 号召性用语横幅上显示的标题列表。 | 
| longHeadlines[] | 
 号召性用语横幅上显示的单行标题列表。 | 
| descriptions[] | 
 号召性用语横幅上显示的说明列表。 | 
| displayUrlBreadcrumb1 | 
 显示网址中域名后面的第一部分。 | 
| displayUrlBreadcrumb2 | 
 显示网址中域名之后的第二部分。 | 
| domain | 
 显示网址的网域。 | 
| videos[] | 
 相应广告使用的 YouTube 视频素材资源列表。 | 
| customParameters | 
 用于将自定义值传递给跟踪网址模板的自定义参数。 包含一系列  | 
| companionBanners[] | 
 相应广告使用的随播横幅列表。 | 
AdUrl
与广告相关的其他网址,包括信标。
| JSON 表示法 | 
|---|
| {
  "type": enum ( | 
| 字段 | |
|---|---|
| type | 
 广告网址的类型。 | 
| url | 
 网址字符串值。 | 
AdUrlType
可能的广告网址类型。
| 枚举 | |
|---|---|
| AD_URL_TYPE_UNSPECIFIED | 未知或未指定。 | 
| AD_URL_TYPE_BEACON_IMPRESSION | 一个 1x1 跟踪像素,用于在投放广告素材的展示时发送 ping。 | 
| AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION | 可扩展的 DCM 展示信标。在投放时,它会扩展为多个信标。 | 
| AD_URL_TYPE_BEACON_CLICK | 点击事件触发时要 ping 的跟踪网址。 | 
| AD_URL_TYPE_BEACON_SKIP | 在触发跳过事件时要 ping 的跟踪网址。 | 
| 方法 | |
|---|---|
| 
 | 获取广告组广告。 | 
| 
 | 列出广告组广告。 |