Use wide Ad Exchange Buyer API integration

With Ants & Apps platform you can connect Ad Exchange Buyer API with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • accounts

    • Get one account by ID

      This action gets one account by ID.

      GETAdexchangebuyerAccountsGet

      Request parameters

      • id*integer

        The account id

    • Retrief the authenticated user's list of accounts

      This action retrieves the authenticated user's list of accounts.

      GETAdexchangebuyerAccountsList
    • Update an existing account

      This action updates an existing account.

      PUTAdexchangebuyerAccountsUpdate

      Request parameters

      • id*integer

        The account id

      • confirmUnsafeAccountChangeboolean

        Confirmation for erasing bidder and cookie matching urls.

      Request body

      • applyPretargetingToNonGuaranteedDealsboolean

        When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder.

      • bidderLocationarray

        Your bidder locations that have distinct URLs.

      • cookieMatchingNidstring

        The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.

      • cookieMatchingUrlstring

        The base URL used in cookie match requests.

      • idinteger

        Account id.

      • kindstring

        Resource type.

      • maximumActiveCreativesinteger

        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.

      • maximumTotalQpsinteger

        The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.

      • numberActiveCreativesinteger

        The number of creatives that this account inserted or bid with in the last 30 days.

      • idstring

        Unique identifier of this account.

      • kindstring

        Kind of resource this is, in this case adsensehost#account.

      • namestring

        Name of this account.

      • statusstring

        Approval status of this account. One of: PENDING, APPROVED, DISABLED.

      • creation_timestring

      • idstring

        Unique identifier of this account.

      • kindstring

        Kind of resource this is, in this case adsense#account.

      • namestring

        Name of this account.

      • premiumboolean

        Whether this account is premium.

      • subAccountsarray

        Sub accounts of the this account.

      • timezonestring

        AdSense timezone of this account.

    • Update an existing account

      This action updates an existing account. This method supports patch semantics.

      PATCHAdexchangebuyerAccountsPatch

      Request parameters

      • id*integer

        The account id

      • confirmUnsafeAccountChangeboolean

        Confirmation for erasing bidder and cookie matching urls.

      Request body

      • applyPretargetingToNonGuaranteedDealsboolean

        When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder.

      • bidderLocationarray

        Your bidder locations that have distinct URLs.

      • cookieMatchingNidstring

        The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.

      • cookieMatchingUrlstring

        The base URL used in cookie match requests.

      • idinteger

        Account id.

      • kindstring

        Resource type.

      • maximumActiveCreativesinteger

        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.

      • maximumTotalQpsinteger

        The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.

      • numberActiveCreativesinteger

        The number of creatives that this account inserted or bid with in the last 30 days.

      • idstring

        Unique identifier of this account.

      • kindstring

        Kind of resource this is, in this case adsensehost#account.

      • namestring

        Name of this account.

      • statusstring

        Approval status of this account. One of: PENDING, APPROVED, DISABLED.

      • creation_timestring

      • idstring

        Unique identifier of this account.

      • kindstring

        Kind of resource this is, in this case adsense#account.

      • namestring

        Name of this account.

      • premiumboolean

        Whether this account is premium.

      • subAccountsarray

        Sub accounts of the this account.

      • timezonestring

        AdSense timezone of this account.

  • billingInfo

    • Return the billing information for one account specified by account ID

      This action returns the billing information for one account specified by account ID.

      GETAdexchangebuyerBillingInfoGet

      Request parameters

      • accountId*integer

        The account id.

    • Retrief a list of billing information for all accounts of the authenticated user

      This action retrieves a list of billing information for all accounts of the authenticated user.

      GETAdexchangebuyerBillingInfoList
  • budget

    • Return the budget information for the adgroup specified by the accountId and billingId

      This action returns the budget information for the adgroup specified by the accountId and billingId.

      GETAdexchangebuyerBudgetGet

      Request parameters

      • accountId*string

        The account id to get the budget information for.

      • billingId*string

        The billing id to get the budget information for.

    • Update the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request

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

      PUTAdexchangebuyerBudgetUpdate

      Request parameters

      • accountId*string

        The account id associated with the budget being updated.

      • billingId*string

        The billing id associated with the budget being updated.

      Request body

      • accountIdstring

        The id of the account. This is required for get and update requests.

      • billingIdstring

        The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.

      • budgetAmountstring

        The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.

      • currencyCodestring

        The currency code for the buyer. This cannot be altered here.

      • idstring

        The unique id that describes this item.

      • kindstring

        The kind of the resource, i.e. "adexchangebuyer#budget".

    • Update the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request

      This action 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.

      PATCHAdexchangebuyerBudgetPatch

      Request parameters

      • accountId*string

        The account id associated with the budget being updated.

      • billingId*string

        The billing id associated with the budget being updated.

      Request body

      • accountIdstring

        The id of the account. This is required for get and update requests.

      • billingIdstring

        The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.

      • budgetAmountstring

        The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.

      • currencyCodestring

        The currency code for the buyer. This cannot be altered here.

      • idstring

        The unique id that describes this item.

      • kindstring

        The kind of the resource, i.e. "adexchangebuyer#budget".

  • creatives

    • Get the status for a single creative

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

      GETAdexchangebuyerCreativesGet

      Request parameters

      • accountId*integer

        The id for the account that will serve this creative.

      • buyerCreativeId*string

        The buyer-specific id for this creative.

    • Retrief a list of the authenticated user's active creatives

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

      GETAdexchangebuyerCreativesList

      Request parameters

      • accountIdinteger

        When specified, only creatives for the given account ids are returned.

      • buyerCreativeIdstring

        When specified, only creatives for the given buyer creative ids are returned.

      • dealsStatusFilterstring

        When specified, only creatives having the given deals status are returned.

      • maxResultsinteger

        Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

      • openAuctionStatusFilterstring

        When specified, only creatives having the given open auction status are returned.

      • pageTokenstring

        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.

    • List the external deal ids associated with the creative

      This action lists the external deal ids associated with the creative.

      GETAdexchangebuyerCreativesListDeals

      Request parameters

      • accountId*integer

        The id for the account that will serve this creative.

      • buyerCreativeId*string

        The buyer-specific id for this creative.

    • Add a deal id association for the creative

      This action add a deal id association for the creative.

      POSTAdexchangebuyerCreativesAddDeal

      Request parameters

      • accountId*integer

        The id for the account that will serve this creative.

      • buyerCreativeId*string

        The buyer-specific id for this creative.

      • dealId*string

        The id of the deal id to associate with this creative.

    • Submit a new creative

      This action submit a new creative.

      POSTAdexchangebuyerCreativesInsert

      Request body

      • HTMLSnippetstring

        The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.

      • accountIdinteger

        Account id.

      • adChoicesDestinationUrlstring

        The link to the Ad Preferences page. This is only supported for native ads.

      • adTechnologyProvidersobject

      • advertiserIdarray

        Detected advertiser id, if any. Read-only. This field should not be set in requests.

      • advertiserNamestring

        The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file.

      • agencyIdstring

        The agency id for this creative.

      • apiUploadTimestampstring

        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).

      • attributearray

        List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.

      • buyerCreativeIdstring

        A buyer-specific id identifying the creative in this ad.

      • clickThroughUrlarray

        The set of destination urls for the snippet.

      • correctionsarray

        Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.

      • creativeStatusIdentityTypestring

        Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.

      • dealsStatusstring

        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.

      • detectedDomainsarray

        Detected domains for this creative. Read-only. This field should not be set in requests.

      • filteringReasonsobject

        The filtering reasons for the creative. Read-only. This field should not be set in requests.

      • heightinteger

        Ad height.

      • impressionTrackingUrlarray

        The set of urls to be called to record an impression.

      • kindstring

        Resource type.

      • languagesarray

        Detected languages for this creative. Read-only. This field should not be set in requests.

      • nativeAdobject

        If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)

      • openAuctionStatusstring

        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.

      • productCategoriesarray

        Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.

      • restrictedCategoriesarray

        All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.

      • sensitiveCategoriesarray

        Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.

      • servingRestrictionsarray

        The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.

      • vendorTypearray

        List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.

      • versioninteger

        The version for this creative. Read-only. This field should not be set in requests.

      • videoURLstring

        The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.

      • videoVastXMLstring

        The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.

      • widthinteger

        Ad width.

    • Remove a deal id associated with the creative

      This action remove a deal id associated with the creative.

      POSTAdexchangebuyerCreativesRemoveDeal

      Request parameters

      • accountId*integer

        The id for the account that will serve this creative.

      • buyerCreativeId*string

        The buyer-specific id for this creative.

      • dealId*string

        The id of the deal id to disassociate with this creative.

  • marketplacedeals

    • List all the deals for a given proposal

      This action list all the deals for a given proposal

      GETAdexchangebuyerMarketplacedealsList

      Request parameters

      • proposalId*string

        The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.

      • pqlQuerystring

        Query string to retrieve specific deals.

    • Delete the specified deals from the proposal

      This action delete the specified deals from the proposal

      POSTAdexchangebuyerMarketplacedealsDelete

      Request parameters

      • proposalId*string

        The proposalId to delete deals from.

      Request body

      • dealIdsarray

        List of deals to delete for a given proposal

      • proposalRevisionNumberstring

        The last known proposal revision number.

      • updateActionstring

        Indicates an optional action to take on the proposal

    • Add new deals for the specified proposal

      This action add new deals for the specified proposal

      POSTAdexchangebuyerMarketplacedealsInsert

      Request parameters

      • proposalId*string

        proposalId for which deals need to be added.

      Request body

      • dealsarray

        The list of deals to add

      • proposalRevisionNumberstring

        The last known proposal revision number.

      • updateActionstring

        Indicates an optional action to take on the proposal

    • Replace all the deals in the proposal with the passed in deals

      This action replaces all the deals in the proposal with the passed in deals

      POSTAdexchangebuyerMarketplacedealsUpdate

      Request parameters

      • proposalId*string

        The proposalId to edit deals on.

      Request body

      • dealsarray

        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 proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.

      • proposalobject

        If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction.

      • proposalRevisionNumberstring

        The last known revision number for the proposal.

      • updateActionstring

        Indicates an optional action to take on the proposal

  • marketplacenotes

    • Get all the notes associated with a proposal

      This action get all the notes associated with a proposal

      GETAdexchangebuyerMarketplacenotesList

      Request parameters

      • proposalId*string

        The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.

      • pqlQuerystring

        Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%"

    • Add notes to the proposal

      This action add notes to the proposal

      POSTAdexchangebuyerMarketplacenotesInsert

      Request parameters

      • proposalId*string

        The proposalId to add notes for.

      Request body

      • notesarray

        The list of notes to add.

  • marketplaceprivateauction

    • Update a given private auction proposal

      This action update a given private auction proposal

      POSTAdexchangebuyerMarketplaceprivateauctionUpdateproposal

      Request parameters

      • privateAuctionId*string

        The private auction id to be updated.

      Request body

      • externalDealIdstring

        The externalDealId of the deal to be updated.

      • noteobject

        Optional note to be added.

      • proposalRevisionNumberstring

        The current revision number of the proposal to be updated.

      • updateActionstring

        The proposed action on the private auction proposal.

  • performanceReport

    • Retrief the authenticated user's list of performance metrics

      This action retrieves the authenticated user's list of performance metrics.

      GETAdexchangebuyerPerformanceReportList

      Request parameters

      • accountId*string

        The account id to get the reports.

      • endDateTime*string

        The end time of the report in ISO 8601 timestamp format using UTC.

      • startDateTime*string

        The start time of the report in ISO 8601 timestamp format using UTC.

      • maxResultsinteger

        Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

      • pageTokenstring

        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.

  • pretargetingConfig

    • Get a specific pretargeting configuration

      This action gets a specific pretargeting configuration

      GETAdexchangebuyerPretargetingConfigGet

      Request parameters

      • accountId*string

        The account id to get the pretargeting config for.

      • configId*string

        The specific id of the configuration to retrieve.

    • Retrief a list of the authenticated user's pretargeting configurations

      This action retrieves a list of the authenticated user's pretargeting configurations.

      GETAdexchangebuyerPretargetingConfigList

      Request parameters

      • accountId*string

        The account id to get the pretargeting configs for.

    • Insert a new pretargeting configuration

      This action inserts a new pretargeting configuration.

      POSTAdexchangebuyerPretargetingConfigInsert

      Request parameters

      • accountId*string

        The account id to insert the pretargeting config for.

      Request body

      • billingIdstring

        The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.

      • configIdstring

        The config id; generated automatically. Leave this field blank for insert requests.

      • configNamestring

        The name of the config. Must be unique. Required for all requests.

      • creativeTypearray

        List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.

      • dimensionsarray

        Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.

      • excludedContentLabelsarray

        Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.

      • excludedGeoCriteriaIdsarray

        Requests containing any of these geo criteria ids will not match.

      • excludedPlacementsarray

        Requests containing any of these placements will not match.

      • excludedUserListsarray

        Requests containing any of these users list ids will not match.

      • excludedVerticalsarray

        Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.

      • geoCriteriaIdsarray

        Requests containing any of these geo criteria ids will match.

      • isActiveboolean

        Whether this config is active. Required for all requests.

      • kindstring

        The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".

      • languagesarray

        Request containing any of these language codes will match.

      • minimumViewabilityDecileinteger

        Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.

      • mobileCarriersarray

        Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.

      • mobileDevicesarray

        Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.

      • mobileOperatingSystemVersionsarray

        Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.

      • placementsarray

        Requests containing any of these placements will match.

      • platformsarray

        Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.

      • supportedCreativeAttributesarray

        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.

      • userIdentifierDataRequiredarray

        Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.

      • userListsarray

        Requests containing any of these user list ids will match.

      • vendorTypesarray

        Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.

      • verticalsarray

        Requests containing any of these vertical ids will match.

      • videoPlayerSizesarray

        Video requests satisfying any of these player size constraints will match.

    • Update an existing pretargeting config

      This action updates an existing pretargeting config.

      PUTAdexchangebuyerPretargetingConfigUpdate

      Request parameters

      • accountId*string

        The account id to update the pretargeting config for.

      • configId*string

        The specific id of the configuration to update.

      Request body

      • billingIdstring

        The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.

      • configIdstring

        The config id; generated automatically. Leave this field blank for insert requests.

      • configNamestring

        The name of the config. Must be unique. Required for all requests.

      • creativeTypearray

        List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.

      • dimensionsarray

        Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.

      • excludedContentLabelsarray

        Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.

      • excludedGeoCriteriaIdsarray

        Requests containing any of these geo criteria ids will not match.

      • excludedPlacementsarray

        Requests containing any of these placements will not match.

      • excludedUserListsarray

        Requests containing any of these users list ids will not match.

      • excludedVerticalsarray

        Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.

      • geoCriteriaIdsarray

        Requests containing any of these geo criteria ids will match.

      • isActiveboolean

        Whether this config is active. Required for all requests.

      • kindstring

        The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".

      • languagesarray

        Request containing any of these language codes will match.

      • minimumViewabilityDecileinteger

        Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.

      • mobileCarriersarray

        Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.

      • mobileDevicesarray

        Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.

      • mobileOperatingSystemVersionsarray

        Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.

      • placementsarray

        Requests containing any of these placements will match.

      • platformsarray

        Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.

      • supportedCreativeAttributesarray

        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.

      • userIdentifierDataRequiredarray

        Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.

      • userListsarray

        Requests containing any of these user list ids will match.

      • vendorTypesarray

        Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.

      • verticalsarray

        Requests containing any of these vertical ids will match.

      • videoPlayerSizesarray

        Video requests satisfying any of these player size constraints will match.

    • Update an existing pretargeting config

      This action updates an existing pretargeting config. This method supports patch semantics.

      PATCHAdexchangebuyerPretargetingConfigPatch

      Request parameters

      • accountId*string

        The account id to update the pretargeting config for.

      • configId*string

        The specific id of the configuration to update.

      Request body

      • billingIdstring

        The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.

      • configIdstring

        The config id; generated automatically. Leave this field blank for insert requests.

      • configNamestring

        The name of the config. Must be unique. Required for all requests.

      • creativeTypearray

        List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.

      • dimensionsarray

        Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.

      • excludedContentLabelsarray

        Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.

      • excludedGeoCriteriaIdsarray

        Requests containing any of these geo criteria ids will not match.

      • excludedPlacementsarray

        Requests containing any of these placements will not match.

      • excludedUserListsarray

        Requests containing any of these users list ids will not match.

      • excludedVerticalsarray

        Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.

      • geoCriteriaIdsarray

        Requests containing any of these geo criteria ids will match.

      • isActiveboolean

        Whether this config is active. Required for all requests.

      • kindstring

        The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".

      • languagesarray

        Request containing any of these language codes will match.

      • minimumViewabilityDecileinteger

        Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.

      • mobileCarriersarray

        Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.

      • mobileDevicesarray

        Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.

      • mobileOperatingSystemVersionsarray

        Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.

      • placementsarray

        Requests containing any of these placements will match.

      • platformsarray

        Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.

      • supportedCreativeAttributesarray

        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.

      • userIdentifierDataRequiredarray

        Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.

      • userListsarray

        Requests containing any of these user list ids will match.

      • vendorTypesarray

        Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.

      • verticalsarray

        Requests containing any of these vertical ids will match.

      • videoPlayerSizesarray

        Video requests satisfying any of these player size constraints will match.

    • Delete an existing pretargeting config

      This action deletes an existing pretargeting config.

      DELETEAdexchangebuyerPretargetingConfigDelete

      Request parameters

      • accountId*string

        The account id to delete the pretargeting config for.

      • configId*string

        The specific id of the configuration to delete.

  • products

    • Get the requested product by id

      This action gets the requested product by id.

      GETAdexchangebuyerProductsGet

      Request parameters

      • productId*string

        The id for the product to get the head revision for.

    • Get the requested product

      This action gets the requested product.

      GETAdexchangebuyerProductsSearch

      Request parameters

      • pqlQuerystring

        The pql query used to query for products.

  • proposals

    • Get a proposal given its id

      This action get a proposal given its id

      GETAdexchangebuyerProposalsGet

      Request parameters

      • proposalId*string

        Id of the proposal to retrieve.

    • Search for proposals using pql query

      This action search for proposals using pql query

      GETAdexchangebuyerProposalsSearch

      Request parameters

      • pqlQuerystring

        Query string to retrieve specific proposals.

    • Create the given list of proposals

      This action create the given list of proposals

      POSTAdexchangebuyerProposalsInsert

      Request body

      • proposalsarray

        The list of proposals to create.

      • webPropertyCodestring

        Web property id of the seller creating these orders

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

      This action update the given proposal to indicate that setup has been completed.

      POSTAdexchangebuyerProposalsSetupcomplete

      Request parameters

      • proposalId*string

        The proposal id for which the setup is complete

    • Update the given proposal

      This action update the given proposal

      PUTAdexchangebuyerProposalsUpdate

      Request parameters

      • proposalId*string

        The proposal id to update.

      • 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 latest proposal at head revision and retry the update at that revision.

      • updateAction*string

        The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.

      Request body

      • billedBuyerobject

        Reference to the buyer that will get billed for this proposal. (readonly)

      • buyerobject

        Reference to the buyer on the proposal. (readonly, except on create)

      • buyerContactsarray

        Optional contact information of the buyer. (seller-readonly)

      • buyerPrivateDataobject

        Private data for buyer. (hidden from seller).

      • dbmAdvertiserIdsarray

        IDs of DBM advertisers permission to this proposal.

      • hasBuyerSignedOffboolean

        When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)

      • hasSellerSignedOffboolean

        When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)

      • inventorySourcestring

        What exchange will provide this inventory (readonly, except on create).

      • isRenegotiatingboolean

        True if the proposal is being renegotiated (readonly).

      • isSetupCompleteboolean

        True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag.

      • kindstring

        Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".

      • labelsarray

        List of labels associated with the proposal. (readonly)

      • lastUpdaterOrCommentorRolestring

        The role of the last user that either updated the proposal or left a comment. (readonly)

      • namestring

        The name for the proposal (updatable)

      • negotiationIdstring

        Optional negotiation id if this proposal is a preferred deal proposal.

      • originatorRolestring

        Indicates whether the buyer/seller created the proposal.(readonly)

      • privateAuctionIdstring

        Optional private auction id if this proposal is a private auction proposal.

      • proposalIdstring

        The unique id of the proposal. (readonly).

      • proposalStatestring

        The current state of the proposal. (readonly)

      • revisionNumberstring

        The revision number for the proposal (readonly).

      • revisionTimeMsstring

        The time (ms since epoch) when the proposal was last revised (readonly).

      • sellerobject

        Reference to the seller on the proposal. (readonly, except on create)

      • sellerContactsarray

        Optional contact information of the seller (buyer-readonly).

    • Update the given proposal

      This action update the given proposal. This method supports patch semantics.

      PATCHAdexchangebuyerProposalsPatch

      Request parameters

      • proposalId*string

        The proposal id to update.

      • 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 latest proposal at head revision and retry the update at that revision.

      • updateAction*string

        The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.

      Request body

      • billedBuyerobject

        Reference to the buyer that will get billed for this proposal. (readonly)

      • buyerobject

        Reference to the buyer on the proposal. (readonly, except on create)

      • buyerContactsarray

        Optional contact information of the buyer. (seller-readonly)

      • buyerPrivateDataobject

        Private data for buyer. (hidden from seller).

      • dbmAdvertiserIdsarray

        IDs of DBM advertisers permission to this proposal.

      • hasBuyerSignedOffboolean

        When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)

      • hasSellerSignedOffboolean

        When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)

      • inventorySourcestring

        What exchange will provide this inventory (readonly, except on create).

      • isRenegotiatingboolean

        True if the proposal is being renegotiated (readonly).

      • isSetupCompleteboolean

        True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag.

      • kindstring

        Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".

      • labelsarray

        List of labels associated with the proposal. (readonly)

      • lastUpdaterOrCommentorRolestring

        The role of the last user that either updated the proposal or left a comment. (readonly)

      • namestring

        The name for the proposal (updatable)

      • negotiationIdstring

        Optional negotiation id if this proposal is a preferred deal proposal.

      • originatorRolestring

        Indicates whether the buyer/seller created the proposal.(readonly)

      • privateAuctionIdstring

        Optional private auction id if this proposal is a private auction proposal.

      • proposalIdstring

        The unique id of the proposal. (readonly).

      • proposalStatestring

        The current state of the proposal. (readonly)

      • revisionNumberstring

        The revision number for the proposal (readonly).

      • revisionTimeMsstring

        The time (ms since epoch) when the proposal was last revised (readonly).

      • sellerobject

        Reference to the seller on the proposal. (readonly, except on create)

      • sellerContactsarray

        Optional contact information of the seller (buyer-readonly).

  • pubprofiles

    • Get the requested publisher profile(s) by publisher accountId

      This action gets the requested publisher profile(s) by publisher accountId.

      GETAdexchangebuyerPubprofilesList

      Request parameters

      • accountId*integer

        The accountId of the publisher to get profiles for.