Api-roll 40: 2016-08-08

generated/googleapis/lib/adexchangebuyer/v1_4.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.adexchangebuyer.v1_4;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 811 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new AddOrderDealsResponse.fromJson(data));
   }
 
   /**
    * List all the deals for a given proposal
    *
    * Request parameters:
    *
-   * [proposalId] - The proposalId to get deals for. To search across proposals
-   * specify order_id = '-' as part of the URL.
+   * [proposalId] - The proposalId to get deals for. To search across all
+   * proposals specify order_id = '-' as part of the URL.
    *
    * [pqlQuery] - Query string to retrieve specific deals.
    *
    * Completes with a [GetOrderDealsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
@@ skipping 120 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new AddOrderNotesResponse.fromJson(data));
   }
 
   /**
    * Get all the notes associated with a proposal
    *
    * Request parameters:
    *
-   * [proposalId] - The proposalId to get notes for.
+   * [proposalId] - The proposalId to get notes for. To search across all
+   * proposals specify order_id = '-' as part of the URL.
+   *
+   * [pqlQuery] - Query string to retrieve specific notes. To search the text
+   * contents of notes, please use syntax like "WHERE note.note = "foo" or
+   * "WHERE note.note LIKE "%bar%"
    *
    * Completes with a [GetOrderNotesResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
-  async.Future<GetOrderNotesResponse> list(core.String proposalId) {
+  async.Future<GetOrderNotesResponse> list(core.String proposalId, {core.String pqlQuery}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (proposalId == null) {
       throw new core.ArgumentError("Parameter proposalId is required.");
     }
+    if (pqlQuery != null) {
+      _queryParams["pqlQuery"] = [pqlQuery];
+    }
 
     _url = 'proposals/' + commons.Escaper.ecapeVariable('$proposalId') + '/notes';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 1933 matching lines @@
   core.List<CreativeCorrections> corrections;
   /**
    * Top-level deals status. Read-only. This field should not be set in
    * requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in
    * servingRestrictions will also exist. Note that this may be nuanced with
    * other contextual restrictions, in which case it may be preferable to read
    * from servingRestrictions directly.
    */
   core.String dealsStatus;
   /**
+   * Detected domains for this creative. Read-only. This field should not be set
+   * in requests.
+   */
+  core.List<core.String> detectedDomains;
+  /**
    * The filtering reasons for the creative. Read-only. This field should not be
    * set in requests.
    */
   CreativeFilteringReasons filteringReasons;
   /** Ad height. */
   core.int height;
   /** The set of urls to be called to record an impression. */
   core.List<core.String> impressionTrackingUrl;
   /** Resource type. */
   core.String kind;
@@ skipping 77 matching lines @@
     }
     if (_json.containsKey("clickThroughUrl")) {
       clickThroughUrl = _json["clickThroughUrl"];
     }
     if (_json.containsKey("corrections")) {
       corrections = _json["corrections"].map((value) => new CreativeCorrections.fromJson(value)).toList();
     }
     if (_json.containsKey("dealsStatus")) {
       dealsStatus = _json["dealsStatus"];
     }
+    if (_json.containsKey("detectedDomains")) {
+      detectedDomains = _json["detectedDomains"];
+    }
     if (_json.containsKey("filteringReasons")) {
       filteringReasons = new CreativeFilteringReasons.fromJson(_json["filteringReasons"]);
     }
     if (_json.containsKey("height")) {
       height = _json["height"];
     }
     if (_json.containsKey("impressionTrackingUrl")) {
       impressionTrackingUrl = _json["impressionTrackingUrl"];
     }
     if (_json.containsKey("kind")) {
@@ skipping 65 matching lines @@
     }
     if (clickThroughUrl != null) {
       _json["clickThroughUrl"] = clickThroughUrl;
     }
     if (corrections != null) {
       _json["corrections"] = corrections.map((value) => (value).toJson()).toList();
     }
     if (dealsStatus != null) {
       _json["dealsStatus"] = dealsStatus;
     }
+    if (detectedDomains != null) {
+      _json["detectedDomains"] = detectedDomains;
+    }
     if (filteringReasons != null) {
       _json["filteringReasons"] = (filteringReasons).toJson();
     }
     if (height != null) {
       _json["height"] = height;
     }
     if (impressionTrackingUrl != null) {
       _json["impressionTrackingUrl"] = impressionTrackingUrl;
     }
     if (kind != null) {
@@ skipping 104 matching lines @@
     return _json;
   }
 }
 
 /**
  * Tracks which parties (if any) have paused a deal. The deal is considered
  * paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused
  * or the has_seller_paused bits can be set independently.
  */
 class DealServingMetadataDealPauseStatus {
+  core.String buyerPauseReason;
   /** If the deal is paused, records which party paused the deal first. */
   core.String firstPausedBy;
   core.bool hasBuyerPaused;
   core.bool hasSellerPaused;
+  core.String sellerPauseReason;
 
   DealServingMetadataDealPauseStatus();
 
   DealServingMetadataDealPauseStatus.fromJson(core.Map _json) {
+    if (_json.containsKey("buyerPauseReason")) {
+      buyerPauseReason = _json["buyerPauseReason"];
+    }
     if (_json.containsKey("firstPausedBy")) {
       firstPausedBy = _json["firstPausedBy"];
     }
     if (_json.containsKey("hasBuyerPaused")) {
       hasBuyerPaused = _json["hasBuyerPaused"];
     }
     if (_json.containsKey("hasSellerPaused")) {
       hasSellerPaused = _json["hasSellerPaused"];
     }
+    if (_json.containsKey("sellerPauseReason")) {
+      sellerPauseReason = _json["sellerPauseReason"];
+    }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
+    if (buyerPauseReason != null) {
+      _json["buyerPauseReason"] = buyerPauseReason;
+    }
     if (firstPausedBy != null) {
       _json["firstPausedBy"] = firstPausedBy;
     }
     if (hasBuyerPaused != null) {
       _json["hasBuyerPaused"] = hasBuyerPaused;
     }
     if (hasSellerPaused != null) {
       _json["hasSellerPaused"] = hasSellerPaused;
     }
+    if (sellerPauseReason != null) {
+      _json["sellerPauseReason"] = sellerPauseReason;
+    }
     return _json;
   }
 }
 
 class DealTerms {
   /** Visibilty of the URL in bid requests. */
   core.String brandingType;
   /** Description for the proposed terms of the deal. */
   core.String description;
   /**
    * Non-binding estimate of the estimated gross spend for this deal Can be set
    * by buyer or seller.
    */
   Price estimatedGrossSpend;
   /**
    * Non-binding estimate of the impressions served per day Can be set by buyer
    * or seller.
    */
   core.String estimatedImpressionsPerDay;
   /** The terms for guaranteed fixed price deals. */
   DealTermsGuaranteedFixedPriceTerms guaranteedFixedPriceTerms;
   /** The terms for non-guaranteed auction deals. */
   DealTermsNonGuaranteedAuctionTerms nonGuaranteedAuctionTerms;
   /** The terms for non-guaranteed fixed price deals. */
   DealTermsNonGuaranteedFixedPriceTerms nonGuaranteedFixedPriceTerms;
+  /** The terms for rubicon non-guaranteed deals. */
+  DealTermsRubiconNonGuaranteedTerms rubiconNonGuaranteedTerms;
   /**
    * For deals with Cost Per Day billing, defines the timezone used to mark the
    * boundaries of a day (buyer-readonly)
    */
   core.String sellerTimeZone;
 
   DealTerms();
 
   DealTerms.fromJson(core.Map _json) {
     if (_json.containsKey("brandingType")) {
@@ skipping 10 matching lines @@
     }
     if (_json.containsKey("guaranteedFixedPriceTerms")) {
       guaranteedFixedPriceTerms = new DealTermsGuaranteedFixedPriceTerms.fromJson(_json["guaranteedFixedPriceTerms"]);
     }
     if (_json.containsKey("nonGuaranteedAuctionTerms")) {
       nonGuaranteedAuctionTerms = new DealTermsNonGuaranteedAuctionTerms.fromJson(_json["nonGuaranteedAuctionTerms"]);
     }
     if (_json.containsKey("nonGuaranteedFixedPriceTerms")) {
       nonGuaranteedFixedPriceTerms = new DealTermsNonGuaranteedFixedPriceTerms.fromJson(_json["nonGuaranteedFixedPriceTerms"]);
     }
+    if (_json.containsKey("rubiconNonGuaranteedTerms")) {
+      rubiconNonGuaranteedTerms = new DealTermsRubiconNonGuaranteedTerms.fromJson(_json["rubiconNonGuaranteedTerms"]);
+    }
     if (_json.containsKey("sellerTimeZone")) {
       sellerTimeZone = _json["sellerTimeZone"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (brandingType != null) {
       _json["brandingType"] = brandingType;
     }
     if (description != null) {
       _json["description"] = description;
     }
     if (estimatedGrossSpend != null) {
       _json["estimatedGrossSpend"] = (estimatedGrossSpend).toJson();
     }
     if (estimatedImpressionsPerDay != null) {
       _json["estimatedImpressionsPerDay"] = estimatedImpressionsPerDay;
     }
     if (guaranteedFixedPriceTerms != null) {
       _json["guaranteedFixedPriceTerms"] = (guaranteedFixedPriceTerms).toJson();
     }
     if (nonGuaranteedAuctionTerms != null) {
       _json["nonGuaranteedAuctionTerms"] = (nonGuaranteedAuctionTerms).toJson();
     }
     if (nonGuaranteedFixedPriceTerms != null) {
       _json["nonGuaranteedFixedPriceTerms"] = (nonGuaranteedFixedPriceTerms).toJson();
     }
+    if (rubiconNonGuaranteedTerms != null) {
+      _json["rubiconNonGuaranteedTerms"] = (rubiconNonGuaranteedTerms).toJson();
+    }
     if (sellerTimeZone != null) {
       _json["sellerTimeZone"] = sellerTimeZone;
     }
     return _json;
   }
 }
 
 class DealTermsGuaranteedFixedPriceTerms {
   /**
    * 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.
    */
   DealTermsGuaranteedFixedPriceTermsBillingInfo billingInfo;
   /** Fixed price for the specified buyer. */
   core.List<PricePerBuyer> fixedPrices;
   /**
    * Guaranteed impressions as a percentage. This is the percentage of
    * guaranteed looks that the buyer is guaranteeing to buy.
    */
   core.String guaranteedImpressions;
-  /** Count of guaranteed looks. Required for deal, optional for product. */
+  /**
+   * Count of guaranteed looks. Required for deal, optional for product. For CPD
+   * deals, buyer changes to guaranteed_looks will be ignored.
+   */
   core.String guaranteedLooks;
+  /**
+   * Count of minimum daily looks for a CPD deal. For CPD deals, buyer should
+   * negotiate on this field instead of guaranteed_looks.
+   */
+  core.String minimumDailyLooks;
 
   DealTermsGuaranteedFixedPriceTerms();
 
   DealTermsGuaranteedFixedPriceTerms.fromJson(core.Map _json) {
     if (_json.containsKey("billingInfo")) {
       billingInfo = new DealTermsGuaranteedFixedPriceTermsBillingInfo.fromJson(_json["billingInfo"]);
     }
     if (_json.containsKey("fixedPrices")) {
       fixedPrices = _json["fixedPrices"].map((value) => new PricePerBuyer.fromJson(value)).toList();
     }
     if (_json.containsKey("guaranteedImpressions")) {
       guaranteedImpressions = _json["guaranteedImpressions"];
     }
     if (_json.containsKey("guaranteedLooks")) {
       guaranteedLooks = _json["guaranteedLooks"];
     }
+    if (_json.containsKey("minimumDailyLooks")) {
+      minimumDailyLooks = _json["minimumDailyLooks"];
+    }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (billingInfo != null) {
       _json["billingInfo"] = (billingInfo).toJson();
     }
     if (fixedPrices != null) {
       _json["fixedPrices"] = fixedPrices.map((value) => (value).toJson()).toList();
     }
     if (guaranteedImpressions != null) {
       _json["guaranteedImpressions"] = guaranteedImpressions;
     }
     if (guaranteedLooks != null) {
       _json["guaranteedLooks"] = guaranteedLooks;
     }
+    if (minimumDailyLooks != null) {
+      _json["minimumDailyLooks"] = minimumDailyLooks;
+    }
     return _json;
   }
 }
 
 class DealTermsGuaranteedFixedPriceTermsBillingInfo {
   /**
    * 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 advertiser's currency without discrepancy.
    */
   core.String currencyConversionTimeMs;
   /**
    * The DFP line item id associated with this deal. For features like CPD,
    * buyers can retrieve the DFP line item for billing reconciliation.
    */
   core.String dfpLineItemId;
   /**
    * The original contracted quantity (# impressions) for this deal. To ensure
-   * delivery, sometimes publisher will book the deal with a impression buffer,
-   * however clients are billed using the original contracted quantity.
+   * 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.
    */
   core.String originalContractedQuantity;
   /**
    * The original reservation price for the deal, if the currency code is
    * different from the one used in negotiation.
    */
   Price price;
 
   DealTermsGuaranteedFixedPriceTermsBillingInfo();
 
@@ skipping 76 matching lines @@
 
   core.Map toJson() {
     var _json = new core.Map();
     if (fixedPrices != null) {
       _json["fixedPrices"] = fixedPrices.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
+class DealTermsRubiconNonGuaranteedTerms {
+  /** Optional price for Rubicon priority access in the auction. */
+  Price priorityPrice;
+  /** Optional price for Rubicon standard access in the auction. */
+  Price standardPrice;
+
+  DealTermsRubiconNonGuaranteedTerms();
+
+  DealTermsRubiconNonGuaranteedTerms.fromJson(core.Map _json) {
+    if (_json.containsKey("priorityPrice")) {
+      priorityPrice = new Price.fromJson(_json["priorityPrice"]);
+    }
+    if (_json.containsKey("standardPrice")) {
+      standardPrice = new Price.fromJson(_json["standardPrice"]);
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (priorityPrice != null) {
+      _json["priorityPrice"] = (priorityPrice).toJson();
+    }
+    if (standardPrice != null) {
+      _json["standardPrice"] = (standardPrice).toJson();
+    }
+    return _json;
+  }
+}
+
 class DeleteOrderDealsRequest {
   /** List of deals to delete for a given proposal */
   core.List<core.String> dealIds;
   /** The last known proposal revision number. */
   core.String proposalRevisionNumber;
   /** Indicates an optional action to take on the proposal */
   core.String updateAction;
 
   DeleteOrderDealsRequest();
 
@@ skipping 324 matching lines @@
   core.Map toJson() {
     var _json = new core.Map();
     if (deals != null) {
       _json["deals"] = deals.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
 class GetOrderNotesResponse {
-  /** The list of matching notes. */
+  /**
+   * The list of matching notes. The notes for a proposal are ordered from
+   * oldest to newest. If the notes span multiple proposals, they will be
+   * grouped by proposal, with the notes for the most recently modified proposal
+   * appearing first.
+   */
   core.List<MarketplaceNote> notes;
 
   GetOrderNotesResponse();
 
   GetOrderNotesResponse.fromJson(core.Map _json) {
     if (_json.containsKey("notes")) {
       notes = _json["notes"].map((value) => new MarketplaceNote.fromJson(value)).toList();
     }
   }
 
@@ skipping 56 matching lines @@
   /** Buyer private data (hidden from seller). */
   PrivateData buyerPrivateData;
   /** The time (ms since epoch) of the deal creation. (readonly) */
   core.String creationTimeMs;
   /** Specifies the creative pre-approval policy (buyer-readonly) */
   core.String creativePreApprovalPolicy;
   /**
    * Specifies whether the creative is safeFrame compatible (buyer-readonly)
    */
   core.String creativeSafeFrameCompatibility;
-  /** A unique deal=id for the deal (readonly). */
+  /** A unique deal-id for the deal (readonly). */
   core.String dealId;
   /**
    * Metadata about the serving status of this deal (readonly, writes via custom
    * actions)
    */
   DealServingMetadata dealServingMetadata;
   /**
    * 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
@@ skipping 1052 matching lines @@
     }
     return _json;
   }
 }
 
 class Price {
   /** The price value in micros. */
   core.double amountMicros;
   /** The currency code for the price. */
   core.String currencyCode;
+  /** In case of CPD deals, the expected CPM in micros. */
+  core.double expectedCpmMicros;
   /** The pricing type for the deal/product. */
   core.String pricingType;
 
   Price();
 
   Price.fromJson(core.Map _json) {
     if (_json.containsKey("amountMicros")) {
       amountMicros = _json["amountMicros"];
     }
     if (_json.containsKey("currencyCode")) {
       currencyCode = _json["currencyCode"];
     }
+    if (_json.containsKey("expectedCpmMicros")) {
+      expectedCpmMicros = _json["expectedCpmMicros"];
+    }
     if (_json.containsKey("pricingType")) {
       pricingType = _json["pricingType"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (amountMicros != null) {
       _json["amountMicros"] = amountMicros;
     }
     if (currencyCode != null) {
       _json["currencyCode"] = currencyCode;
     }
+    if (expectedCpmMicros != null) {
+      _json["expectedCpmMicros"] = expectedCpmMicros;
+    }
     if (pricingType != null) {
       _json["pricingType"] = pricingType;
     }
     return _json;
   }
 }
 
 /**
  * Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
  * an product can become [0,1] deals. To check if there is a PricePerBuyer for a
@@ skipping 334 matching lines @@
  * set this field. (updatable) - The field is updatable at all times by either
  * buyer or the seller.
  */
 class Proposal {
   /**
    * Reference to the buyer that will get billed for this proposal. (readonly)
    */
   Buyer billedBuyer;
   /** Reference to the buyer on the proposal. (readonly, except on create) */
   Buyer buyer;
-  /** Optional contact information fort the buyer. (seller-readonly) */
+  /** Optional contact information of the buyer. (seller-readonly) */
   core.List<ContactInformation> buyerContacts;
   /** Private data for buyer. (hidden from seller). */
   PrivateData buyerPrivateData;
   /**
    * When an proposal is in an accepted state, indicates whether the buyer has
-   * signed off Once both sides have signed off on a deal, the proposal can be
+   * signed off. Once both sides have signed off on a deal, the proposal can be
    * finalized by the seller. (seller-readonly)
    */
   core.bool hasBuyerSignedOff;
   /**
    * When an proposal is in an accepted state, indicates whether the buyer has
    * signed off Once both sides have signed off on a deal, the proposal can be
    * finalized by the seller. (buyer-readonly)
    */
   core.bool hasSellerSignedOff;
   /**
@@ skipping 34 matching lines @@
   /** The current state of the proposal. (readonly) */
   core.String proposalState;
   /** The revision number for the proposal (readonly). */
   core.String revisionNumber;
   /**
    * The time (ms since epoch) when the proposal was last revised (readonly).
    */
   core.String revisionTimeMs;
   /** Reference to the seller on the proposal. (readonly, except on create) */
   Seller seller;
-  /** Optional contact information for the seller (buyer-readonly). */
+  /** Optional contact information of the seller (buyer-readonly). */
   core.List<ContactInformation> sellerContacts;
 
   Proposal();
 
   Proposal.fromJson(core.Map _json) {
     if (_json.containsKey("billedBuyer")) {
       billedBuyer = new Buyer.fromJson(_json["billedBuyer"]);
     }
     if (_json.containsKey("buyer")) {
       buyer = new Buyer.fromJson(_json["buyer"]);
@@ skipping 691 matching lines @@
     }
     if (proposalRevisionNumber != null) {
       _json["proposalRevisionNumber"] = proposalRevisionNumber;
     }
     if (updateAction != null) {
       _json["updateAction"] = updateAction;
     }
     return _json;
   }
 }