The DCM/DFA Reporting and Trafficking API v2.7 is deprecated and will be sunset on November 30th, 2017. All users must migrate to a newer API version by that date.

CreativeFields: list

Requires authorization

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

Request

HTTP request

GET https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/creativeFields

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
advertiserIds long Select only creative fields that belong to these advertisers.
ids long Select only creative fields with these IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
pageToken string Value of the nextPageToken from the previous result page.
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".
sortField string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)
  • "DESCENDING"

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "dfareporting#creativeFieldsListResponse",
  "nextPageToken": string,
  "creativeFields": [
    creativeFields Resource
  ]
}
Property name Value Description Notes
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[] list Creative field collection.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager