6.0.0 • Published 5 years ago

@datafire/google_adexchangebuyer v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/google_adexchangebuyer

Client library for Ad Exchange Buyer API

Installation and Usage

npm install --save @datafire/google_adexchangebuyer
let google_adexchangebuyer = require('@datafire/google_adexchangebuyer').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_adexchangebuyer.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_adexchangebuyer.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

adexchangebuyer.accounts.list

Retrieves the authenticated user's list of accounts.

google_adexchangebuyer.adexchangebuyer.accounts.list({}, context)

Input

  • input object
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.accounts.get

Gets one account by ID.

google_adexchangebuyer.adexchangebuyer.accounts.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The account id
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.accounts.patch

Updates an existing account. This method supports patch semantics.

google_adexchangebuyer.adexchangebuyer.accounts.patch({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The account id
    • confirmUnsafeAccountChange boolean: Confirmation for erasing bidder and cookie matching urls.
    • body Account
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.accounts.update

Updates an existing account.

google_adexchangebuyer.adexchangebuyer.accounts.update({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The account id
    • confirmUnsafeAccountChange boolean: Confirmation for erasing bidder and cookie matching urls.
    • body Account
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.billingInfo.list

Retrieves a list of billing information for all accounts of the authenticated user.

google_adexchangebuyer.adexchangebuyer.billingInfo.list({}, context)

Input

  • input object
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.billingInfo.get

Returns the billing information for one account specified by account ID.

google_adexchangebuyer.adexchangebuyer.billingInfo.get({
  "accountId": 0
}, context)

Input

  • input object
    • accountId required integer: The account id.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.budget.get

Returns the budget information for the adgroup specified by the accountId and billingId.

google_adexchangebuyer.adexchangebuyer.budget.get({
  "accountId": "",
  "billingId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to get the budget information for.
    • billingId required string: The billing id to get the budget information for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.budget.patch

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.

google_adexchangebuyer.adexchangebuyer.budget.patch({
  "accountId": "",
  "billingId": ""
}, context)

Input

  • input object
    • accountId required string: The account id associated with the budget being updated.
    • billingId required string: The billing id associated with the budget being updated.
    • body Budget
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.budget.update

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

google_adexchangebuyer.adexchangebuyer.budget.update({
  "accountId": "",
  "billingId": ""
}, context)

Input

  • input object
    • accountId required string: The account id associated with the budget being updated.
    • billingId required string: The billing id associated with the budget being updated.
    • body Budget
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.creatives.list

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

google_adexchangebuyer.adexchangebuyer.creatives.list({}, context)

Input

  • input object
    • accountId array: When specified, only creatives for the given account ids are returned.
    • buyerCreativeId array: When specified, only creatives for the given buyer creative ids are returned.
    • dealsStatusFilter string (values: approved, conditionally_approved, disapproved, not_checked): When specified, only creatives having the given deals status are returned.
    • maxResults integer: Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
    • openAuctionStatusFilter string (values: approved, conditionally_approved, disapproved, not_checked): When specified, only creatives having the given open auction status are returned.
    • pageToken string: 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.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.creatives.insert

Submit a new creative.

google_adexchangebuyer.adexchangebuyer.creatives.insert({}, context)

Input

  • input object
    • body Creative
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.creatives.get

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

google_adexchangebuyer.adexchangebuyer.creatives.get({
  "accountId": 0,
  "buyerCreativeId": ""
}, context)

Input

  • input object
    • accountId required integer: The id for the account that will serve this creative.
    • buyerCreativeId required string: The buyer-specific id for this creative.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.creatives.addDeal

Add a deal id association for the creative.

google_adexchangebuyer.adexchangebuyer.creatives.addDeal({
  "accountId": 0,
  "buyerCreativeId": "",
  "dealId": ""
}, context)

Input

  • input object
    • accountId required integer: The id for the account that will serve this creative.
    • buyerCreativeId required string: The buyer-specific id for this creative.
    • dealId required string: The id of the deal id to associate with this creative.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

adexchangebuyer.creatives.listDeals

Lists the external deal ids associated with the creative.

google_adexchangebuyer.adexchangebuyer.creatives.listDeals({
  "accountId": 0,
  "buyerCreativeId": ""
}, context)

Input

  • input object
    • accountId required integer: The id for the account that will serve this creative.
    • buyerCreativeId required string: The buyer-specific id for this creative.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.creatives.removeDeal

Remove a deal id associated with the creative.

google_adexchangebuyer.adexchangebuyer.creatives.removeDeal({
  "accountId": 0,
  "buyerCreativeId": "",
  "dealId": ""
}, context)

Input

  • input object
    • accountId required integer: The id for the account that will serve this creative.
    • buyerCreativeId required string: The buyer-specific id for this creative.
    • dealId required string: The id of the deal id to disassociate with this creative.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

adexchangebuyer.performanceReport.list

Retrieves the authenticated user's list of performance metrics.

google_adexchangebuyer.adexchangebuyer.performanceReport.list({
  "accountId": "",
  "endDateTime": "",
  "startDateTime": ""
}, context)

Input

  • input object
    • accountId required string: The account id to get the reports.
    • endDateTime required string: The end time of the report in ISO 8601 timestamp format using UTC.
    • startDateTime required string: The start time of the report in ISO 8601 timestamp format using UTC.
    • maxResults integer: Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
    • pageToken string: 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.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.pretargetingConfig.list

Retrieves a list of the authenticated user's pretargeting configurations.

google_adexchangebuyer.adexchangebuyer.pretargetingConfig.list({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to get the pretargeting configs for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.pretargetingConfig.insert

Inserts a new pretargeting configuration.

google_adexchangebuyer.adexchangebuyer.pretargetingConfig.insert({
  "accountId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to insert the pretargeting config for.
    • body PretargetingConfig
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.pretargetingConfig.delete

Deletes an existing pretargeting config.

google_adexchangebuyer.adexchangebuyer.pretargetingConfig.delete({
  "accountId": "",
  "configId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to delete the pretargeting config for.
    • configId required string: The specific id of the configuration to delete.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

adexchangebuyer.pretargetingConfig.get

Gets a specific pretargeting configuration

google_adexchangebuyer.adexchangebuyer.pretargetingConfig.get({
  "accountId": "",
  "configId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to get the pretargeting config for.
    • configId required string: The specific id of the configuration to retrieve.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.pretargetingConfig.patch

Updates an existing pretargeting config. This method supports patch semantics.

google_adexchangebuyer.adexchangebuyer.pretargetingConfig.patch({
  "accountId": "",
  "configId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to update the pretargeting config for.
    • configId required string: The specific id of the configuration to update.
    • body PretargetingConfig
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.pretargetingConfig.update

Updates an existing pretargeting config.

google_adexchangebuyer.adexchangebuyer.pretargetingConfig.update({
  "accountId": "",
  "configId": ""
}, context)

Input

  • input object
    • accountId required string: The account id to update the pretargeting config for.
    • configId required string: The specific id of the configuration to update.
    • body PretargetingConfig
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplaceprivateauction.updateproposal

Update a given private auction proposal

google_adexchangebuyer.adexchangebuyer.marketplaceprivateauction.updateproposal({
  "privateAuctionId": ""
}, context)

Input

  • input object
    • privateAuctionId required string: The private auction id to be updated.
    • body UpdatePrivateAuctionProposalRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

adexchangebuyer.products.search

Gets the requested product.

google_adexchangebuyer.adexchangebuyer.products.search({}, context)

Input

  • input object
    • pqlQuery string: The pql query used to query for products.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.products.get

Gets the requested product by id.

google_adexchangebuyer.adexchangebuyer.products.get({
  "productId": ""
}, context)

Input

  • input object
    • productId required string: The id for the product to get the head revision for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.proposals.insert

Create the given list of proposals

google_adexchangebuyer.adexchangebuyer.proposals.insert({}, context)

Input

  • input object
    • body CreateOrdersRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.proposals.search

Search for proposals using pql query

google_adexchangebuyer.adexchangebuyer.proposals.search({}, context)

Input

  • input object
    • pqlQuery string: Query string to retrieve specific proposals.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.proposals.get

Get a proposal given its id

google_adexchangebuyer.adexchangebuyer.proposals.get({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: Id of the proposal to retrieve.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplacedeals.list

List all the deals for a given proposal

google_adexchangebuyer.adexchangebuyer.marketplacedeals.list({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.
    • pqlQuery string: Query string to retrieve specific deals.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplacedeals.delete

Delete the specified deals from the proposal

google_adexchangebuyer.adexchangebuyer.marketplacedeals.delete({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: The proposalId to delete deals from.
    • body DeleteOrderDealsRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplacedeals.insert

Add new deals for the specified proposal

google_adexchangebuyer.adexchangebuyer.marketplacedeals.insert({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: proposalId for which deals need to be added.
    • body AddOrderDealsRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplacedeals.update

Replaces all the deals in the proposal with the passed in deals

google_adexchangebuyer.adexchangebuyer.marketplacedeals.update({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: The proposalId to edit deals on.
    • body EditAllOrderDealsRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplacenotes.list

Get all the notes associated with a proposal

google_adexchangebuyer.adexchangebuyer.marketplacenotes.list({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.
    • pqlQuery string: 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%"
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.marketplacenotes.insert

Add notes to the proposal

google_adexchangebuyer.adexchangebuyer.marketplacenotes.insert({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: The proposalId to add notes for.
    • body AddOrderNotesRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.proposals.setupcomplete

Update the given proposal to indicate that setup has been completed.

google_adexchangebuyer.adexchangebuyer.proposals.setupcomplete({
  "proposalId": ""
}, context)

Input

  • input object
    • proposalId required string: The proposal id for which the setup is complete
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

adexchangebuyer.proposals.patch

Update the given proposal. This method supports patch semantics.

google_adexchangebuyer.adexchangebuyer.proposals.patch({
  "proposalId": "",
  "revisionNumber": "",
  "updateAction": ""
}, context)

Input

  • input object
    • proposalId required string: The proposal id to update.
    • revisionNumber required string: 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.
    • updateAction required string (values: accept, cancel, propose, proposeAndAccept, unknownAction, updateNonTerms): The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
    • body Proposal
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.proposals.update

Update the given proposal

google_adexchangebuyer.adexchangebuyer.proposals.update({
  "proposalId": "",
  "revisionNumber": "",
  "updateAction": ""
}, context)

Input

  • input object
    • proposalId required string: The proposal id to update.
    • revisionNumber required string: 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.
    • updateAction required string (values: accept, cancel, propose, proposeAndAccept, unknownAction, updateNonTerms): The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
    • body Proposal
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

adexchangebuyer.pubprofiles.list

Gets the requested publisher profile(s) by publisher accountId.

google_adexchangebuyer.adexchangebuyer.pubprofiles.list({
  "accountId": 0
}, context)

Input

  • input object
    • accountId required integer: The accountId of the publisher to get profiles for.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Definitions

Account

  • Account object: Configuration data for an Ad Exchange buyer account.
    • applyPretargetingToNonGuaranteedDeals boolean: 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.
    • bidderLocation array: Your bidder locations that have distinct URLs.
      • items object
        • bidProtocol string: The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values:
        • maximumQps integer: The maximum queries per second the Ad Exchange will send.
        • region string: 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:
        • url string: The URL to which the Ad Exchange will send bid requests.
    • cookieMatchingNid string: The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
    • cookieMatchingUrl string: The base URL used in cookie match requests.
    • id integer: Account id.
    • kind string: Resource type.
    • maximumActiveCreatives integer: 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.
    • maximumTotalQps integer: The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
    • numberActiveCreatives integer: The number of creatives that this account inserted or bid with in the last 30 days.

AccountsList

  • AccountsList object: 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.
    • items array: A list of accounts.
    • kind string: Resource type.

AddOrderDealsRequest

  • AddOrderDealsRequest object
    • deals array: The list of deals to add
    • proposalRevisionNumber string: The last known proposal revision number.
    • updateAction string: Indicates an optional action to take on the proposal

AddOrderDealsResponse

  • AddOrderDealsResponse object
    • deals array: List of deals added (in the same proposal as passed in the request)
    • proposalRevisionNumber string: The updated revision number for the proposal.

AddOrderNotesRequest

  • AddOrderNotesRequest object

AddOrderNotesResponse

BillingInfo

  • BillingInfo object: The configuration data for an Ad Exchange billing info.
    • accountId integer: Account id.
    • accountName string: Account name.
    • billingId array: 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 string
    • kind string: Resource type.

BillingInfoList

  • BillingInfoList object: 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.
    • items array: A list of billing info relevant for your account.
    • kind string: Resource type.

Budget

  • Budget object: The configuration data for Ad Exchange RTB - Budget API.
    • accountId string: The id of the account. This is required for get and update requests.
    • billingId string: The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
    • budgetAmount string: The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
    • currencyCode string: The currency code for the buyer. This cannot be altered here.
    • id string: The unique id that describes this item.
    • kind string: The kind of the resource, i.e. "adexchangebuyer#budget".

Buyer

  • Buyer object
    • accountId string: Adx account id of the buyer.

ContactInformation

  • ContactInformation object
    • email string: Email address of the contact.
    • name string: The name of the contact.

CreateOrdersRequest

  • CreateOrdersRequest object
    • proposals array: The list of proposals to create.
    • webPropertyCode string: Web property id of the seller creating these orders

CreateOrdersResponse

  • CreateOrdersResponse object
    • proposals array: The list of proposals successfully created.

Creative

  • Creative object: A creative and its classification data.
    • HTMLSnippet string: The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.
    • accountId integer: Account id.
    • adChoicesDestinationUrl string: The link to the Ad Preferences page. This is only supported for native ads.
    • adTechnologyProviders object
      • detectedProviderIds array: The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the BidRequest.adslot.consented_providers_settings.consented_providers field on the Authorized Buyers Real-Time Bidding protocol or the BidRequest.user.ext.consented_providers_settings.consented_providers field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
        • items string
      • hasUnidentifiedProvider boolean: Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
    • advertiserId array: Detected advertiser id, if any. Read-only. This field should not be set in requests.
      • items string
    • advertiserName string: The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.
    • agencyId string: The agency id for this creative.
    • apiUploadTimestamp string: 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).
    • attribute array: 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 integer
    • buyerCreativeId string: A buyer-specific id identifying the creative in this ad.
    • clickThroughUrl array: The set of destination urls for the snippet.
      • items string
    • corrections array: Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
      • items object
        • contexts array: All known serving contexts containing serving status information.
          • items object
            • auctionType array: Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
            • contextType string: The type of context (e.g., location, platform, auction type, SSL-ness).
            • geoCriteriaId array: Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
            • platform array: Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
        • details array: Additional details about the correction.
          • items string
        • reason string: The type of correction that was applied to the creative.
    • creativeStatusIdentityType string: 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.
    • dealsStatus string: 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.
    • detectedDomains array: Detected domains for this creative. Read-only. This field should not be set in requests.
      • items string
    • filteringReasons object: The filtering reasons for the creative. Read-only. This field should not be set in requests.
      • date string: The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
      • reasons array: The filtering reasons.
        • items object
          • filteringCount string: The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
          • filteringStatus integer: The filtering status code as defined in creative-status-codes.txt.
    • height integer: Ad height.
    • impressionTrackingUrl array: The set of urls to be called to record an impression.
      • items string
    • kind string: Resource type.
    • languages array: Detected languages for this creative. Read-only. This field should not be set in requests.
      • items string
    • nativeAd object: If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
      • advertiser string
      • appIcon object: The app icon, for app download ads.
        • height integer
        • url string
        • width integer
      • body string: A long description of the ad.
      • callToAction string: A label for the button that the user is supposed to click.
      • clickLinkUrl string: The URL that the browser/SDK will load when the user clicks the ad.
      • clickTrackingUrl string: The URL to use for click tracking.
      • headline string: A short title for the ad.
      • image object: A large image.
        • height integer
        • url string
        • width integer
      • impressionTrackingUrl array: The URLs are called when the impression is rendered.
        • items string
      • logo object: A smaller image, for the advertiser logo.
        • height integer
        • url string
        • width integer
      • price string: The price of the promoted app including the currency info.
      • starRating number: The app rating in the app store. Must be in the range 0-5.
      • videoURL string: The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.
    • openAuctionStatus string: 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.
    • productCategories array: Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.
      • items integer
    • restrictedCategories array: All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.
      • items integer
    • sensitiveCategories array: Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.
      • items integer
    • servingRestrictions array: 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. See the examples in the Creatives guide for more details.
      • items object
        • contexts array: All known contexts/restrictions.
          • items object
            • auctionType array: Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
            • contextType string: The type of context (e.g., location, platform, auction type, SSL-ness).
            • geoCriteriaId array: Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.
            • platform array: Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
        • disapprovalReasons array: 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.
          • items object
            • details array: Additional details about the reason for disapproval.
            • reason string: The categorized reason for disapproval.
        • reason string: Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
    • vendorType array: List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.
      • items integer
    • version integer: The version for this creative. Read-only. This field should not be set in requests.
    • videoURL string: The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.
    • videoVastXML string: The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.
    • width integer: Ad width.

CreativeDealIds

  • CreativeDealIds object: The external deal ids associated with a creative.
    • dealStatuses array: A list of external deal ids and ARC approval status.
      • items object
        • arcStatus string: ARC approval status.
        • dealId string: External deal ID.
        • webPropertyId integer: Publisher ID.
    • kind string: Resource type.

CreativesList

  • CreativesList object: The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
    • items array: A list of creatives.
    • kind string: Resource type.
    • nextPageToken string: Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.

DealServingMetadata

  • DealServingMetadata object
    • alcoholAdsAllowed boolean: True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals
    • dealPauseStatus DealServingMetadataDealPauseStatus

DealServingMetadataDealPauseStatus

  • DealServingMetadataDealPauseStatus object: 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.
    • buyerPauseReason string
    • firstPausedBy string: If the deal is paused, records which party paused the deal first.
    • hasBuyerPaused boolean
    • hasSellerPaused boolean
    • sellerPauseReason string

DealTerms

  • DealTerms object
    • brandingType string: Visibility of the URL in bid requests.
    • crossListedExternalDealIdType string: Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
    • description string: Description for the proposed terms of the deal.
    • estimatedGrossSpend Price
    • estimatedImpressionsPerDay string: Non-binding estimate of the impressions served per day Can be set by buyer or seller.
    • guaranteedFixedPriceTerms DealTermsGuaranteedFixedPriceTerms
    • nonGuaranteedAuctionTerms DealTermsNonGuaranteedAuctionTerms
    • nonGuaranteedFixedPriceTerms DealTermsNonGuaranteedFixedPriceTerms
    • rubiconNonGuaranteedTerms DealTermsRubiconNonGuaranteedTerms
    • sellerTimeZone string: For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)

DealTermsGuaranteedFixedPriceTerms

  • DealTermsGuaranteedFixedPriceTerms object
    • billingInfo DealTermsGuaranteedFixedPriceTermsBillingInfo
    • fixedPrices array: Fixed price for the specified buyer.
    • guaranteedImpressions string: Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
    • guaranteedLooks string: Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
    • minimumDailyLooks string: Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.

DealTermsGuaranteedFixedPriceTermsBillingInfo

  • DealTermsGuaranteedFixedPriceTermsBillingInfo object
    • currencyConversionTimeMs string: The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy.
    • dfpLineItemId string: The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
    • originalContractedQuantity string: The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
    • price Price

DealTermsNonGuaranteedAuctionTerms

  • DealTermsNonGuaranteedAuctionTerms object
    • autoOptimizePrivateAuction boolean: True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
    • reservePricePerBuyers array: Reserve price for the specified buyer.

DealTermsNonGuaranteedFixedPriceTerms

  • DealTermsNonGuaranteedFixedPriceTerms object
    • fixedPrices array: Fixed price for the specified buyer.

DealTermsRubiconNonGuaranteedTerms

  • DealTermsRubiconNonGuaranteedTerms object

DeleteOrderDealsRequest

  • DeleteOrderDealsRequest object
    • dealIds array: List of deals to delete for a given proposal
      • items string
    • proposalRevisionNumber string: The last known proposal revision number.
    • updateAction string: Indicates an optional action to take on the proposal

DeleteOrderDealsResponse

  • DeleteOrderDealsResponse object
    • deals array: List of deals deleted (in the same proposal as passed in the request)
    • proposalRevisionNumber string: The updated revision number for the proposal.

DeliveryControl

  • DeliveryControl object
    • creativeBlockingLevel string
    • deliveryRateType `stri
datafire
@infinitebrahmanuniverse/nolb-_datafire_g@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_g
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

8 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago