DealTerms

The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher.

JSON representation
{
  "description": string,
  "brandingType": enum(BrandingType),
  "estimatedGrossSpend": {
    object(Price)
  },
  "estimatedImpressionsPerDay": string,
  "sellerTimeZone": string,

  // Union field pricing_terms can be only one of the following:
  "guaranteedFixedPriceTerms": {
    object(GuaranteedFixedPriceTerms)
  },
  "nonGuaranteedFixedPriceTerms": {
    object(NonGuaranteedFixedPriceTerms)
  },
  "nonGuaranteedAuctionTerms": {
    object(NonGuaranteedAuctionTerms)
  },
  // End of list of possible types for union field pricing_terms.
}
Fields
description

string

Publisher provided description for the terms.

brandingType

enum(BrandingType)

Visibility of the URL in bid requests. (default: BRANDED)

estimatedGrossSpend

object(Price)

Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller.

estimatedImpressionsPerDay

string (int64 format)

Non-binding estimate of the impressions served per day. Can be set by buyer or seller.

sellerTimeZone

string

The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Union field pricing_terms. Specifies the pricing terms for a deal. pricing_terms can be only one of the following:
guaranteedFixedPriceTerms

object(GuaranteedFixedPriceTerms)

The terms for guaranteed fixed price deals.

nonGuaranteedFixedPriceTerms

object(NonGuaranteedFixedPriceTerms)

The terms for non-guaranteed fixed price deals.

nonGuaranteedAuctionTerms

object(NonGuaranteedAuctionTerms)

The terms for non-guaranteed auction deals.

BrandingType

Specifies the branding type for the deal.

Enums
BRANDING_TYPE_UNSPECIFIED A placeholder for an undefined branding type.
BRANDED Full URL is included in bid requests.
SEMI_TRANSPARENT A TopLevelDomain or masked URL is sent in bid requests rather than the full one.

Price

Represents a price and a pricing type for a product / deal.

JSON representation
{
  "pricingType": enum(PricingType),
  "amount": {
    object(Money)
  },
}
Fields
pricingType

enum(PricingType)

The pricing type for the deal/product. (default: CPM)

amount

object(Money)

The actual price with currency specified.

PricingType

Specifies the pricing type for a deal.

Enums
PRICING_TYPE_UNSPECIFIED A placeholder for an undefined pricing type. If the pricing type is unpsecified, COST_PER_MILLE will be used instead.
COST_PER_MILLE Cost per thousand impressions.
COST_PER_DAY Cost per day

Money

Represents an amount of money with its currency type.

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

string

The 3-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

number

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.

GuaranteedFixedPriceTerms

Terms for Programmatic Guaranteed Deals.

JSON representation
{
  "guaranteedLooks": string,
  "guaranteedImpressions": string,
  "fixedPrices": [
    {
      object(PricePerBuyer)
    }
  ],
  "minimumDailyLooks": string,
}
Fields
guaranteedLooks

string (int64 format)

Count of guaranteed looks. Required for deal, optional for product.

guaranteedImpressions

string (int64 format)

Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.

fixedPrices[]

object(PricePerBuyer)

Fixed price for the specified buyer.

minimumDailyLooks

string (int64 format)

Daily minimum looks for CPD deal types.

PricePerBuyer

Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.

JSON representation
{
  "price": {
    object(Price)
  },
  "buyer": {
    object(Buyer)
  },
  "advertiserIds": [
    string
  ],
}
Fields
price

object(Price)

The specified price.

buyer

object(Buyer)

The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).

advertiserIds[]

string

The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price.

NonGuaranteedFixedPriceTerms

Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request.

JSON representation
{
  "fixedPrices": [
    {
      object(PricePerBuyer)
    }
  ],
}
Fields
fixedPrices[]

object(PricePerBuyer)

Fixed price for the specified buyer.

NonGuaranteedAuctionTerms

Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request.

JSON representation
{
  "reservePricesPerBuyer": [
    {
      object(PricePerBuyer)
    }
  ],
  "autoOptimizePrivateAuction": boolean,
}
Fields
reservePricesPerBuyer[]

object(PricePerBuyer)

Reserve price for the specified buyer.

autoOptimizePrivateAuction

boolean

True if open auction buyers are allowed to compete with invited buyers in this private auction.

Send feedback about...

Buyer REST API
Buyer REST API