Campaigns

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

包含某个 Campaign Manager 广告系列的属性。

{
  "kind": "dfareporting#campaign",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "advertiserGroupId": long,
  "name": string,
  "archived": boolean,
  "startDate": date,
  "endDate": date,
  "comment": string,
  "billingInvoiceCode": string,
  "audienceSegmentGroups": [
    {
      "id": long,
      "name": string,
      "audienceSegments": [
        {
          "id": long,
          "name": string,
          "allocation": integer
        }
      ]
    }
  ],
  "eventTagOverrides": [
    {
      "id": long,
      "enabled": boolean
    }
  ],
  "clickThroughUrlSuffixProperties": {
    "overrideInheritedSuffix": boolean,
    "clickThroughUrlSuffix": string
  },
  "defaultClickThroughEventTagProperties": {
    "overrideInheritedEventTag": boolean,
    "defaultClickThroughEventTagId": long
  },
  "creativeGroupIds": [
    long
  ],
  "creativeOptimizationConfiguration": {
    "optimizationModel": string,
    "optimizationActivitys": [
      {
        "floodlightActivityId": long,
        "floodlightActivityIdDimensionValue": dimensionValues Resource,
        "weight": integer
      }
    ],
    "id": long,
    "name": string
  },
  "additionalCreativeOptimizationConfigurations": [
    {
      "optimizationModel": string,
      "optimizationActivitys": [
        {
          "floodlightActivityId": long,
          "floodlightActivityIdDimensionValue": dimensionValues Resource,
          "weight": integer
        }
      ],
      "id": long,
      "name": string
    }
  ],
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "traffickerEmails": [
    string
  ],
  "externalId": string,
  "nielsenOcrEnabled": boolean,
  "adBlockingConfiguration": {
    "enabled": boolean,
    "overrideClickThroughUrl": boolean,
    "clickThroughUrl": string,
    "creativeBundleId": long
  },
  "defaultLandingPageId": long
}
属性名称 说明 备注
accountId long 此广告系列所属帐号的 ID。该字段是只读字段,可以留空。
adBlockingConfiguration nested object 此广告系列的广告屏蔽设置。
adBlockingConfiguration.clickThroughUrl string 品牌中性广告使用的点击后到达网址。当 overrideClickThroughUrl 设为 true 时,该字段为必填字段。
adBlockingConfiguration.creativeBundleId long 要用于此广告系列的广告素材集合的 ID。如果设置此 ID,品牌中性广告将从此集合中选择广告素材。否则,将使用默认的透明像素。
adBlockingConfiguration.enabled boolean 此广告系列是否已启用广告屏蔽功能。值为 true 时,系统会为此广告系列中的展示位置启用广告屏蔽功能,但此设置可能会被网站设置和展示位置设置所覆盖。值为 false 时,系统会为此广告系列下的所有展示位置停用广告屏蔽功能(无论网站设置和展示位置设置为何)。
adBlockingConfiguration.overrideClickThroughUrl boolean 品牌中性广告的点击后到达网址是来自广告系列的广告素材集合还是替换网址。如果已启用广告屏蔽功能且未配置任何广告素材集合,必须设为 true。
additionalCreativeOptimizationConfigurations[] list 此广告系列的其他广告素材优化配置。
additionalCreativeOptimizationConfigurations[].id long 此广告素材优化配置的 ID。您插入或更新广告系列时,系统会自动生成该字段。对于现有广告系列,该字段可以是 null。
additionalCreativeOptimizationConfigurations[].name string 此广告素材优化配置的名称。该字段是必填字段,且长度必须少于 129 个字符。
additionalCreativeOptimizationConfigurations[].optimizationActivitys[] list 与此配置相关联的优化活动的列表。
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityId long 此优化活动的 Floodlight 活动 ID。该字段是必填字段。
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityIdDimensionValue nested object Floodlight 活动 ID 的维度值。该字段是自动生成的只读字段。
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].weight integer 与此优化相关联的权重。分配的权重可以理解为,与分配给其他优化活动的权重所成的比例。值必须大于或等于 1
additionalCreativeOptimizationConfigurations[].optimizationModel string 适用于此配置的优化模型。

可接受的值为:
  • CLICK
  • POST_CLICK
  • POST_CLICK_AND_IMPRESSION
  • POST_IMPRESSION
  • VIDEO_COMPLETION
advertiserGroupId long 关联的广告客户的广告客户组 ID。
advertiserId long 此广告系列的广告客户 ID。该字段是必填字段。
advertiserIdDimensionValue nested object 此广告系列的广告客户 ID 的维度值。该字段是自动生成的只读字段。
archived boolean 此广告系列是否已归档。
audienceSegmentGroups[] list 为此广告系列分配的细分受众群组。细分受众群组的数量不得超过 300。
audienceSegmentGroups[].audienceSegments[] list 为此组分配的细分受众群。细分受众群的数量必须介于 2 到 100 之间。
audienceSegmentGroups[].audienceSegments[].allocation integer 为此细分受众群分配的权重。分配的权重可以理解为,与分配给同一细分受众群组中其他细分受众群的权重所成的比例。可接受的值介于 1(含)到 1000(含)之间。
audienceSegmentGroups[].audienceSegments[].id long 此细分受众群的 ID。该字段是自动生成的只读字段。
audienceSegmentGroups[].audienceSegments[].name string 此细分受众群的名称。该字段是必填字段,且长度必须少于 65 个字符。
audienceSegmentGroups[].id long 此细分受众群组的 ID。该字段是自动生成的只读字段。
audienceSegmentGroups[].name string 此细分受众群组的名称。该字段是必填字段,且长度必须少于 65 个字符。
billingInvoiceCode string 与此广告系列相关联的 Campaign Manager 客户结算帐单中包含的结算帐单代码。
clickThroughUrlSuffixProperties nested object 此广告系列的点击后到达网址后缀替换属性。
clickThroughUrlSuffixProperties.clickThroughUrlSuffix string 要应用于此实体范围内所有广告的点击后到达网址后缀。长度必须少于 128 个字符。
clickThroughUrlSuffixProperties.overrideInheritedSuffix boolean 此实体是否应将沿用的点击后到达网址后缀替换为其自行指定的值。
comment string 有关此广告系列的任意备注。长度必须少于 256 个字符。
createInfo nested object 与此广告系列的制作有关的信息。该字段是只读字段。
createInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
creativeGroupIds[] list 为此广告系列分配的广告素材组 ID 的列表。
creativeOptimizationConfiguration nested object 此广告系列的广告素材优化配置。
creativeOptimizationConfiguration.id long 此广告素材优化配置的 ID。您插入或更新广告系列时,系统会自动生成该字段。对于现有广告系列,该字段可以是 null。
creativeOptimizationConfiguration.name string 此广告素材优化配置的名称。该字段是必填字段,且长度必须少于 129 个字符。
creativeOptimizationConfiguration.optimizationActivitys[] list 与此配置相关联的优化活动的列表。
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityId long 此优化活动的 Floodlight 活动 ID。该字段是必填字段。
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue nested object Floodlight 活动 ID 的维度值。该字段是自动生成的只读字段。
creativeOptimizationConfiguration.optimizationActivitys[].weight integer 与此优化相关联的权重。分配的权重可以理解为,与分配给其他优化活动的权重所成的比例。值必须大于或等于 1
creativeOptimizationConfiguration.optimizationModel string 适用于此配置的优化模型。

可接受的值为:
  • CLICK
  • POST_CLICK
  • POST_CLICK_AND_IMPRESSION
  • POST_IMPRESSION
  • VIDEO_COMPLETION
defaultClickThroughEventTagProperties nested object 此广告系列的点击事件代码 ID 替换属性。
defaultClickThroughEventTagProperties.defaultClickThroughEventTagId long 要应用于此实体范围内所有广告的点击事件代码的 ID。
defaultClickThroughEventTagProperties.overrideInheritedEventTag boolean 此实体是否应将沿用的默认点击事件代码替换为其自行指定的值。
defaultLandingPageId long 此广告系列的默认着陆页 ID。
endDate date 广告系列停止投放的日期。插入时,结束日期必须是当天或未来的日期。结束日期必须晚于开始日期或与开始日期相同。例如,如果您将开始日期和结束日期均设为 2015 年 6 月 25 日,有效的广告系列投放日期便仅仅是 2015 年 6 月 25 日当天。不应为结束日期设置小时数、分钟数和秒数,因为这样会导致错误。该字段是必填字段。
eventTagOverrides[] list 可用于启用或停用广告客户事件代码的替换值。
eventTagOverrides[].enabled boolean 是否已启用此替换值。
eventTagOverrides[].id long 对应事件代码替换值的 ID。该字段是自动生成的只读字段。
externalId string 此广告系列的外部 ID。
id long 此广告系列的 ID。该字段是自动生成的只读字段。
idDimensionValue nested object 此广告系列的 ID 的维度值。该字段是自动生成的只读字段。
kind string 标识所属资源种类。值:固定字符串 "dfareporting#campaign"
lastModifiedInfo nested object 与此广告系列的近期修改有关的信息。该字段是只读字段。
lastModifiedInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
name string 此广告系列的名称。该字段是必填字段,长度必须少于 256 个字符,且在同一广告客户的广告系列中是唯一的。
nielsenOcrEnabled boolean 是否已为此广告系列启用 Nielsen 报表。
startDate date 广告系列开始投放的日期。开始日期可以是任何日期。不应为开始日期设置小时数、分钟数和秒数,因为这样会导致错误。该字段是必填字段。
subaccountId long 此广告系列的子帐号 ID。该字段是只读字段,可以留空。
traffickerEmails[] list 广告系列的广告投放人员的联系电子邮件地址。

方法

get
根据 ID 获取一个广告系列。
insert
插入新的广告系列。
list
检索广告系列列表,该列表可能经过了过滤。此方法支持分页
patch
更新现有广告系列。此方法支持补丁语义
update
更新现有广告系列。