v1

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

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

get/userprofiles/{+profileId}/advertisers

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

advertiserGroupIdsstring[]

Select only advertisers with these advertiser group IDs.

floodlightConfigurationIdsstring[]

Select only advertisers with these floodlight configuration IDs.

idsstring[]

Select only advertisers with these IDs.

includeAdvertisersWithoutGroupsOnlyboolean

Select only advertisers which do not belong to any advertiser group.

maxResultsinteger

Maximum number of results to return.

onlyParentboolean

Select only advertisers which use another advertiser's floodlight configuration.

pageTokenstring

Value of the nextPageToken from the previous result page.

searchStringstring

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" .

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

status'APPROVED' | 'ON_HOLD'

Select only advertisers with the specified status.

subaccountIdstring

Select only advertisers with these subaccount IDs.

Response

Successful response