Method: advertiserGroups.list

AI-generated Key Takeaways

This method retrieves a list of advertiser groups and supports paging.
The request uses a GET HTTP method to a specific URL containing a user profile ID.
The request body must be empty, and filtering and sorting can be applied using query parameters.
The response body includes a list of advertiser group objects, a kind identifier, and a pagination token.
The request requires authorization using the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Retrieves a list of advertiser groups, possibly filtered. This method supports paging .

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/advertiserGroups

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`profileId`	`string ( int64 format)` User profile ID associated with this request.

profileId

string ( int64 format)

User profile ID associated with this request.

Parameters
`maxResults`	`integer` Maximum number of results to return.
`ids[]`	`string ( int64 format)` Select only advertiser groups with these IDs.
`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`	`enum ( SortField )` Field by which to sort the list.
`sortOrder`	`enum ( SortOrder )` Order of sorted results.

The request body must be empty.

Advertiser Group advertiserGroups.list Response

If successful, the response body contains data with the following structure:

JSON representation
{ "kind" : string , "nextPageToken" : string , "advertiserGroups" : [ { object ( `AdvertiserGroup` ) } ] }

Fields

Fields
`kind`	`string` Identifies what kind of resource this is. Value: the fixed string `"dfareporting#advertiserGroupsListResponse"` .
`nextPageToken`	`string` Pagination token to be used for the next list operation.
`advertiserGroups[]`	`object ( AdvertiserGroup )` Advertiser group collection.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#advertiserGroupsListResponse"

nextPageToken

string

Pagination token to be used for the next list operation.

advertiserGroups[]

Advertiser group collection.

Requires the following OAuth scope: