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.

Creatives: list

Requires authorization

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

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
active boolean Select only active creatives. Leave blank to select active and inactive creatives.
advertiserId long Select only creatives with this advertiser ID.
archived boolean Select only archived creatives. Leave blank to select archived and unarchived creatives.
campaignId long Select only creatives with this campaign ID.
companionCreativeIds long Select only in-stream video creatives with these companion IDs.
creativeFieldIds long Select only creatives with these creative field IDs.
ids long Select only creatives 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.
renderingIds long Select only creatives with these rendering IDs.
searchString string Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
sizeIds long Select only creatives with these size IDs.
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"
studioCreativeId long Select only creatives corresponding to this Studio creative ID.
types string Select only creatives with these creative types.

Acceptable values are:
  • "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
  • "CUSTOM_DISPLAY"
  • "CUSTOM_DISPLAY_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_IMAGE_GALLERY"
  • "DISPLAY_REDIRECT"
  • "FLASH_INPAGE"
  • "HTML5_BANNER"
  • "IMAGE"
  • "INSTREAM_VIDEO"
  • "INSTREAM_VIDEO_REDIRECT"
  • "INTERNAL_REDIRECT"
  • "INTERSTITIAL_INTERNAL_REDIRECT"
  • "RICH_MEDIA_DISPLAY_BANNER"
  • "RICH_MEDIA_DISPLAY_EXPANDING"
  • "RICH_MEDIA_DISPLAY_INTERSTITIAL"
  • "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL"
  • "RICH_MEDIA_IM_EXPAND"
  • "RICH_MEDIA_INPAGE_FLOATING"
  • "RICH_MEDIA_MOBILE_IN_APP"
  • "RICH_MEDIA_PEEL_DOWN"
  • "TRACKING_TEXT"
  • "VPAID_LINEAR_VIDEO"
  • "VPAID_NON_LINEAR_VIDEO"

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#creativesListResponse",
  "nextPageToken": string,
  "creatives": [
    creatives Resource
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
nextPageToken string Pagination token to be used for the next list operation.
creatives[] list Creative collection.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager