PlacementGroups

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

资源表示形式

包含某个产品包或包版的属性。

{
  "kind": "dfareporting#placementGroup",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "campaignId": long,
  "campaignIdDimensionValue": dimensionValues Resource,
  "name": string,
  "siteId": long,
  "siteIdDimensionValue": dimensionValues Resource,
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource,
  "archived": boolean,
  "pricingSchedule": {
    "testingStartDate": date,
    "startDate": date,
    "endDate": date,
    "pricingType": string,
    "capCostOption": string,
    "flighted": boolean,
    "pricingPeriods": [
      {
        "startDate": date,
        "endDate": date,
        "units": long,
        "rateOrCostNanos": long,
        "pricingComment": string
      }
    ],
    "floodlightActivityId": long
  },
  "placementGroupType": string,
  "contentCategoryId": long,
  "placementStrategyId": long,
  "comment": string,
  "childPlacementIds": [
    long
  ],
  "primaryPlacementId": long,
  "primaryPlacementIdDimensionValue": dimensionValues Resource,
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "externalId": string
}
属性名称 说明 备注
accountId long 此展示位置组所对应的帐号 ID。此字段是只读字段,可以留空。
advertiserId long 此展示位置组所对应的广告客户 ID。在插入时,此字段是必填字段。
advertiserIdDimensionValue nested object 广告客户 ID 的维度值。此字段是自动生成的只读字段。
archived boolean 此展示位置组是否已归档。
campaignId long 此展示位置组所对应的广告系列 ID。在插入时,此字段是必填字段。
campaignIdDimensionValue nested object 广告系列 ID 的维度值。此字段是自动生成的只读字段。
childPlacementIds[] list 分配给此展示位置组的展示位置的 ID。此字段是自动生成的只读字段。
comment string 有关此展示位置组的备注。
contentCategoryId long 为此展示位置组指定的内容分类的 ID。
createInfo nested object 有关此展示位置组的创建的信息。此字段是只读字段。
createInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
directorySiteId long 与此展示位置组相关联的目录网站 ID。在插入时,您必须设置此字段或 site_id 字段,以指定与此展示位置组相关联的网站。此字段是必填字段;而在插入后,此字段是只读字段。
directorySiteIdDimensionValue nested object 目录网站 ID 的维度值。此字段是自动生成的只读字段。
externalId string 此展示位置所对应的外部 ID。
id long 此展示位置组的 ID。此字段是自动生成的只读字段。
idDimensionValue nested object 此展示位置组 ID 的维度值。此字段是自动生成的只读字段。
kind string 标识所属资源种类。值:固定字符串 "dfareporting#placementGroup"
lastModifiedInfo nested object 有关此展示位置组的近期修改的信息。此字段是只读字段。
lastModifiedInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
name string 此展示位置组的名称。此字段是必填字段,且长度必须少于 256 个字符。
placementGroupType string 此展示位置组的类型。产品包是一个简单的展示位置组,可作为一组代码的单个价位。包版是一个展示位置组,不仅可以作为单个价位,还会假设其中的所有代码同时投放。包版要求将所分配的一个展示位置标记为主要展示位置来生成报表。在插入时,此字段是必填字段。

可接受的值包括:
  • PLACEMENT_PACKAGE
  • PLACEMENT_ROADBLOCK
placementStrategyId long 为此展示位置组指定的展示位置策略的 ID。
pricingSchedule nested object 此展示位置组的定价计划。在插入时,此字段是必填字段。
pricingSchedule.capCostOption string 展示位置费用上限选项。

可接受的值包括:
  • CAP_COST_CUMULATIVE
  • CAP_COST_MONTHLY
  • CAP_COST_NONE
pricingSchedule.endDate date 展示位置的结束日期。该日期必须晚于展示位置的开始日期,也可以与之相同,但不能晚于广告系列的结束日期。例如,如果您将开始日期和结束日期均设为 2015 年 6 月 25 日,有效的展示位置日期便仅仅是 2015 年 6 月 25 日当天。不应为结束日期设置小时数、分钟数和秒数,因为这样会导致错误。在插入时,此字段是必填字段。
pricingSchedule.flighted boolean 是否已为此展示位置指定排期。如果值为 true,系统将自动计算定价期。
pricingSchedule.floodlightActivityId long 与此展示位置相关联的 Floodlight 活动 ID。当展示位置定价类型设为 PRICING_TYPE_CPA 时,应设置该字段。
pricingSchedule.pricingPeriods[] list 此展示位置的定价期。
pricingSchedule.pricingPeriods[].endDate date 定价期的结束日期。该日期必须晚于定价期的开始日期,也可以与之相同,但不能晚于展示位置的结束日期。定价期的结束日期和开始日期可以相同。例如,如果您将开始日期和结束日期均设为 2015 年 6 月 25 日,有效的定价期日期便仅仅是 2015 年 6 月 25 日当天。不应为结束日期设置小时数、分钟数和秒数,因为这样会导致错误。
pricingSchedule.pricingPeriods[].pricingComment string 有关此定价期的备注。
pricingSchedule.pricingPeriods[].rateOrCostNanos long 此定价期的费率或费用(以十亿分比为单位,即要乘以 1000000000)。可接受的值介于 0(含)到 1000000000000000000(含)之间。
pricingSchedule.pricingPeriods[].startDate date 定价期的开始日期。该日期必须晚于展示位置的开始日期,也可以与之相同。不应为开始日期设置小时数、分钟数和秒数,因为这样会导致错误。
pricingSchedule.pricingPeriods[].units long 此定价期的单元数。可接受的值介于 0(含)到 10000000000(含)之间。
pricingSchedule.pricingType string 展示位置的定价类型。在插入时,此字段是必填字段。

可接受的值包括:
  • PRICING_TYPE_CPA
  • PRICING_TYPE_CPC
  • PRICING_TYPE_CPM
  • PRICING_TYPE_CPM_ACTIVEVIEW
  • PRICING_TYPE_FLAT_RATE_CLICKS
  • PRICING_TYPE_FLAT_RATE_IMPRESSIONS
pricingSchedule.startDate date 展示位置的开始日期。该日期必须晚于广告系列的开始日期,也可以与之相同。不应为开始日期设置小时数、分钟数和秒数,因为这样会导致错误。在插入时,此字段是必填字段。
pricingSchedule.testingStartDate date 此展示位置的测试开始日期。不应为开始日期设置小时数、分钟数和秒数,因为这样会导致错误。
primaryPlacementId long 主要展示位置的 ID,用于计算包版广告(展示位置组)的媒体费用。如果修改此字段,系统将自动修改所有受影响的包版广告子展示位置上的 primary 字段。
primaryPlacementIdDimensionValue nested object 主要展示位置 ID 的维度值。此字段是自动生成的只读字段。
siteId long 与此展示位置组相关联的网站 ID。在插入时,您必须设置此字段或 directorySiteId 字段,以指定与此展示位置组相关联的网站。此字段是必填字段;而在插入后,此字段是只读字段。
siteIdDimensionValue nested object 网站 ID 的维度值。此字段是自动生成的只读字段。
subaccountId long 此展示位置组所对应的子帐号 ID。此字段是只读字段,可以留空。

方法

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