Method: bidders.endpoints.list

  • Lists all endpoints associated with a specific bidder account.

  • Allows for pagination to retrieve large sets of endpoints via pageSize and pageToken parameters.

  • Returns an array of Endpoint objects along with a token for accessing the next page of results.

  • Requires authorization with the https://www.googleapis.com/auth/realtime-bidding scope.

  • The request body should be empty and the response body provides details on the endpoints.

Lists all the bidder's endpoints.

HTTP request

GET https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/endpoints

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the bidder whose endpoints will be listed. Format: bidders/{bidderAccountId}

Query parameters

Parameters
pageSize

integer

The maximum number of endpoints to return. If unspecified, at most 100 endpoints 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 endpoints.list call in ListEndpointsResponse.nextPageToken.

Request body

The request body must be empty.

Response body

A response containing bidder endpoints.

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

JSON representation 
{
  "endpoints": [
    {
      object (Endpoint)
    }
  ],
  "nextPageToken": string
}
Fields
endpoints[]

object (Endpoint)

List of bidder endpoints.
nextPageToken

string

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

Authorization scopes

Requires the following OAuth scope:

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