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.

Ads: list

Requires authorization

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

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
active boolean Select only active ads.
advertiserId long Select only ads with this advertiser ID.
archived boolean Select only archived ads.
audienceSegmentIds long Select only ads with these audience segment IDs.
campaignIds long Select only ads with these campaign IDs.
compatibility string Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.

Acceptable values are:
  • "APP"
  • "APP_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
  • "IN_STREAM_VIDEO"
creativeIds long Select only ads with these creative IDs assigned.
creativeOptimizationConfigurationIds long Select only ads with these creative optimization configuration IDs.
dynamicClickTracker boolean Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
ids long Select only ads with these IDs.
landingPageIds long Select only ads with these landing page IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
overriddenEventTagId long Select only ads with this event tag override ID.
pageToken string Value of the nextPageToken from the previous result page.
placementIds long Select only ads with these placement IDs assigned.
remarketingListIds long Select only ads whose list targeting expression use these remarketing list IDs.
searchString string Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
sizeIds long Select only ads 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"
sslCompliant boolean Select only ads that are SSL-compliant.
sslRequired boolean Select only ads that require SSL.
type string Select only ads with these types.

Acceptable values are:
  • "AD_SERVING_CLICK_TRACKER"
  • "AD_SERVING_DEFAULT_AD"
  • "AD_SERVING_STANDARD_AD"
  • "AD_SERVING_TRACKING"

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

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager