Method: creativeFieldValues.list

  • This method retrieves a list of creative field values, with options for filtering and paging.

  • The HTTP request uses a GET method with specific path parameters for profileId and creativeFieldId.

  • Several query parameters are available for refining the results, including maxResults, searchString, ids[], pageToken, sortField, and sortOrder.

  • The response body contains a JSON representation of the list of creative field values, along with a kind identifier and a nextPageToken for pagination.

  • The method requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope for authorization.

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

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.
creativeFieldId

string (int64 format)

Creative field ID for this creative field value.

Query parameters

Parameters
maxResults

integer

Maximum number of results to return.
searchString

string

Allows searching for creative field values by their values. Wildcards (e.g.

*

) are not allowed.
ids[]

string (int64 format)

Select only creative field values with these IDs.
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 Value creativeFieldValues.list Response

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

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

string

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

"dfareporting#creativeFieldValuesListResponse"

.
nextPageToken

string

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

object (CreativeFieldValue)

Creative field value collection.

Authorization scopes

Requires the following OAuth scope:

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

SortField

Enums
ID
VALUE