REST Resource: networks.privateAuctionDeals

Resource: PrivateAuctionDeal

The PrivateAuctionDeal resource.

JSON representation 
{
  "name": string,
  "creativeSizes": [
    {
      object (Size)
    }
  ],
  "privateAuctionDealId": string,
  "privateAuctionId": string,
  "privateAuctionDisplayName": string,
  "buyerAccountId": string,
  "externalDealId": string,
  "targeting": {
    object (Targeting)
  },
  "endTime": string,
  "floorPrice": {
    object (Money)
  },
  "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}
creativeSizes[]

object (Size)

Optional. The expected creative sizes of the PrivateAuctionDeal.
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.
targeting

object (Targeting)

Optional. The targeting 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.
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".

Targeting

Targeting expression.

JSON representation 
{
  "geoTargeting": {
    object (GeoTargeting)
  },
  "technologyTargeting": {
    object (TechnologyTargeting)
  },
  "inventoryTargeting": {
    object (InventoryTargeting)
  },
  "requestPlatformTargeting": {
    object (RequestPlatformTargeting)
  },
  "customTargeting": {
    object (CustomTargeting)
  },
  "userDomainTargeting": {
    object (UserDomainTargeting)
  },
  "videoPositionTargeting": {
    object (VideoPositionTargeting)
  },
  "dataSegmentTargeting": {
    object (DataSegmentTargeting)
  }
}
Fields
geoTargeting

object (GeoTargeting)

Optional. Used to target/exclude various geo targets.
technologyTargeting

object (TechnologyTargeting)

Optional. Used to target various technology targeting dimensions.
inventoryTargeting

object (InventoryTargeting)

Optional. Used to target/exclude various ad units and/or placements.
requestPlatformTargeting

object (RequestPlatformTargeting)

Optional. Used to target specific request platforms.
customTargeting

object (CustomTargeting)

Optional. Used to target key/values, audience segments, and/or CMS metadata.
userDomainTargeting

object (UserDomainTargeting)

Optional. Used to target user domains.
videoPositionTargeting

object (VideoPositionTargeting)

Optional. Used to target video positions.
dataSegmentTargeting

object (DataSegmentTargeting)

Optional. Used to target data segments.

GeoTargeting

Represents a list of targeted and excluded geos.

JSON representation 
{
  "targetedGeos": [
    string
  ],
  "excludedGeos": [
    string
  ]
}
Fields
targetedGeos[]

string

Optional. A list of geo resource names that should be targeted/included.
excludedGeos[]

string

Optional. A list of geo resource names that should be excluded.

TechnologyTargeting

Various types of technology targeting expressed by child messages are applied with logical AND.

JSON representation 
{
  "bandwidthTargeting": {
    object (BandwidthTargeting)
  },
  "deviceCategoryTargeting": {
    object (DeviceCategoryTargeting)
  },
  "operatingSystemTargeting": {
    object (OperatingSystemTargeting)
  }
}
Fields
bandwidthTargeting

object (BandwidthTargeting)

Optional. Bandwidth targeting dimension.
deviceCategoryTargeting

object (DeviceCategoryTargeting)

Optional. Device category targeting dimension.
operatingSystemTargeting

object (OperatingSystemTargeting)

Optional. Operating system targeting dimension.

BandwidthTargeting

Bandwidth Targeting.

Reach users accessing the internet via various means of connection, such as cable, DSL, or dial-up. Can be useful to target campaigns using low-resolution creatives or text ads for users with low bandwidth.

JSON representation 
{
  "targetedBandwidthGroups": [
    string
  ],
  "excludedBandwidthGroups": [
    string
  ]
}
Fields
targetedBandwidthGroups[]

string

Optional. A list of resource names of the bandwidth groups that should be targeted/included.
excludedBandwidthGroups[]

string

Optional. A list of resource names of the bandwidth groups that should be excluded.

DeviceCategoryTargeting

Represents a list of targeted and excluded device categories.

JSON representation 
{
  "targetedCategories": [
    string
  ],
  "excludedCategories": [
    string
  ]
}
Fields
targetedCategories[]

string

Optional. A list of device category resource names that should be targeted/included.
excludedCategories[]

string

Optional. A list of device category resource names that should be excluded.

OperatingSystemTargeting

Operating System Targeting

JSON representation 
{
  "targetedOperatingSystems": [
    string
  ],
  "excludedOperatingSystems": [
    string
  ],
  "targetedOperatingSystemVersions": [
    string
  ],
  "excludedOperatingSystemVersions": [
    string
  ]
}
Fields
targetedOperatingSystems[]

string

Optional. A list of operating system resource names that should be targeted/included.
excludedOperatingSystems[]

string

Optional. A list of operating system resource names that should be excluded.
targetedOperatingSystemVersions[]

string

Optional. A list of operating system version resource names that should be targeted/included.
excludedOperatingSystemVersions[]

string

Optional. A list of operating system version resource names that should be excluded.

InventoryTargeting

Targeted ad units and AU placements are applied with logical OR. Example:

(au:1 OR au:2 OR au_placement:5) AND (NOT (au:3))

JSON representation 
{
  "targetedAdUnits": [
    {
      object (AdUnitTargeting)
    }
  ],
  "excludedAdUnits": [
    {
      object (AdUnitTargeting)
    }
  ],
  "targetedPlacements": [
    string
  ]
}
Fields
targetedAdUnits[]

object (AdUnitTargeting)

Optional. A list of ad units that should be targeted/included.
excludedAdUnits[]

object (AdUnitTargeting)

Optional. A list of ad units that should be excluded.

Excluded AUs take precedence over targeted AUs. In fact an AU can be excluded only if one of its ancestors is targeted. Subsequently child AUs of an excluded AU can not be targeted (except via a placement).
targetedPlacements[]

string

Optional. The resource names of the placements that should be targeted/included.

AdUnitTargeting

Specifies an ad unit and (optionally) its descendants.

JSON representation 
{
  "includeDescendants": boolean,
  "adUnit": string
}
Fields
includeDescendants

boolean

Whether this ad unit's children should be targeted/excluded as well.
adUnit

string

Optional. The resource name of this ad unit.

RequestPlatformTargeting

Represents a list of targeted request platforms.

JSON representation 
{
  "requestPlatforms": [
    enum (RequestPlatform)
  ]
}
Fields
requestPlatforms[]

enum (RequestPlatform)

Optional. The list of request platforms that should be targeted.

RequestPlatform

The different environments in which an ad can be shown.

Enums
REQUEST_PLATFORM_UNSPECIFIED No value specified
BROWSER Represents a request made from a web browser (incl. desktop browsers, mobile browsers, webviews, etc.).
MOBILE_APP Represents a request made from a Mobile Application.
VIDEO_PLAYER Represents a request made from a video player.

CustomTargeting

Represents the top level targeting expression for custom key/values, audience segments, and/or CMS metadata.

JSON representation 
{
  "customTargetingClauses": [
    {
      object (CustomTargetingClause)
    }
  ]
}
Fields
customTargetingClauses[]

object (CustomTargetingClause)

Optional. These clauses are all ORed together.

CustomTargetingClause

Represents a logical AND of individual custom targeting expressions.

JSON representation 
{
  "customTargetingLiterals": [
    {
      object (CustomTargetingLiteral)
    }
  ]
}
Fields
customTargetingLiterals[]

object (CustomTargetingLiteral)

Optional. Leaf targeting expressions for custom key/values.

CustomTargetingLiteral

Represents targeting for custom key/values. The values are ORed together.

JSON representation 
{
  "customTargetingValues": [
    string
  ],
  "negative": boolean,
  "customTargetingKey": string
}
Fields
customTargetingValues[]

string

Optional. The resource names of the targeted CustomValues.
negative

boolean

Whether this expression is negatively targeted, meaning it matches ad requests that exclude the below values.
customTargetingKey

string

Optional. The resource name of the targeted CustomKey.

UserDomainTargeting

User Domain Targeting

JSON representation 
{
  "targetedUserDomains": [
    string
  ],
  "excludedUserDomains": [
    string
  ]
}
Fields
targetedUserDomains[]

string

Optional. A list of user domains that should be targeted/included.
excludedUserDomains[]

string

Optional. A list of user domains that should be excluded.

VideoPositionTargeting

Video Position Targeting

JSON representation 
{
  "videoPositions": [
    {
      object (VideoPosition)
    }
  ]
}
Fields
videoPositions[]

object (VideoPosition)

Optional. A list of video position targeting criterion (applied with a logical AND).

VideoPosition

Video Position Targeting Criterion

JSON representation 
{
  "midrollIndex": string,
  "reverseMidrollIndex": string,
  "podPosition": string,
  "positionType": enum (VideoPosition),
  "bumperType": enum (TargetedVideoBumperType)
}
Fields
midrollIndex

string (int64 format)

Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. positionType) other than MIDROLL.
reverseMidrollIndex

string (int64 format)

Optional. The index from the back of the pod of the mid-roll to target. This field is ignored when targeting any video position (e.g. positionType) other than MIDROLL or if targeting a specific midroll index (e.g. midrollIndex != 0).
podPosition

string (int64 format)

Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. positionType), bumper type (e.g. bumperType), or custom ad spot (e.g. customSpotId).
positionType

enum (VideoPosition)

Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.
bumperType

enum (TargetedVideoBumperType)

Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. positionType), pod position (e.g. podPosition), or custom ad spot (e.g. customSpotId).

VideoPosition

Represents a targetable position within a video.

Enums
VIDEO_POSITION_UNSPECIFIED Default value. This value is unused.
ALL Allow ad placement at any position within the video.
MIDROLL Target ad placement during the video.
POSTROLL Target ad placement after the video ends.
PREROLL Target ad placement before the video starts.

TargetedVideoBumperType

Represents the options for targetable bumper positions, surrounding an ad pod, within a video stream. This includes before and after the supported ad pod positions, VideoPositionType.PREROLL, VideoPositionType.MIDROLL, and VideoPositionType.POSTROLL.

Enums
TARGETED_VIDEO_BUMPER_TYPE_UNSPECIFIED Default value. This value is unused.
AFTER Represents the bumper position after the ad pod.
BEFORE Represents the bumper position before the ad pod.

DataSegmentTargeting

Data Segment Targeting

JSON representation 
{
  "hasDataSegmentTargeting": boolean
}
Fields
hasDataSegmentTargeting

boolean

Output only. Whether any data segments are currently targeted.

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

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.