- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves a list of placement groups, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/placementGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profile |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only placement groups with these IDs. |
campaign |
Select only placement groups that belong to these campaigns. |
site |
Select only placement groups that are associated with these sites. |
directory |
Select only placement groups that are associated with these directory sites. |
placement |
Select only placement groups that are associated with these placement strategies. |
content |
Select only placement groups that are associated with these content categories. |
pricing |
Select only placement groups with these pricing types. |
advertiser |
Select only placement groups that belong to these advertisers. |
placement |
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. |
search |
Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example,
will return placement groups with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match placement groups with name
,
, or simply
. |
max |
Select only placements or placement groups whose end date is on or before the specified
. The date should be formatted as "yyyy-MM-dd". |
max |
Maximum number of results to return. |
active |
Select only placements with these active statuses. |
max |
Select only placements or placement groups whose start date is on or before the specified
. The date should be formatted as "yyyy-MM-dd". |
min |
Select only placements or placement groups whose end date is on or after the specified
. The date should be formatted as "yyyy-MM-dd". |
min |
Select only placements or placement groups whose start date is on or after the specified
. The date should be formatted as "yyyy-MM-dd". |
page |
Value of the
from the previous result page. |
sort |
Field by which to sort the list. |
sort |
Order of sorted results. |
Request body
The request body must be empty.
Response body
Placement Group placementGroups.list Response
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"nextPageToken": string,
"placementGroups": [
{
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
next |
Pagination token to be used for the next list operation. |
placement |
Placement group collection. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking