Method: advertisers.list

  • This method retrieves a list of advertisers, with support for paging and filtering.

  • The HTTP request uses a GET method with a URL structure including a profileId path parameter.

  • Various query parameters are available to filter the results, such as maxResults, subaccountId, status, and searchString.

  • The request body for this method must be empty, and the response body contains a list of advertisers and a nextPageToken for pagination.

  • Authorization is required using the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/advertisers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
maxResults

integer

Maximum number of results to return.
subaccountId

string (int64 format)

Select only advertisers with these subaccount IDs.
status

enum (AdvertiserStatus)

Select only advertisers with the specified status.
advertiserGroupIds[]

string (int64 format)

Select only advertisers with these advertiser group IDs.
floodlightConfigurationIds[]

string (int64 format)

Select only advertisers with these floodlight configuration IDs.
includeAdvertisersWithoutGroupsOnly

boolean

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

boolean

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

string (int64 format)

Select only advertisers with these IDs.
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

enum (SortField)

Field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Advertiser advertisers.list Response

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "advertisers": [
    {
      object (Advertiser)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#advertisersListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
advertisers[]

object (Advertiser)

Advertiser collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking