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.

Campaigns: list

Requires authorization

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

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
advertiserGroupIds long Select only campaigns whose advertisers belong to these advertiser groups.
advertiserIds long Select only campaigns that belong to these advertisers.
archived boolean Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
atLeastOneOptimizationActivity boolean Select only campaigns that have at least one optimization activity.
excludedIds long Exclude campaigns with these IDs.
ids long Select only campaigns with these IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
overriddenEventTagId long Select only campaigns that have overridden this event tag ID.
pageToken string Value of the nextPageToken from the previous result page.
searchString string Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 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 "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
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"
subaccountId long Select only campaigns that belong to this subaccount.

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

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager