REST Resource: buyers.auctionPackages

  • An AuctionPackage represents a segment of inventory a buyer wants to purchase, created by and shareable with multiple buyers.

  • It includes details such as name, creator, display name, description, creation and update times, and lists of subscribed clients, buyers, and media planners.

  • Buyers can get, list, subscribe to, and unsubscribe from AuctionPackages using the provided methods.

  • AuctionPackages can be subscribed to by specific clients or buyers, offering flexibility in managing access.

  • Eligible seat IDs can be set by media planners, allowing for deal transactions with specific DSPs.

Resource: AuctionPackage

Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.

JSON representation 
{
  "name": string,
  "creator": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "subscribedClients": [
    string
  ],
  "subscribedBuyers": [
    string
  ],
  "subscribedMediaPlanners": [
    {
      object (MediaPlanner)
    }
  ],
  "eligibleSeatIds": [
    string
  ],
  "dealOwnerSeatId": string
}
Fields
name

string

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

string

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

string

The displayName assigned to the auction package.
description

string

Output only. A description of the auction package.
createTime

string (Timestamp format)

Output only. Time the auction package was created.

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

string (Timestamp format)

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.

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".
subscribedClients[]

string

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}
subscribedBuyers[]

string

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}
subscribedMediaPlanners[]

object (MediaPlanner)

Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
eligibleSeatIds[]

string

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

string

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.

Methods

get

 Gets an auction package given its name.

list

 List the auction packages.

subscribe

 Subscribe to the auction package for the specified buyer.

subscribeClients

 Subscribe the specified clients of the buyer to the auction package.

unsubscribe

 Unsubscribe from the auction package for the specified buyer.

unsubscribeClients

 Unsubscribe from the auction package for the specified clients of the buyer.