REST Resource: bidders.publisherConnections
Stay organized with collections
Save and categorize content based on your preferences.
Resource: PublisherConnection
An Open Bidding exchange's connection to a publisher. This is initiated by the publisher for the bidder to review. If approved by the bidder, this means that the bidder agrees to receive bid requests from the publisher.
JSON representation |
{
"name": string,
"publisherPlatform": enum (PublisherPlatform ),
"displayName": string,
"biddingState": enum (State ),
"createTime": string
} |
Fields |
name |
string
Output only. Name of the publisher connection. This follows the pattern bidders/{bidder}/publisherConnections/{publisher} , where {bidder} represents the account ID of the bidder, and {publisher} is the ads.txt/app-ads.txt publisher ID.
|
publisherPlatform |
enum (PublisherPlatform )
Output only. Whether the publisher is an Ad Manager or AdMob publisher.
|
displayName |
string
Output only. Publisher display name.
|
biddingState |
enum (State )
Whether the publisher has been approved by the bidder.
|
createTime |
string (Timestamp format)
Output only. The time at which the publisher initiated a connection with the bidder (irrespective of if or when the bidder approves it). This is subsequently updated if the publisher revokes and re-initiates the connection. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
|
State
Possible states of the publisher connection. Bidders may approve a connection in order to receive bid requests from the publisher. If a connection is rejected, no bid requests from the associated publisher will be received.
Enums |
STATE_UNSPECIFIED |
An unspecified bidding status. |
PENDING |
Indicates a request for connection from the publisher that the bidder needs to review. |
REJECTED |
Indicates that the publisher was rejected. |
APPROVED |
Indicates that the publisher was approved. |
Methods |
|
Batch approves multiple publisher connections. |
|
Batch rejects multiple publisher connections. |
|
Gets a publisher connection. |
|
Lists publisher connections for a given bidder. |
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\u003eA PublisherConnection represents a publisher's request to connect with a bidder on an Open Bidding exchange, requiring bidder review and approval for bid request reception.\u003c/p\u003e\n"],["\u003cp\u003eThe connection status can be pending, rejected, or approved, impacting whether bid requests are received from the publisher.\u003c/p\u003e\n"],["\u003cp\u003ePublishers can originate from platforms like Google Ad Manager or AdMob.\u003c/p\u003e\n"],["\u003cp\u003eBidders can manage connections through methods like batch approval, rejection, retrieval, and listing.\u003c/p\u003e\n"],["\u003cp\u003eConnection details include a unique name, publisher platform, display name, bidding state, and creation time.\u003c/p\u003e\n"]]],["Publisher connections represent a link between a bidding exchange and a publisher. Publishers initiate these connections for bidder review. Once approved, bidders receive bid requests from that publisher. Connections include the publisher's name, platform (Ad Manager or AdMob), display name, bidding state (pending, rejected, or approved), and creation time. Bidders can use batch methods to approve or reject multiple connections, or individually retrieve or list them.\n"],null,["# REST Resource: bidders.publisherConnections\n\n- [Resource: PublisherConnection](#PublisherConnection)\n - [JSON representation](#PublisherConnection.SCHEMA_REPRESENTATION)\n- [PublisherPlatform](#PublisherPlatform)\n- [State](#State)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PublisherConnection\n-----------------------------\n\nAn Open Bidding exchange's connection to a publisher. This is initiated by the publisher for the bidder to review. If approved by the bidder, this means that the bidder agrees to receive bid requests from the publisher.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"publisherPlatform\": enum (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections#PublisherPlatform), \"displayName\": string, \"biddingState\": enum (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections#State), \"createTime\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Name of the publisher connection. This follows the pattern `bidders/{bidder}/publisherConnections/{publisher}`, where `{bidder}` represents the account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt publisher ID. |\n| `publisherPlatform` | `enum (`[PublisherPlatform](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections#PublisherPlatform)`)` Output only. Whether the publisher is an Ad Manager or AdMob publisher. |\n| `displayName` | `string` Output only. Publisher display name. |\n| `biddingState` | `enum (`[State](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections#State)`)` Whether the publisher has been approved by the bidder. |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The time at which the publisher initiated a connection with the bidder (irrespective of if or when the bidder approves it). This is subsequently updated if the publisher revokes and re-initiates the connection. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nPublisherPlatform\n-----------------\n\nPublisher platforms from which a PublisherConnection can originate.\n\n| Enums ||\n|----------------------------------|------------------------------------|\n| `PUBLISHER_PLATFORM_UNSPECIFIED` | An unspecified publisher platform. |\n| `GOOGLE_AD_MANAGER` | A Google Ad Manager publisher. |\n| `ADMOB` | An AdMob publisher. |\n\nState\n-----\n\nPossible states of the publisher connection. Bidders may approve a connection in order to receive bid requests from the publisher. If a connection is rejected, no bid requests from the associated publisher will be received.\n\n| Enums ||\n|---------------------|----------------------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | An unspecified bidding status. |\n| `PENDING` | Indicates a request for connection from the publisher that the bidder needs to review. |\n| `REJECTED` | Indicates that the publisher was rejected. |\n| `APPROVED` | Indicates that the publisher was approved. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|\n| ### [batchApprove](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections/batchApprove) | Batch approves multiple publisher connections. |\n| ### [batchReject](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections/batchReject) | Batch rejects multiple publisher connections. |\n| ### [get](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections/get) | Gets a publisher connection. |\n| ### [list](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.publisherConnections/list) | Lists publisher connections for a given bidder. |"]]