dfareporting.creative Groups.list
GET {{baseUrl}}/userprofiles/:profileId/creativeGroups?advertiserIds=<string>&advertiserIds=<string>&groupNumber=<integer>&ids=<string>&ids=<string>&maxResults=<integer>&pageToken=<string>&searchString=<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 creative groups, possibly filtered. This method supports paging.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
advertiserIds | string | Select only creative groups that belong to these advertisers. | |
advertiserIds | string | Select only creative groups that belong to these advertisers. | |
groupNumber | string | Select only creative groups that belong to this subgroup. | |
ids | string | Select only creative groups with these IDs. | |
ids | string | Select only creative groups with these IDs. | |
maxResults | string | Maximum number of results to return. | |
pageToken | string | Value of the nextPageToken from the previous result page. | |
searchString | string | Allows searching for creative groups by name or ID. Wildcards () are allowed. For example, "creativegroup2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". | |
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
{"creativeGroups":[{"accountId":"nostrud dolore enim","advertiserId":"in sunt","advertiserIdDimensionValue":{"dimensionName":"adipisicing","etag":"sunt ad cupidatat in","id":"irure officia","kind":"eu in veniam deserunt labore","matchType":"CONTAINS","value":"sunt cillum in"},"groupNumber":-52262974,"id":"in sint","kind":"et culpa ipsum","name":"quis nisi consequat","subaccountId":"ea officia nisi veniam"},{"accountId":"dolor labore qui anim ","advertiserId":"qui dolor","advertiserIdDimensionValue":{"dimensionName":"deserunt ","etag":"esse in aliqua","id":"enim in dolore sed fugiat","kind":"eiusmod cillum mollit","matchType":"EXACT","value":"sed amet"},"groupNumber":93928303,"id":"Excepteur labore","kind":"qui consequat incididunt","name":"ut adipisicing fugiat ex","subaccountId":"ad velit tempor"}],"kind":"voluptate qui reprehenderit","nextPageToken":"eu mollit irure"}