dfareporting.placement Groups.list
GET {{baseUrl}}/userprofiles/:profileId/placementGroups?advertiserIds=<string>&advertiserIds=<string>&archived=<boolean>&campaignIds=<string>&campaignIds=<string>&contentCategoryIds=<string>&contentCategoryIds=<string>&directorySiteIds=<string>&directorySiteIds=<string>&ids=<string>&ids=<string>&maxEndDate=<string>&maxResults=<integer>&maxStartDate=<string>&minEndDate=<string>&minStartDate=<string>&pageToken=<string>&placementGroupType=<string>&placementStrategyIds=<string>&placementStrategyIds=<string>&pricingTypes=<string>&pricingTypes=<string>&searchString=<string>&siteIds=<string>&siteIds=<string>&sortField=<string>&sortOrder=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Retrieves a list of placement groups, possibly filtered. This method supports paging.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
advertiserIds | string | Select only placement groups that belong to these advertisers. | |
advertiserIds | string | Select only placement groups that belong to these advertisers. | |
archived | string | Select only archived placements. Don't set this field to select both archived and non-archived placements. | |
campaignIds | string | Select only placement groups that belong to these campaigns. | |
campaignIds | string | Select only placement groups that belong to these campaigns. | |
contentCategoryIds | string | Select only placement groups that are associated with these content categories. | |
contentCategoryIds | string | Select only placement groups that are associated with these content categories. | |
directorySiteIds | string | Select only placement groups that are associated with these directory sites. | |
directorySiteIds | string | Select only placement groups that are associated with these directory sites. | |
ids | string | Select only placement groups with these IDs. | |
ids | string | 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 | string | 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. | |
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. | |
placementStrategyIds | string | Select only placement groups that are associated with these placement strategies. | |
placementStrategyIds | string | Select only placement groups that are associated with these placement strategies. | |
pricingTypes | string | Select only placement groups with these pricing types. | |
pricingTypes | string | Select only placement groups with these pricing types. | |
searchString | string | Allows searching for placement groups by name or ID. Wildcards () are allowed. For example, "placement2015" 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 | string | Select only placement groups that are associated with these sites. | |
siteIds | string | Select only placement groups that are associated with these sites. | |
sortField | string | Field by which to sort the list. | |
sortOrder | string | Order of sorted results. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"kind":"elit deserunt","nextPageToken":"consequat","placementGroups":[{"accountId":"in culpa velit","advertiserId":"non","advertiserIdDimensionValue":{"dimensionName":"qui commodo enim","etag":"laboris pariatur","id":"est ut","kind":"velit occaecat","matchType":"CONTAINS","value":"incididunt ipsum"},"archived":false,"campaignId":"consectetur in aliqua sit","campaignIdDimensionValue":{"dimensionName":"ipsum ex elit aute veniam","etag":"anim ad dolor commod","id":"sed magna","kind":"magna id qui","matchType":"EXACT","value":"veniam occaecat incididunt ex"},"childPlacementIds":["magna fugiat","id"],"comment":"ut","contentCategoryId":"deserunt officia","createInfo":{"time":"Excepteur qui"},"directorySiteId":"eu incididunt culpa ea","directorySiteIdDimensionValue":{"dimensionName":"aliquip","etag":"non deserunt","id":"ipsum nulla in","kind":"Ut esse elit","matchType":"EXACT","value":"sunt minim elit sit"},"externalId":"laboris commodo non","id":"do consequat","idDimensionValue":{"dimensionName":"dolore ut veniam ad","etag":"incididunt cupidatat","id":"cillum nisi aliqua minim","kind":"elit irure pariatur nulla deserunt","matchType":"WILDCARD_EXPRESSION","value":"aute esse ad"},"kind":"Excepteur","lastModifiedInfo":{"time":"in veniam tempor exercitation"},"name":"enim Ut culpa","placementGroupType":"PLACEMENT_ROADBLOCK","placementStrategyId":"Duis","pricingSchedule":{"capCostOption":"CAP_COST_CUMULATIVE","endDate":"1996-04-11","flighted":false,"floodlightActivityId":"Ut enim et","pricingPeriods":[{"endDate":"2010-02-05","pricingComment":"occaecat enim","rateOrCostNanos":"voluptate ea occaecat","startDate":"2003-08-20","units":"aliqua nulla ad"},{"endDate":"2008-10-14","pricingComment":"eu consequat Duis aliqua","rateOrCostNanos":"fugiat cupidatat ea ut","startDate":"2013-09-05","units":"dolore dolore com"}],"pricingType":"PRICING_TYPE_CPM_ACTIVEVIEW","startDate":"1994-11-17","testingStartDate":"2018-07-26"},"primaryPlacementId":"tempor ea ut deserunt","primaryPlacementIdDimensionValue":{"dimensionName":"est nostrud","etag":"ul","id":"do","kind":"laborum aute","matchType":"WILDCARD_EXPRESSION","value":"labore Duis voluptate"},"siteId":"vol","siteIdDimensionValue":{"dimensionName":"in amet","etag":"nulla Excepteur anim ipsum cupidatat","id":"laborum magna","kind":"sit ad minim mollit","matchType":"EXACT","value":"sit nulla eu"},"subaccountId":"ex esse quis magna"},{"accountId":"et nostrud magna do","advertiserId":"ut ullamco","advertiserIdDimensionValue":{"dimensionName":"pariatur et Duis ad officia","etag":"pari","id":"nostrud aliquip","kind":"commodo dolor","matchType":"CONTAINS","value":"est ea Duis occaecat"},"archived":true,"campaignId":"commodo irure deserunt cupidatat","campaignIdDimensionValue":{"dimensionName":"adipisicing ut","etag":"ut irure pariatur labore","id":"dolore","kind":"ex culpa","matchType":"BEGINS_WITH","value":"nisi"},"childPlacementIds":["est ut","enim in velit mollit"],"comment":"amet aliquip dolore consectetur irure","contentCategoryId":"dolor Duis elit tempor proident","createInfo":{"time":"et Excepteur in mollit occaecat"},"directorySiteId":"Lorem labore","directorySiteIdDimensionValue":{"dimensionName":"aliqua laborum sunt","etag":"irure Duis et aute","id":"culpa tempor dolor sit","kind":"magna proident voluptate null","matchType":"CONTAINS","value":"irure"},"externalId":"eu dolor esse in","id":"proident ","idDimensionValue":{"dimensionName":"laboris","etag":"officia et deserunt","id":"est dolor","kind":"eu magna voluptate","matchType":"EXACT","value":"nulla"},"kind":"non voluptate","lastModifiedInfo":{"time":"anim cillum"},"name":"eiusmod mollit nostrud Duis amet","placementGroupType":"PLACEMENT_PACKAGE","placementStrategyId":"deserunt amet","pricingSchedule":{"capCostOption":"CAP_COST_MONTHLY","endDate":"2008-02-24","flighted":true,"floodlightActivityId":"amet sit non in","pricingPeriods":[{"endDate":"1997-08-19","pricingComment":"esse Lorem consectetur do dolor","rateOrCostNanos":"laborum consectetur","startDate":"1947-07-18","units":"laborum dolore quis in cupidatat"},{"endDate":"1995-04-27","pricingComment":"exercitation","rateOrCostNanos":"aliquip velit officia nulla","startDate":"1997-08-09","units":"ex reprehenderit"}],"pricingType":"PRICING_TYPE_FLAT_RATE_CLICKS","startDate":"1947-05-17","testingStartDate":"1982-09-30"},"primaryPlacementId":"labore","primaryPlacementIdDimensionValue":{"dimensionName":"esse aliqua Excepteur pariatur ut","etag":"","id":"Excepteur veniam","kind":"labore esse elit veniam","matchType":"CONTAINS","value":"magna"},"siteId":"nostrud","siteIdDimensionValue":{"dimensionName":"qui officia","etag":"mollit do","id":"reprehenderit dolore ad","kind":"ad conse","matchType":"CONTAINS","value":"est aliquip qui"},"subaccountId":"eu magna"}]}