GOgoogle
placementGroups

POST /userprofiles/{userprofilesId}/placementGroups

Inserts a new placement group.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Request body

accountIdstring int64

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

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.

advertiserIdstring int64

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

campaignIdstring int64

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

childPlacementIdsstring[]

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

commentstring

Comments for this placement group.

contentCategoryIdstring int64

ID of the content category assigned to 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.

externalIdstring

External ID for this placement.

idstring int64

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

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.

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.

placementStrategyIdstring int64

ID of the placement strategy assigned to this placement group.

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.

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.

subaccountIdstring int64

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

Response

Successful response

accountIdstring int64

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

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.

advertiserIdstring int64

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

campaignIdstring int64

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

childPlacementIdsstring[]

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

commentstring

Comments for this placement group.

contentCategoryIdstring int64

ID of the content category assigned to 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.

externalIdstring

External ID for this placement.

idstring int64

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

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.

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.

placementStrategyIdstring int64

ID of the placement strategy assigned to this placement group.

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.

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.

subaccountIdstring int64

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

Changes

No recorded changes to this operation across all 5 revisions of this API.