Placements

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

资源表示形式

包含某个展示位置的属性。

{
  "kind": "dfareporting#placement",
  "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,
  "keyName": string,
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource,
  "paymentSource": string,
  "compatibility": string,
  "size": sizes Resource,
  "additionalSizes": [
    sizes Resource
  ],
  "archived": boolean,
  "paymentApproved": 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
  },
  "placementGroupId": long,
  "placementGroupIdDimensionValue": dimensionValues Resource,
  "primary": boolean,
  "tagSetting": {
    "additionalKeyValues": string,
    "includeClickTracking": boolean,
    "includeClickThroughUrls": boolean,
    "keywordOption": string
  },
  "tagFormats": [
    string
  ],
  "contentCategoryId": long,
  "placementStrategyId": long,
  "lookbackConfiguration": {
    "clickDuration": integer,
    "postImpressionActivitiesDuration": integer
  },
  "comment": string,
  "status": string,
  "publisherUpdateInfo": {
    "time": long
  },
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "sslRequired": boolean,
  "externalId": string,
  "videoSettings": {
    "kind": "dfareporting#videoSettings",
    "companionSettings": {
      "kind": "dfareporting#companionSetting",
      "companionsDisabled": boolean,
      "enabledSizes": [
        sizes Resource
      ],
      "imageOnly": boolean
    },
    "transcodeSettings": {
      "kind": "dfareporting#transcodeSetting",
      "enabledVideoFormats": [
        integer
      ]
    },
    "skippableSettings": {
      "kind": "dfareporting#skippableSetting",
      "skippable": boolean,
      "skipOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      },
      "progressOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      }
    },
    "orientation": string,
    "obaSettings": {
      "resourceUrl": string,
      "xPosition": string,
      "yPosition": string,
      "size": sizes Resource,
      "program": string,
      "iconClickThroughUrl": string,
      "iconClickTrackingUrl": string,
      "iconViewTrackingUrl": string
    },
    "obaEnabled": boolean
  },
  "videoActiveViewOptOut": boolean,
  "vpaidAdapterChoice": string,
  "adBlockingOptOut": boolean
}
属性名称 说明 备注
accountId long 此展示位置的帐号 ID。该字段可以留空。
adBlockingOptOut boolean 此展示位置是否已停用广告屏蔽功能。值为 true 时,系统会为此展示位置停用广告屏蔽功能。值为 false 时,广告系列设置和网站设置将会生效。
additionalSizes[] list 与此展示位置相关联的其他尺寸。在插入或更新展示位置时,仅需使用尺寸的 ID 字段。
advertiserId long 此展示位置的广告客户 ID。该字段可以留空。
advertiserIdDimensionValue nested object 广告客户的 ID 的维度值。该字段是自动生成的只读字段。
archived boolean 此展示位置是否已归档。
campaignId long 此展示位置的广告系列 ID。在插入时,该字段是必填字段。
campaignIdDimensionValue nested object 广告系列的 ID 的维度值。该字段是自动生成的只读字段。
comment string 有关此展示位置的备注。
compatibility string 展示位置兼容性。DISPLAYDISPLAY_INTERSTITIAL 分别是指常规广告或插页式广告在桌面设备、移动设备或移动应用中的呈现。APPAPP_INTERSTITIAL 不可再用于插入新的展示位置。请改用 DISPLAYDISPLAY_INTERSTITIALIN_STREAM_VIDEO 是指在采用 VAST 标准制作的插播视频广告中的呈现。在插入时,该字段是必填字段。

可接受的值包括:
  • APP
  • APP_INTERSTITIAL
  • DISPLAY
  • DISPLAY_INTERSTITIAL
  • IN_STREAM_AUDIO
  • IN_STREAM_VIDEO
contentCategoryId long 为此展示位置指定的内容分类的 ID。
createInfo nested object 与此展示位置的创建有关的信息。该字段是只读字段。
createInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
directorySiteId long 此展示位置的目录网站 ID。在插入时,您必须设置该字段或 siteId 字段,以指定与此展示位置相关联的网站。该字段是必填字段,但在插入后会变成只读字段。
directorySiteIdDimensionValue nested object 目录网站 ID 的维度值。该字段是自动生成的只读字段。
externalId string 此展示位置的外部 ID。
id long 此展示位置的 ID。该字段是自动生成的只读字段。
idDimensionValue nested object 此展示位置的 ID 的维度值。该字段是自动生成的只读字段。
keyName string 此展示位置的键名。该字段是自动生成的只读字段。
kind string 标识所属资源种类。值:固定字符串 "dfareporting#placement"
lastModifiedInfo nested object 与此展示位置的近期修改有关的信息。该字段是只读字段。
lastModifiedInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
lookbackConfiguration nested object 此展示位置的回溯期设置。
lookbackConfiguration.clickDuration integer 从指定用户最后一次点击您的某个广告开始的回溯期(以天为单位)。如果您输入 0,系统不会将点击视为触发 Floodlight 跟踪的事件。如果将该字段留空,将使用您帐号的默认值。可接受的值介于 0(含)到 90(含)之间。
lookbackConfiguration.postImpressionActivitiesDuration integer 从指定用户最后一次查看您的某个广告开始的回溯期(以天为单位)。如果您输入 0,系统不会将展示视为触发 Floodlight 跟踪的事件。如果将该字段留空,将使用您帐号的默认值。可接受的值介于 0(含)到 90(含)之间。
name string 此展示位置的名称。该字段是必填字段,且长度必须少于或等于 256 个字符。
paymentApproved boolean 针对此展示位置的付款是否已获批。该字段是只读字段,仅与由发布商付费的展示位置相关。
paymentSource string 此展示位置的付款来源。该字段是必填字段,但在插入后会变成只读字段。

可接受的值包括:
  • PLACEMENT_AGENCY_PAID
  • PLACEMENT_PUBLISHER_PAID
placementGroupId long 此展示位置所在组的 ID(如果有)。
placementGroupIdDimensionValue nested object 展示位置组的 ID 的维度值。该字段是自动生成的只读字段。
placementStrategyId long 为此展示位置指定的展示位置策略的 ID。
pricingSchedule nested object 此展示位置的定价计划。在插入时,该字段是必填字段,具体而言,子字段 startDateendDatepricingType 是必填字段。
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 此展示位置的测试开始日期。不应为开始日期设置小时数、分钟数和秒数,因为这样会导致错误。
primary boolean 此展示位置是否为包版(展示位置组)的主要展示位置。您无法将该字段从 true 更改为 false。将该字段设为 true 后,系统会自动将包版的原始主要展示位置的 primary 字段设为 false,并且会自动将包版的 primaryPlacementId 字段设为此展示位置的 ID。
publisherUpdateInfo nested object 与上次发布商更新有关的信息。该字段是只读字段。
publisherUpdateInfo.time long 上次更改的时间戳(以毫秒为单位,自纪元开始的时间算起)。
siteId long 与此展示位置相关联的网站 ID。在插入时,您必须设置该字段或 directorySiteId 字段,以指定与此展示位置相关联的网站。该字段是必填字段,但在插入后会变成只读字段。
siteIdDimensionValue nested object 网站 ID 的维度值。该字段是自动生成的只读字段。
size nested object 与此展示位置相关联的尺寸。在插入或更新展示位置时,仅需使用尺寸的 ID 字段。在插入时,该字段是必填字段。
sslRequired boolean 为此展示位置指定的广告素材是否必须符合 SSL 规定。
status string 第三方展示位置状态。

可接受的值包括:
  • ACKNOWLEDGE_ACCEPTANCE”:
    广告客户已同意接受在展示位置投放广告的费用。
  • ACKNOWLEDGE_REJECTION”:
    广告客户已同意拒绝在展示位置投放广告的费用。
  • DRAFT”:发布商尚未审核展示位置。
  • PAYMENT_ACCEPTED”:
    发布商已接受在展示位置投放广告的费用。
  • PAYMENT_REJECTED”:
    发布商已拒绝在展示位置投放广告的费用。
  • PENDING_REVIEW”:
    发布商尚未审核展示位置。
subaccountId long 此展示位置的子帐号 ID。该字段可以留空。
tagFormats[] list 要为此展示位置生成的代码格式。在插入时,该字段是必填字段。

可接受的值包括:

  • PLACEMENT_TAG_STANDARD
  • PLACEMENT_TAG_IFRAME_JAVASCRIPT
  • PLACEMENT_TAG_IFRAME_ILAYER
  • PLACEMENT_TAG_INTERNAL_REDIRECT
  • PLACEMENT_TAG_JAVASCRIPT
  • PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
  • PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
  • PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
  • PLACEMENT_TAG_CLICK_COMMANDS
  • PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
  • PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
  • PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4
  • PLACEMENT_TAG_TRACKING
  • PLACEMENT_TAG_TRACKING_IFRAME
  • PLACEMENT_TAG_TRACKING_JAVASCRIPT

tagSetting nested object 此展示位置的代码设置。
tagSetting.additionalKeyValues string 要添加到代码中的其他键值对。每个键值对均必须采用 key=value 格式,且各个键值对之间必须以英文分号 (;) 分隔。键和值不得包含逗号。例如,对该字段来说,id=2;color=red 是一个有效值。
tagSetting.includeClickThroughUrls boolean 是否应在代码中添加静态着陆页网址。此设置仅适用于展示位置。
tagSetting.includeClickTracking boolean 是否应在代码中添加点击跟踪字符串。
tagSetting.keywordOption string 用于指定关键字在广告代码中的嵌入方式的选项。此设置可用于指定是否在此网站的展示位置代码中插入关键字占位符。插入后,发布商可以向这些占位符添加关键字。

可接受的值包括:
  • GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD
  • IGNORE
  • PLACEHOLDER_WITH_LIST_OF_KEYWORDS
videoActiveViewOptOut boolean 是否为此展示位置的插播视频广告素材停用 Verification 和 ActiveView。网站一级也存在相同的 videoActiveViewOptOut 设置,如果这两种设置中的任一设置为 true,系统便会停用 Verification 和 ActiveView。这些设置不同于仅适用于展示广告的 DirectorySites.settings.activeViewOptOutSites.siteSettings.activeViewOptOut。不过,如果 Accounts.activeViewOptOut 设为 true,系统会同时为视频流量和展示广告停用 Verification 和 ActiveView。
videoSettings nested object 设置的集合,这些设置会影响通过此展示位置投放的视频广告素材。适用于兼容性类型为 IN_STREAM_VIDEO 的展示位置。
videoSettings.companionSettings nested object 投放到此展示位置的视频广告素材的随播广告素材的设置。
videoSettings.companionSettings.companionsDisabled boolean 是否为此展示位置停用随播广告素材。
videoSettings.companionSettings.enabledSizes[] list 要投放到此展示位置的随播广告素材的尺寸许可名单。将此列表设为 null 或留空即可投放各种尺寸的随播广告素材。
videoSettings.companionSettings.imageOnly boolean 是否仅将静态图片作为随播广告素材投放。
videoSettings.companionSettings.kind string 标识所属资源种类。值:固定字符串 "dfareporting#companionSetting"
videoSettings.kind string 标识所属资源种类。值:固定字符串 "dfareporting#videoSettings"
videoSettings.obaEnabled boolean 是否为此展示位置启用 OBA 图标。
videoSettings.obaSettings nested object 投放到此展示位置的视频广告素材的 OBA 图标的设置。如果提供此对象,广告素材一级的 OBA 设置将会被覆盖。
videoSettings.obaSettings.iconClickThroughUrl string 点击 OBA 图标后重定向到的网址。
videoSettings.obaSettings.iconClickTrackingUrl string 用于在点击 OBA 图标后跟踪点击的网址。
videoSettings.obaSettings.iconViewTrackingUrl string 用于在点击 OBA 图标后跟踪浏览的网址。
videoSettings.obaSettings.program string 指明相关图标支持的业界规范。例如,AdChoices。
videoSettings.obaSettings.resourceUrl string OBA 图标资源网址。Campaign Manager 仅支持图片和 JavaScript 图标。了解详情
videoSettings.obaSettings.size nested object OBA 图标的尺寸。
videoSettings.obaSettings.xPosition string OBA 图标在 x 坐标的位置。可接受的值为“left”或“right”。
videoSettings.obaSettings.yPosition string OBA 图标在 y 坐标的位置。可接受的值为“top”或“bottom”。
videoSettings.orientation string 视频展示位置的方向。设置此值后,展示位置将返回与指定的方向相匹配的素材资源。

可接受的值包括:
  • ANY
  • LANDSCAPE
  • PORTRAIT
videoSettings.skippableSettings nested object 投放到此展示位置的视频广告素材的可跳过性设置。如果提供此对象,广告素材一级的可跳过设置将会被覆盖。
videoSettings.skippableSettings.kind string 标识所属资源种类。值:固定字符串 "dfareporting#skippableSetting"
videoSettings.skippableSettings.progressOffset nested object 在统计一次观看之前,投放到此展示位置的视频的播放时长。当 skippable 为 true 时,该字段适用。
videoSettings.skippableSettings.progressOffset.offsetPercentage integer 时长(百分比形式的视频时长)。如果已设置 offsetSeconds,请勿设置此字段。可接受的值介于 0(含)到 100(含)之间。
videoSettings.skippableSettings.progressOffset.offsetSeconds integer 时长(以秒为单位)。如果已设置 offsetPercentage,请勿设置此字段。可接受的值介于 0(含)到 86399(含)之间。
videoSettings.skippableSettings.skipOffset nested object 在“跳过”按钮应该显示之前,投放到此展示位置的视频的播放时长。当 skippable 为 true 时,该字段适用。
videoSettings.skippableSettings.skipOffset.offsetPercentage integer 时长(百分比形式的视频时长)。如果已设置 offsetSeconds,请勿设置此字段。可接受的值介于 0(含)到 100(含)之间。
videoSettings.skippableSettings.skipOffset.offsetSeconds integer 时长(以秒为单位)。如果已设置 offsetPercentage,请勿设置此字段。可接受的值介于 0(含)到 86399(含)之间。
videoSettings.skippableSettings.skippable boolean 用户是否可以跳过投放到此展示位置的广告素材。
videoSettings.transcodeSettings nested object 投放到此展示位置的视频广告素材的转码设置。如果提供此对象,广告素材一级的转码设置将会被覆盖。
videoSettings.transcodeSettings.enabledVideoFormats[] list 要投放到此展示位置的视频的格式许可名单。将此列表设为 null 或留空即可投放各种格式的视频。
videoSettings.transcodeSettings.kind string 标识所属资源种类。值:固定字符串 "dfareporting#transcodeSetting"
vpaidAdapterChoice string 此展示位置的 VPAID 适配器设置。为分配给此展示位置的插播视频广告素材控制测量适配器将要使用的 VPAID 格式。

注意:不再支持使用 Flash。现在,如果提供值 FLASHBOTH,该字段的默认值为 HTML5

可接受的值包括:
  • BOTH
  • DEFAULT
  • FLASH
  • HTML5

方法

generatetags
为展示位置生成代码。
get
根据 ID 获取一个展示位置。
insert
插入新的展示位置。
list
检索展示位置列表,可能是过滤后的。此方法支持分页
patch
更新现有展示位置。此方法支持补丁语义
update
更新现有展示位置。