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
}
字段
name

string

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

advertiserId

string (int64 format)

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

partnerId

string (int64 format)

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

displayName

string

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

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

entityStatus

enum (EntityStatus)

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

  • 接受的值为 ENTITY_STATUS_ACTIVEENTITY_STATUS_PAUSEDENTITY_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,以便用于此广告客户的预算规划、结算和对帐。

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,
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
字段
cmAccountId

string (int64 format)

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

cmFloodlightConfigId

string (int64 format)

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

cmSyncableSiteIds[]

string (int64 format)

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

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

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

dv360ToCmDataSharingEnabled

boolean

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

dv360ToCmCostReportingEnabled

boolean

是否向 CM360 报告 DV360 费用。

cmFloodlightLinkingAuthorized

boolean

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

AdvertiserCreativeConfig

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

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

string (int64 format)

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

obaComplianceDisabled

boolean

是否遵循 DV360 的在线行为广告 (OBA) 规范。

警告:更改 OBA 设置可能会导致某些广告交易平台重置您的广告素材审核状态,导致这些广告素材在重新获得批准之前无法投放。

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

相应广告客户名下的所有视频订单项是否无需为联网电视设备设置可见度定位条件。

方法

audit

审核广告客户。

bulkEditAdvertiserAssignedTargetingOptions

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

bulkListAdvertiserAssignedTargetingOptions

列出广告客户在各个定位类型中的指定定位选项。

create

创建新的广告客户。

delete

删除广告客户。

get

获取广告客户。

list

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

patch

更新现有广告客户。