REST Resource: bidders.publisherConnections

  • A 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.

  • The connection status can be pending, rejected, or approved, impacting whether bid requests are received from the publisher.

  • Publishers can originate from platforms like Google Ad Manager or AdMob.

  • Bidders can manage connections through methods like batch approval, rejection, retrieval, and listing.

  • Connection details include a unique name, publisher platform, display name, bidding state, and creation time.

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".

PublisherPlatform

Publisher platforms from which a PublisherConnection can originate.

Enums
PUBLISHER_PLATFORM_UNSPECIFIED An unspecified publisher platform.
GOOGLE_AD_MANAGER A Google Ad Manager publisher.
ADMOB An AdMob publisher.

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

batchApprove

 Batch approves multiple publisher connections.

batchReject

 Batch rejects multiple publisher connections.

get

 Gets a publisher connection.

list

 Lists publisher connections for a given bidder.