GOgoogle
buyers

POST /v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe

Changed on

Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace

Path parameters

buyersIdstring required
auctionPackagesIdstring required

Request body

SubscribeAuctionPackageRequest required

Request message for SubscribeAuctionPackage.

Response

Successful response

createTimestring google-datetime

Output only. Time the auction package was created.

creatorstring

Output only. The buyer that created this auction package. Format: buyers/{buyerAccountId}

dealOwnerSeatIdstring

Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.

descriptionstring

Output only. A description of the auction package.

displayNamestring

The display_name assigned to the auction package.

eligibleSeatIdsstring[]

Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.

namestring

Immutable. The unique identifier for the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId} The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.

subscribedBuyersstring[]

Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: buyers/{buyerAccountId}

subscribedClientsstring[]

Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: buyers/{buyerAccountId}/clients/{clientAccountId}

updateTimestring google-datetime

Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.

Changes