Resource: PlacementGroup
Contains properties of a package or roadblock.
JSON representation |
---|
{ "id": string, "accountId": string, "subaccountId": string, "advertiserId": string, "campaignId": string, "name": string, "siteId": string, "directorySiteId": string, "kind": string, "pricingSchedule": { object ( |
Fields | |
---|---|
id |
ID of this placement group. This is a read-only, auto-generated field. |
accountId |
Account ID of this placement group. This is a read-only field that can be left blank. |
subaccountId |
Subaccount ID of this placement group. This is a read-only field that can be left blank. |
advertiserId |
Advertiser ID of this placement group. This is a required field on insertion. |
campaignId |
Campaign ID of this placement group. This field is required on insertion. |
name |
Name of this placement group. This is a required field and must be less than 256 characters long. |
siteId |
Site ID associated with this placement group. On insert, you must set either this field or the
field to specify the site associated with this placement group. This is a required field that is read-only after insertion. |
directorySiteId |
Directory site ID associated with this placement group. On insert, you must set either this field or the
field to specify the site associated with this placement group. This is a required field that is read-only after insertion. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
pricingSchedule |
Pricing schedule of this placement group. This field is required on insertion. |
placementGroupType |
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. |
contentCategoryId |
ID of the content category assigned to this placement group. |
placementStrategyId |
ID of the placement strategy assigned to this placement group. |
comment |
Comments for this placement group. |
childPlacementIds[] |
IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. |
primaryPlacementId |
ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the
field on all affected roadblock child placements. |
lastModifiedInfo |
Information about the most recent modification of this placement group. This is a read-only field. |
idDimensionValue |
Dimension value for the ID of this placement group. This is a read-only, auto-generated field. |
advertiserIdDimensionValue |
Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
campaignIdDimensionValue |
Dimension value for the ID of the campaign. This is a read-only, auto-generated field. |
siteIdDimensionValue |
Dimension value for the ID of the site. This is a read-only, auto-generated field. |
directorySiteIdDimensionValue |
Dimension value for the ID of the directory site. This is a read-only, auto-generated field. |
primaryPlacementIdDimensionValue |
Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. |
externalId |
External ID for this placement. |
createInfo |
Information about the creation of this placement group. This is a read-only field. |
activeStatus |
Whether this placement group is active, inactive, archived or permanently archived. |
PlacementGroupType
Enums | |
---|---|
PLACEMENT_PACKAGE |
A simple group of site-placements (tags). Basically acts as a single pricing point for a group of tags. |
PLACEMENT_ROADBLOCK |
A group of site-placements (tags) 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. This kind of group requires one of its assigned site-placements to be marked as primary for reporting purposes. |
Methods |
|
---|---|
|
Gets one placement group by ID. |
|
Inserts a new placement group. |
|
Retrieves a list of placement groups, possibly filtered. |
|
Updates an existing placement group. |
|
Updates an existing placement group. |