Method: bidders.publisherConnections.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists publisher connections for a given bidder.
HTTP request
GET https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/publisherConnections
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Name of the bidder for which publishers have initiated connections. The pattern for this resource is bidders/{bidder} where {bidder} represents the account ID of the bidder.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available through another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of ListPublisherConnectionsResponse.nextPageToken returned from the previous call to the 'publisherConnections.list' method.
|
filter |
string
Query string to filter publisher connections. Connections can be filtered by displayName, publisherPlatform, and biddingState. If no filter is specified, all publisher connections will be returned. Example: 'displayName="Great Publisher*" AND publisherPlatform=ADMOB AND biddingState != PENDING' See https://google.aip.dev/160 for more information about filtering syntax.
|
orderBy |
string
Order specification by which results should be sorted. If no sort order is specified, the results will be returned in alphabetic order based on the publisher's publisher code. Results can be sorted by createTime. Example: 'createTime DESC'.
|
Request body
The request body must be empty.
Response body
A response to a request for listing publisher connections.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"publisherConnections": [
{
object (PublisherConnection)
}
],
"nextPageToken": string
} |
| Fields |
publisherConnections[] |
object (PublisherConnection)
The list of publisher connections.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the ListPublisherConnectionsRequest.pageToken field in the subsequent call to the publisherConnections.list method to retrieve the next page of results.
|
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 publisher connections associated with a specific bidder account.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by display name, publisher platform, and bidding state.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination for retrieving large result sets.\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\u003eProvides details such as publisher platform, bidding state, and creation time for each connection.\u003c/p\u003e\n"]]],["This document details how to list publisher connections for a bidder using the Real-time Bidding API. The core action involves sending a `GET` request to `https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/publisherConnections`. The `parent` path parameter specifies the bidder. Optional query parameters like `pageSize`, `pageToken`, `filter`, and `orderBy` manage pagination, filtering, and sorting. The request body must be empty, and the response body contains a list of `publisherConnections` and a `nextPageToken` for subsequent requests. OAuth scope `https://www.googleapis.com/auth/realtime-bidding` is required.\n"],null,["# Method: bidders.publisherConnections.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.ListPublisherConnectionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists publisher connections for a given bidder.\n\n### HTTP request\n\n`GET https://realtimebidding.googleapis.com/v1/{parent=bidders/*}/publisherConnections`\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 for which publishers have initiated connections. The pattern for this resource is `bidders/{bidder}` where `{bidder}` represents the account ID of the bidder. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. The server may return fewer results than requested (due to timeout constraint) even if more are available through another call. If unspecified, the server will pick an appropriate default. Acceptable values are 1 to 5000, inclusive. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [ListPublisherConnectionsResponse.nextPageToken](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections/list#body.ListPublisherConnectionsResponse.FIELDS.next_page_token) returned from the previous call to the 'publisherConnections.list' method. |\n| `filter` | `string` Query string to filter publisher connections. Connections can be filtered by `displayName`, `publisherPlatform`, and `biddingState`. If no filter is specified, all publisher connections will be returned. Example: 'displayName=\"Great Publisher\\*\" AND publisherPlatform=ADMOB AND biddingState != PENDING' See \u003chttps://google.aip.dev/160\u003e for more information about filtering syntax. |\n| `orderBy` | `string` Order specification by which results should be sorted. If no sort order is specified, the results will be returned in alphabetic order based on the publisher's publisher code. Results can be sorted by `createTime`. Example: 'createTime DESC'. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response to a request for listing publisher connections.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"publisherConnections\": [ { object (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections#PublisherConnection) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `publisherConnections[]` | `object (`[PublisherConnection](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections#PublisherConnection)`)` The list of publisher connections. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListPublisherConnectionsRequest.pageToken](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the `publisherConnections.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
