| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="adexchangebuyer_v1_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.products.html">products</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(productId)</a></code></p> |
| <p class="firstline">Gets the requested product by id.</p> |
| <p class="toc_element"> |
| <code><a href="#search">search(pqlQuery=None)</a></code></p> |
| <p class="firstline">Gets the requested product.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(productId)</code> |
| <pre>Gets the requested product by id. |
| |
| Args: |
| productId: string, The id for the product to get the head revision for. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting: |
| # |
| # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. |
| "billedBuyer": { # The billed buyer corresponding to the buyer that created the offer. (readonly, except on create) |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "buyer": { # The buyer that created the offer if this is a buyer initiated offer (readonly, except on create) |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly) |
| "creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly) |
| { |
| "email": "A String", # Email address of the contact. |
| "name": "A String", # The name of the contact. |
| }, |
| ], |
| "creatorRole": "A String", # The role that created the offer. Set to BUYER for buyer initiated offers. |
| "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. |
| "creativeBlockingLevel": "A String", |
| "deliveryRateType": "A String", |
| "frequencyCaps": [ |
| { |
| "maxImpressions": 42, |
| "numTimeUnits": 42, |
| "timeUnitType": "A String", |
| }, |
| ], |
| }, |
| "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly) |
| "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly) |
| "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. |
| "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create). |
| "kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product". |
| "labels": [ # Optional List of labels for the product (optional, buyer-readonly). |
| { |
| "accountId": "A String", # The accountId of the party that created the label. |
| "createTimeMs": "A String", # The creation time (in ms since epoch) for the label. |
| "deprecatedMarketplaceDealParty": { # Information about the party that created the label. |
| "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party. |
| "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. |
| "subAccountId": "A String", # Optional sub-account id for the seller. |
| }, |
| }, |
| "label": "A String", # The label to use. |
| }, |
| ], |
| "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly) |
| "legacyOfferId": "A String", # Optional legacy offer id if this offer is a preferred deal offer. |
| "marketplacePublisherProfileId": "A String", # Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself. |
| "name": "A String", # The name for this product as set by the seller. (buyer-readonly) |
| "privateAuctionId": "A String", # Optional private auction id if this offer is a private auction offer. |
| "productId": "A String", # The unique id for the product (readonly) |
| "publisherProfileId": "A String", # Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller. |
| "publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher self-provided forecast information. |
| "dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc... |
| { # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]} |
| "dimensionType": "A String", |
| "dimensionValues": [ |
| { # Value of the dimension. |
| "id": 42, # Id of the dimension. |
| "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. |
| "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. |
| }, |
| ], |
| }, |
| ], |
| "weeklyImpressions": "A String", # Publisher provided weekly impressions. |
| "weeklyUniques": "A String", # Publisher provided weekly uniques. |
| }, |
| "revisionNumber": "A String", # The revision number of the product. (readonly) |
| "seller": { # Information about the seller that created this product (readonly, except on create) |
| "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. |
| "subAccountId": "A String", # Optional sub-account id for the seller. |
| }, |
| "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly) |
| { |
| "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| { |
| "creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include. |
| "allowedFormats": [ # The formats allowed by the publisher. |
| "A String", |
| ], |
| "companionSizes": [ # For video size type, the list of companion sizes. |
| { |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| ], |
| "creativeSizeType": "A String", # The Creative size type. |
| "nativeTemplate": "A String", # The native template for native ad. |
| "size": { # For regular or video creative size type, specifies the size of the creative. |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| "skippableAdType": "A String", # The skippable ad type for video size. |
| }, |
| "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. |
| "dayParts": [ |
| { |
| "dayOfWeek": "A String", |
| "endHour": 42, |
| "endMinute": 42, |
| "startHour": 42, |
| "startMinute": 42, |
| }, |
| ], |
| "timeZoneType": "A String", |
| }, |
| "demogAgeCriteriaValue": { |
| "demogAgeCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "demogGenderCriteriaValue": { |
| "demogGenderCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "longValue": "A String", # The long value to exclude/include. |
| "requestPlatformTargetingValue": { |
| "requestPlatforms": [ |
| "A String", |
| ], |
| }, |
| "stringValue": "A String", # The string value to exclude/include. |
| }, |
| ], |
| "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| { |
| "creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include. |
| "allowedFormats": [ # The formats allowed by the publisher. |
| "A String", |
| ], |
| "companionSizes": [ # For video size type, the list of companion sizes. |
| { |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| ], |
| "creativeSizeType": "A String", # The Creative size type. |
| "nativeTemplate": "A String", # The native template for native ad. |
| "size": { # For regular or video creative size type, specifies the size of the creative. |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| "skippableAdType": "A String", # The skippable ad type for video size. |
| }, |
| "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. |
| "dayParts": [ |
| { |
| "dayOfWeek": "A String", |
| "endHour": 42, |
| "endMinute": 42, |
| "startHour": 42, |
| "startMinute": 42, |
| }, |
| ], |
| "timeZoneType": "A String", |
| }, |
| "demogAgeCriteriaValue": { |
| "demogAgeCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "demogGenderCriteriaValue": { |
| "demogGenderCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "longValue": "A String", # The long value to exclude/include. |
| "requestPlatformTargetingValue": { |
| "requestPlatforms": [ |
| "A String", |
| ], |
| }, |
| "stringValue": "A String", # The string value to exclude/include. |
| }, |
| ], |
| "key": "A String", # The key representing the shared targeting criterion. |
| }, |
| ], |
| "state": "A String", # The state of the product. (buyer-readonly) |
| "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create) |
| "terms": { # The negotiable terms of the deal (buyer-readonly) |
| "brandingType": "A String", # Visibility of the URL in bid requests. |
| "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case. |
| "description": "A String", # Description for the proposed terms of the deal. |
| "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller. |
| "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. |
| "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. |
| "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy. |
| "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. |
| "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. |
| "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| "fixedPrices": [ # Fixed price for the specified buyer. |
| { # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. |
| "auctionTier": "A String", # Optional access type for this buyer. |
| "billedBuyer": { # Reference to the buyer that will get billed. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "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). |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "price": { # The specified price |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| ], |
| "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. |
| "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. |
| }, |
| "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. |
| "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). |
| "reservePricePerBuyers": [ # Reserve price for the specified buyer. |
| { # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. |
| "auctionTier": "A String", # Optional access type for this buyer. |
| "billedBuyer": { # Reference to the buyer that will get billed. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "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). |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "price": { # The specified price |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| ], |
| }, |
| "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. |
| "fixedPrices": [ # Fixed price for the specified buyer. |
| { # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. |
| "auctionTier": "A String", # Optional access type for this buyer. |
| "billedBuyer": { # Reference to the buyer that will get billed. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "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). |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "price": { # The specified price |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| ], |
| }, |
| "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. |
| "priorityPrice": { # Optional price for Rubicon priority access in the auction. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| "standardPrice": { # Optional price for Rubicon standard access in the auction. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) |
| }, |
| "webPropertyCode": "A String", # The web property code for the seller. This field is meant to be copied over as is when creating deals. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="search">search(pqlQuery=None)</code> |
| <pre>Gets the requested product. |
| |
| Args: |
| pqlQuery: string, The pql query used to query for products. |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "products": [ # The returned list of products. |
| { # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting: |
| # |
| # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. |
| "billedBuyer": { # The billed buyer corresponding to the buyer that created the offer. (readonly, except on create) |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "buyer": { # The buyer that created the offer if this is a buyer initiated offer (readonly, except on create) |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly) |
| "creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly) |
| { |
| "email": "A String", # Email address of the contact. |
| "name": "A String", # The name of the contact. |
| }, |
| ], |
| "creatorRole": "A String", # The role that created the offer. Set to BUYER for buyer initiated offers. |
| "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. |
| "creativeBlockingLevel": "A String", |
| "deliveryRateType": "A String", |
| "frequencyCaps": [ |
| { |
| "maxImpressions": 42, |
| "numTimeUnits": 42, |
| "timeUnitType": "A String", |
| }, |
| ], |
| }, |
| "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly) |
| "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly) |
| "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. |
| "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create). |
| "kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product". |
| "labels": [ # Optional List of labels for the product (optional, buyer-readonly). |
| { |
| "accountId": "A String", # The accountId of the party that created the label. |
| "createTimeMs": "A String", # The creation time (in ms since epoch) for the label. |
| "deprecatedMarketplaceDealParty": { # Information about the party that created the label. |
| "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party. |
| "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. |
| "subAccountId": "A String", # Optional sub-account id for the seller. |
| }, |
| }, |
| "label": "A String", # The label to use. |
| }, |
| ], |
| "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly) |
| "legacyOfferId": "A String", # Optional legacy offer id if this offer is a preferred deal offer. |
| "marketplacePublisherProfileId": "A String", # Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself. |
| "name": "A String", # The name for this product as set by the seller. (buyer-readonly) |
| "privateAuctionId": "A String", # Optional private auction id if this offer is a private auction offer. |
| "productId": "A String", # The unique id for the product (readonly) |
| "publisherProfileId": "A String", # Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller. |
| "publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher self-provided forecast information. |
| "dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc... |
| { # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]} |
| "dimensionType": "A String", |
| "dimensionValues": [ |
| { # Value of the dimension. |
| "id": 42, # Id of the dimension. |
| "name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids. |
| "percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender. |
| }, |
| ], |
| }, |
| ], |
| "weeklyImpressions": "A String", # Publisher provided weekly impressions. |
| "weeklyUniques": "A String", # Publisher provided weekly uniques. |
| }, |
| "revisionNumber": "A String", # The revision number of the product. (readonly) |
| "seller": { # Information about the seller that created this product (readonly, except on create) |
| "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. |
| "subAccountId": "A String", # Optional sub-account id for the seller. |
| }, |
| "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly) |
| { |
| "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| { |
| "creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include. |
| "allowedFormats": [ # The formats allowed by the publisher. |
| "A String", |
| ], |
| "companionSizes": [ # For video size type, the list of companion sizes. |
| { |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| ], |
| "creativeSizeType": "A String", # The Creative size type. |
| "nativeTemplate": "A String", # The native template for native ad. |
| "size": { # For regular or video creative size type, specifies the size of the creative. |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| "skippableAdType": "A String", # The skippable ad type for video size. |
| }, |
| "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. |
| "dayParts": [ |
| { |
| "dayOfWeek": "A String", |
| "endHour": 42, |
| "endMinute": 42, |
| "startHour": 42, |
| "startMinute": 42, |
| }, |
| ], |
| "timeZoneType": "A String", |
| }, |
| "demogAgeCriteriaValue": { |
| "demogAgeCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "demogGenderCriteriaValue": { |
| "demogGenderCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "longValue": "A String", # The long value to exclude/include. |
| "requestPlatformTargetingValue": { |
| "requestPlatforms": [ |
| "A String", |
| ], |
| }, |
| "stringValue": "A String", # The string value to exclude/include. |
| }, |
| ], |
| "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| { |
| "creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include. |
| "allowedFormats": [ # The formats allowed by the publisher. |
| "A String", |
| ], |
| "companionSizes": [ # For video size type, the list of companion sizes. |
| { |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| ], |
| "creativeSizeType": "A String", # The Creative size type. |
| "nativeTemplate": "A String", # The native template for native ad. |
| "size": { # For regular or video creative size type, specifies the size of the creative. |
| "height": 42, # The height of the creative. |
| "width": 42, # The width of the creative. |
| }, |
| "skippableAdType": "A String", # The skippable ad type for video size. |
| }, |
| "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. |
| "dayParts": [ |
| { |
| "dayOfWeek": "A String", |
| "endHour": 42, |
| "endMinute": 42, |
| "startHour": 42, |
| "startMinute": 42, |
| }, |
| ], |
| "timeZoneType": "A String", |
| }, |
| "demogAgeCriteriaValue": { |
| "demogAgeCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "demogGenderCriteriaValue": { |
| "demogGenderCriteriaIds": [ |
| "A String", |
| ], |
| }, |
| "longValue": "A String", # The long value to exclude/include. |
| "requestPlatformTargetingValue": { |
| "requestPlatforms": [ |
| "A String", |
| ], |
| }, |
| "stringValue": "A String", # The string value to exclude/include. |
| }, |
| ], |
| "key": "A String", # The key representing the shared targeting criterion. |
| }, |
| ], |
| "state": "A String", # The state of the product. (buyer-readonly) |
| "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create) |
| "terms": { # The negotiable terms of the deal (buyer-readonly) |
| "brandingType": "A String", # Visibility of the URL in bid requests. |
| "crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case. |
| "description": "A String", # Description for the proposed terms of the deal. |
| "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller. |
| "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. |
| "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX. |
| "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy. |
| "dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation. |
| "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity. |
| "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| "fixedPrices": [ # Fixed price for the specified buyer. |
| { # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. |
| "auctionTier": "A String", # Optional access type for this buyer. |
| "billedBuyer": { # Reference to the buyer that will get billed. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "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). |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "price": { # The specified price |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| ], |
| "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored. |
| "minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. |
| }, |
| "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. |
| "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly). |
| "reservePricePerBuyers": [ # Reserve price for the specified buyer. |
| { # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. |
| "auctionTier": "A String", # Optional access type for this buyer. |
| "billedBuyer": { # Reference to the buyer that will get billed. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "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). |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "price": { # The specified price |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| ], |
| }, |
| "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. |
| "fixedPrices": [ # Fixed price for the specified buyer. |
| { # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set. |
| "auctionTier": "A String", # Optional access type for this buyer. |
| "billedBuyer": { # Reference to the buyer that will get billed. |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "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). |
| "accountId": "A String", # Adx account id of the buyer. |
| }, |
| "price": { # The specified price |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| ], |
| }, |
| "rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals. |
| "priorityPrice": { # Optional price for Rubicon priority access in the auction. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| "standardPrice": { # Optional price for Rubicon standard access in the auction. |
| "amountMicros": 3.14, # The price value in micros. |
| "currencyCode": "A String", # The currency code for the price. |
| "expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros. |
| "pricingType": "A String", # The pricing type for the deal/product. |
| }, |
| }, |
| "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly) |
| }, |
| "webPropertyCode": "A String", # The web property code for the seller. This field is meant to be copied over as is when creating deals. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
