Advertisers: list

Requires authorization

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

Request

HTTP request

GET https://www.googleapis.com/dfareporting/v3.3/userprofiles/profileId/advertisers

Parameters

Parameter name	Value	Description
Path parameters
profileId	long	User profile ID associated with this request.
Optional query parameters
advertiserGroupIds	long	Select only advertisers with these advertiser group IDs.
floodlightConfigurationIds	long	Select only advertisers with these floodlight configuration IDs.
ids	long	Select only advertisers with these IDs.
includeAdvertisersWithoutGroupsOnly	boolean	Select only advertisers which do not belong to any advertiser group.
maxResults	integer	Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
onlyParent	boolean	Select only advertisers which use another advertiser's floodlight configuration.
pageToken	string	Value of the nextPageToken from the previous result page.
searchString	string	Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" 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	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"
status	string	Select only advertisers with the specified status. Acceptable values are: "APPROVED" "ON_HOLD"
subaccountId	long	Select only advertisers with these subaccount IDs.

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#advertisersListResponse",
  "nextPageToken": string,
  "advertisers": [
    advertisers Resource
  ]
}

Property name	Value	Description	Notes
kind	string	Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
advertisers[]	list	Advertiser collection.
nextPageToken	string	Pagination token to be used for the next list operation.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.