REST Resource: advertisers.adGroupAds

资源：AdGroupAd

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

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

  // 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)
  },
  "demandGenVideoAd": {
    object (DemandGenVideoAd)
  },
  "demandGenImageAd": {
    object (DemandGenImageAd)
  },
  "demandGenCarouselAd": {
    object (DemandGenCarouselAd)
  },
  "demandGenProductAd": {
    object (DemandGenProductAd)
  }
  // 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 字节。
adPolicy

object (AdPolicy)

仅限输出。广告的政策审批状态。
entityStatus

enum (EntityStatus)

必需。广告的实体状态。
adUrls[]

object (AdUrl)

仅限输出。广告使用的网址列表。
dcmTrackingInfo

object (DcmTrackingInfo)

可选。DCM 跟踪广告信息。仅对需求开发广告有效。

如需移除 DCM 跟踪广告信息，请将此字段留空。
联合字段 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)

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

object (DemandGenVideoAd)

视频需求开发广告的详细信息。
demandGenImageAd

object (DemandGenImageAd)

需求开发图片广告的详细信息。
demandGenProductAd

object (DemandGenProductAd)

产品需求开发广告的详细信息。

AdPolicy

与广告组广告相关联的单个广告政策。

JSON 表示法 
{
  "adPolicyApprovalStatus": enum (AdPolicyApprovalStatus),
  "adPolicyReviewStatus": enum (AdPolicyReviewStatus),
  "adPolicyTopicEntry": [
    {
      object (AdPolicyTopicEntry)
    }
  ]
}
字段
adPolicyApprovalStatus

enum (AdPolicyApprovalStatus)

广告的政策审批状态，表示审批决定。
adPolicyReviewStatus

enum (AdPolicyReviewStatus)

广告的政策审核状态，指明广告目前处于审核流程的哪个阶段。
adPolicyTopicEntry[]

object (AdPolicyTopicEntry)

与广告相关的每个政策主题的条目。每个条目都包含主题、限制级别以及有关如何解决政策问题的指导。

AdPolicyApprovalStatus

广告政策审批的可能状态。

枚举
AD_POLICY_APPROVAL_STATUS_UNKNOWN 未知或未指定。
DISAPPROVED 不会投放。
APPROVED_LIMITED 将受限投放。
APPROVED 将不受限制地投放。
AREA_OF_INTEREST_ONLY 不会在定位到的国家/地区展示，但可能会向搜索定位到的国家/地区相关信息的用户展示。

AdPolicyReviewStatus

广告政策审核的可能状态。

枚举
AD_POLICY_REVIEW_STATUS_UNKNOWN 未知或未指定。
REVIEW_IN_PROGRESS 目前正在审核中。
REVIEWED 主要审核已完成。其他评价可能仍在审核中。
UNDER_APPEAL 已重新提交以供审批，或已就违规认定提出申诉。
ELIGIBLE_MAY_SERVE 被视为符合条件，可能正在投放。我们可能还会进行进一步审核。

AdPolicyTopicEntry

一个条目，用于说明广告是如何被确定为与广告政策相关的。

JSON 表示法 
{
  "policyTopic": string,
  "policyLabel": string,
  "policyTopicDescription": string,
  "policyTopicType": enum (AdPolicyTopicEntryType),
  "policyDecisionType": enum (AdPolicyDecisionType),
  "policyEnforcementMeans": enum (AdPolicyEnforcementMeans),
  "policyTopicEvidences": [
    {
      object (AdPolicyTopicEvidence)
    }
  ],
  "policyTopicConstraints": [
    {
      object (AdPolicyTopicConstraint)
    }
  ],
  "helpCenterLink": string,
  "appealInfo": {
    object (AdPolicyTopicAppealInfo)
  }
}
字段
policyTopic

string

政策主题。

例如“商标”“酒精”等。
policyLabel

string

相应政策的本地化标签文本。

例如，“文字中的商标”“含有酒精”等。
policyTopicDescription

string

政策主题的简短摘要说明。
policyTopicType

enum (AdPolicyTopicEntryType)

广告投放因与广告政策主题相关而受到的影响。
policyDecisionType

enum (AdPolicyDecisionType)

违规认定的来源。
policyEnforcementMeans

enum (AdPolicyEnforcementMeans)

政策审核中使用的政策执行方式。
policyTopicEvidences[]

object (AdPolicyTopicEvidence)

违规认定中使用的证据。
policyTopicConstraints[]

object (AdPolicyTopicConstraint)

与违规认定相关的投放限制。
appealInfo

object (AdPolicyTopicAppealInfo)

有关如何就违规认定提出申诉的信息。

AdPolicyTopicEntryType

广告政策主题可能对广告投放产生的影响。

枚举
AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN 未知或未指定。
PROHIBITED 相应资源将不会投放。
FULLY_LIMITED 相应资源将无法在所有目标国家/地区投放。
LIMITED 相应资源无法在某些国家/地区投放。
DESCRIPTIVE 资源可以投放。
BROADENING 资源可以投放，并且可能超出正常覆盖范围。
AREA_OF_INTEREST_ONLY 该资源在所有目标国家/地区都受到限制，但可能会向搜索目标国家/地区相关信息的用户展示。

AdPolicyDecisionType

政策决定的可能来源。

枚举
AD_POLICY_DECISION_TYPE_UNKNOWN 未知或未指定。
PURSUANT_TO_NOTICE 此决定是根据法律通知、法院命令或商标内容所有者的投诉等做出的。
GOOGLE_INVESTIGATION 此裁决是 Google 开展调查后做出的。

AdPolicyEnforcementMeans

政策审核中可能使用的政策违规处置措施。

枚举
AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN 未知或未指定。
AUTOMATED 违规处置流程完全自动化。
HUMAN_REVIEW 在违规处置流程中，有人工部分或完全参与。

AdPolicyTopicEvidence

违规认定中使用的证据信息。

JSON 表示法 
{

  // Union field value can be only one of the following:
  "textList": {
    object (TextList)
  },
  "websiteList": {
    object (WebsiteList)
  },
  "httpCode": integer,
  "languageCode": string,
  "destinationTextList": {
    object (DestinationTextList)
  },
  "destinationMismatch": {
    object (DestinationMismatch)
  },
  "destinationNotWorking": {
    object (DestinationNotWorking)
  },
  "trademark": {
    object (Trademark)
  },
  "legalRemoval": {
    object (LegalRemoval)
  },
  "counterfeit": {
    object (Counterfeit)
  },
  "regionalRequirements": {
    object (RegionalRequirements)
  }
  // End of list of possible types for union field value.
}
字段
联合字段 value。违规认定的证据。value 只能是下列其中一项：
textList

object (TextList)

广告文本中发现的证据列表。
websiteList

object (WebsiteList)

与广告相关联的网站的列表。
httpCode

integer

抓取最终网址时返回的 HTTP 代码。
languageCode

string

检测到的广告所用语言。

此字段使用 IETF 语言标记，例如“en-US”。
destinationTextList

object (DestinationTextList)

导致违规的广告目标页面中的文字。
destinationMismatch

object (DestinationMismatch)

广告目标页面网址不一致。
destinationNotWorking

object (DestinationNotWorking)

与广告目标页面相关的 HTTP 或 DNS 错误信息。
trademark

object (Trademark)

导致政策违规的商标字词。
legalRemoval

object (LegalRemoval)

因法律相关法规强制执行而导致的政策违规。
counterfeit

object (Counterfeit)

导致违规的仿冒商品处置措施。
regionalRequirements

object (RegionalRequirements)

导致违规的 T&S 主动执行操作。

TextList

违反政策的文本片段列表。

JSON 表示法 
{
  "texts": [
    string
  ]
}
字段
texts[]

string

导致政策发现结果的资源中的文本片段。

WebsiteList

违反政策的网站的列表。

JSON 表示法 
{
  "websites": [
    string
  ]
}
字段
websites[]

string

导致政策发现结果的网站。

DestinationTextList

违反政策的目标文字列表。

JSON 表示法 
{
  "destinationTexts": [
    string
  ]
}
字段
destinationTexts[]

string

导致发现政策违规的目标网页文本。

DestinationMismatch

有关目标网址类型不匹配的详细信息。

JSON 表示法 
{
  "uriTypes": [
    enum (AdPolicyTopicEvidenceDestinationMismatchUrlType)
  ]
}
字段
uriTypes[]

enum (AdPolicyTopicEvidenceDestinationMismatchUrlType)

不匹配的网址集。该列表可以包含单个或多个 URI 类型。

示例 1：[DISPLAY_URL, FINAL_URL] 表示广告显示网址与广告最终到达网址不一致。

示例 2：[FINAL_URL] 表示广告最终到达网址与抓取的网址不一致，这也属于目标页面不匹配。

AdPolicyTopicEvidenceDestinationMismatchUrlType

可能的网址类型。

枚举
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN 未指定或未知。
DISPLAY_URL 显示网址。
FINAL_URL 最终到达网址。
FINAL_MOBILE_URL 最终到达移动网址。
TRACKING_URL 跟踪网址。
MOBILE_TRACKING_URL 移动跟踪网址。

DestinationNotWorking

与广告目标页面相关的 HTTP 或 DNS 错误的详细信息。

JSON 表示法 
{
  "expandedUri": string,
  "device": enum (AdPolicyTopicEvidenceDestinationNotWorkingDeviceType),
  "lastCheckedTime": string,

  // Union field reason can be only one of the following:
  "dnsErrorType": enum (AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType),
  "httpErrorCode": string
  // End of list of possible types for union field reason.
}
字段
expandedUri

string

无法正常运行的完整网址。
device

enum (AdPolicyTopicEvidenceDestinationNotWorkingDeviceType)

访问相应网址时出现错误的设备。
lastCheckedTime

string (Timestamp format)

导航到相应网址时上次看到该错误的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
联合字段 reason。HTTP 或 DNS 错误。reason 只能是下列其中一项：
dnsErrorType

enum (AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType)

DNS 错误的类型。
httpErrorCode

string (int64 format)

HTTP 错误代码。

AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType

可能的 DNS 错误类型。

枚举
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN 未指定或未知。
HOSTNAME_NOT_FOUND 在提取着陆页时，DNS 中未找到主机名。
GOOGLE_CRAWLER_DNS_ISSUE 在与 DNS 通信时，Google 无法抓取着陆页。

AdPolicyTopicEvidenceDestinationNotWorkingDeviceType

访问相应网址时可能出现错误的设备。

枚举
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN 未指定或未知。
DESKTOP 桌面设备。
ANDROID Android 设备。
IOS iOS 设备。

商标

导致政策违规的商标字词。

JSON 表示法 
{
  "owner": string,
  "term": string,
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
字段
owner

string

商标内容所有者。
term

string

商标用语。
countryRestrictions[]

object (AdPolicyCriterionRestriction)

政策违规行为的相关国家/地区。

AdPolicyCriterionRestriction

表示国家/地区限制。

JSON 表示法 
{
  "countryCriterionId": string,
  "countryLabel": string
}
字段
countryCriterionId

string (int64 format)

国家/地区条件 ID。
countryLabel

string

相应国家/地区的本地化名称。可能为空。

LegalRemoval

与法律相关的法规强制执行，无论是根据《数字千年版权法案》(DMCA) 还是当地法律法规。

JSON 表示法 
{
  "complaintType": enum (AdPolicyTopicEvidenceLegalRemovalComplaintType),
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ],
  "restrictedUris": [
    string
  ],

  // Union field type can be only one of the following:
  "dmca": {
    object (Dmca)
  },
  "localLegal": {
    object (LocalLegal)
  }
  // End of list of possible types for union field type.
}
字段
complaintType

enum (AdPolicyTopicEvidenceLegalRemovalComplaintType)

导致法律移除的投诉类型。
countryRestrictions[]

object (AdPolicyCriterionRestriction)

因法律移除而受到限制的国家/地区。
restrictedUris[]

string

因法律移除要求而受到限制的网址。
联合字段 type。有关法律移除类型的详细信息。type 只能是下列其中一项：
dmca

object (Dmca)

有关 DMCA 法规依法移除的详细信息。

数字千年版权法案 (DMCA)

DMCA 投诉详细信息。

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

string

提交法律投诉的实体。

LocalLegal

当地法律法规的详细信息。

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

string

法律声明所依据的法律类型。

AdPolicyTopicEvidenceLegalRemovalComplaintType

可针对依法移除提交的投诉类型。

枚举
COPYRIGHT

版权。

仅适用于 DMCA。
COURT_ORDER

法院命令。

仅适用于当地法律。

仿冒

导致违规的仿冒商品处置措施的详细信息。

JSON 表示法 
{
  "owners": [
    string
  ]
}
字段
owners[]

string

提出投诉的内容或商品所有者。

RegionalRequirements

针对旨在满足区域要求的政策，信任与安全 (T&S) 团队会主动执行违规处置措施。由于这是主动执行服务条款和政策，因此被视为 Google 自行开展的调查，而不是违规通知。

JSON 表示法 
{
  "regionalRequirementsEntries": [
    {
      object (RegionalRequirementsEntry)
    }
  ]
}
字段
regionalRequirementsEntries[]

object (RegionalRequirementsEntry)

地区要求列表。

RegionalRequirementsEntry

政策级区域法律违规详情。

JSON 表示法 
{
  "legalPolicy": string,
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
字段
legalPolicy

string

所违反的法律政策。
countryRestrictions[]

object (AdPolicyCriterionRestriction)

因法律政策而受到限制的国家/地区。

AdPolicyTopicConstraint

广告投放限制的详细信息。

JSON 表示法 
{
  "requestCertificateFormLink": string,

  // Union field constraint can be only one of the following:
  "countryConstraint": {
    object (AdPolicyCountryConstraintList)
  },
  "resellerConstraint": {
    object (AdPolicyResellerConstraint)
  },
  "certificateMissingCountryList": {
    object (AdPolicyCountryConstraintList)
  },
  "certificateDomainMismatchCountryList": {
    object (AdPolicyCountryConstraintList)
  },
  "globalCertificateMissing": {
    object (AdPolicyGlobalCertificateMissingConstraint)
  },
  "globalCertificateDomainMismatch": {
    object (AdPolicyGlobalCertificateDomainMismatchConstraint)
  }
  // End of list of possible types for union field constraint.
}
字段
联合字段 constraint。投放限制。constraint 只能是下列其中一项：
countryConstraint

object (AdPolicyCountryConstraintList)

无法投放广告的国家/地区。
resellerConstraint

object (AdPolicyResellerConstraint)

转销商限制。
certificateMissingCountryList

object (AdPolicyCountryConstraintList)

需要证书才能投放广告的国家/地区。
certificateDomainMismatchCountryList

object (AdPolicyCountryConstraintList)

资源网域未被与其关联的证书覆盖的国家/地区。
globalCertificateMissing

object (AdPolicyGlobalCertificateMissingConstraint)

必须要有证书，才能在任何国家/地区投放。
globalCertificateDomainMismatch

object (AdPolicyGlobalCertificateDomainMismatchConstraint)

必须提供证书才能在任何国家/地区投放广告，但现有证书未涵盖相应广告的网域。

AdPolicyCountryConstraintList

由于政策限制，广告无法投放的国家/地区列表。

JSON 表示法 
{
  "countries": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
字段
countries[]

object (AdPolicyCriterionRestriction)

无法投放广告的国家/地区。

AdPolicyResellerConstraint

此类型没有字段。

由于网站因转销商用途而被拒批，政策主题受到限制。

AdPolicyGlobalCertificateMissingConstraint

此类型没有字段。

必须要有证书，才能在任何国家/地区投放。

AdPolicyGlobalCertificateDomainMismatchConstraint

此类型没有字段。

必须提供证书才能在任何国家/地区投放广告，但现有证书未涵盖相应广告的网域。

AdPolicyTopicAppealInfo

有关如何就违规认定提出申诉的信息。

JSON 表示法 
{
  "appealType": enum (AdPolicyAppealType),
  "appealFormLink": string
}
字段
appealType

enum (AdPolicyAppealType)

相应决定是否可以通过自助申诉或申诉表单进行申诉。

AdPolicyAppealType

可能的申诉类型。

枚举
AD_POLICY_APPEAL_TYPE_UNKNOWN 未知或未指定。
SELF_SERVICE_APPEAL 您可以通过自助申诉流程对该决定提出申诉。
APPEAL_FORM 您可以使用申诉表单对此决定提出申诉。

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),
  "videoAssetId": string
}
字段
id

string

仅限输出。可在 YouTube 网页上搜索的 YouTube 视频 ID。
unavailableReason

enum (VideoUnavailableReason)

视频数据不可用的原因。
videoAssetId

string (int64 format)

必需。YouTube 视频素材资源 ID。这是 AdAsset 资源的 adAssetId。

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,
  "assetId": string
}
字段
mimeType

string

仅限输出。图片素材资源的 MIME 类型。
fullSize

object (Dimensions)

仅限输出。相应图片在原始大小下的元数据。
fileSize

string (int64 format)

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

string (int64 format)

必需。相应素材资源的唯一 ID。

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)

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

DemandGenVideoAd

需求开发视频广告的详细信息。

JSON 表示法 
{
  "finalUrl": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "callToAction": enum (CallToAction),
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanner": {
    object (ImageAsset)
  },
  "logo": {
    object (ImageAsset)
  },
  "finalMobileUrl": string,
  "finalUrlSuffix": string,
  "businessName": string
}
字段
finalUrl

string

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

string

仅限输出。为跟踪目的而在后台加载的网址地址。
userSpecifiedTrackingUrl

string

可选。由用户手动指定的跟踪网址。
callToAction

enum (CallToAction)

必需。广告中显示的号召性用语按钮。

支持的值如下：

  • AUTOMATED
  • LEARN_MORE
  • GET_QUOTE
  • APPLY_NOW
  • SIGN_UP
  • CONTACT_US
  • SUBSCRIBE
  • DOWNLOAD
  • BOOK_NOW
  • SHOP_NOW
  • BUY_NOW
  • DONATE_NOW
  • ORDER_NOW
  • PLAY_NOW
  • SEE_MORE
  • START_NOW
  • VISIT_SITE
  • WATCH_NOW
headlines[]

string

必需。广告中显示的标题列表。
longHeadlines[]

string

必需。广告上显示的长标题列表。
descriptions[]

string

必需。广告中显示的说明列表。
displayUrlBreadcrumb1

string

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

string

可选。显示网址中域名之后的第二部分。
videos[]

object (YoutubeVideoDetails)

必需。相应广告使用的 YouTube 视频素材资源列表。
customParameters

map (key: string, value: string)

可选。要添加到跟踪网址的自定义参数和相应值。

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

object (ImageAsset)

可选。相应广告使用的随播横幅广告。
finalMobileUrl

string

可选。用户在移动设备上点击广告后到达的网页的网址。
finalUrlSuffix

string

可选。要附加到着陆页网址的后缀。
businessName

string

必需。广告中显示的商家名称。

CallToAction

需求开发产品广告/视频广告的可能号召性用语值。

枚举
CALL_TO_ACTION_UNSPECIFIED 未指定或未知。
AUTOMATED 由系统自动拨打。
LEARN_MORE 了解详情。
GET_QUOTE 获取报价。
APPLY_NOW 立即申请。
SIGN_UP 注册。
CONTACT_US 与我们联系。
SUBSCRIBE 订阅。
DOWNLOAD 下载。
BOOK_NOW 立即预订。
SHOP_NOW 立即选购。
BUY_NOW 立即购买。
DONATE_NOW 立即捐款。
ORDER_NOW 立即订购。
PLAY_NOW 立即畅玩。
SEE_MORE 查看详情。
START_NOW 立即启动。
VISIT_SITE 访问网站。
WATCH_NOW 立即观看。

DemandGenImageAd

需求开发图片广告的详细信息。

JSON 表示法 
{
  "finalUrl": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "callToAction": string,
  "headlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "customParameters": {
    string: string,
    ...
  },
  "finalMobileUrl": string,
  "finalUrlSuffix": string,
  "businessName": string,
  "marketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "squareMarketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "portraitMarketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "logoImages": [
    {
      object (ImageAsset)
    }
  ]
}
字段
finalUrl

string

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

string

仅限输出。为跟踪目的而在后台加载的网址地址。
userSpecifiedTrackingUrl

string

可选。由用户手动指定的跟踪网址。
callToAction

string

必需。广告中显示的号召性用语按钮。
headlines[]

string

必需。广告中显示的标题列表。
descriptions[]

string

必需。广告中显示的说明列表。
customParameters

map (key: string, value: string)

可选。要添加到跟踪网址的自定义参数和相应值。

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

string

可选。用户在移动设备上点击广告后到达的网页的网址。
finalUrlSuffix

string

可选。要附加到着陆页网址的后缀。
businessName

string

必需。广告中显示的商家名称。
marketingImages[]

object (ImageAsset)

广告中显示的营销图片列表。
squareMarketingImages[]

object (ImageAsset)

广告中显示的方形营销图片列表。
portraitMarketingImages[]

object (ImageAsset)

广告中显示的纵向营销图片列表。
logoImages[]

object (ImageAsset)

广告中显示的徽标图片列表。

DemandGenCarouselAd

需求开发轮播广告的详细信息。

JSON 表示法 
{
  "finalUrl": string,
  "headline": string,
  "description": string,
  "cards": [
    {
      object (CarouselCard)
    }
  ],
  "finalUrlSuffix": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "businessName": string,
  "customParameters": {
    string: string,
    ...
  },
  "logo": {
    object (ImageAsset)
  }
}
字段
finalUrl

string

必需。用户点击广告后到达的网页的网址。
headline

string

必需。广告的标题。
description

string

必需。广告的说明。
cards[]

object (CarouselCard)

必需。广告中显示的卡片列表。
finalUrlSuffix

string

可选。要附加到着陆页网址的后缀。
trackingUrl

string

仅限输出。为跟踪目的而在后台加载的网址地址。
userSpecifiedTrackingUrl

string

可选。由用户手动指定的跟踪网址。
businessName

string

必需。广告中显示的商家名称。
customParameters

map (key: string, value: string)

可选。要添加到跟踪网址的自定义参数和相应值。

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

CarouselCard

需求开发广告轮播卡片的详细信息。

JSON 表示法 
{
  "finalUrl": string,
  "finalMobileUrl": string,
  "headline": string,
  "callToAction": string,
  "marketingImage": {
    object (ImageAsset)
  },
  "squareMarketingImage": {
    object (ImageAsset)
  },
  "portraitMarketingImage": {
    object (ImageAsset)
  }
}
字段
finalUrl

string

必需。用户点击卡片后到达的网页的网址。
finalMobileUrl

string

可选。用户在移动设备上点击卡片后到达的网页的网址。
headline

string

必需。卡片的标题。
callToAction

string

必需。卡片上显示的行动号召按钮中的文字。

不得超过 10 个字符。
marketingImage

object (ImageAsset)

可选。卡片上显示的营销图片。
squareMarketingImage

object (ImageAsset)

可选。卡片上显示的方形营销图片。
portraitMarketingImage

object (ImageAsset)

可选。卡片上显示的纵向营销图片。

DemandGenProductAd

产品需求开发广告的详细信息。

JSON 表示法 
{
  "finalUrl": string,
  "headline": string,
  "description": string,
  "finalUrlSuffix": string,
  "callToAction": enum (CallToAction),
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "businessName": string,
  "customParameters": {
    string: string,
    ...
  },
  "logo": {
    object (ImageAsset)
  },
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string
}
字段
finalUrl

string

必需。用户点击广告后到达的网页的网址。
headline

string

必需。广告的标题。
description

string

必需。广告的说明。
finalUrlSuffix

string

可选。要附加到着陆页网址的后缀。
callToAction

enum (CallToAction)

必需。广告中显示的号召性用语按钮。

支持的值如下：

  • AUTOMATED
  • APPLY_NOW
  • BOOK_NOW
  • CONTACT_US
  • DOWNLOAD
  • GET_QUOTE
  • LEARN_MORE
  • SHOP_NOW
  • SIGN_UP
  • SUBSCRIBE
trackingUrl

string

仅限输出。为跟踪目的而在后台加载的网址地址。
userSpecifiedTrackingUrl

string

可选。由用户手动指定的跟踪网址。
businessName

string

必需。广告中显示的商家名称。
customParameters

map (key: string, value: string)

可选。要添加到跟踪网址的自定义参数和相应值。

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

string

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

string

可选。显示网址中域名之后的第二部分。

AdUrl

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

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

enum (AdUrlType)

广告网址的类型。
url

string

网址字符串值。

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 的跟踪网址。

DcmTrackingInfo

DCM 跟踪的详细信息。

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

string (int64 format)

必需。DCM 展示位置 ID。
trackingAdId

string (int64 format)

必需。DCM 跟踪广告 ID。
creativeId

string (int64 format)

必需。DCM 广告素材 ID。

方法

create

 创建广告组广告。

delete

 删除广告组广告。

get

 获取广告组广告。

list

 列出广告组广告。

patch

 更新广告组广告。