Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
placementGroups

Updates an existing placement group. This method supports patch semantics.

patch/userprofiles/{+profileId}/placementGroups

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

idstring required

Required. Placement ID.

Request body

externalIdstring

External ID for this placement.

childPlacementIdsstring[]

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

placementGroupType'PLACEMENT_PACKAGE' | 'PLACEMENT_ROADBLOCK'

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.

commentstring

Comments for this placement group.

directorySiteIdstring int64

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.

advertiserIdstring int64

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

siteIdstring int64

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.

primaryPlacementIdstring int64

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.

campaignIdstring int64

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

placementStrategyIdstring int64

ID of the placement strategy assigned to this placement group.

activeStatus'PLACEMENT_STATUS_UNKNOWN' | 'PLACEMENT_STATUS_ACTIVE' | 'PLACEMENT_STATUS_INACTIVE' | 'PLACEMENT_STATUS_ARCHIVED' | 'PLACEMENT_STATUS_PERMANENTLY_ARCHIVED'

Whether this placement group is active, inactive, archived or permanently archived.

idstring int64

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

contentCategoryIdstring int64

ID of the content category assigned to this placement group.

subaccountIdstring int64

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

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".

namestring

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

accountIdstring int64

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

Response

Successful response