Retrieves a list of placement groups, possibly filtered. This method supports paging. Try it now.
Request
HTTP request
GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/placementGroups
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
profileId |
long |
User profile ID associated with this request. |
Optional query parameters | ||
advertiserIds |
long |
Select only placement groups that belong to these advertisers. |
archived |
boolean |
Select only archived placements. Don't set this field to select both archived and non-archived placements. |
campaignIds |
long |
Select only placement groups that belong to these campaigns. |
contentCategoryIds |
long |
Select only placement groups that are associated with these content categories. |
directorySiteIds |
long |
Select only placement groups that are associated with these directory sites. |
ids |
long |
Select only placement groups with these IDs. |
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.
Acceptable values are 0 to 800 , inclusive.
(Default: 800 )
|
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.
|
placementGroupType |
string |
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.
Acceptable values are:
|
placementStrategyIds |
long |
Select only placement groups that are associated with these placement strategies. |
pricingTypes |
string |
Select only placement groups with these pricing types.
Acceptable values are:
|
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" .
|
siteIds |
long |
Select only placement groups that are associated with these sites. |
sortField |
string |
Field by which to sort the list.
Acceptable values are:
|
sortOrder |
string |
Order of sorted results.
Acceptable values are:
|
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/dfatrafficking |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "dfareporting#placementGroupsListResponse", "nextPageToken": string, "placementGroups": [ placementGroups Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse" . |
|
placementGroups[] |
list |
Placement group collection. | |
nextPageToken |
string |
Pagination token to be used for the next list operation. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.