v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
campaigns

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

get/userprofiles/{+profileId}/campaigns

Path parameters

profileIdstring required

User profile ID associated with this request.

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

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

Select only campaigns that belong to this subaccount.

Response

Successful response