Method: bidders.endpoints.list
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eLists all endpoints associated with a specific bidder account.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of endpoints via \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns an array of \u003ccode\u003eEndpoint\u003c/code\u003e objects along with a token for accessing the next page of results.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty and the response body provides details on the endpoints.\u003c/p\u003e\n"]]],[],null,["# Method: bidders.endpoints.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEndpointsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the bidder's endpoints.\n\n### HTTP request\n\n`GET https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/endpoints`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Name of the bidder whose endpoints will be listed. Format: `bidders/{bidderAccountId}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints/list#body.ListEndpointsResponse.FIELDS.next_page_token). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response containing bidder endpoints.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"endpoints\": [ { object (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#Endpoint) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `endpoints[]` | `object (`[Endpoint](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#Endpoint)`)` List of bidder endpoints. |\n| `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](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints/list#body.QUERY_PARAMETERS.page_token). |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
