REST Resource: placementGroups

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 (  PricingSchedule 
 
) 
 } 
 , 
 "placementGroupType" 
 : 
 enum (  PlacementGroupType 
 
) 
 , 
 "contentCategoryId" 
 : 
 string 
 , 
 "placementStrategyId" 
 : 
 string 
 , 
 "comment" 
 : 
 string 
 , 
 "childPlacementIds" 
 : 
 [ 
 string 
 ] 
 , 
 "primaryPlacementId" 
 : 
 string 
 , 
 "lastModifiedInfo" 
 : 
 { 
 object (  LastModifiedInfo 
 
) 
 } 
 , 
 "idDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "advertiserIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "campaignIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "siteIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "directorySiteIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "primaryPlacementIdDimensionValue" 
 : 
 { 
 object (  DimensionValue 
 
) 
 } 
 , 
 "externalId" 
 : 
 string 
 , 
 "createInfo" 
 : 
 { 
 object (  LastModifiedInfo 
 
) 
 } 
 , 
 "activeStatus" 
 : 
 enum (  PlacementActiveStatus 
 
) 
 }
Fields
id

string ( int64 format)

ID of this placement group. This is a read-only, auto-generated field.
account Id

string ( int64 format)

Account ID of this placement group. This is a read-only field that can be left blank.
subaccount Id

string ( int64 format)

Subaccount ID of this placement group. This is a read-only field that can be left blank.
advertiser Id

string ( int64 format)

Advertiser ID of this placement group. This is a required field on insertion.
campaign Id

string ( int64 format)

Campaign ID of this placement group. This field is required on insertion.
name

string

Name of this placement group. This is a required field and must be less than 256 characters long.
site Id

string ( int64 format)

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.
directory Site Id

string ( int64 format)

Directory site ID associated with this placement group. On insert, you must set either this field or the

siteId

field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#placementGroup"

.
pricing Schedule

object ( PricingSchedule )

Pricing schedule of this placement group. This field is required on insertion.
placement Group Type

enum ( 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.
content Category Id

string ( int64 format)

ID of the content category assigned to this placement group.
placement Strategy Id

string ( int64 format)

ID of the placement strategy assigned to this placement group.
comment

string

Comments for this placement group.
child Placement Ids[]

string ( int64 format)

IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
primary Placement Id

string ( int64 format)

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.
last Modified Info

object ( LastModifiedInfo )

Information about the most recent modification of this placement group. This is a read-only field.
id Dimension Value

object ( DimensionValue )

Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
advertiser Id Dimension Value

object ( DimensionValue )

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
campaign Id Dimension Value

object ( DimensionValue )

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
site Id Dimension Value

object ( DimensionValue )

Dimension value for the ID of the site. This is a read-only, auto-generated field.
directory Site Id Dimension Value

object ( DimensionValue )

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
primary Placement Id Dimension Value

object ( DimensionValue )

Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
external Id

string

External ID for this placement.
create Info

object ( LastModifiedInfo )

Information about the creation of this placement group. This is a read-only field.
active Status

enum ( PlacementActiveStatus )

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

get

Gets one placement group by ID.

insert

Inserts a new placement group.

list

Retrieves a list of placement groups, possibly filtered.

patch

Updates an existing placement group.

update

Updates an existing placement group.