REST Resource: advertisers

资源：广告客户

展示广告和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)
  }
}
字段
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)

仅限输出。上次更新广告客户时的时间戳。由系统分配。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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)

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

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 表示法 
{

  // Union field ad_server_config_scheme can be only one of the following:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of list of possible types for union field ad_server_config_scheme.
}
字段
联合字段 ad_server_config_scheme。必需。ad_server_config_scheme 只能是下列其中一项：
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)

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

如果 advertisers.create 方法中不存在或为空，系统会自动创建 CM360 网站。

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

boolean

是否在 CM360 数据传输报表中添加 DV360 数据。
dv360ToCmCostReportingEnabled

boolean

是否向 CM360 报告 DV360 费用。
cmFloodlightLinkingAuthorized

boolean

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

AdvertiserCreativeConfig

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

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

string (int64 format)

用于配置广告系列监控功能的 ID，由 Integral Ad Service (IAS) 提供。DV360 系统将附加一个 IAS“Campaign Monitor”添加到广告素材代码中。
obaComplianceDisabled

boolean

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

如果您选择将此字段设置为 true，请注意，通过展示广告网络和Video 360 必须符合以下要求：

  • 按照您与 Google Marketing Platform 签订的合同，遵守在线行为广告 (OBA) 规范。
  • 在欧洲经济区 (EEA)，请添加透明度信息并为用户提供举报广告中的非法内容的机制。如果您使用替代的广告标记、透明度和举报解决方案，则必须确保其包含必要的透明度信息和非法内容举报机制，并通过适当的表单将收到的任何非法内容举报信息告知 Google。
dynamicCreativeEnabled

boolean

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

boolean

将此字段设置为“true”，即表示您代表贵公司授权 Google 使用与此展示广告和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

 更新现有广告客户。