Method: creativeFields.list

  • This method retrieves a list of creative fields, with support for filtering and paging.

  • The HTTP request uses a GET method with a URL containing the user profile ID.

  • Path parameters are used for the user profile ID, while query parameters allow for filtering by IDs, search string, advertiser IDs, and controlling pagination and sorting.

  • The request body must be empty, and the successful response body contains a list of creative fields and a pagination token.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

HTTP request

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

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 fields with these IDs.
searchString

string

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

*

) are allowed. For example,

"creativefield*2015"

will return creative fields with names like

"creativefield June 2015"

,

"creativefield April 2015"

, or simply

"creativefield 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

"creativefield"

will match creative fields with the name

"my creativefield"

,

"creativefield 2015"

, or simply

"creativefield"

.
advertiserIds[]

string (int64 format)

Select only creative fields 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 Field creativeFields.list Response

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

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

string

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

"dfareporting#creativeFieldsListResponse"

.
nextPageToken

string

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

object (CreativeField)

Creative field collection.

Authorization scopes

Requires the following OAuth scope:

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