Method: placementGroups.list

Retrieves a list of placement groups, possibly filtered. This method supports paging.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v3.3/userprofiles/{profileId}/placementGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids

string (int64 format)

Select only placement groups with these IDs.

campaignIds

string (int64 format)

Select only placement groups that belong to these campaigns.

siteIds

string (int64 format)

Select only placement groups that are associated with these sites.

directorySiteIds

string (int64 format)

Select only placement groups that are associated with these directory sites.

placementStrategyIds

string (int64 format)

Select only placement groups that are associated with these placement strategies.

contentCategoryIds

string (int64 format)

Select only placement groups that are associated with these content categories.

pricingTypes

enum (PricingTypes)

Select only placement groups with these pricing types.

archived

boolean

Select only archived placements. Don't set this field to select both archived and non-archived placements.

placementGroupType

enum (PlacementGroupType)

Select only placement groups belonging with this group type. 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.

searchString

string

Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example,

"placement*2015"

will return placement groups with names like

"placement group June 2015"

,

"placement group May 2015"

, or simply

"placements 2015"

. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of

"placementgroup"

will match placement groups with name

"my placementgroup"

,

"placementgroup 2015"

, or simply

"placementgroup"

.

advertiserIds

string (int64 format)

Select only placement groups that belong to these advertisers.

maxEndDate

string

Select only placements or placement groups whose end date is on or before the specified

maxEndDate

. The date should be formatted as "yyyy-MM-dd".

maxResults

integer

Maximum number of results to return.

maxStartDate

string

Select only placements or placement groups whose start date is on or before the specified

maxStartDate

. The date should be formatted as "yyyy-MM-dd".

minEndDate

string

Select only placements or placement groups whose end date is on or after the specified

minEndDate

. The date should be formatted as "yyyy-MM-dd".

minStartDate

string

Select only placements or placement groups whose start date is on or after the specified

minStartDate

. The date should be formatted as "yyyy-MM-dd".

pageToken

string

Value of the

nextPageToken

from the previous result page.

sortField

enum (SortField)

Field by which to sort the list.

sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Placement Group accountPermissionGroups.list Response

JSON representation
{
  "kind": string,
  "nextPageToken": string,
  "placementGroups": [
    {
      object (PlacementGroup)
    }
  ]
}
Fields
kind

string

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

"dfareporting#placementGroupsListResponse"

.

nextPageToken

string

Pagination token to be used for the next list operation.

placementGroups[]

object (PlacementGroup)

Placement group collection.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking

PricingTypes

Enums
PRICING_TYPE_CPM
PRICING_TYPE_CPC
PRICING_TYPE_CPA
PRICING_TYPE_FLAT_RATE_IMPRESSIONS
PRICING_TYPE_FLAT_RATE_CLICKS
PRICING_TYPE_CPM_ACTIVEVIEW

PlacementGroupType

Enums
PLACEMENT_PACKAGE
PLACEMENT_ROADBLOCK

SortField

Enums
ID
NAME

SortOrder

Enums
ASCENDING
DESCENDING