Index: generated/googleapis/lib/adexchangebuyer/v1_4.dart |
diff --git a/generated/googleapis/lib/adexchangebuyer/v1_3.dart b/generated/googleapis/lib/adexchangebuyer/v1_4.dart |
similarity index 89% |
copy from generated/googleapis/lib/adexchangebuyer/v1_3.dart |
copy to generated/googleapis/lib/adexchangebuyer/v1_4.dart |
index c4c7929ffa8150d810d88e70221a85c7051c6ce9..f7e201b110fcc93fad34b0817825618a352b7126 100644 |
--- a/generated/googleapis/lib/adexchangebuyer/v1_3.dart |
+++ b/generated/googleapis/lib/adexchangebuyer/v1_4.dart |
@@ -1,6 +1,6 @@ |
// This is a generated file (see the discoveryapis_generator project). |
-library googleapis.adexchangebuyer.v1_3; |
+library googleapis.adexchangebuyer.v1_4; |
import 'dart:core' as core; |
import 'dart:async' as async; |
@@ -12,7 +12,7 @@ import 'package:http/http.dart' as http; |
export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show |
ApiRequestError, DetailedApiRequestError; |
-const core.String USER_AGENT = 'dart-api-client adexchangebuyer/v1.3'; |
+const core.String USER_AGENT = 'dart-api-client adexchangebuyer/v1.4'; |
/** |
* Accesses your bidding-account information, submits creatives for validation, |
@@ -29,11 +29,10 @@ class AdexchangebuyerApi { |
BillingInfoResourceApi get billingInfo => new BillingInfoResourceApi(_requester); |
BudgetResourceApi get budget => new BudgetResourceApi(_requester); |
CreativesResourceApi get creatives => new CreativesResourceApi(_requester); |
- DirectDealsResourceApi get directDeals => new DirectDealsResourceApi(_requester); |
PerformanceReportResourceApi get performanceReport => new PerformanceReportResourceApi(_requester); |
PretargetingConfigResourceApi get pretargetingConfig => new PretargetingConfigResourceApi(_requester); |
- AdexchangebuyerApi(http.Client client, {core.String rootUrl: "https://www.googleapis.com/", core.String servicePath: "adexchangebuyer/v1.3/"}) : |
+ AdexchangebuyerApi(http.Client client, {core.String rootUrl: "https://www.googleapis.com/", core.String servicePath: "adexchangebuyer/v1.4/"}) : |
_requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT); |
} |
@@ -548,21 +547,36 @@ class CreativesResourceApi { |
* [buyerCreativeId] - When specified, only creatives for the given buyer |
* creative ids are returned. |
* |
+ * [dealsStatusFilter] - When specified, only creatives having the given |
+ * direct deals status are returned. |
+ * Possible string values are: |
+ * - "approved" : Creatives which have been approved for serving on direct |
+ * deals. |
+ * - "conditionally_approved" : Creatives which have been conditionally |
+ * approved for serving on direct deals. |
+ * - "disapproved" : Creatives which have been disapproved for serving on |
+ * direct deals. |
+ * - "not_checked" : Creatives whose direct deals status is not yet checked. |
+ * |
* [maxResults] - Maximum number of entries returned on one result page. If |
* not set, the default is 100. Optional. |
* Value must be between "1" and "1000". |
* |
+ * [openAuctionStatusFilter] - When specified, only creatives having the given |
+ * open auction status are returned. |
+ * Possible string values are: |
+ * - "approved" : Creatives which have been approved for serving on the open |
+ * auction. |
+ * - "conditionally_approved" : Creatives which have been conditionally |
+ * approved for serving on the open auction. |
+ * - "disapproved" : Creatives which have been disapproved for serving on the |
+ * open auction. |
+ * - "not_checked" : Creatives whose open auction status is not yet checked. |
+ * |
* [pageToken] - A continuation token, used to page through ad clients. To |
* retrieve the next page, set this parameter to the value of "nextPageToken" |
* from the previous response. Optional. |
* |
- * [statusFilter] - When specified, only creatives having the given status are |
- * returned. |
- * Possible string values are: |
- * - "approved" : Creatives which have been approved. |
- * - "disapproved" : Creatives which have been disapproved. |
- * - "not_checked" : Creatives whose status is not yet checked. |
- * |
* Completes with a [CreativesList]. |
* |
* Completes with a [commons.ApiRequestError] if the API endpoint returned an |
@@ -571,7 +585,7 @@ class CreativesResourceApi { |
* If the used [http.Client] completes with an error when making a REST call, |
* this method will complete with the same error. |
*/ |
- async.Future<CreativesList> list({core.List<core.int> accountId, core.List<core.String> buyerCreativeId, core.int maxResults, core.String pageToken, core.String statusFilter}) { |
+ async.Future<CreativesList> list({core.List<core.int> accountId, core.List<core.String> buyerCreativeId, core.String dealsStatusFilter, core.int maxResults, core.String openAuctionStatusFilter, core.String pageToken}) { |
var _url = null; |
var _queryParams = new core.Map(); |
var _uploadMedia = null; |
@@ -585,15 +599,18 @@ class CreativesResourceApi { |
if (buyerCreativeId != null) { |
_queryParams["buyerCreativeId"] = buyerCreativeId; |
} |
+ if (dealsStatusFilter != null) { |
+ _queryParams["dealsStatusFilter"] = [dealsStatusFilter]; |
+ } |
if (maxResults != null) { |
_queryParams["maxResults"] = ["${maxResults}"]; |
} |
+ if (openAuctionStatusFilter != null) { |
+ _queryParams["openAuctionStatusFilter"] = [openAuctionStatusFilter]; |
+ } |
if (pageToken != null) { |
_queryParams["pageToken"] = [pageToken]; |
} |
- if (statusFilter != null) { |
- _queryParams["statusFilter"] = [statusFilter]; |
- } |
_url = 'creatives'; |
@@ -610,88 +627,6 @@ class CreativesResourceApi { |
} |
-class DirectDealsResourceApi { |
- final commons.ApiRequester _requester; |
- |
- DirectDealsResourceApi(commons.ApiRequester client) : |
- _requester = client; |
- |
- /** |
- * Gets one direct deal by ID. |
- * |
- * Request parameters: |
- * |
- * [id] - The direct deal id |
- * |
- * Completes with a [DirectDeal]. |
- * |
- * 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<DirectDeal> get(core.String id) { |
- var _url = null; |
- var _queryParams = new core.Map(); |
- var _uploadMedia = null; |
- var _uploadOptions = null; |
- var _downloadOptions = commons.DownloadOptions.Metadata; |
- var _body = null; |
- |
- if (id == null) { |
- throw new core.ArgumentError("Parameter id is required."); |
- } |
- |
- _url = 'directdeals/' + commons.Escaper.ecapeVariable('$id'); |
- |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
- return _response.then((data) => new DirectDeal.fromJson(data)); |
- } |
- |
- /** |
- * Retrieves the authenticated user's list of direct deals. |
- * |
- * Request parameters: |
- * |
- * Completes with a [DirectDealsList]. |
- * |
- * 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<DirectDealsList> list() { |
- var _url = null; |
- var _queryParams = new core.Map(); |
- var _uploadMedia = null; |
- var _uploadOptions = null; |
- var _downloadOptions = commons.DownloadOptions.Metadata; |
- var _body = null; |
- |
- |
- _url = 'directdeals'; |
- |
- var _response = _requester.request(_url, |
- "GET", |
- body: _body, |
- queryParams: _queryParams, |
- uploadOptions: _uploadOptions, |
- uploadMedia: _uploadMedia, |
- downloadOptions: _downloadOptions); |
- return _response.then((data) => new DirectDealsList.fromJson(data)); |
- } |
- |
-} |
- |
- |
class PerformanceReportResourceApi { |
final commons.ApiRequester _requester; |
@@ -1398,35 +1333,6 @@ class CreativeCorrections { |
} |
} |
-class CreativeDisapprovalReasons { |
- /** Additional details about the reason for disapproval. */ |
- core.List<core.String> details; |
- /** The categorized reason for disapproval. */ |
- core.String reason; |
- |
- CreativeDisapprovalReasons(); |
- |
- CreativeDisapprovalReasons.fromJson(core.Map _json) { |
- if (_json.containsKey("details")) { |
- details = _json["details"]; |
- } |
- if (_json.containsKey("reason")) { |
- reason = _json["reason"]; |
- } |
- } |
- |
- core.Map toJson() { |
- var _json = new core.Map(); |
- if (details != null) { |
- _json["details"] = details; |
- } |
- if (reason != null) { |
- _json["reason"] = reason; |
- } |
- return _json; |
- } |
-} |
- |
class CreativeFilteringReasonsReasons { |
/** |
* The number of times the creative was filtered for the status. The count is |
@@ -1498,6 +1404,137 @@ class CreativeFilteringReasons { |
} |
} |
+class CreativeServingRestrictionsContexts { |
+ /** |
+ * Only set when contextType=AUCTION_TYPE. Represents the auction types this |
+ * restriction applies to. |
+ */ |
+ core.List<core.String> auctionType; |
+ /** |
+ * The type of context (e.g., location, platform, auction type, SSL-ness). |
+ */ |
+ core.String contextType; |
+ /** |
+ * Only set when contextType=LOCATION. Represents the geo criterias this |
+ * restriction applies to. |
+ */ |
+ core.List<core.int> geoCriteriaId; |
+ /** |
+ * Only set when contextType=PLATFORM. Represents the platforms this |
+ * restriction applies to. |
+ */ |
+ core.List<core.String> platform; |
+ |
+ CreativeServingRestrictionsContexts(); |
+ |
+ CreativeServingRestrictionsContexts.fromJson(core.Map _json) { |
+ if (_json.containsKey("auctionType")) { |
+ auctionType = _json["auctionType"]; |
+ } |
+ if (_json.containsKey("contextType")) { |
+ contextType = _json["contextType"]; |
+ } |
+ if (_json.containsKey("geoCriteriaId")) { |
+ geoCriteriaId = _json["geoCriteriaId"]; |
+ } |
+ if (_json.containsKey("platform")) { |
+ platform = _json["platform"]; |
+ } |
+ } |
+ |
+ core.Map toJson() { |
+ var _json = new core.Map(); |
+ if (auctionType != null) { |
+ _json["auctionType"] = auctionType; |
+ } |
+ if (contextType != null) { |
+ _json["contextType"] = contextType; |
+ } |
+ if (geoCriteriaId != null) { |
+ _json["geoCriteriaId"] = geoCriteriaId; |
+ } |
+ if (platform != null) { |
+ _json["platform"] = platform; |
+ } |
+ return _json; |
+ } |
+} |
+ |
+class CreativeServingRestrictionsDisapprovalReasons { |
+ /** Additional details about the reason for disapproval. */ |
+ core.List<core.String> details; |
+ /** The categorized reason for disapproval. */ |
+ core.String reason; |
+ |
+ CreativeServingRestrictionsDisapprovalReasons(); |
+ |
+ CreativeServingRestrictionsDisapprovalReasons.fromJson(core.Map _json) { |
+ if (_json.containsKey("details")) { |
+ details = _json["details"]; |
+ } |
+ if (_json.containsKey("reason")) { |
+ reason = _json["reason"]; |
+ } |
+ } |
+ |
+ core.Map toJson() { |
+ var _json = new core.Map(); |
+ if (details != null) { |
+ _json["details"] = details; |
+ } |
+ if (reason != null) { |
+ _json["reason"] = reason; |
+ } |
+ return _json; |
+ } |
+} |
+ |
+class CreativeServingRestrictions { |
+ /** All known contexts/restrictions. */ |
+ core.List<CreativeServingRestrictionsContexts> contexts; |
+ /** |
+ * The reasons for disapproval within this restriction, if any. Note that not |
+ * all disapproval reasons may be categorized, so it is possible for the |
+ * creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an |
+ * empty list for disapproval_reasons. In this case, please reach out to your |
+ * TAM to help debug the issue. |
+ */ |
+ core.List<CreativeServingRestrictionsDisapprovalReasons> disapprovalReasons; |
+ /** |
+ * Why the creative is ineligible to serve in this context (e.g., it has been |
+ * explicitly disapproved or is pending review). |
+ */ |
+ core.String reason; |
+ |
+ CreativeServingRestrictions(); |
+ |
+ CreativeServingRestrictions.fromJson(core.Map _json) { |
+ if (_json.containsKey("contexts")) { |
+ contexts = _json["contexts"].map((value) => new CreativeServingRestrictionsContexts.fromJson(value)).toList(); |
+ } |
+ if (_json.containsKey("disapprovalReasons")) { |
+ disapprovalReasons = _json["disapprovalReasons"].map((value) => new CreativeServingRestrictionsDisapprovalReasons.fromJson(value)).toList(); |
+ } |
+ if (_json.containsKey("reason")) { |
+ reason = _json["reason"]; |
+ } |
+ } |
+ |
+ core.Map toJson() { |
+ var _json = new core.Map(); |
+ if (contexts != null) { |
+ _json["contexts"] = contexts.map((value) => (value).toJson()).toList(); |
+ } |
+ if (disapprovalReasons != null) { |
+ _json["disapprovalReasons"] = disapprovalReasons.map((value) => (value).toJson()).toList(); |
+ } |
+ if (reason != null) { |
+ _json["reason"] = reason; |
+ } |
+ return _json; |
+ } |
+} |
+ |
/** A creative and its classification data. */ |
class Creative { |
/** |
@@ -1528,13 +1565,13 @@ class Creative { |
*/ |
core.List<CreativeCorrections> corrections; |
/** |
- * The reasons for disapproval, if any. Note that not all disapproval reasons |
- * may be categorized, so it is possible for the creative to have a status of |
- * DISAPPROVED with an empty list for disapproval_reasons. In this case, |
- * please reach out to your TAM to help debug the issue. Read-only. This field |
- * should not be set in requests. |
+ * 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.List<CreativeDisapprovalReasons> disapprovalReasons; |
+ core.String dealsStatus; |
/** |
* The filtering reasons for the creative. Read-only. This field should not be |
* set in requests. |
@@ -1545,6 +1582,14 @@ class Creative { |
/** Resource type. */ |
core.String kind; |
/** |
+ * Top-level open auction status. Read-only. This field should not be set in |
+ * requests. If disapproved, an entry for auctionType=OPEN_AUCTION (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 openAuctionStatus; |
+ /** |
* Detected product categories, if any. Read-only. This field should not be |
* set in requests. |
*/ |
@@ -1559,10 +1604,12 @@ class Creative { |
*/ |
core.List<core.int> sensitiveCategories; |
/** |
- * Creative serving status. Read-only. This field should not be set in |
- * requests. |
+ * The granular status of this ad in specific contexts. A context here relates |
+ * to where something ultimately serves (for example, a physical location, a |
+ * platform, an HTTPS vs HTTP request, or the type of auction). Read-only. |
+ * This field should not be set in requests. |
*/ |
- core.String status; |
+ core.List<CreativeServingRestrictions> servingRestrictions; |
/** All vendor types for the ads that may be shown from this snippet. */ |
core.List<core.int> vendorType; |
/** The url to fetch a video ad. If set, HTMLSnippet should not be set. */ |
@@ -1600,8 +1647,8 @@ class Creative { |
if (_json.containsKey("corrections")) { |
corrections = _json["corrections"].map((value) => new CreativeCorrections.fromJson(value)).toList(); |
} |
- if (_json.containsKey("disapprovalReasons")) { |
- disapprovalReasons = _json["disapprovalReasons"].map((value) => new CreativeDisapprovalReasons.fromJson(value)).toList(); |
+ if (_json.containsKey("dealsStatus")) { |
+ dealsStatus = _json["dealsStatus"]; |
} |
if (_json.containsKey("filteringReasons")) { |
filteringReasons = new CreativeFilteringReasons.fromJson(_json["filteringReasons"]); |
@@ -1612,6 +1659,9 @@ class Creative { |
if (_json.containsKey("kind")) { |
kind = _json["kind"]; |
} |
+ if (_json.containsKey("openAuctionStatus")) { |
+ openAuctionStatus = _json["openAuctionStatus"]; |
+ } |
if (_json.containsKey("productCategories")) { |
productCategories = _json["productCategories"]; |
} |
@@ -1621,8 +1671,8 @@ class Creative { |
if (_json.containsKey("sensitiveCategories")) { |
sensitiveCategories = _json["sensitiveCategories"]; |
} |
- if (_json.containsKey("status")) { |
- status = _json["status"]; |
+ if (_json.containsKey("servingRestrictions")) { |
+ servingRestrictions = _json["servingRestrictions"].map((value) => new CreativeServingRestrictions.fromJson(value)).toList(); |
} |
if (_json.containsKey("vendorType")) { |
vendorType = _json["vendorType"]; |
@@ -1664,8 +1714,8 @@ class Creative { |
if (corrections != null) { |
_json["corrections"] = corrections.map((value) => (value).toJson()).toList(); |
} |
- if (disapprovalReasons != null) { |
- _json["disapprovalReasons"] = disapprovalReasons.map((value) => (value).toJson()).toList(); |
+ if (dealsStatus != null) { |
+ _json["dealsStatus"] = dealsStatus; |
} |
if (filteringReasons != null) { |
_json["filteringReasons"] = (filteringReasons).toJson(); |
@@ -1676,6 +1726,9 @@ class Creative { |
if (kind != null) { |
_json["kind"] = kind; |
} |
+ if (openAuctionStatus != null) { |
+ _json["openAuctionStatus"] = openAuctionStatus; |
+ } |
if (productCategories != null) { |
_json["productCategories"] = productCategories; |
} |
@@ -1685,8 +1738,8 @@ class Creative { |
if (sensitiveCategories != null) { |
_json["sensitiveCategories"] = sensitiveCategories; |
} |
- if (status != null) { |
- _json["status"] = status; |
+ if (servingRestrictions != null) { |
+ _json["servingRestrictions"] = servingRestrictions.map((value) => (value).toJson()).toList(); |
} |
if (vendorType != null) { |
_json["vendorType"] = vendorType; |
@@ -1746,172 +1799,6 @@ class CreativesList { |
} |
} |
-/** The configuration data for an Ad Exchange direct deal. */ |
-class DirectDeal { |
- /** The account id of the buyer this deal is for. */ |
- core.int accountId; |
- /** The name of the advertiser this deal is for. */ |
- core.String advertiser; |
- /** |
- * The currency code that applies to the fixed_cpm value. If not set then |
- * assumed to be USD. |
- */ |
- core.String currencyCode; |
- /** |
- * End time for when this deal stops being active. If not set then this deal |
- * is valid until manually disabled by the publisher. In seconds since the |
- * epoch. |
- */ |
- core.String endTime; |
- /** |
- * The fixed price for this direct deal. In cpm micros of currency according |
- * to currency_code. If set, then this deal is eligible for the fixed price |
- * tier of buying (highest priority, pay exactly the configured fixed price). |
- */ |
- core.String fixedCpm; |
- /** Deal id. */ |
- core.String id; |
- /** Resource type. */ |
- core.String kind; |
- /** Deal name. */ |
- core.String name; |
- /** |
- * The minimum price for this direct deal. In cpm micros of currency according |
- * to currency_code. If set, then this deal is eligible for the private |
- * exchange tier of buying (below fixed price priority, run as a second price |
- * auction). |
- */ |
- core.String privateExchangeMinCpm; |
- /** |
- * If true, the publisher has opted to have their blocks ignored when a |
- * creative is bid with for this deal. |
- */ |
- core.bool publisherBlocksOverriden; |
- /** The name of the publisher offering this direct deal. */ |
- core.String sellerNetwork; |
- /** |
- * Start time for when this deal becomes active. If not set then this deal is |
- * active immediately upon creation. In seconds since the epoch. |
- */ |
- core.String startTime; |
- |
- DirectDeal(); |
- |
- DirectDeal.fromJson(core.Map _json) { |
- if (_json.containsKey("accountId")) { |
- accountId = _json["accountId"]; |
- } |
- if (_json.containsKey("advertiser")) { |
- advertiser = _json["advertiser"]; |
- } |
- if (_json.containsKey("currencyCode")) { |
- currencyCode = _json["currencyCode"]; |
- } |
- if (_json.containsKey("endTime")) { |
- endTime = _json["endTime"]; |
- } |
- if (_json.containsKey("fixedCpm")) { |
- fixedCpm = _json["fixedCpm"]; |
- } |
- if (_json.containsKey("id")) { |
- id = _json["id"]; |
- } |
- if (_json.containsKey("kind")) { |
- kind = _json["kind"]; |
- } |
- if (_json.containsKey("name")) { |
- name = _json["name"]; |
- } |
- if (_json.containsKey("privateExchangeMinCpm")) { |
- privateExchangeMinCpm = _json["privateExchangeMinCpm"]; |
- } |
- if (_json.containsKey("publisherBlocksOverriden")) { |
- publisherBlocksOverriden = _json["publisherBlocksOverriden"]; |
- } |
- if (_json.containsKey("sellerNetwork")) { |
- sellerNetwork = _json["sellerNetwork"]; |
- } |
- if (_json.containsKey("startTime")) { |
- startTime = _json["startTime"]; |
- } |
- } |
- |
- core.Map toJson() { |
- var _json = new core.Map(); |
- if (accountId != null) { |
- _json["accountId"] = accountId; |
- } |
- if (advertiser != null) { |
- _json["advertiser"] = advertiser; |
- } |
- if (currencyCode != null) { |
- _json["currencyCode"] = currencyCode; |
- } |
- if (endTime != null) { |
- _json["endTime"] = endTime; |
- } |
- if (fixedCpm != null) { |
- _json["fixedCpm"] = fixedCpm; |
- } |
- if (id != null) { |
- _json["id"] = id; |
- } |
- if (kind != null) { |
- _json["kind"] = kind; |
- } |
- if (name != null) { |
- _json["name"] = name; |
- } |
- if (privateExchangeMinCpm != null) { |
- _json["privateExchangeMinCpm"] = privateExchangeMinCpm; |
- } |
- if (publisherBlocksOverriden != null) { |
- _json["publisherBlocksOverriden"] = publisherBlocksOverriden; |
- } |
- if (sellerNetwork != null) { |
- _json["sellerNetwork"] = sellerNetwork; |
- } |
- if (startTime != null) { |
- _json["startTime"] = startTime; |
- } |
- return _json; |
- } |
-} |
- |
-/** |
- * A direct deals feed lists Direct Deals the Ad Exchange buyer account has |
- * access to. This includes direct deals set up for the buyer account as well as |
- * its merged stream seats. |
- */ |
-class DirectDealsList { |
- /** A list of direct deals relevant for your account. */ |
- core.List<DirectDeal> directDeals; |
- /** Resource type. */ |
- core.String kind; |
- |
- DirectDealsList(); |
- |
- DirectDealsList.fromJson(core.Map _json) { |
- if (_json.containsKey("directDeals")) { |
- directDeals = _json["directDeals"].map((value) => new DirectDeal.fromJson(value)).toList(); |
- } |
- if (_json.containsKey("kind")) { |
- kind = _json["kind"]; |
- } |
- } |
- |
- core.Map toJson() { |
- var _json = new core.Map(); |
- if (directDeals != null) { |
- _json["directDeals"] = directDeals.map((value) => (value).toJson()).toList(); |
- } |
- if (kind != null) { |
- _json["kind"] = kind; |
- } |
- return _json; |
- } |
-} |
- |
/** The configuration data for an Ad Exchange performance report list. */ |
class PerformanceReport { |
/** The number of bid responses with an ad. */ |