dfareporting.advertiser Groups.list
GET {{baseUrl}}/userprofiles/:profileId/advertiserGroups?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 advertiser groups, possibly filtered. This method supports paging.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
ids | string | Select only advertiser groups with these IDs. | |
ids | string | Select only advertiser 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 objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". | |
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
{"advertiserGroups":[{"accountId":"voluptate fugiat minim ut","id":"eu laboris","kind":"esse ut","name":"labore dolor quis"},{"accountId":"exercitation in pariatur Excepteur","id":"Duis et dolor pariatur","kind":"do esse","name":"exercitation est"}],"kind":"id proident","nextPageToken":""}