Method: creativeGroups.list

  • This method retrieves a list of creative groups and supports paging.

  • The HTTP request uses the GET method and requires a profileId as a path parameter.

  • The request supports several query parameters for filtering and sorting the results, such as ids, groupNumber, searchString, advertiserIds, maxResults, pageToken, sortField, and sortOrder.

  • The request body must be empty.

  • The successful response body contains a list of creative groups, along with kind and nextPageToken fields for pagination.

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

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/creativeGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids[]

string (int64 format)

Select only creative groups with these IDs.
groupNumber

integer

Select only creative groups that belong to this subgroup.
searchString

string

Allows searching for creative groups by name or ID. Wildcards (

*

) are allowed. For example,

"creativegroup*2015"

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"

.
advertiserIds[]

string (int64 format)

Select only creative groups that belong to these advertisers.
maxResults

integer

Maximum number of results to return.
pageToken

string

Value of the

nextPageToken

from the previous result page.
sortField

enum (SortField)

Field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Creative Group creativeGroups.list Response

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

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "creativeGroups": [
    {
      object (CreativeGroup)
    }
  ]
}
Fields
kind

string

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

"dfareporting#creativeGroupsListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
creativeGroups[]

object (CreativeGroup)

Creative group collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking