+ get(id)
Gets one account by ID.
+
+ list()
Retrieves the authenticated user's list of accounts.
+ +Updates an existing account. This method supports patch semantics.
+ +Updates an existing account.
+get(id)
+ Gets one account by ID.
+
+Args:
+ id: integer, The account id (required)
+
+Returns:
+ An object of the form:
+
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "maximumActiveCreatives": 42, # 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.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A 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:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+list()
+ Retrieves the authenticated user's list of accounts.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ { # 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": [ # A list of accounts.
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "maximumActiveCreatives": 42, # 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.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A 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:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ },
+ ],
+ "kind": "adexchangebuyer#accountsList", # Resource type.
+ }
+patch(id, body)
+ Updates an existing account. This method supports patch semantics.
+
+Args:
+ id: integer, The account id (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "maximumActiveCreatives": 42, # 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.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A 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:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "maximumActiveCreatives": 42, # 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.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A 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:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+update(id, body)
+ Updates an existing account.
+
+Args:
+ id: integer, The account id (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "maximumActiveCreatives": 42, # 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.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A 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:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Configuration data for an Ad Exchange buyer account.
+ "kind": "adexchangebuyer#account", # Resource type.
+ "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
+ "maximumActiveCreatives": 42, # 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.
+ "bidderLocation": [ # Your bidder locations that have distinct URLs.
+ {
+ "url": "A String", # The URL to which the Ad Exchange will send bid requests.
+ "region": "A 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:
+ # - ASIA
+ # - EUROPE
+ # - US_EAST
+ # - US_WEST
+ "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
+ },
+ ],
+ "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
+ "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
+ "id": 42, # Account id.
+ "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
+ }
+Returns the billing information for one account specified by account ID.
+
+ list()
Retrieves a list of billing information for all accounts of the authenticated user.
+get(accountId)
+ Returns the billing information for one account specified by account ID.
+
+Args:
+ accountId: integer, The account id. (required)
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for an Ad Exchange billing info.
+ "billingId": [ # 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.
+ "A String",
+ ],
+ "accountName": "A String", # Account name.
+ "kind": "adexchangebuyer#billingInfo", # Resource type.
+ "accountId": 42, # Account id.
+ }
+list()
+ Retrieves a list of billing information for all accounts of the authenticated user.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ { # 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": [ # A list of billing info relevant for your account.
+ { # The configuration data for an Ad Exchange billing info.
+ "billingId": [ # 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.
+ "A String",
+ ],
+ "accountName": "A String", # Account name.
+ "kind": "adexchangebuyer#billingInfo", # Resource type.
+ "accountId": 42, # Account id.
+ },
+ ],
+ "kind": "adexchangebuyer#billingInfoList", # Resource type.
+ }
+Returns the budget information for the adgroup specified by the accountId and billingId.
+
+ patch(accountId, billingId, body)
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.
+
+ update(accountId, billingId, body)
Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
+get(accountId, billingId)
+ Returns the budget information for the adgroup specified by the accountId and billingId.
+
+Args:
+ accountId: string, The account id to get the budget information for. (required)
+ billingId: string, The billing id to get the budget information for. (required)
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for Ad Exchange RTB - Budget API.
+ "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
+ "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
+ "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
+ "id": "A String", # The unique id that describes this item.
+ "accountId": "A String", # The id of the account. This is required for get and update requests.
+ }
+patch(accountId, billingId, body)
+ 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.
+
+Args:
+ accountId: string, The account id associated with the budget being updated. (required)
+ billingId: string, The billing id associated with the budget being updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The configuration data for Ad Exchange RTB - Budget API.
+ "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
+ "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
+ "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
+ "id": "A String", # The unique id that describes this item.
+ "accountId": "A String", # The id of the account. This is required for get and update requests.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for Ad Exchange RTB - Budget API.
+ "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
+ "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
+ "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
+ "id": "A String", # The unique id that describes this item.
+ "accountId": "A String", # The id of the account. This is required for get and update requests.
+ }
+update(accountId, billingId, body)
+ Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
+
+Args:
+ accountId: string, The account id associated with the budget being updated. (required)
+ billingId: string, The billing id associated with the budget being updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The configuration data for Ad Exchange RTB - Budget API.
+ "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
+ "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
+ "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
+ "id": "A String", # The unique id that describes this item.
+ "accountId": "A String", # The id of the account. This is required for get and update requests.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for Ad Exchange RTB - Budget API.
+ "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
+ "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests.
+ "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
+ "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
+ "id": "A String", # The unique id that describes this item.
+ "accountId": "A String", # The id of the account. This is required for get and update requests.
+ }
+
+ delete(clientAccountId, sponsorAccountId)
A description of how to use this function
+
+ get(clientAccountId, sponsorAccountId)
A description of how to use this function
+
+ insert(body, clientAccountId=None, sponsorAccountId=None)
A description of how to use this function
+
+ list()
A description of how to use this function
+
+ patch(clientAccountId, sponsorAccountId, body)
A description of how to use this function
+
+ update(clientAccountId, sponsorAccountId, body)
A description of how to use this function
+delete(clientAccountId, sponsorAccountId)
+ A description of how to use this function + +Args: + clientAccountId: string, A parameter (required) + sponsorAccountId: integer, A parameter (required) ++
get(clientAccountId, sponsorAccountId)
+ A description of how to use this function
+
+Args:
+ clientAccountId: string, A parameter (required)
+ sponsorAccountId: integer, A parameter (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+insert(body, clientAccountId=None, sponsorAccountId=None)
+ A description of how to use this function
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+
+ clientAccountId: string, A parameter
+ sponsorAccountId: integer, A parameter
+
+Returns:
+ An object of the form:
+
+ {
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+list()
+ A description of how to use this function
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "clientAccessPermissions": [
+ {
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ },
+ ],
+ }
+patch(clientAccountId, sponsorAccountId, body)
+ A description of how to use this function
+
+Args:
+ clientAccountId: string, A parameter (required)
+ sponsorAccountId: integer, A parameter (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+update(clientAccountId, sponsorAccountId, body)
+ A description of how to use this function
+
+Args:
+ clientAccountId: string, A parameter (required)
+ sponsorAccountId: integer, A parameter (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "clientAccountId": "A String",
+ "capabilities": [
+ 42,
+ ],
+ }
+
+ get(accountId, buyerCreativeId)
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
+ +Submit a new creative.
+ +Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+get(accountId, buyerCreativeId)
+ Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
+
+Args:
+ accountId: integer, The id for the account that will serve this creative. (required)
+ buyerCreativeId: string, The buyer-specific id for this creative. (required)
+
+Returns:
+ An object of the form:
+
+ { # A creative and its classification data.
+ "api_upload_timestamp": "A 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": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "openAuctionStatus": "A 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.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "dealsStatus": "A 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.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "servingRestrictions": [ # 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.
+ {
+ "contexts": [ # All known contexts/restrictions.
+ {
+ "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
+ "A String",
+ ],
+ "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
+ "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
+ "A String",
+ ],
+ "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
+ 42,
+ ],
+ },
+ ],
+ "disapprovalReasons": [ # 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.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A 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": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ }
+insert(body)
+ Submit a new creative.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A creative and its classification data.
+ "api_upload_timestamp": "A 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": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "openAuctionStatus": "A 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.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "dealsStatus": "A 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.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "servingRestrictions": [ # 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.
+ {
+ "contexts": [ # All known contexts/restrictions.
+ {
+ "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
+ "A String",
+ ],
+ "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
+ "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
+ "A String",
+ ],
+ "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
+ 42,
+ ],
+ },
+ ],
+ "disapprovalReasons": [ # 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.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A 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": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A creative and its classification data.
+ "api_upload_timestamp": "A 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": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "openAuctionStatus": "A 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.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "dealsStatus": "A 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.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "servingRestrictions": [ # 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.
+ {
+ "contexts": [ # All known contexts/restrictions.
+ {
+ "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
+ "A String",
+ ],
+ "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
+ "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
+ "A String",
+ ],
+ "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
+ 42,
+ ],
+ },
+ ],
+ "disapprovalReasons": [ # 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.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A 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": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ }
+list(dealsStatusFilter=None, openAuctionStatusFilter=None, pageToken=None, maxResults=None, buyerCreativeId=None, accountId=None)
+ Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
+
+Args:
+ dealsStatusFilter: string, When specified, only creatives having the given direct deals status are returned.
+ Allowed values
+ approved - Creatives which have been approved for serving on direct deals.
+ conditionally_approved - Creatives which have been conditionally approved for serving on direct deals.
+ disapproved - Creatives which have been disapproved for serving on direct deals.
+ not_checked - Creatives whose direct deals status is not yet checked.
+ openAuctionStatusFilter: string, When specified, only creatives having the given open auction status are returned.
+ Allowed values
+ approved - Creatives which have been approved for serving on the open auction.
+ conditionally_approved - Creatives which have been conditionally approved for serving on the open auction.
+ disapproved - Creatives which have been disapproved for serving on the open auction.
+ not_checked - Creatives whose open auction status is not yet checked.
+ pageToken: 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.
+ maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
+ buyerCreativeId: string, When specified, only creatives for the given buyer creative ids are returned. (repeated)
+ accountId: integer, When specified, only creatives for the given account ids are returned. (repeated)
+
+Returns:
+ An object of the form:
+
+ { # 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.
+ "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
+ "items": [ # A list of creatives.
+ { # A creative and its classification data.
+ "api_upload_timestamp": "A 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": [ # All attributes for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "height": 42, # Ad height.
+ "advertiserName": "A String", # The name of the company being advertised in the creative.
+ "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+ "openAuctionStatus": "A 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.
+ "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+ "impressionTrackingUrl": [ # The set of urls to be called to record an impression.
+ "A String",
+ ],
+ "accountId": 42, # Account id.
+ "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+ "clickThroughUrl": [ # The set of destination urls for the snippet.
+ "A String",
+ ],
+ "width": 42, # Ad width.
+ "nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set.
+ "body": "A String", # A long description of the ad.
+ "advertiser": "A String",
+ "store": "A String", # The URL to the app store to purchase/download the promoted app.
+ "headline": "A String", # A short title for the ad.
+ "image": { # A large image.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
+ "callToAction": "A String", # A label for the button that the user is supposed to click.
+ "logo": { # A smaller image, for the advertiser logo.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "appIcon": { # The app icon, for app download ads.
+ "url": "A String",
+ "width": 42,
+ "height": 42,
+ },
+ "impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
+ "A String",
+ ],
+ "price": "A String", # The price of the promoted app including the currency info.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
+ },
+ "version": 42, # The version for this creative. Read-only. This field should not be set in requests.
+ "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+ 42,
+ ],
+ "agencyId": "A String", # The agency id for this creative.
+ "dealsStatus": "A 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.
+ "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+ "A String",
+ ],
+ "kind": "adexchangebuyer#creative", # Resource type.
+ "servingRestrictions": [ # 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.
+ {
+ "contexts": [ # All known contexts/restrictions.
+ {
+ "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
+ "A String",
+ ],
+ "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
+ "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
+ "A String",
+ ],
+ "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to.
+ 42,
+ ],
+ },
+ ],
+ "disapprovalReasons": [ # 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.
+ {
+ "reason": "A String", # The categorized reason for disapproval.
+ "details": [ # Additional details about the reason for disapproval.
+ "A String",
+ ],
+ },
+ ],
+ "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
+ },
+ ],
+ "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet.
+ 42,
+ ],
+ "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
+ {
+ "reason": "A String", # The type of correction that was applied to the creative.
+ "details": [ # Additional details about the correction.
+ "A String",
+ ],
+ },
+ ],
+ "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
+ "date": "A 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": [ # The filtering reasons.
+ {
+ "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
+ "filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.
+ },
+ ],
+ },
+ },
+ ],
+ "kind": "adexchangebuyer#creativesList", # Resource type.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
Gets the requested deal.
+get(dealId)
+ Gets the requested deal.
+
+Args:
+ dealId: string, A parameter (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # The status of this negotiation.
+ "buyerEmailContacts": [ # The buyer party's contact email.
+ "A String",
+ ],
+ "labelNames": [ # A list of label names applicable to this negotiation.
+ "A String",
+ ],
+ "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "kind": "adexchangebuyer#negotiation",
+ "offerId": "A String", # The ID of this negotiation's original offer.
+ "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
+ {
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+ },
+ ],
+ "negotiationId": "A String", # The unique ID of this negotiation.
+ "negotiationState": "A String", # The state of this negotiation.
+ "buyer": { # Details of the buyer party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "stats": { # The stats for this negotiation.
+ "revenue": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "bids": "A String",
+ "impressions": "A String",
+ "requests": "A String",
+ "goodBids": "A String",
+ "spend": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
+ "seller": { # Details of the seller party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "dealType": "A String", # The type of this deal.
+ "sellerEmailContacts": [ # The seller party's contact email.
+ "A String",
+ ],
+ }
+
+ accounts()
+
Returns the accounts Resource.
+ +
+ billingInfo()
+
Returns the billingInfo Resource.
+ +
+ budget()
+
Returns the budget Resource.
+ +
+ clientaccess()
+
Returns the clientaccess Resource.
+ +
+ creatives()
+
Returns the creatives Resource.
+ +
+ deals()
+
Returns the deals Resource.
+ + +Returns the marketplacedeals Resource.
+ + +Returns the marketplacenotes Resource.
+ + +Returns the marketplaceoffers Resource.
+ + +Returns the marketplaceorders Resource.
+ + +Returns the negotiationrounds Resource.
+ +
+ negotiations()
+
Returns the negotiations Resource.
+ +
+ offers()
+
Returns the offers Resource.
+ + +Returns the performanceReport Resource.
+ + +Returns the pretargetingConfig Resource.
+ + +Create a BatchHttpRequest object based on the discovery document.
+new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
Delete the specified deals from the order
+ +Add new deals for the specified order
+ +List all the deals for a given order
+ +Replaces all the deals in the order with the passed in deals
+delete(orderId, body)
+ Delete the specified deals from the order
+
+Args:
+ orderId: string, The orderId to delete deals from. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "orderRevisionNumber": "A String", # The last known order revision number.
+ "updateAction": "A String",
+ "dealIds": [ # List of deals to delete for a given order
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "deals": [ # List of deals deleted (in the same order as passed in the request)
+ { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "deliveryRateType": "A String",
+ },
+ "orderId": "A String",
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create)
+ "dealId": "A String", # A unique deal=id for the deal (readonly).
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create)
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ },
+ ],
+ "orderRevisionNumber": "A String", # The updated revision number for the order.
+ }
+insert(orderId, body)
+ Add new deals for the specified order
+
+Args:
+ orderId: string, OrderId for which deals need to be added. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "deals": [ # The list of deals to add
+ { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "deliveryRateType": "A String",
+ },
+ "orderId": "A String",
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create)
+ "dealId": "A String", # A unique deal=id for the deal (readonly).
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create)
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ },
+ ],
+ "orderRevisionNumber": "A String", # The last known order revision number.
+ "updateAction": "A String", # Indicates an optional action to take on the order
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "deals": [ # List of deals added (in the same order as passed in the request)
+ { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "deliveryRateType": "A String",
+ },
+ "orderId": "A String",
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create)
+ "dealId": "A String", # A unique deal=id for the deal (readonly).
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create)
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ },
+ ],
+ "orderRevisionNumber": "A String", # The updated revision number for the order.
+ }
+list(orderId)
+ List all the deals for a given order
+
+Args:
+ orderId: string, The orderId to get deals for. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "deals": [ # List of deals for the order
+ { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "deliveryRateType": "A String",
+ },
+ "orderId": "A String",
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create)
+ "dealId": "A String", # A unique deal=id for the deal (readonly).
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create)
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ },
+ ],
+ }
+update(orderId, body)
+ Replaces all the deals in the order with the passed in deals
+
+Args:
+ orderId: string, The orderId to edit deals on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "deals": [ # List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to order If a deal in this list does not exist in the order, the service will create a new deal and add it to the order. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the order If a deal in this list already exist in the order, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the order (just need the id) If a existing deal in the order is not present in this list, the service will delete that deal from the order. Validation will follow DeleteOrderDealsRequest.
+ { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "deliveryRateType": "A String",
+ },
+ "orderId": "A String",
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create)
+ "dealId": "A String", # A unique deal=id for the deal (readonly).
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create)
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ },
+ ],
+ "orderRevisionNumber": "A String", # The last known revision number for the order.
+ "order": { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting: # If specified, also updates the order in the batch transaction. This is useful when the order and the deals need to be updated in one transaction.
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ },
+ "updateAction": "A String", # Indicates an optional action to take on the order
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "deals": [ # List of all deals in the order after edit.
+ { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "deliveryRateType": "A String",
+ },
+ "orderId": "A String",
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create)
+ "dealId": "A String", # A unique deal=id for the deal (readonly).
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create)
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ },
+ ],
+ }
+Add notes to the order
+ +Get all the notes associated with an order
+insert(orderId, body)
+ Add notes to the order
+
+Args:
+ orderId: string, The orderId to add notes for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "notes": [ # The list of notes to add.
+ { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
+ "orderId": "A String", # The order_id that a note is attached to. (readonly)
+ "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
+ "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
+ "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
+ "note": "A String", # The actual note to attach. (readonly, except on create)
+ "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
+ "noteId": "A String", # The unique id for the note. (readonly)
+ "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "notes": [
+ { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
+ "orderId": "A String", # The order_id that a note is attached to. (readonly)
+ "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
+ "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
+ "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
+ "note": "A String", # The actual note to attach. (readonly, except on create)
+ "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
+ "noteId": "A String", # The unique id for the note. (readonly)
+ "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
+ },
+ ],
+ }
+list(orderId)
+ Get all the notes associated with an order
+
+Args:
+ orderId: string, The orderId to get notes for. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "notes": [ # The list of matching notes.
+ { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
+ "orderId": "A String", # The order_id that a note is attached to. (readonly)
+ "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
+ "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
+ "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
+ "note": "A String", # The actual note to attach. (readonly, except on create)
+ "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
+ "noteId": "A String", # The unique id for the note. (readonly)
+ "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
+ },
+ ],
+ }
+Gets the requested negotiation.
+ +Gets the requested negotiation.
+get(offerId)
+ Gets the requested negotiation.
+
+Args:
+ offerId: string, The offerId for the offer to get the head revision for. (required)
+
+Returns:
+ An object of the form:
+
+ { # An offer is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "creatorContacts": [ # Optional contact information for the creator of this offer. (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "kind": "adexchangebuyer#marketplaceOffer", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOffer".
+ "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "terms": { # The negotiable terms of the deal (buyer-readonly)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name for this offer as set by the seller. (buyer-readonly)
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
+ "labels": [ # Optional List of labels for the offer (optional, buyer-readonly).
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "offerId": "A String", # The unique id for the offer (readonly)
+ "seller": { # Information about the seller that created this offer (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "webPropertyCode": "A String",
+ "state": "A String", # The state of the offer. (buyer-readonly)
+ "hasCreatorSignedOff": True or False, # If the creator has already signed off on the offer, then the buyer can finalize the deal by accepting the offer as is. When copying to an order, if any of the terms are changed, then auto_finalize is automatically set to false.
+ "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
+ "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
+ "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
+ "revisionNumber": "A String", # The revision number of the offer. (readonly)
+ }
+search(pqlQuery=None)
+ Gets the requested negotiation.
+
+Args:
+ pqlQuery: string, The pql query used to query for offers.
+
+Returns:
+ An object of the form:
+
+ {
+ "offers": [ # The returned list of offers.
+ { # An offer is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "creatorContacts": [ # Optional contact information for the creator of this offer. (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "kind": "adexchangebuyer#marketplaceOffer", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOffer".
+ "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
+ {
+ "inclusions": [ # The list of value to include as part of the targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "exclusions": [ # The list of values to exclude from targeting.
+ {
+ "longValue": "A String", # The long value to exclude/include.
+ "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+ "dayParts": [
+ {
+ "dayOfWeek": "A String",
+ "endHour": 42,
+ "startMinute": 42,
+ "endMinute": 42,
+ "startHour": 42,
+ },
+ ],
+ "timeZoneType": "A String",
+ },
+ "creativeSizeValue": { # The creative size value to exclude/include.
+ "creativeSizeType": "A String", # The Creative size type.
+ "companionSizes": [ # For video size type, the list of companion sizes.
+ {
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ ],
+ "size": { # For regular creative size type, specifies the size of the creative.
+ "width": 42, # The width of the creative.
+ "height": 42, # The height of the creative.
+ },
+ },
+ "stringValue": "A String", # The string value to exclude/include.
+ },
+ ],
+ "key": "A String", # The key representing the shared targeting criterion.
+ },
+ ],
+ "terms": { # The negotiable terms of the deal (buyer-readonly)
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ "privateAuctionId": "A String", # Id of the corresponding private auction.
+ },
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The CPM value in micros.
+ },
+ },
+ ],
+ },
+ },
+ "name": "A String", # The name for this offer as set by the seller. (buyer-readonly)
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
+ "labels": [ # Optional List of labels for the offer (optional, buyer-readonly).
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "offerId": "A String", # The unique id for the offer (readonly)
+ "seller": { # Information about the seller that created this offer (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "webPropertyCode": "A String",
+ "state": "A String", # The state of the offer. (buyer-readonly)
+ "hasCreatorSignedOff": True or False, # If the creator has already signed off on the offer, then the buyer can finalize the deal by accepting the offer as is. When copying to an order, if any of the terms are changed, then auto_finalize is automatically set to false.
+ "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
+ "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
+ "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
+ "revisionNumber": "A String", # The revision number of the offer. (readonly)
+ },
+ ],
+ }
+Get an order given its id
+ +Create the given list of orders
+
+ patch(orderId, revisionNumber, updateAction, body)
Update the given order. This method supports patch semantics.
+ +Search for orders using pql query
+
+ update(orderId, revisionNumber, updateAction, body)
Update the given order
+get(orderId)
+ Get an order given its id
+
+Args:
+ orderId: string, Id of the order to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ }
+insert(body)
+ Create the given list of orders
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "webPropertyCode": "A String",
+ "orders": [ # The list of orders to create.
+ { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "orders": [ # The list of orders successfully created.
+ { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ },
+ ],
+ }
+patch(orderId, revisionNumber, updateAction, body)
+ Update the given order. This method supports patch semantics.
+
+Args:
+ orderId: string, The order id to update. (required)
+ revisionNumber: 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 lastest order at head revision and retry the update at that revision. (required)
+ updateAction: string, The proposed action to take on the order. (required)
+ Allowed values
+ accept -
+ cancel -
+ propose -
+ unknownAction -
+ updateFinalized -
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ }
+search(pqlQuery=None)
+ Search for orders using pql query
+
+Args:
+ pqlQuery: string, Query string to retrieve specific orders.
+
+Returns:
+ An object of the form:
+
+ {
+ "orders": [ # The list of matching orders.
+ { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ },
+ ],
+ }
+update(orderId, revisionNumber, updateAction, body)
+ Update the given order
+
+Args:
+ orderId: string, The order id to update. (required)
+ revisionNumber: 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 lastest order at head revision and retry the update at that revision. (required)
+ updateAction: string, The proposed action to take on the order. (required)
+ Allowed values
+ accept -
+ cancel -
+ propose -
+ unknownAction -
+ updateFinalized -
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+}
+
+
+Returns:
+ An object of the form:
+
+ { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting:
+ #
+ # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+ "orderId": "A String", # The unique id of the order. (readonly).
+ "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder".
+ "seller": { # Reference to the seller on the order. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ "name": "A String", # The name for the order (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "labels": [ # List of labels associated with the order. (readonly)
+ {
+ "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+ "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+ "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer.
+ },
+ },
+ "label": "A String", # The label to use.
+ "accountId": "A String", # The accountId of the party that created the label.
+ },
+ ],
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly).
+ "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "lastUpdaterRole": "A String",
+ "orderState": "A String", # The current state of the order. (readonly)
+ "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly)
+ "isRenegotiating": True or False, # True if the order is being renegotiated (readonly).
+ "buyer": { # Reference to the buyer on the order. (readonly, except on create)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly)
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly)
+ "revisionNumber": "A String", # The revision number for the order (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly)
+ "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ }
+Adds the requested negotiationRound to the requested negotiation.
+insert(negotiationId, body)
+ Adds the requested negotiationRound to the requested negotiation.
+
+Args:
+ negotiationId: string, A parameter (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+}
+
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+ }
+Gets the requested negotiation.
+ +Creates or updates the requested negotiation.
+
+ list()
Lists all negotiations the authenticated user has access to.
+get(negotiationId)
+ Gets the requested negotiation.
+
+Args:
+ negotiationId: string, A parameter (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # The status of this negotiation.
+ "buyerEmailContacts": [ # The buyer party's contact email.
+ "A String",
+ ],
+ "labelNames": [ # A list of label names applicable to this negotiation.
+ "A String",
+ ],
+ "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "kind": "adexchangebuyer#negotiation",
+ "offerId": "A String", # The ID of this negotiation's original offer.
+ "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
+ {
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+ },
+ ],
+ "negotiationId": "A String", # The unique ID of this negotiation.
+ "negotiationState": "A String", # The state of this negotiation.
+ "buyer": { # Details of the buyer party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "stats": { # The stats for this negotiation.
+ "revenue": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "bids": "A String",
+ "impressions": "A String",
+ "requests": "A String",
+ "goodBids": "A String",
+ "spend": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
+ "seller": { # Details of the seller party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "dealType": "A String", # The type of this deal.
+ "sellerEmailContacts": [ # The seller party's contact email.
+ "A String",
+ ],
+ }
+insert(body)
+ Creates or updates the requested negotiation.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "status": "A String", # The status of this negotiation.
+ "buyerEmailContacts": [ # The buyer party's contact email.
+ "A String",
+ ],
+ "labelNames": [ # A list of label names applicable to this negotiation.
+ "A String",
+ ],
+ "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "kind": "adexchangebuyer#negotiation",
+ "offerId": "A String", # The ID of this negotiation's original offer.
+ "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
+ {
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+ },
+ ],
+ "negotiationId": "A String", # The unique ID of this negotiation.
+ "negotiationState": "A String", # The state of this negotiation.
+ "buyer": { # Details of the buyer party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "stats": { # The stats for this negotiation.
+ "revenue": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "bids": "A String",
+ "impressions": "A String",
+ "requests": "A String",
+ "goodBids": "A String",
+ "spend": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
+ "seller": { # Details of the seller party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "dealType": "A String", # The type of this deal.
+ "sellerEmailContacts": [ # The seller party's contact email.
+ "A String",
+ ],
+}
+
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # The status of this negotiation.
+ "buyerEmailContacts": [ # The buyer party's contact email.
+ "A String",
+ ],
+ "labelNames": [ # A list of label names applicable to this negotiation.
+ "A String",
+ ],
+ "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "kind": "adexchangebuyer#negotiation",
+ "offerId": "A String", # The ID of this negotiation's original offer.
+ "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
+ {
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+ },
+ ],
+ "negotiationId": "A String", # The unique ID of this negotiation.
+ "negotiationState": "A String", # The state of this negotiation.
+ "buyer": { # Details of the buyer party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "stats": { # The stats for this negotiation.
+ "revenue": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "bids": "A String",
+ "impressions": "A String",
+ "requests": "A String",
+ "goodBids": "A String",
+ "spend": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
+ "seller": { # Details of the seller party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "dealType": "A String", # The type of this deal.
+ "sellerEmailContacts": [ # The seller party's contact email.
+ "A String",
+ ],
+ }
+list()
+ Lists all negotiations the authenticated user has access to.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adexchangebuyer#negotiationsList",
+ "negotiations": [
+ {
+ "status": "A String", # The status of this negotiation.
+ "buyerEmailContacts": [ # The buyer party's contact email.
+ "A String",
+ ],
+ "labelNames": [ # A list of label names applicable to this negotiation.
+ "A String",
+ ],
+ "billedBuyer": { # The billed buyer; Specified by a buyer buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "kind": "adexchangebuyer#negotiation",
+ "offerId": "A String", # The ID of this negotiation's original offer.
+ "negotiationRounds": [ # The series of negotiation rounds for this negotiation.
+ {
+ "kind": "adexchangebuyer#negotiationRound",
+ "terms": { # The detailed terms proposed in this negotiation round.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "negotiationId": "A String", # The ID of the negotiation to which this negotiation round applies.
+ "roundNumber": "A String", # The number of this negotiation round, in sequence.
+ "notes": "A String", # Notes regarding this negotiation round.
+ "originatorRole": "A String", # The role, either buyer or seller, initiating this negotiation round.
+ "dbmPartnerId": "A String", # Stores DBM partner ID for use by DBM
+ "editHistory": { # The edit history of this negotiation round.
+ "createdTimeStamp": "A String",
+ "createdByLoginName": "A String",
+ "lastUpdatedByLoginName": "A String",
+ "lastUpdateTimeStamp": "A String",
+ },
+ "action": "A String", # The action performed by this negotiation round.
+ },
+ ],
+ "negotiationId": "A String", # The unique ID of this negotiation.
+ "negotiationState": "A String", # The state of this negotiation.
+ "buyer": { # Details of the buyer party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "stats": { # The stats for this negotiation.
+ "revenue": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "bids": "A String",
+ "impressions": "A String",
+ "requests": "A String",
+ "goodBids": "A String",
+ "spend": {
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "externalDealId": "A String", # For finalized negotiations, the ID of the finalized deal.
+ "seller": { # Details of the seller party in this negotiation.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "dealType": "A String", # The type of this deal.
+ "sellerEmailContacts": [ # The seller party's contact email.
+ "A String",
+ ],
+ },
+ ],
+ }
+Gets the requested offer.
+ +Creates or updates the requested offer.
+
+ list()
Lists all offers the authenticated user has access to.
+get(offerId)
+ Gets the requested offer.
+
+Args:
+ offerId: string, A parameter (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # The status of this offer.
+ "kind": "adexchangebuyer#offer",
+ "labelNames": [ # The list of label names applicable to this offer.
+ "A String",
+ ],
+ "pointOfContact": "A String", # The point of contact for this offer.
+ "isOpen": True or False, # Whether this offer is open.
+ "creator": { # The creator of this offer.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "offerId": "A String", # The unique ID of this offer.
+ "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "offerState": "A String", # The state of this offer.
+ "anonymous": True or False, # Whether this offer is anonymous.
+ "terms": { # The terms of this offer.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "emailContacts": [ # The list of email contacts for this offer.
+ "A String",
+ ],
+ }
+insert(body)
+ Creates or updates the requested offer.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "status": "A String", # The status of this offer.
+ "kind": "adexchangebuyer#offer",
+ "labelNames": [ # The list of label names applicable to this offer.
+ "A String",
+ ],
+ "pointOfContact": "A String", # The point of contact for this offer.
+ "isOpen": True or False, # Whether this offer is open.
+ "creator": { # The creator of this offer.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "offerId": "A String", # The unique ID of this offer.
+ "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "offerState": "A String", # The state of this offer.
+ "anonymous": True or False, # Whether this offer is anonymous.
+ "terms": { # The terms of this offer.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "emailContacts": [ # The list of email contacts for this offer.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "status": "A String", # The status of this offer.
+ "kind": "adexchangebuyer#offer",
+ "labelNames": [ # The list of label names applicable to this offer.
+ "A String",
+ ],
+ "pointOfContact": "A String", # The point of contact for this offer.
+ "isOpen": True or False, # Whether this offer is open.
+ "creator": { # The creator of this offer.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "offerId": "A String", # The unique ID of this offer.
+ "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "offerState": "A String", # The state of this offer.
+ "anonymous": True or False, # Whether this offer is anonymous.
+ "terms": { # The terms of this offer.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "emailContacts": [ # The list of email contacts for this offer.
+ "A String",
+ ],
+ }
+list()
+ Lists all offers the authenticated user has access to.
+
+Args:
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "adexchangebuyer#offersList",
+ "offers": [
+ {
+ "status": "A String", # The status of this offer.
+ "kind": "adexchangebuyer#offer",
+ "labelNames": [ # The list of label names applicable to this offer.
+ "A String",
+ ],
+ "pointOfContact": "A String", # The point of contact for this offer.
+ "isOpen": True or False, # Whether this offer is open.
+ "creator": { # The creator of this offer.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "closedToDealParties": [ # The list of buyer or seller parties this offer is closed to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "billedBuyer": { # The billed buyer; For buyer initiated offers, buying through an intermediary.
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ "offerId": "A String", # The unique ID of this offer.
+ "openToDealParties": [ # The list of buyer or seller parties this offer is open to.
+ {
+ "buyer": {
+ "enabledForPreferredDeals": True or False,
+ "displayName": "A String",
+ "customerId": 42,
+ "enabledForInterestTargetingDeals": True or False,
+ "sponsorAccountId": 42,
+ "id": 42,
+ "accountId": 42,
+ },
+ "webProperty": {
+ "enabledForPreferredDeals": True or False,
+ "name": "A String",
+ "syndicationProduct": "A String",
+ "allowInterestTargetedAds": True or False,
+ "siteUrls": [
+ "A String",
+ ],
+ "propertyCode": "A String",
+ "id": 42,
+ },
+ "customerId": 42,
+ "name": "A String",
+ "buyerSellerRole": "A String",
+ },
+ ],
+ "offerState": "A String", # The state of this offer.
+ "anonymous": True or False, # Whether this offer is anonymous.
+ "terms": { # The terms of this offer.
+ "finalizeAutomatically": True or False, # If true, the offer will finalize automatically when accepted.
+ "inventorySegmentTargeting": { # The inventory segment targeting for the offer.
+ "positiveIcmInterests": [
+ "A String",
+ ],
+ "positiveInventorySlots": [
+ "A String",
+ ],
+ "negativeSiteUrls": [
+ "A String",
+ ],
+ "positiveIcmBrands": [
+ "A String",
+ ],
+ "negativeXfpPlacements": [
+ "A String",
+ ],
+ "positiveVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeIcmInterests": [
+ "A String",
+ ],
+ "negativeAudienceSegments": [
+ "A String",
+ ],
+ "positiveOperatingSystems": [
+ "A String",
+ ],
+ "negativeOperatingSystems": [
+ "A String",
+ ],
+ "negativeIcmBrands": [
+ "A String",
+ ],
+ "positiveLocations": [
+ "A String",
+ ],
+ "negativeMobileApps": [
+ "A String",
+ ],
+ "positiveDeviceCategories": [
+ "A String",
+ ],
+ "negativeAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeInventorySlots": [
+ "A String",
+ ],
+ "negativeVideoAdPositionSegments": [
+ "A String",
+ ],
+ "negativeVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveSizes": [
+ "A String",
+ ],
+ "positiveXfpAdSlots": [
+ "A String",
+ ],
+ "positiveKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "positiveSiteUrls": [
+ "A String",
+ ],
+ "positiveMobileApps": [
+ "A String",
+ ],
+ "negativeKeyValues": [
+ {
+ "keyName": "A String",
+ "value": "A String",
+ },
+ ],
+ "negativeSizes": [
+ "A String",
+ ],
+ "positiveOperatingSystemVersions": [
+ "A String",
+ ],
+ "negativeLocations": [
+ "A String",
+ ],
+ "positiveAdSizes": [
+ {
+ "width": 42,
+ "height": 42,
+ },
+ ],
+ "negativeOperatingSystemVersions": [
+ "A String",
+ ],
+ "positiveXfpPlacements": [
+ "A String",
+ ],
+ "negativeXfpAdSlots": [
+ "A String",
+ ],
+ "positiveVideoDurationSegments": [
+ "A String",
+ ],
+ "positiveAudienceSegments": [
+ "A String",
+ ],
+ "negativeDeviceCategories": [
+ "A String",
+ ],
+ "positiveAdTypeSegments": [
+ "A String",
+ ],
+ "negativeAdTypeSegments": [
+ "A String",
+ ],
+ },
+ "endDate": { # The end date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "termsAttributes": [ # A list of terms attributes.
+ "A String",
+ ],
+ "startDate": { # The start date for the offer.
+ "timeZoneId": "A String",
+ "hour": 42,
+ "month": 42,
+ "second": 42,
+ "year": 42,
+ "day": 42,
+ "minute": 42,
+ },
+ "buyerBillingType": "A String", # The buyer billing type.
+ "estimatedImpressionsPerDay": "A String", # The estimated daily impressions for the offer.
+ "monetizerType": "A String", # The monetizer type.
+ "targetByDealId": True or False, # Whether to target by deal id.
+ "adSlots": [ # The particular ad slots targeted by the offer.
+ {
+ "name": "A String",
+ "description": "A String",
+ "channelId": 42,
+ "channelCode": "A String",
+ "webPropertyId": 42,
+ "size": "A String",
+ },
+ ],
+ "advertisers": [ # A list of advertisers for this offer.
+ {
+ "brands": [
+ {
+ "advertiserId": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "status": "A String",
+ "id": "A String",
+ "name": "A String",
+ },
+ ],
+ "minimumSpendMicros": "A String", # The minimum spend for the offer.
+ "targetingAllAdSlots": True or False, # If true, the offer targets all ad slots.
+ "creativeReviewPolicy": "A String", # Whether to use publisher review policy or AdX review policy.
+ "audienceSegmentDescription": "A String", # A description of the audience segment for the offer.
+ "dealPremium": { # The premium terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "creativeBlockingLevel": "A String", # Whether to use or ignore publisher blocking rules.
+ "audienceSegment": { # The audience segment for the offer.
+ "numCookies": "A String",
+ "description": "A String",
+ "name": "A String",
+ "id": "A String",
+ },
+ "description": "A String", # A description for these terms.
+ "billingTerms": "A String", # The billing terms.
+ "semiTransparent": True or False, # Whether this offer is semi-transparent.
+ "minimumTrueLooks": "A String", # The minimum true looks for the offer.
+ "cpm": { # The cpm terms.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ "isReservation": True or False, # Whether the offer is a reservation.
+ "descriptiveName": "A String", # A descriptive name for these terms.
+ "urls": [ # The urls applicable to the offer.
+ "A String",
+ ],
+ "estimatedSpend": { # The estimated spend for the offer.
+ "micros": "A String",
+ "currencyCode": "A String",
+ },
+ },
+ "emailContacts": [ # The list of email contacts for this offer.
+ "A String",
+ ],
+ },
+ ],
+ }
+
+ list(accountId, endDateTime, startDateTime, pageToken=None, maxResults=None)
Retrieves the authenticated user's list of performance metrics.
+list(accountId, endDateTime, startDateTime, pageToken=None, maxResults=None)
+ Retrieves the authenticated user's list of performance metrics.
+
+Args:
+ accountId: string, The account id to get the reports. (required)
+ endDateTime: string, The end time of the report in ISO 8601 timestamp format using UTC. (required)
+ startDateTime: string, The start time of the report in ISO 8601 timestamp format using UTC. (required)
+ 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.
+ maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
+
+Returns:
+ An object of the form:
+
+ { # The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
+ "kind": "adexchangebuyer#performanceReportList", # Resource type.
+ "performanceReport": [ # A list of performance reports relevant for the account.
+ { # The configuration data for an Ad Exchange performance report list.
+ "bidRequestRate": 3.14, # The number of bid requests sent to your bidder.
+ "unsuccessfulRequestRate": 3.14, # The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc.
+ "successfulRequestRate": 3.14, # The number of properly formed bid responses received by our servers within the deadline.
+ "hostedMatchStatusRate": [ # Average QPS for hosted match operations.
+ "",
+ ],
+ "bidRate": 3.14, # The number of bid responses with an ad.
+ "quotaThrottledLimit": 3.14, # The throttled quota limits for this account.
+ "cookieMatcherStatusRate": [ # Average QPS for cookie matcher operations.
+ "",
+ ],
+ "calloutStatusRate": [ # Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.
+ "",
+ ],
+ "noQuotaInRegion": 3.14, # Rate of various quota account statuses per quota check.
+ "timestamp": "A String", # The unix timestamp of the starting time of this performance data.
+ "latency50thPercentile": 3.14, # The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
+ "latency85thPercentile": 3.14, # The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
+ "pixelMatchResponses": 3.14, # Average QPS for pixel match responses from clients.
+ "creativeStatusRate": [ # Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.
+ "",
+ ],
+ "latency95thPercentile": 3.14, # The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
+ "kind": "adexchangebuyer#performanceReport", # Resource type.
+ "inventoryMatchRate": 3.14, # The number of potential queries based on your pretargeting settings.
+ "region": "A String", # The trading location of this data.
+ "quotaConfiguredLimit": 3.14, # The configured quota limits for this account.
+ "outOfQuota": 3.14, # Rate of various quota account statuses per quota check.
+ "filteredBidRate": 3.14, # The number of bid responses that were filtered due to a policy violation or other errors.
+ "pixelMatchRequests": 3.14, # Average QPS for pixel match requests from clients.
+ },
+ ],
+ }
+Deletes an existing pretargeting config.
+ +Gets a specific pretargeting configuration
+ +Inserts a new pretargeting configuration.
+ +Retrieves a list of the authenticated user's pretargeting configurations.
+
+ patch(accountId, configId, body)
Updates an existing pretargeting config. This method supports patch semantics.
+
+ update(accountId, configId, body)
Updates an existing pretargeting config.
+delete(accountId, configId)
+ Deletes an existing pretargeting config. + +Args: + accountId: string, The account id to delete the pretargeting config for. (required) + configId: string, The specific id of the configuration to delete. (required) ++
get(accountId, configId)
+ Gets a specific pretargeting configuration
+
+Args:
+ accountId: string, The account id to get the pretargeting config for. (required)
+ configId: string, The specific id of the configuration to retrieve. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+insert(accountId, body)
+ Inserts a new pretargeting configuration.
+
+Args:
+ accountId: string, The account id to insert the pretargeting config for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+list(accountId)
+ Retrieves a list of the authenticated user's pretargeting configurations.
+
+Args:
+ accountId: string, The account id to get the pretargeting configs for. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "items": [ # A list of pretargeting configs
+ {
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfigList", # Resource type.
+ }
+patch(accountId, configId, body)
+ Updates an existing pretargeting config. This method supports patch semantics.
+
+Args:
+ accountId: string, The account id to update the pretargeting config for. (required)
+ configId: string, The specific id of the configuration to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+update(accountId, configId, body)
+ Updates an existing pretargeting config.
+
+Args:
+ accountId: string, The account id to update the pretargeting config for. (required)
+ configId: string, The specific id of the configuration to update. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "verticals": [ # Requests containing any of these vertical ids will match.
+ "A String",
+ ],
+ "platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
+ "A String",
+ ],
+ "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests.
+ "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
+ "A String",
+ ],
+ "configName": "A String", # The name of the config. Must be unique. Required for all requests.
+ "excludedGeoCriteriaIds": [ # Requests containing any of these geo criteria ids will not match.
+ "A String",
+ ],
+ "excludedContentLabels": [ # Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
+ "A String",
+ ],
+ "languages": [ # Request containing any of these language codes will match.
+ "A String",
+ ],
+ "mobileDevices": [ # Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
+ "A String",
+ ],
+ "mobileCarriers": [ # Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedPlacements": [ # Requests containing any of these placements will not match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ "billingId": "A String", # The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
+ "geoCriteriaIds": [ # Requests containing any of these geo criteria ids will match.
+ "A String",
+ ],
+ "mobileOperatingSystemVersions": [ # Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
+ "A String",
+ ],
+ "excludedUserLists": [ # Requests containing any of these users list ids will not match.
+ "A String",
+ ],
+ "isActive": True or False, # Whether this config is active. Required for all requests.
+ "dimensions": [ # Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
+ {
+ "width": "A String", # Width in pixels.
+ "height": "A String", # Height in pixels.
+ },
+ ],
+ "kind": "adexchangebuyer#pretargetingConfig", # The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
+ "supportedCreativeAttributes": [ # Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.
+ "A String",
+ ],
+ "vendorTypes": [ # Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
+ "A String",
+ ],
+ "userLists": [ # Requests containing any of these user list ids will match.
+ "A String",
+ ],
+ "creativeType": [ # List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
+ "A String",
+ ],
+ "placements": [ # Requests containing any of these placements will match.
+ {
+ "token": "A String", # The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement.
+ "type": "A String", # The type of the placement.
+ },
+ ],
+ }
+Looks up an enterprise by domain name.
+
+ sendTestPushNotification(enterpriseId)
Sends a test push notification to validate the MDM integration with the Google Cloud Pubsub service for this enterprise.
setAccount(enterpriseId, body)
Set the account that will be used to authenticate to the API as the enterprise.
@@ -250,6 +253,22 @@sendTestPushNotification(enterpriseId)
+ Sends a test push notification to validate the MDM integration with the Google Cloud Pubsub service for this enterprise.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "topicName": "A String", # The name of the Cloud Pubsub topic to which notifications for this enterprise's enrolled account will be sent.
+ "messageId": "A String", # The message ID of the test push notification that was sent.
+ }
+setAccount(enterpriseId, body)
Set the account that will be used to authenticate to the API as the enterprise. diff --git a/docs/dyn/androidenterprise_v1.grouplicenses.html b/docs/dyn/androidenterprise_v1.grouplicenses.html index cb398f3c847..06da7c93e13 100644 --- a/docs/dyn/androidenterprise_v1.grouplicenses.html +++ b/docs/dyn/androidenterprise_v1.grouplicenses.html @@ -92,11 +92,11 @@Method Details
Returns: An object of the form: - { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play done by the enterprise admin. + { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin. # - # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, i.e. the total number of user entitlements in existence for the product. + # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product. # - # Group license objects are never deleted; if e.g. a free app is added to a collection and then removed, the group license will remain, allowing to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play. + # Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play. "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense". "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free"). "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. @@ -118,11 +118,11 @@Method Details
{ # The grouplicense resources for the enterprise. "groupLicense": [ # A group license for a product approved for use in the enterprise. - { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play done by the enterprise admin. + { # A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin. # - # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, i.e. the total number of user entitlements in existence for the product. + # The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product. # - # Group license objects are never deleted; if e.g. a free app is added to a collection and then removed, the group license will remain, allowing to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play. + # Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play. "kind": "androidenterprise#groupLicense", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense". "numPurchased": 42, # The number of purchased licenses (possibly in multiple purchases). If this field is omitted then there is no limit on the number of licenses that can be provisioned (e.g. if the acquisition kind is "free"). "numProvisioned": 42, # The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations. diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html index 0d5c6ddb807..ad40c7f0270 100644 --- a/docs/dyn/androidenterprise_v1.products.html +++ b/docs/dyn/androidenterprise_v1.products.html @@ -79,7 +79,7 @@Instance Methods
Approves the specified product (and the relevant app permissions, if any).
-
generateApprovalUrl(enterpriseId, productId, languageCode=None)Generates a URL that can be used to display an iframe to view the product's permissions (if any) and approve the product. This URL can be used to approve the product for a limited time (currently 1 hour) using the Products.approve call.
+Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.
get(enterpriseId, productId, language=None)Retrieves details of a product for display to an enterprise admin.
@@ -104,7 +104,7 @@Method Details
The object takes the form of: { - "approvalUrlInfo": { # Information on an approval URL. + "approvalUrlInfo": { # Information on an approval URL. # The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated. "kind": "androidenterprise#approvalUrlInfo", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#approvalUrlInfo". "approvalUrl": "A String", # A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call. }, @@ -115,18 +115,20 @@Method Details
@@ -146,21 +148,20 @@generateApprovalUrl(enterpriseId, productId, languageCode=None)-Generates a URL that can be used to display an iframe to view the product's permissions (if any) and approve the product. This URL can be used to approve the product for a limited time (currently 1 hour) using the Products.approve call. +Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. + +Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day. Args: enterpriseId: string, The ID of the enterprise. (required) productId: string, The ID of the product. (required) - languageCode: string, The language code that will be used for permission names and descriptions in the returned iframe. + languageCode: string, The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US". Returns: An object of the form: { - "url": "A String", # A iframe-able URL that displays a product's permissions (if any). This URL can be used to approve the product only once and for a limited time (1 hour), using the Products.approve call. If the product is not currently approved and has no permissions, this URL will point to an empty page. If the product is currently approved and all of its permissions (if any) are also approved, this field will not be populated. + "url": "A String", # A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted. }Method Details
# # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface. "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product". - "distributionChannel": "A String", # How and to whom the package is made available. + "distributionChannel": "A String", # How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted. "title": "A String", # The name of the product. "workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator. - "appVersion": [ # List of app versions available for this product. The returned list contains only public versions. E.g. alpha, beta or canary versions will not be included. - { # App version represents a single APK version. - "versionCode": 42, # Unique increasing identifier for the apk version. - "versionString": "A String", # The string used in the Play Store by the app developer to identify a version of an app. The string is not necessarily unique or localized (e.g. "1.4"). + "appVersion": [ # App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included. + { # This represents a single version of the app. + "versionCode": 42, # Unique increasing identifier for the app version. + "versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4"). }, ], "iconUrl": "A String", # A link to an image that can be used as an icon for the product. "authorName": "A String", # The name of the author of the product (e.g. the app developer). "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app. "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product. - "productId": "A String", # A string of the form "app: - # " - e.g. "app:com.google.android.gm" represents the GMail app. + "productId": "A String", # A string of the form app:. For example, app:com.google.android.gm represents the Gmail app. }
Retrieves a user's details.
+
+ getAvailableProductSet(enterpriseId, userId)
Retrieves the set of products a user is entitled to access.
Looks up a user by email address.
revokeToken(enterpriseId, userId)
Revokes a previously generated token (activation code) for the user.
+
+ setAvailableProductSet(enterpriseId, userId, body)
Modifies the set of products a user is entitled to access.
generateToken(enterpriseId, userId)
@@ -127,6 +133,25 @@ getAvailableProductSet(enterpriseId, userId)
+ Retrieves the set of products a user is entitled to access.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+
+Returns:
+ An object of the form:
+
+ { # A set of products.
+ "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
+ "productId": [ # The list of product IDs making up the set of products.
+ "A String",
+ ],
+ }
+list(enterpriseId, email)
Looks up a user by email address. @@ -164,4 +189,33 @@Method Details
setAvailableProductSet(enterpriseId, userId, body)
+ Modifies the set of products a user is entitled to access.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ userId: string, The ID of the user. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A set of products.
+ "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
+ "productId": [ # The list of product IDs making up the set of products.
+ "A String",
+ ],
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A set of products.
+ "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
+ "productId": [ # The list of product IDs making up the set of products.
+ "A String",
+ ],
+ }
+