REST Resource: advertisers.adGroupAds

资源：AdGroupAd

与广告组关联的单个广告。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
字段
name

string

广告的资源名称。
advertiserId

string (int64 format)

广告所属广告客户的唯一 ID。
adGroupAdId

string (int64 format)

广告的唯一 ID。由系统分配。
adGroupId

string (int64 format)

广告所属广告组的唯一 ID。
displayName

string

广告的显示名称。

必须采用 UTF-8 编码，大小不得超过 255 字节。
entityStatus

enum (EntityStatus)

广告的实体状态。
adUrls[]

object (AdUrl)

广告使用的网址列表。
联合字段 ad_details。广告的详细信息。ad_details 只能是下列其中一项：
displayVideoSourceAd

object (DisplayVideoSourceAd)

从 Display & Video 360 广告素材中获取的广告的详细信息。
mastheadAd

object (MastheadAd)

在 YouTube 首页动态中投放的广告的详细信息。
inStreamAd

object (InStreamAd)

5 秒后可跳过的插播广告的详细信息，用于实现品牌认知度或覆盖面营销目标。
nonSkippableAd

object (NonSkippableAd)

用于覆盖面营销目标的不可跳过的插播广告详情（时长介于 6-15 秒之间）。
bumperAd

object (BumperAd)

不可跳过的短视频广告的详细信息，时长等于或短于 6 秒，用于覆盖面。
audioAd

object (AudioAd)

用于覆盖面营销目标的音频广告的详细信息。
videoDiscoverAd

object (VideoDiscoveryAd)

在发现途径中展示的宣传视频的广告的详细信息。
videoPerformanceAd

object (VideoPerformanceAd)

行动号召视频广告系列中使用的广告的详细信息，旨在吸引用户针对您的业务、服务或产品采取行动。

DisplayVideoSourceAd

源自 DV360 广告素材的广告。

JSON 表示法 
{
  "creativeId": string
}
字段
creativeId

string (int64 format)

来源广告素材的 ID。

MastheadAd

标头广告的详细信息。

JSON 表示法 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
字段
video

object (YoutubeVideoDetails)

广告使用的 YouTube 视频。
headline

string

广告的标题。
description

string

广告的说明。
videoAspectRatio

enum (VideoAspectRatio)

标头广告上自动播放的 YouTube 视频的宽高比。
autoplayVideoStartMillisecond

string (int64 format)

视频开始播放的时间（以毫秒为单位）。
autoplayVideoDuration

string (Duration format)

视频自动播放的时长。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
callToActionButtonLabel

string

号召性用语按钮上的文字。
callToActionFinalUrl

string

号召性用语按钮的目标网址。
callToActionTrackingUrl

string

号召性用语按钮的跟踪网址。
showChannelArt

boolean

是否在 YouTube 页面顶部显示背景或横幅。
companionYoutubeVideos[]

object (YoutubeVideoDetails)

在桌面设备上的标头广告旁边显示的视频。不得超过两个。

YoutubeVideoDetails

YouTube 视频的详细信息。

JSON 表示法 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
字段
id

string

可在 YouTube 网页上搜索的 YouTube 视频 ID。
unavailableReason

enum (VideoUnavailableReason)

视频数据不可用的原因。

VideoUnavailableReason

视频不可用的一些可能原因。

枚举
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED 未知或未指定。
VIDEO_UNAVAILABLE_REASON_PRIVATE 该视频是私享的。
VIDEO_UNAVAILABLE_REASON_DELETED 视频已被删除。

VideoAspectRatio

可能的 YouTube 视频宽高比。

枚举
VIDEO_ASPECT_RATIO_UNSPECIFIED 未指定或未知。
VIDEO_ASPECT_RATIO_WIDESCREEN 视频会被拉伸，并且顶部和底部会被剪裁。
VIDEO_ASPECT_RATIO_FIXED_16_9 视频使用固定的 16:9 宽高比。

InStreamAd

插播广告的详细信息。

JSON 表示法 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
字段
commonInStreamAttribute

object (CommonInStreamAttribute)

常见的广告属性。
customParameters

map (key: string, value: string)

用于将自定义值传递给跟踪网址模板的自定义参数。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

CommonInStreamAttribute

插播广告、不可跳过的广告和导视广告的常见属性。

JSON 表示法 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
字段
displayUrl

string

随广告一同展示的网页地址。
finalUrl

string

用户点击广告后到达的网页的网址。
trackingUrl

string

在后台加载的网址地址，用于跟踪目的。
actionButtonLabel

string

号召性用语按钮上的文字。
actionHeadline

string

号召性用语横幅的标题。
video

object (YoutubeVideoDetails)

广告的 YouTube 视频。
companionBanner

object (ImageAsset)

视频广告旁边显示的图片。

ImageAsset

图片素材资源的元数据。

JSON 表示法 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
字段
mimeType

string

图片素材资源的 MIME 类型。
fullSize

object (Dimensions)

此图片的原始大小元数据。
fileSize

string (int64 format)

图片素材资源的文件大小（以字节为单位）。

NonSkippableAd

不可跳过的广告的详细信息。

JSON 表示法 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
字段
commonInStreamAttribute

object (CommonInStreamAttribute)

常见的广告属性。
customParameters

map (key: string, value: string)

用于将自定义值传递给跟踪网址模板的自定义参数。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

BumperAd

导视广告的详细信息。

JSON 表示法 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
字段
commonInStreamAttribute

object (CommonInStreamAttribute)

常见的广告属性。

AudioAd

音频广告的详细信息。

JSON 表示法 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
字段
displayUrl

string

随广告一同展示的网页地址。
finalUrl

string

用户点击广告后到达的网页的网址。
trackingUrl

string

在后台加载的网址地址，用于跟踪目的。
video

object (YoutubeVideoDetails)

广告的 YouTube 视频。

VideoDiscoveryAd

视频发现广告的详细信息。

JSON 表示法 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
字段
headline

string

广告的标题。
description1

string

广告的第一行文字。
description2

string

广告的第二行文字。
video

object (YoutubeVideoDetails)

广告宣传的 YouTube 视频。
thumbnail

enum (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 (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
字段
finalUrl

string

用户点击广告后到达的网页的网址。
trackingUrl

string

为进行跟踪而在后台加载的网址。
actionButtonLabels[]

string

号召性用语按钮上显示的文字素材资源列表。
headlines[]

string

号召性用语横幅上显示的标题列表。
longHeadlines[]

string

号召性用语横幅上显示的孤立标题列表。
descriptions[]

string

号召性用语横幅上显示的说明列表。
displayUrlBreadcrumb1

string

显示网址中域名后面的第一个部分。
displayUrlBreadcrumb2

string

显示网址中域名后面的第二部分。
domain

string

显示网址的域名。
videos[]

object (YoutubeVideoDetails)

此广告使用的 YouTube 视频素材资源列表。
customParameters

map (key: string, value: string)

用于将自定义值传递给跟踪网址模板的自定义参数。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
companionBanners[]

object (ImageAsset)

此广告使用的随播横幅广告列表。

AdUrl

与广告相关的其他网址，包括信标。

JSON 表示法 
{
  "type": enum (AdUrlType),
  "url": string
}
字段
type

enum (AdUrlType)

广告网址的类型。
url

string

网址字符串值。

AdUrlType

可能的广告网址类型。

枚举
AD_URL_TYPE_UNSPECIFIED 未知或未指定。
AD_URL_TYPE_BEACON_IMPRESSION 在广告素材展示时发送 ping 的 1x1 跟踪像素。
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION 可扩展的 DCM 展示信标。在投放时，它会扩展为多个信标。
AD_URL_TYPE_BEACON_CLICK 点击事件触发时要执行 ping 操作的跟踪网址。
AD_URL_TYPE_BEACON_SKIP 在跳过事件触发时要 ping 的跟踪网址。

方法

get

 获取广告组广告。

list

 列出广告组广告。