REST Resource: advertisers

资源：广告客户

Display & Video 360 (DV360) 中的单个广告客户。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  },
  "prismaEnabled": boolean,
  "billingConfig": {
    object (AdvertiserBillingConfig)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus),
  "defaultBusinessName": string,
  "defaultLogoAssetId": string
}
字段
name

string

仅限输出。广告客户的资源名称。
advertiserId

string (int64 format)

仅限输出。广告客户的唯一 ID。由系统分配。
partnerId

string (int64 format)

必需。不可变。相应广告客户所属合作伙伴的唯一 ID。
displayName

string

必需。广告客户的显示名称。

必须采用 UTF-8 编码，大小上限为 240 字节。
entityStatus

enum (EntityStatus)

必需。控制广告客户的广告订单和订单项能否使用其预算并对广告资源出价。

  • 可接受的值为 ENTITY_STATUS_ACTIVE、ENTITY_STATUS_PAUSED 和 ENTITY_STATUS_SCHEDULED_FOR_DELETION。
  • 如果设置为 ENTITY_STATUS_SCHEDULED_FOR_DELETION，则广告客户将在首次被安排删除后的 30 天内被删除。
updateTime

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"。
generalConfig

object (AdvertiserGeneralConfig)

必需。广告客户的一般设置。
adServerConfig

object (AdvertiserAdServerConfig)

必需。不可变。广告客户的广告服务器相关设置。
creativeConfig

object (AdvertiserCreativeConfig)

必需。广告客户的广告素材相关设置。
dataAccessConfig

object (AdvertiserDataAccessConfig)

用于控制广告客户数据访问方式的设置。
integrationDetails

object (IntegrationDetails)

广告客户的集成详细信息。目前仅 integrationCode 适用于广告客户。不支持 IntegrationDetails 的其他字段，如果提供，系统会忽略。
servingConfig

object (AdvertiserTargetingConfig)

与广告客户的广告投放相关的定位设置。
prismaEnabled

boolean

是否已启用与 Mediaocean (Prisma) 的集成。启用此功能即表示您同意以下条款：

我谨代表本公司授权 Mediaocean (Prisma) 将预算期方案发送给 Google，并授权 Google 将相应的 DV360 报告和账单发送给 Mediaocean，以完成与此广告客户相关的预算规划、结算和对账事宜。
billingConfig

object (AdvertiserBillingConfig)

必需。广告客户的结算相关设置。
containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

可选。相应广告客户是否包含投放欧盟政治广告的订单项。

如果此字段设置为 DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING，则会发生以下情况：

  • 如果未另行指定，则在此广告客户下创建的任何新订单项都将分配 DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING。
  • 此广告客户名下所有未设置值的现有订单项将在 1 天内更新为 DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING。
defaultBusinessName

string

可选。广告客户的默认商家名称。

如果未提供商家名称，YouTube 和需求开发广告系列中相应广告客户的广告将使用此值。
defaultLogoAssetId

string (int64 format)

可选。相应广告客户的默认徽标图片的资产 ID。

如果未提供徽标素材资源，YouTube 广告和需求广告将使用此广告客户下的此资产 ID。

您必须使用 advertisers.adAssets.upload 通过 API 上传此资源。

AdvertiserGeneralConfig

广告客户的一般设置。

JSON 表示法 
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
字段
domainUrl

string

必需。广告客户主要网站的网域网址。系统会将此信息发送给需要网站网址才能将广告系列与广告客户相关联的发布商。

请提供以 http: 或 https: 开头且不含路径或查询字符串的网址。例如，http://www.example.com
timeZone

string

仅限输出。广告客户时区的标准 TZ 数据库名称。例如 America/New_York。

如需了解详情，请访问：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

对于 CM360 混合型广告客户，时区与关联的 CM360 账号的时区相同；对于仅限第三方广告客户，时区与父级合作伙伴的时区相同。
currencyCode

string

必需。不可变。广告客户的币种，采用 ISO 4217 格式。

可接受的代码及其代表的币种如下：

货币代码：货币名称

  • ARS：阿根廷比索
  • AUD：澳元
  • BRL：巴西雷亚尔
  • CAD：加拿大元
  • CHF：瑞士法郎
  • CLP：智利比索
  • CNY：人民币
  • COP：哥伦比亚比索
  • CZK：捷克克朗
  • DKK：丹麦克朗
  • EGP：埃及镑
  • EUR：欧元
  • GBP：英镑
  • HKD：港元
  • HUF：匈牙利福林
  • IDR：印度尼西亚卢比
  • ILS：以色列谢克尔
  • INR：印度卢比
  • JPY：日元
  • KRW：韩元
  • MXN：墨西哥比索
  • MYR：马来西亚林吉特
  • NGN：尼日利亚奈拉
  • NOK：挪威克朗
  • NZD：新西兰元
  • PEN：秘鲁新索尔
  • PLN：波兰兹罗提
  • RON：罗马尼亚新列伊
  • RUB：俄罗斯卢布
  • SEK：瑞典克朗
  • TRY：土耳其里拉
  • TWD：新台币
  • USD：美元
  • ZAR：南非兰特

AdvertiserAdServerConfig

广告客户的广告服务器相关设置。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of mutually exclusive fields.
}
字段
必需。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

仅适用于使用第三方广告服务器的广告客户的配置。
cmHybridConfig

object (CmHybridConfig)

同时使用 Campaign Manager 360 (CM360) 和第三方广告服务器的广告客户的配置。
互斥字段的结束。

ThirdPartyOnlyConfig

仅适用于使用第三方广告服务器的广告客户的设置。

JSON 表示法 
{
  "pixelOrderIdReportingEnabled": boolean
}
字段
pixelOrderIdReportingEnabled

boolean

是否已为像素启用订单 ID 报告。此值一旦设置为 true，便无法更改。

CmHybridConfig

同时使用 Campaign Manager 360 (CM360) 和第三方广告服务器的广告客户的设置。

JSON 表示法 
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
字段
cmAccountId

string (int64 format)

必需。不可变。与 DV360 广告客户相关联的 CM360 Floodlight 配置的账号 ID。
cmFloodlightConfigId

string (int64 format)

必需。不可变。与 DV360 广告客户相关联的 CM360 Floodlight 配置的 ID。
cmAdvertiserIds[]

string (int64 format)

仅限输出。共享 CM360 Floodlight 配置的一组 CM360 广告客户 ID。
cmSyncableSiteIds[]

string (int64 format)

CM360 网站的列表，这些网站的展示位置将作为广告素材同步到 DV360。

如果 advertisers.create 方法中缺少或为空，系统将自动创建 CM360 网站。

从该列表中移除网站可能会导致从 CM360 同步的 DV360 广告素材被删除。必须至少指定一个网站。
dv360ToCmDataSharingEnabled

boolean

是否在 CM360 数据传输报告中包含 DV360 数据。
dv360ToCmCostReportingEnabled

boolean

是否向 CM360 报告 DV360 费用。
cmFloodlightLinkingAuthorized

boolean

必需。不可变。将此字段设置为 true，即表示您代表贵公司授权将指定 Floodlight 配置中的信息共享给此 Display & Video 360 广告客户。

AdvertiserCreativeConfig

广告客户的广告素材相关设置。

JSON 表示法 
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
字段
iasClientId

string (int64 format)

Integral Ad Service (IAS) 提供的用于配置广告系列监控的 ID。DV360 系统会将包含此 ID 的 IAS“广告系列监控”代码附加到广告素材代码。
obaComplianceDisabled

boolean

是否停用 Google 的“关于此广告”功能，该功能会为您的线上行为广告 (OBA) 添加标记（用于将内容标识为广告）和透明度信息（在与“关于此广告”互动时），以满足法规要求。“关于此广告”功能可让用户更好地控制自己看到的广告，还能帮助您解释为什么他们会看到您的广告。了解详情。

如果您选择将此字段设置为 true，请注意，通过 Display & Video 360 投放的广告必须遵守以下规定：

  • 根据您与 Google Marketing Platform 签订的合同，符合线上行为广告 (OBA) 规范。
  • 在欧洲经济区 (EEA)，广告中必须包含透明度信息和供用户举报非法内容的机制。如果使用替代广告标记、透明度和举报解决方案，您必须确保该解决方案包含所需的透明度信息和非法内容标记机制，并使用相应表单将收到的任何非法内容举报信息告知 Google。
dynamicCreativeEnabled

boolean

广告客户是否已启用动态广告素材。
videoCreativeDataSharingAuthorized

boolean

将此字段设置为 true，即表示您代表贵公司授权 Google 使用与此 Display & Video 360 广告客户相关联的视频广告素材，以提供与该广告客户的电视广告系列相关的报告和功能。

仅当广告客户采用 CM360 hybrid 广告服务器配置时适用。

AdvertiserDataAccessConfig

用于控制广告客户相关数据的访问方式的设置。

JSON 表示法 
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
字段
sdfConfig

object (AdvertiserSdfConfig)

广告客户的结构化数据文件 (SDF) 设置。

如果未指定，则使用父合作伙伴的 SDF 设置。

AdvertiserSdfConfig

广告客户的结构化数据文件 (SDF) 设置。

JSON 表示法 
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
字段
overridePartnerSdfConfig

boolean

相应广告客户是否会替换其父级合作伙伴的 SDF 配置。

默认情况下，广告客户会沿用父级合作伙伴的 SDF 配置。如需替换合作伙伴配置，请将此字段设置为 true，并在 sdfConfig 中提供新配置。
sdfConfig

object (SdfConfig)

相应广告客户的 SDF 配置。

AdvertiserTargetingConfig

与广告客户的广告投放相关的定位设置。

JSON 表示法 
{
  "exemptTvFromViewabilityTargeting": boolean
}
字段
exemptTvFromViewabilityTargeting

boolean

联网电视设备是否可免于接受相应广告客户名下所有视频订单项的可见度定位。

AdvertiserBillingConfig

广告客户的结算相关设置。

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

string (int64 format)

必需。分配给广告客户的结算资料的 ID。

方法

audit

 审核广告客户。

create

 创建新的广告客户。

delete

 删除广告客户。

editAssignedTargetingOptions

 修改单个广告客户下的定位选项。

get

 获取广告客户。

list

 列出当前用户可访问的广告客户。

listAssignedTargetingOptions

 列出广告客户在各种定位类型中分配的定位选项。

patch

 更新现有广告客户。