Method: buyers.list

  • This document details how to list all buyer account information that a buyer user or service account is permissioned to manage using an HTTP GET request.

  • The request supports optional query parameters pageSize and pageToken for controlling the number of results returned and for pagination.

  • The request body must be empty.

  • The response body contains a list of buyer objects and a nextPageToken for retrieving subsequent pages of results.

  • Listing buyer information requires the https://www.googleapis.com/auth/realtime-bidding OAuth scope.

Lists all buyer account information the calling buyer user or service account is permissioned to manage.

HTTP request

GET https://realtimebidding.googleapis.com/v1/buyers

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

The maximum number of buyers to return. If unspecified, at most 100 buyers will be returned. The maximum value is 500; values above 500 will be coerced to 500.
pageToken

string

A token identifying a page of results the server should return.

This value is received from a previous buyers.list call in ListBuyersResponse.nextPageToken.

Request body

The request body must be empty.

Response body

A response containing buyer account information.

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

JSON representation 
{
  "buyers": [
    {
      object (Buyer)
    }
  ],
  "nextPageToken": string
}
Fields
buyers[]

object (Buyer)

List of buyers.
nextPageToken

string

A token which can be passed to a subsequent call to the buyers.list method to retrieve the next page of results in ListBuyersRequest.pageToken.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/realtime-bidding