Method: creativeFields.list

AI-generated Key Takeaways

This method retrieves a list of creative fields and supports paging.
The HTTP request uses a GET method to a specific URL that includes a profileId .
Path parameters include the required profileId to associate the request with a user profile.
Query parameters allow filtering and sorting of the results based on criteria like IDs, search string, advertiser IDs, max results, page token, sort field, and sort order.
The response body contains a JSON representation that includes the resource type, a next page token for pagination, and a collection of creative fields.

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

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

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
`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, `"creativefield2015"` 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.

The request body must be empty.

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

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.

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[]

Creative field collection.

Requires the following OAuth scope: