- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves a list of campaigns, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/campaigns
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only campaigns with these IDs. |
advertiserIds[] |
Select only campaigns that belong to these advertisers. |
advertiserGroupIds[] |
Select only campaigns whose advertisers belong to these advertiser groups. |
archived |
Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. |
overriddenEventTagId |
Select only campaigns that have overridden this event tag ID. |
subaccountId |
Select only campaigns that belong to this subaccount. |
atLeastOneOptimizationActivity |
Select only campaigns that have at least one optimization activity. |
searchString |
Allows searching for campaigns by name or ID. Wildcards (
) are allowed. For example,
will return campaigns with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match campaigns with name
,
, or simply
. |
excludedIds[] |
Exclude campaigns with these IDs. |
maxResults |
Maximum number of results to return. |
pageToken |
Value of the
from the previous result page. |
sortField |
Field by which to sort the list. |
sortOrder |
Order of sorted results. |
Request body
The request body must be empty.
Response body
Campaign campaigns.list Response
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"nextPageToken": string,
"campaigns": [
{
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
nextPageToken |
Pagination token to be used for the next list operation. |
campaigns[] |
Campaign collection. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking