GOgoogle
campaigns

GET /userprofiles/{userprofilesId}/campaigns

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

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Query parameters

advertiserGroupIdsstring[]

Select only campaigns whose advertisers belong to these advertiser groups.

advertiserIdsstring[]

Select only campaigns that belong to these advertisers.

archivedboolean

Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

atLeastOneOptimizationActivityboolean

Select only campaigns that have at least one optimization activity.

excludedIdsstring[]

Exclude campaigns with these IDs.

idsstring[]

Select only campaigns with these IDs.

maxResultsinteger

Maximum number of results to return.

overriddenEventTagIdstring int64

Select only campaigns that have overridden this event tag ID.

pageTokenstring

Value of the nextPageToken from the previous result page.

searchStringstring

Allows searching for campaigns by name or ID. Wildcards () are allowed. For example, "campaign2015" 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'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

subaccountIdstring int64

Select only campaigns that belong to this subaccount.

Response

Successful response

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

No recorded changes to this operation across all 5 revisions of this API.