openapi-directory/api/googleapis.com/adexchangebuyer.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.","title":"Ad Exchange Buyer","version":"v1.4","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-logo":{"url":"https://www.doubleclickbygoogle.com/static/core/img/doubleclick-google-logo-wide.svg"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/adexchangebuyer/v1.4/rest","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"adexchangebuyer"},"externalDocs":{"url":"https://developers.google.com/ad-exchange/buyer-rest"},"tags":[{"name":"accounts"},{"name":"billingInfo"},{"name":"budget"},{"name":"creatives"},{"name":"marketplacedeals"},{"name":"marketplacenotes"},{"name":"marketplaceprivateauction"},{"name":"performanceReport"},{"name":"pretargetingConfig"},{"name":"products"},{"name":"proposals"},{"name":"pubprofiles"}],"paths":{"/accounts":{"get":{"description":"Retrieves the authenticated user's list of accounts.","operationId":"adexchangebuyer.accounts.list","responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountsList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["accounts"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/accounts/{id}":{"get":{"description":"Gets one account by ID.","operationId":"adexchangebuyer.accounts.get","parameters":[{"description":"The account id","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["accounts"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates an existing account. This method supports patch semantics.","operationId":"adexchangebuyer.accounts.patch","parameters":[{"description":"Confirmation for erasing bidder and cookie matching urls.","in":"query","name":"confirmUnsafeAccountChange","schema":{"type":"boolean"}},{"description":"The account id","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/Account"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["accounts"]},"put":{"description":"Updates an existing account.","operationId":"adexchangebuyer.accounts.update","parameters":[{"description":"Confirmation for erasing bidder and cookie matching urls.","in":"query","name":"confirmUnsafeAccountChange","schema":{"type":"boolean"}},{"description":"The account id","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/Account"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["accounts"]}},"/billinginfo":{"get":{"description":"Retrieves a list of billing information for all accounts of the authenticated user.","operationId":"adexchangebuyer.billingInfo.list","responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BillingInfoList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["billingInfo"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/billinginfo/{accountId}":{"get":{"description":"Returns the billing information for one account specified by account ID.","operationId":"adexchangebuyer.billingInfo.get","parameters":[{"description":"The account id.","in":"path","name":"accountId","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BillingInfo"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["billingInfo"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/billinginfo/{accountId}/{billingId}":{"get":{"description":"Returns the budget information for the adgroup specified by the accountId and billingId.","operationId":"adexchangebuyer.budget.get","parameters":[{"description":"The account id to get the budget information for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The billing id to get the budget information for.","in":"path","name":"billingId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Budget"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["budget"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.","operationId":"adexchangebuyer.budget.patch","parameters":[{"description":"The account id associated with the budget being updated.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The billing id associated with the budget being updated.","in":"path","name":"billingId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Budget"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Budget"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["budget"]},"put":{"description":"Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.","operationId":"adexchangebuyer.budget.update","parameters":[{"description":"The account id associated with the budget being updated.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The billing id associated with the budget being updated.","in":"path","name":"billingId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Budget"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Budget"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["budget"]}},"/creatives":{"get":{"description":"Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.","operationId":"adexchangebuyer.creatives.list","parameters":[{"description":"When specified, only creatives for the given account ids are returned.","in":"query","name":"accountId","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"When specified, only creatives for the given buyer creative ids are returned.","in":"query","name":"buyerCreativeId","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"When specified, only creatives having the given deals status are returned.","in":"query","name":"dealsStatusFilter","schema":{"type":"string","enum":["approved","conditionally_approved","disapproved","not_checked"]}},{"description":"Maximum number of entries returned on one result page. If not set, the default is 100. Optional.","in":"query","name":"maxResults","schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"When specified, only creatives having the given open auction status are returned.","in":"query","name":"openAuctionStatusFilter","schema":{"type":"string","enum":["approved","conditionally_approved","disapproved","not_checked"]}},{"description":"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreativesList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["creatives"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Submit a new creative.","operationId":"adexchangebuyer.creatives.insert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Creative"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Creative"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["creatives"]}},"/creatives/{accountId}/{buyerCreativeId}":{"get":{"description":"Gets the status for a single creative. A creative will be available 30-40 minutes after submission.","operationId":"adexchangebuyer.creatives.get","parameters":[{"description":"The id for the account that will serve this creative.","in":"path","name":"accountId","required":true,"schema":{"type":"integer"}},{"description":"The buyer-specific id for this creative.","in":"path","name":"buyerCreativeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Creative"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["creatives"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Add a deal id association for the creative.","operationId":"adexchangebuyer.creatives.addDeal","parameters":[{"description":"The id for the account that will serve this creative.","in":"path","name":"accountId","required":true,"schema":{"type":"integer"}},{"description":"The buyer-specific id for this creative.","in":"path","name":"buyerCreativeId","required":true,"schema":{"type":"string"}},{"description":"The id of the deal id to associate with this creative.","in":"path","name":"dealId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["creatives"]}},"/creatives/{accountId}/{buyerCreativeId}/listDeals":{"get":{"description":"Lists the external deal ids associated with the creative.","operationId":"adexchangebuyer.creatives.listDeals","parameters":[{"description":"The id for the account that will serve this creative.","in":"path","name":"accountId","required":true,"schema":{"type":"integer"}},{"description":"The buyer-specific id for this creative.","in":"path","name":"buyerCreativeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreativeDealIds"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["creatives"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Remove a deal id associated with the creative.","operationId":"adexchangebuyer.creatives.removeDeal","parameters":[{"description":"The id for the account that will serve this creative.","in":"path","name":"accountId","required":true,"schema":{"type":"integer"}},{"description":"The buyer-specific id for this creative.","in":"path","name":"buyerCreativeId","required":true,"schema":{"type":"string"}},{"description":"The id of the deal id to disassociate with this creative.","in":"path","name":"dealId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["creatives"]}},"/performancereport":{"get":{"description":"Retrieves the authenticated user's list of performance metrics.","operationId":"adexchangebuyer.performanceReport.list","parameters":[{"description":"The account id to get the reports.","in":"query","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The end time of the report in ISO 8601 timestamp format using UTC.","in":"query","name":"endDateTime","required":true,"schema":{"type":"string"}},{"description":"Maximum number of entries returned on one result page. If not set, the default is 100. Optional.","in":"query","name":"maxResults","schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The start time of the report in ISO 8601 timestamp format using UTC.","in":"query","name":"startDateTime","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PerformanceReportList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["performanceReport"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/pretargetingconfigs/{accountId}":{"get":{"description":"Retrieves a list of the authenticated user's pretargeting configurations.","operationId":"adexchangebuyer.pretargetingConfig.list","parameters":[{"description":"The account id to get the pretargeting configs for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PretargetingConfigList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pretargetingConfig"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Inserts a new pretargeting configuration.","operationId":"adexchangebuyer.pretargetingConfig.insert","parameters":[{"description":"The account id to insert the pretargeting config for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PretargetingConfig"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PretargetingConfig"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pretargetingConfig"]}},"/pretargetingconfigs/{accountId}/{configId}":{"delete":{"description":"Deletes an existing pretargeting config.","operationId":"adexchangebuyer.pretargetingConfig.delete","parameters":[{"description":"The account id to delete the pretargeting config for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The specific id of the configuration to delete.","in":"path","name":"configId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pretargetingConfig"]},"get":{"description":"Gets a specific pretargeting configuration","operationId":"adexchangebuyer.pretargetingConfig.get","parameters":[{"description":"The account id to get the pretargeting config for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The specific id of the configuration to retrieve.","in":"path","name":"configId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PretargetingConfig"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pretargetingConfig"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates an existing pretargeting config. This method supports patch semantics.","operationId":"adexchangebuyer.pretargetingConfig.patch","parameters":[{"description":"The account id to update the pretargeting config for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The specific id of the configuration to update.","in":"path","name":"configId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PretargetingConfig"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PretargetingConfig"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pretargetingConfig"]},"put":{"description":"Updates an existing pretargeting config.","operationId":"adexchangebuyer.pretargetingConfig.update","parameters":[{"description":"The account id to update the pretargeting config for.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The specific id of the configuration to update.","in":"path","name":"configId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PretargetingConfig"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PretargetingConfig"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pretargetingConfig"]}},"/privateauction/{privateAuctionId}/updateproposal":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Update a given private auction proposal","operationId":"adexchangebuyer.marketplaceprivateauction.updateproposal","parameters":[{"in":"path","name":"privateAuctionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePrivateAuctionProposalRequest"}}}},"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplaceprivateauction"]}},"/products/search":{"get":{"description":"Gets the requested product.","operationId":"adexchangebuyer.products.search","parameters":[{"description":"The pql query used to query for products.","in":"query","name":"pqlQuery","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetOffersResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["products"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/products/{productId}":{"get":{"description":"Gets the requested product by id.","operationId":"adexchangebuyer.products.get","parameters":[{"description":"The id for the product to get the head revision for.","in":"path","name":"productId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Product"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["products"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/proposals/insert":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Create the given list of proposals","operationId":"adexchangebuyer.proposals.insert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrdersRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateOrdersResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["proposals"]}},"/proposals/search":{"get":{"description":"Search for proposals using pql query","operationId":"adexchangebuyer.proposals.search","parameters":[{"description":"Query string to retrieve specific proposals.","in":"query","name":"pqlQuery","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetOrdersResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["proposals"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/proposals/{proposalId}":{"get":{"description":"Get a proposal given its id","operationId":"adexchangebuyer.proposals.get","parameters":[{"description":"Id of the proposal to retrieve.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Proposal"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["proposals"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/proposals/{proposalId}/deals":{"get":{"description":"List all the deals for a given proposal","operationId":"adexchangebuyer.marketplacedeals.list","parameters":[{"description":"Query string to retrieve specific deals.","in":"query","name":"pqlQuery","schema":{"type":"string"}},{"description":"The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetOrderDealsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplacedeals"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/proposals/{proposalId}/deals/delete":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Delete the specified deals from the proposal","operationId":"adexchangebuyer.marketplacedeals.delete","parameters":[{"description":"The proposalId to delete deals from.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteOrderDealsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteOrderDealsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplacedeals"]}},"/proposals/{proposalId}/deals/insert":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Add new deals for the specified proposal","operationId":"adexchangebuyer.marketplacedeals.insert","parameters":[{"description":"proposalId for which deals need to be added.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrderDealsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AddOrderDealsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplacedeals"]}},"/proposals/{proposalId}/deals/update":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Replaces all the deals in the proposal with the passed in deals","operationId":"adexchangebuyer.marketplacedeals.update","parameters":[{"description":"The proposalId to edit deals on.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditAllOrderDealsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditAllOrderDealsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplacedeals"]}},"/proposals/{proposalId}/notes":{"get":{"description":"Get all the notes associated with a proposal","operationId":"adexchangebuyer.marketplacenotes.list","parameters":[{"description":"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%\"","in":"query","name":"pqlQuery","schema":{"type":"string"}},{"description":"The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetOrderNotesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplacenotes"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/proposals/{proposalId}/notes/insert":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Add notes to the proposal","operationId":"adexchangebuyer.marketplacenotes.insert","parameters":[{"description":"The proposalId to add notes for.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrderNotesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AddOrderNotesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["marketplacenotes"]}},"/proposals/{proposalId}/setupcomplete":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Update the given proposal to indicate that setup has been completed.","operationId":"adexchangebuyer.proposals.setupcomplete","parameters":[{"description":"The proposal id for which the setup is complete","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["proposals"]}},"/proposals/{proposalId}/{revisionNumber}/{updateAction}":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Update the given proposal. This method supports patch semantics.","operationId":"adexchangebuyer.proposals.patch","parameters":[{"description":"The proposal id to update.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}},{"description":"The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.","in":"path","name":"revisionNumber","required":true,"schema":{"type":"string"}},{"description":"The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.","in":"path","name":"updateAction","required":true,"schema":{"type":"string","enum":["accept","cancel","propose","proposeAndAccept","unknownAction","updateNonTerms"]}}],"requestBody":{"$ref":"#/components/requestBodies/Proposal"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Proposal"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["proposals"]},"put":{"description":"Update the given proposal","operationId":"adexchangebuyer.proposals.update","parameters":[{"description":"The proposal id to update.","in":"path","name":"proposalId","required":true,"schema":{"type":"string"}},{"description":"The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.","in":"path","name":"revisionNumber","required":true,"schema":{"type":"string"}},{"description":"The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.","in":"path","name":"updateAction","required":true,"schema":{"type":"string","enum":["accept","cancel","propose","proposeAndAccept","unknownAction","updateNonTerms"]}}],"requestBody":{"$ref":"#/components/requestBodies/Proposal"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Proposal"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["proposals"]}},"/publisher/{accountId}/profiles":{"get":{"description":"Gets the requested publisher profile(s) by publisher accountId.","operationId":"adexchangebuyer.pubprofiles.list","parameters":[{"description":"The accountId of the publisher to get profiles for.","in":"path","name":"accountId","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetPublisherProfilesByAccountIdResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/adexchange.buyer"]}],"tags":["pubprofiles"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]}},"servers":[{"url":"https://www.googleapis.com/adexchangebuyer/v1.4"}],"components":{"parameters":{"alt":{"description":"Data format for the response.","in":"query","name":"alt","schema":{"type":"string","enum":["json"],"default":"json"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"userIp":{"description":"Deprecated. Please use quotaUser instead.","in":"query","name":"userIp","schema":{"type":"string"}}},"requestBodies":{"Proposal":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}}},"PretargetingConfig":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PretargetingConfig"}}}},"Budget":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Budget"}}}},"Account":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/adexchange.buyer":"Manage your Ad Exchange buyer account configuration"}}}}},"schemas":{"Account":{"description":"Configuration data for an Ad Exchange buyer account.","properties":{"applyPretargetingToNonGuaranteedDeals":{"description":"When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder.","type":"boolean"},"bidderLocation":{"description":"Your bidder locations that have distinct URLs.","items":{"properties":{"bidProtocol":{"description":"The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON.  Allowed values:  \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_2_4 \n- PROTOCOL_OPENRTB_2_5 \n- PROTOCOL_OPENRTB_PROTOBUF_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF_2_4 \n- PROTOCOL_OPENRTB_PROTOBUF_2_5","type":"string"},"maximumQps":{"description":"The maximum queries per second the Ad Exchange will send.","format":"int32","type":"integer"},"region":{"description":"The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:  \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST","type":"string"},"url":{"description":"The URL to which the Ad Exchange will send bid requests.","type":"string"}},"type":"object"},"type":"array"},"cookieMatchingNid":{"description":"The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.","type":"string"},"cookieMatchingUrl":{"description":"The base URL used in cookie match requests.","type":"string"},"id":{"description":"Account id.","format":"int32","type":"integer"},"kind":{"default":"adexchangebuyer#account","description":"Resource type.","type":"string"},"maximumActiveCreatives":{"description":"The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.","format":"int32","type":"integer"},"maximumTotalQps":{"description":"The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.","format":"int32","type":"integer"},"numberActiveCreatives":{"description":"The number of creatives that this account inserted or bid with in the last 30 days.","format":"int32","type":"integer"}},"type":"object"},"AccountsList":{"description":"An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.","properties":{"items":{"description":"A list of accounts.","items":{"$ref":"#/components/schemas/Account"},"type":"array"},"kind":{"default":"adexchangebuyer#accountsList","description":"Resource type.","type":"string"}},"type":"object"},"AddOrderDealsRequest":{"properties":{"deals":{"description":"The list of deals to add","items":{"$ref":"#/components/schemas/MarketplaceDeal"},"type":"array"},"proposalRevisionNumber":{"description":"The last known proposal revision number.","format":"int64","type":"string"},"updateAction":{"description":"Indicates an optional action to take on the proposal","type":"string"}},"type":"object"},"AddOrderDealsResponse":{"properties":{"deals":{"description":"List of deals added (in the same proposal as passed in the request)","items":{"$ref":"#/components/schemas/MarketplaceDeal"},"type":"array"},"proposalRevisionNumber":{"description":"The updated revision number for the proposal.","format":"int64","type":"string"}},"type":"object"},"AddOrderNotesRequest":{"properties":{"notes":{"description":"The list of notes to add.","items":{"$ref":"#/components/schemas/MarketplaceNote"},"type":"array"}},"type":"object"},"AddOrderNotesResponse":{"properties":{"notes":{"items":{"$ref":"#/components/schemas/MarketplaceNote"},"type":"array"}},"type":"object"},"BillingInfo":{"description":"The configuration data for an Ad Exchange billing info.","properties":{"accountId":{"description":"Account id.","format":"int32","type":"integer"},"accountName":{"description":"Account name.","type":"string"},"billingId":{"description":"A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.","items":{"type":"string"},"type":"array"},"kind":{"default":"adexchangebuyer#billingInfo","description":"Resource type.","type":"string"}},"type":"object"},"BillingInfoList":{"description":"A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.","properties":{"items":{"description":"A list of billing info relevant for your account.","items":{"$ref":"#/components/schemas/BillingInfo"},"type":"array"},"kind":{"default":"adexchangebuyer#billingInfoList","description":"Resource type.","type":"string"}},"type":"object"},"Budget":{"description":"The configuration data for Ad Exchange RTB - Budget API.","properties":{"accountId":{"description":"The id of the account. This is required for get and update requests.","format":"int64","type":"string"},"billingId":{"description":"The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.","format":"int64","type":"string"},"budgetAmount":{"description":"The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.","format":"int64","type":"string"},"currencyCode":{"description":"The currency code for the buyer. This cannot be altered here.","type":"string"},"id":{"description":"The unique id that describes this item.","type":"string"},"kind":{"default":"adexchangebuyer#budget","description":"The kind of the resource, i.e. \"adexchangebuyer#budget\".","type":"string"}},"type":"object"},"Buyer":{"properties":{"accountId":{"description":"Adx account id of the buyer.","type":"string"}},"type":"object"},"ContactInformation":{"properties":{"email":{"description":"Email address of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"}},"type":"object"},"CreateOrdersRequest":{"properties":{"proposals":{"description":"The list of proposals to create.","items":{"$ref":"#/components/schemas/Proposal"},"type":"array"},"webPropertyCode":{"description":"Web property id of the seller creating these orders","type":"string"}},"type":"object"},"CreateOrdersResponse":{"properties":{"proposals":{"description":"The list of proposals successfully created.","items":{"$ref":"#/components/schemas/Proposal"},"type":"array"}},"type":"object"},"Creative":{"description":"A creative and its classification data.","properties":{"HTMLSnippet":{"description":"The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.","type":"string"},"accountId":{"description":"Account id.","format":"int32","type":"integer"},"adChoicesDestinationUrl":{"description":"The link to the Ad Preferences page. This is only supported for native ads.","type":"string"},"advertiserId":{"description":"Detected advertiser id, if any. Read-only. This field should not be set in requests.","items":{"format":"int64","type":"string"},"type":"array"},"advertiserName":{"description":"The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file.","type":"string"},"agencyId":{"description":"The agency id for this creative.","format":"int64","type":"string"},"apiUploadTimestamp":{"description":"The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).","format":"date-time","type":"string"},"attribute":{"description":"List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in  buyer-declarable-creative-attributes.txt.","items":{"format":"int32","type":"integer"},"type":"array"},"buyerCreativeId":{"description":"A buyer-specific id identifying the creative in this ad.","type":"string"},"clickThroughUrl":{"description":"The set of destination urls for the snippet.","items":{"type":"string"},"type":"array"},"corrections":{"description":"Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.","items":{"properties":{"contexts":{"description":"All known serving contexts containing serving status information.","items":{"properties":{"auctionType":{"description":"Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.","items":{"type":"string"},"type":"array"},"contextType":{"description":"The type of context (e.g., location, platform, auction type, SSL-ness).","type":"string"},"geoCriteriaId":{"description":"Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.","items":{"format":"int32","type":"integer"},"type":"array"},"platform":{"description":"Only set when contextType=PLATFORM. Represents the platforms this correction applies to.","items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"details":{"description":"Additional details about the correction.","items":{"type":"string"},"type":"array"},"reason":{"description":"The type of correction that was applied to the creative.","type":"string"}},"type":"object"},"type":"array"},"creativeStatusIdentityType":{"description":"Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.","type":"string"},"dealsStatus":{"description":"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.","type":"string"},"detectedDomains":{"description":"Detected domains for this creative. Read-only. This field should not be set in requests.","items":{"type":"string"},"type":"array"},"filteringReasons":{"description":"The filtering reasons for the creative. Read-only. This field should not be set in requests.","properties":{"date":{"description":"The date in ISO 8601 format for the data.