REST Resource: networks.privateAuctionDeals

Resource: PrivateAuctionDeal

The PrivateAuctionDeal resource.

JSON representation 
{
  "name": string,
  "privateAuctionDealId": string,
  "privateAuctionId": string,
  "privateAuctionDisplayName": string,
  "buyerAccountId": string,
  "externalDealId": string,
  "endTime": string,
  "floorPrice": {
    object (Money)
  },
  "creativeSizes": [
    {
      object (Size)
    }
  ],
  "status": enum (PrivateMarketplaceDealStatus),
  "auctionPriorityEnabled": boolean,
  "blockOverrideEnabled": boolean,
  "buyerPermissionType": enum (DealBuyerPermissionType),
  "buyerData": {
    object (BuyerData)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name of the PrivateAuctionDeal. Format: networks/{networkCode}/privateAuctionDeals/{privateAuctionDealId}
privateAuctionDealId

string (int64 format)

Output only. PrivateAuctionDeal ID.
privateAuctionId

string (int64 format)

Immutable. The ID of the PrivateAuction.
privateAuctionDisplayName

string

Output only. The display name of the PrivateAuction.
buyerAccountId

string (int64 format)

Immutable. The account ID of the buyer of the PrivateAuctionDeal.
externalDealId

string (int64 format)

Output only. The external ID of the PrivateAuctionDeal.
endTime

string (Timestamp format)

Optional. The end time of the PrivateAuctionDeal.

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

object (Money)

Required. The floor price of the PrivateAuctionDeal.
creativeSizes[]

object (Size)

Optional. The expected creative sizes of the PrivateAuctionDeal.
status

enum (PrivateMarketplaceDealStatus)

Output only. The status of the PrivateAuctionDeal.
auctionPriorityEnabled

boolean

Optional. Whether the deal is enabled with priority over open auction.
blockOverrideEnabled

boolean

Optional. Whether the deal has block override enabled.
buyerPermissionType

enum (DealBuyerPermissionType)

Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder.
buyerData

object (BuyerData)

Optional. The buyer data required by the Marketplace API.
createTime

string (Timestamp format)

Output only. The instant at which the PrivateAuctionDeal 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. The instant at which the PrivateAuctionDeal was last updated.

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

Money

Represents an amount of money with its currency type.

JSON representation 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Fields
currencyCode

string

The three-letter currency code defined in ISO 4217.
units

string (int64 format)

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
nanos

integer

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

PrivateMarketplaceDealStatus

Describes the status of a private marketplace deal.

Enums
PRIVATE_MARKETPLACE_DEAL_STATUS_UNSPECIFIED No value specified.
PENDING The deal is pending.
ACTIVE The deal is active.
CANCELED The deal is canceled.
SELLER_PAUSED The deal is paused by the seller.
BUYER_PAUSED The deal is paused by the buyer.

DealBuyerPermissionType

Defines how a deal would transact among all buyers under the same bidder.

Enums
DEAL_BUYER_PERMISSION_TYPE_UNSPECIFIED No value specified.
NEGOTIATOR_ONLY The deal only transacts with the buyer specified.
BIDDER The deal transacts with all buyers under the same bidder.

BuyerData

Contains buyer data. This data is required by the Marketplace API.

JSON representation 
{
  "buyerEmails": [
    string
  ]
}
Fields
buyerEmails[]

string

Optional. The email contacts of the buyer of the PrivateAuctionDeal.

Methods

batchCreate

 API to batch create PrivateAuctionDeal objects.

batchPause

 API to batch pause PrivateAuctionDeal objects.

batchResume

 API to batch resume PrivateAuctionDeal objects.

batchUpdate

 API to batch update PrivateAuctionDeal objects.

create

 API to create a PrivateAuctionDeal object.

get

 API to retrieve a PrivateAuctionDeal object.

list

 API to retrieve a list of PrivateAuctionDeal objects.

patch

 API to update a PrivateAuctionDeal object.