The DCM/DFA Reporting and Trafficking API v3.2 is deprecated and will be sunset on August 31st, 2019. All users must migrate to a newer API version by that date.

PlacementGroups

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a package or roadblock.

{
  "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,
    "disregardOverdelivery": boolean,
    "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
}
Property name Value Description Notes
accountId long Account ID of this placement group. This is a read-only field that can be left blank.
advertiserId long Advertiser ID of this placement group. This is a required field on insertion.
advertiserIdDimensionValue nested object Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
archived boolean Whether this placement group is archived.
campaignId long Campaign ID of this placement group. This field is required on insertion.
campaignIdDimensionValue nested object Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
childPlacementIds[] list IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
comment string Comments for this placement group.
contentCategoryId long ID of the content category assigned to this placement group.
createInfo nested object Information about the creation of this placement group. This is a read-only field.
createInfo.time long Timestamp of the last change in milliseconds since epoch.
directorySiteId long Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
directorySiteIdDimensionValue nested object Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
externalId string External ID for this placement.
id long ID of this placement group. This is a read-only, auto-generated field.
idDimensionValue nested object Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
lastModifiedInfo nested object Information about the most recent modification of this placement group. This is a read-only field.
lastModifiedInfo.time long Timestamp of the last change in milliseconds since epoch.
name string Name of this placement group. This is a required field and must be less than 256 characters long.
placementGroupType string Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.

Acceptable values are:
  • "PLACEMENT_PACKAGE"
  • "PLACEMENT_ROADBLOCK"
placementStrategyId long ID of the placement strategy assigned to this placement group.
pricingSchedule nested object Pricing schedule of this placement group. This field is required on insertion.
pricingSchedule.capCostOption string Placement cap cost option.

Acceptable values are:
  • "CAP_COST_CUMULATIVE"
  • "CAP_COST_MONTHLY"
  • "CAP_COST_NONE"
pricingSchedule.disregardOverdelivery boolean Whether cap costs are ignored by ad serving.
pricingSchedule.endDate date Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
pricingSchedule.flighted boolean Whether this placement is flighted. If true, pricing periods will be computed automatically.
pricingSchedule.floodlightActivityId long Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
pricingSchedule.pricingPeriods[] list Pricing periods for this placement.
pricingSchedule.pricingPeriods[].endDate date Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
pricingSchedule.pricingPeriods[].pricingComment string Comments for this pricing period.
pricingSchedule.pricingPeriods[].rateOrCostNanos long Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
pricingSchedule.pricingPeriods[].startDate date Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
pricingSchedule.pricingPeriods[].units long Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
pricingSchedule.pricingType string Placement pricing type. This field is required on insertion.

Acceptable values are:
  • "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 Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
pricingSchedule.testingStartDate date Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
primaryPlacementId long ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
primaryPlacementIdDimensionValue nested object Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
siteId long Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
siteIdDimensionValue nested object Dimension value for the ID of the site. This is a read-only, auto-generated field.
subaccountId long Subaccount ID of this placement group. This is a read-only field that can be left blank.

Methods

get
Gets one placement group by ID.
insert
Inserts a new placement group.
list
Retrieves a list of placement groups, possibly filtered. This method supports paging.
patch
Updates an existing placement group. This method supports patch semantics.
update
Updates an existing placement group.

Send feedback about...

Campaign Manager
Campaign Manager