API Reference google_api_ad_exchange_buyer v0.36.0

Modules

API client metadata for GoogleApi.AdExchangeBuyer.V14.

API calls for all endpoints tagged Accounts.

API calls for all endpoints tagged BillingInfo.

API calls for all endpoints tagged Budget.

API calls for all endpoints tagged Creatives.

API calls for all endpoints tagged Marketplacedeals.

API calls for all endpoints tagged Marketplacenotes.

API calls for all endpoints tagged Marketplaceprivateauction.

API calls for all endpoints tagged PerformanceReport.

API calls for all endpoints tagged PretargetingConfig.

API calls for all endpoints tagged Products.

API calls for all endpoints tagged Proposals.

API calls for all endpoints tagged Pubprofiles.

Handle Tesla connections for GoogleApi.AdExchangeBuyer.V14.

Configuration data for an Ad Exchange buyer account.

Attributes

  • bidProtocol (type: String.t, default: nil) - The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values:
    • PROTOCOL_ADX
    • PROTOCOL_OPENRTB_2_2
    • PROTOCOL_OPENRTB_2_3
    • PROTOCOL_OPENRTB_2_4
    • PROTOCOL_OPENRTB_2_5
    • PROTOCOL_OPENRTB_PROTOBUF_2_3
    • PROTOCOL_OPENRTB_PROTOBUF_2_4
    • PROTOCOL_OPENRTB_PROTOBUF_2_5
  • maximumQps (type: integer(), default: nil) - The maximum queries per second the Ad Exchange will send.
  • region (type: String.t, default: nil) - 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
  • url (type: String.t, default: nil) - The URL to which the Ad Exchange will send bid requests.

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.

Attributes

  • deals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDeal.t), default: nil) - The list of deals to add
  • proposalRevisionNumber (type: String.t, default: nil) - The last known proposal revision number.
  • updateAction (type: String.t, default: nil) - Indicates an optional action to take on the proposal

Attributes

  • deals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDeal.t), default: nil) - List of deals added (in the same proposal as passed in the request)
  • proposalRevisionNumber (type: String.t, default: nil) - The updated revision number for the proposal.

Attributes

  • notes (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceNote.t), default: nil) - The list of notes to add.

Attributes

  • notes (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceNote.t), default: nil) -

The configuration data for an Ad Exchange billing info.

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.

The configuration data for Ad Exchange RTB - Budget API.

Attributes

  • accountId (type: String.t, default: nil) - Adx account id of the buyer.

Attributes

  • email (type: String.t, default: nil) - Email address of the contact.
  • name (type: String.t, default: nil) - The name of the contact.

Attributes

  • proposals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t), default: nil) - The list of proposals to create.
  • webPropertyCode (type: String.t, default: nil) - Web property id of the seller creating these orders

Attributes

  • proposals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t), default: nil) - The list of proposals successfully created.

A creative and its classification data.

Attributes

  • detectedProviderIds (type: list(String.t), default: nil) - The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the BidRequest.adslot.consented_providers_settings.consented_providers field on the Authorized Buyers Real-Time Bidding protocol or the BidRequest.user.ext.consented_providers_settings.consented_providers field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
  • hasUnidentifiedProvider (type: boolean(), default: nil) - Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.

Attributes

  • contexts (type: list(GoogleApi.AdExchangeBuyer.V14.Model.CreativeCorrectionsContexts.t), default: nil) - All known serving contexts containing serving status information.
  • details (type: list(String.t), default: nil) - Additional details about the correction.
  • reason (type: String.t, default: nil) - The type of correction that was applied to the creative.

Attributes

  • auctionType (type: list(String.t), default: nil) - Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
  • contextType (type: String.t, default: nil) - The type of context (e.g., location, platform, auction type, SSL-ness).
  • geoCriteriaId (type: list(integer()), default: nil) - Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
  • platform (type: list(String.t), default: nil) - Only set when contextType=PLATFORM. Represents the platforms this correction applies to.

The external deal ids associated with a creative.

Attributes

  • arcStatus (type: String.t, default: nil) - ARC approval status.
  • dealId (type: String.t, default: nil) - External deal ID.
  • webPropertyId (type: integer(), default: nil) - Publisher ID.

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

Attributes

  • filteringCount (type: String.t, default: nil) - The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
  • filteringStatus (type: integer(), default: nil) - The filtering status code as defined in creative-status-codes.txt.

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

A smaller image, for the advertiser logo.

Attributes

  • contexts (type: list(GoogleApi.AdExchangeBuyer.V14.Model.CreativeServingRestrictionsContexts.t), default: nil) - All known contexts/restrictions.
  • disapprovalReasons (type: list(GoogleApi.AdExchangeBuyer.V14.Model.CreativeServingRestrictionsDisapprovalReasons.t), default: nil) - 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 (type: String.t, default: nil) - Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).

Attributes

  • auctionType (type: list(String.t), default: nil) - Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
  • contextType (type: String.t, default: nil) - The type of context (e.g., location, platform, auction type, SSL-ness).
  • geoCriteriaId (type: list(integer()), default: nil) - Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.
  • platform (type: list(String.t), default: nil) - Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.

Attributes

  • details (type: list(String.t), default: nil) - Additional details about the reason for disapproval.
  • reason (type: String.t, default: nil) - The categorized reason for disapproval.

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.

Attributes

  • alcoholAdsAllowed (type: boolean(), default: nil) - True if alcohol ads are allowed for this deal (read-only). This field is only populated when querying for finalized orders using the method GetFinalizedOrderDeals
  • dealPauseStatus (type: GoogleApi.AdExchangeBuyer.V14.Model.DealServingMetadataDealPauseStatus.t, default: nil) - Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)

Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently.

Attributes

  • brandingType (type: String.t, default: nil) - Visibility of the URL in bid requests.
  • crossListedExternalDealIdType (type: String.t, default: nil) - Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
  • description (type: String.t, default: nil) - Description for the proposed terms of the deal.
  • estimatedGrossSpend (type: GoogleApi.AdExchangeBuyer.V14.Model.Price.t, default: nil) - Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
  • estimatedImpressionsPerDay (type: String.t, default: nil) - Non-binding estimate of the impressions served per day Can be set by buyer or seller.
  • guaranteedFixedPriceTerms (type: GoogleApi.AdExchangeBuyer.V14.Model.DealTermsGuaranteedFixedPriceTerms.t, default: nil) - The terms for guaranteed fixed price deals.
  • nonGuaranteedAuctionTerms (type: GoogleApi.AdExchangeBuyer.V14.Model.DealTermsNonGuaranteedAuctionTerms.t, default: nil) - The terms for non-guaranteed auction deals.
  • nonGuaranteedFixedPriceTerms (type: GoogleApi.AdExchangeBuyer.V14.Model.DealTermsNonGuaranteedFixedPriceTerms.t, default: nil) - The terms for non-guaranteed fixed price deals.
  • rubiconNonGuaranteedTerms (type: GoogleApi.AdExchangeBuyer.V14.Model.DealTermsRubiconNonGuaranteedTerms.t, default: nil) - The terms for rubicon non-guaranteed deals.
  • sellerTimeZone (type: String.t, default: nil) - For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)

Attributes

  • billingInfo (type: GoogleApi.AdExchangeBuyer.V14.Model.DealTermsGuaranteedFixedPriceTermsBillingInfo.t, default: nil) - External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
  • fixedPrices (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PricePerBuyer.t), default: nil) - Fixed price for the specified buyer.
  • guaranteedImpressions (type: String.t, default: nil) - Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
  • guaranteedLooks (type: String.t, default: nil) - Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
  • minimumDailyLooks (type: String.t, default: nil) - Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.

Attributes

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

Attributes

  • autoOptimizePrivateAuction (type: boolean(), default: nil) - True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
  • reservePricePerBuyers (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PricePerBuyer.t), default: nil) - Reserve price for the specified buyer.

Attributes

  • fixedPrices (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PricePerBuyer.t), default: nil) - Fixed price for the specified buyer.

Attributes

  • priorityPrice (type: GoogleApi.AdExchangeBuyer.V14.Model.Price.t, default: nil) - Optional price for Rubicon priority access in the auction.
  • standardPrice (type: GoogleApi.AdExchangeBuyer.V14.Model.Price.t, default: nil) - Optional price for Rubicon standard access in the auction.

Attributes

  • dealIds (type: list(String.t), default: nil) - List of deals to delete for a given proposal
  • proposalRevisionNumber (type: String.t, default: nil) - The last known proposal revision number.
  • updateAction (type: String.t, default: nil) - Indicates an optional action to take on the proposal

Attributes

  • deals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDeal.t), default: nil) - List of deals deleted (in the same proposal as passed in the request)
  • proposalRevisionNumber (type: String.t, default: nil) - The updated revision number for the proposal.

Attributes

  • creativeBlockingLevel (type: String.t, default: nil) -
  • deliveryRateType (type: String.t, default: nil) -
  • frequencyCaps (type: list(GoogleApi.AdExchangeBuyer.V14.Model.DeliveryControlFrequencyCap.t), default: nil) -

Attributes

  • maxImpressions (type: integer(), default: nil) -
  • numTimeUnits (type: integer(), default: nil) -
  • timeUnitType (type: String.t, default: nil) -

This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}

Attributes

  • deals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDeal.t), default: nil) - 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.
  • proposal (type: GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t, default: nil) - 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.
  • proposalRevisionNumber (type: String.t, default: nil) - The last known revision number for the proposal.
  • updateAction (type: String.t, default: nil) - Indicates an optional action to take on the proposal

Attributes

  • deals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDeal.t), default: nil) - List of all deals in the proposal after edit.
  • orderRevisionNumber (type: String.t, default: nil) - The latest revision number after the update has been applied.

Attributes

  • products (type: list(GoogleApi.AdExchangeBuyer.V14.Model.Product.t), default: nil) - The returned list of products.

Attributes

  • deals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDeal.t), default: nil) - List of deals for the proposal

Attributes

  • notes (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceNote.t), default: nil) - The list of matching notes. The notes for a proposal are ordered from oldest to newest. If the notes span multiple proposals, they will be grouped by proposal, with the notes for the most recently modified proposal appearing first.

Attributes

  • proposals (type: list(GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t), default: nil) - The list of matching proposals.

Attributes

  • profiles (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PublisherProfileApiProto.t), default: nil) - Profiles for the requested publisher

A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.

Attributes

  • buyer (type: GoogleApi.AdExchangeBuyer.V14.Model.Buyer.t, default: nil) - The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
  • seller (type: GoogleApi.AdExchangeBuyer.V14.Model.Seller.t, default: nil) - The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.

Attributes

  • accountId (type: String.t, default: nil) - The accountId of the party that created the label.
  • createTimeMs (type: String.t, default: nil) - The creation time (in ms since epoch) for the label.
  • deprecatedMarketplaceDealParty (type: GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceDealParty.t, default: nil) - Information about the party that created the label.
  • label (type: String.t, default: nil) - The label to use.

A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.

Attributes

  • appStore (type: String.t, default: nil) -
  • externalAppId (type: String.t, default: nil) -

The configuration data for an Ad Exchange performance report list.

The configuration data for an Ad Exchange performance report list.

Attributes

  • billingId (type: String.t, default: nil) - The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.
  • configId (type: String.t, default: nil) - The config id; generated automatically. Leave this field blank for insert requests.
  • configName (type: String.t, default: nil) - The name of the config. Must be unique. Required for all requests.
  • creativeType (type: list(String.t), default: nil) - List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
  • dimensions (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfigDimensions.t), default: nil) - Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.
  • excludedContentLabels (type: list(String.t), default: nil) - Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.
  • excludedGeoCriteriaIds (type: list(String.t), default: nil) - Requests containing any of these geo criteria ids will not match.
  • excludedPlacements (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfigExcludedPlacements.t), default: nil) - Requests containing any of these placements will not match.
  • excludedUserLists (type: list(String.t), default: nil) - Requests containing any of these users list ids will not match.
  • excludedVerticals (type: list(String.t), default: nil) - Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.
  • geoCriteriaIds (type: list(String.t), default: nil) - Requests containing any of these geo criteria ids will match.
  • isActive (type: boolean(), default: nil) - Whether this config is active. Required for all requests.
  • kind (type: String.t, default: adexchangebuyer#pretargetingConfig) - The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
  • languages (type: list(String.t), default: nil) - Request containing any of these language codes will match.
  • maximumQps (type: String.t, default: nil) - The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).
  • minimumViewabilityDecile (type: integer(), default: nil) - 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.
  • mobileCarriers (type: list(String.t), default: nil) - Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.
  • mobileDevices (type: list(String.t), default: nil) - Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.
  • mobileOperatingSystemVersions (type: list(String.t), default: nil) - Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.
  • placements (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfigPlacements.t), default: nil) - Requests containing any of these placements will match.
  • platforms (type: list(String.t), default: nil) - Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.
  • supportedCreativeAttributes (type: list(String.t), default: nil) - 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.
  • userIdentifierDataRequired (type: list(String.t), default: nil) - 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.
  • userLists (type: list(String.t), default: nil) - Requests containing any of these user list ids will match.
  • vendorTypes (type: list(String.t), default: nil) - Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.
  • verticals (type: list(String.t), default: nil) - Requests containing any of these vertical ids will match.
  • videoPlayerSizes (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfigVideoPlayerSizes.t), default: nil) - Video requests satisfying any of these player size constraints will match.

Attributes

  • height (type: String.t, default: nil) - Height in pixels.
  • width (type: String.t, default: nil) - Width in pixels.

Attributes

  • token (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The type of the placement.

Attributes

  • items (type: list(GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig.t), default: nil) - A list of pretargeting configs
  • kind (type: String.t, default: adexchangebuyer#pretargetingConfigList) - Resource type.

Attributes

  • token (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The type of the placement.

Attributes

  • aspectRatio (type: String.t, default: nil) - The type of aspect ratio. Leave this field blank to match all aspect ratios.
  • minHeight (type: String.t, default: nil) - The minimum player height in pixels. Leave this field blank to match any player height.
  • minWidth (type: String.t, default: nil) - The minimum player width in pixels. Leave this field blank to match any player width.

Attributes

  • amountMicros (type: float(), default: nil) - The price value in micros.
  • currencyCode (type: String.t, default: nil) - The currency code for the price.
  • expectedCpmMicros (type: float(), default: nil) - In case of CPD deals, the expected CPM in micros.
  • pricingType (type: String.t, default: nil) - The pricing type for the deal/product.

Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.

Attributes

  • referenceId (type: String.t, default: nil) -
  • referencePayload (type: String.t, default: nil) -

A product 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 a product can have one of the following setting

Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting

Attributes

  • audience (type: String.t, default: nil) - Publisher provided info on its audience.
  • buyerPitchStatement (type: String.t, default: nil) - A pitch statement for the buyer
  • directContact (type: String.t, default: nil) - Direct contact for the publisher profile.
  • exchange (type: String.t, default: nil) - Exchange where this publisher profile is from. E.g. AdX, Rubicon etc...
  • googlePlusLink (type: String.t, default: nil) - Link to publisher's Google+ page.
  • isParent (type: boolean(), default: nil) - True, if this is the parent profile, which represents all domains owned by the publisher.
  • isPublished (type: boolean(), default: nil) - True, if this profile is published. Deprecated for state.
  • kind (type: String.t, default: adexchangebuyer#publisherProfileApiProto) - Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#publisherProfileApiProto".
  • logoUrl (type: String.t, default: nil) - The url to the logo for the publisher.
  • mediaKitLink (type: String.t, default: nil) - The url for additional marketing and sales materials.
  • name (type: String.t, default: nil) -
  • overview (type: String.t, default: nil) - Publisher provided overview.
  • profileId (type: integer(), default: nil) - The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher.
  • programmaticContact (type: String.t, default: nil) - Programmatic contact for the publisher profile.
  • publisherAppIds (type: list(String.t), default: nil) - The list of app IDs represented in this pubisher profile. Empty if this is a parent profile. Deprecated in favor of publisher_app.
  • publisherApps (type: list(GoogleApi.AdExchangeBuyer.V14.Model.MobileApplication.t), default: nil) - The list of apps represented in this pubisher profile. Empty if this is a parent profile.
  • publisherDomains (type: list(String.t), default: nil) - The list of domains represented in this publisher profile. Empty if this is a parent profile.
  • publisherProfileId (type: String.t, default: nil) - Unique Id for publisher profile.
  • publisherProvidedForecast (type: GoogleApi.AdExchangeBuyer.V14.Model.PublisherProvidedForecast.t, default: nil) - Publisher provided forecasting information.
  • rateCardInfoLink (type: String.t, default: nil) - Link to publisher rate card
  • samplePageLink (type: String.t, default: nil) - Link for a sample content page.
  • seller (type: GoogleApi.AdExchangeBuyer.V14.Model.Seller.t, default: nil) - Seller of the publisher profile.
  • state (type: String.t, default: nil) - State of the publisher profile.
  • topHeadlines (type: list(String.t), default: nil) - Publisher provided key metrics and rankings.

This message carries publisher provided forecasting information.

Attributes

  • accountId (type: String.t, default: nil) - The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
  • subAccountId (type: String.t, default: nil) - Optional sub-account id for the seller.

Attributes

  • exclusions (type: list(GoogleApi.AdExchangeBuyer.V14.Model.TargetingValue.t), default: nil) - The list of values to exclude from targeting. Each value is AND'd together.
  • inclusions (type: list(GoogleApi.AdExchangeBuyer.V14.Model.TargetingValue.t), default: nil) - The list of value to include as part of the targeting. Each value is OR'd together.
  • key (type: String.t, default: nil) - The key representing the shared targeting criterion.

Attributes

  • creativeSizeValue (type: GoogleApi.AdExchangeBuyer.V14.Model.TargetingValueCreativeSize.t, default: nil) - The creative size value to exclude/include.
  • dayPartTargetingValue (type: GoogleApi.AdExchangeBuyer.V14.Model.TargetingValueDayPartTargeting.t, default: nil) - The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
  • demogAgeCriteriaValue (type: GoogleApi.AdExchangeBuyer.V14.Model.TargetingValueDemogAgeCriteria.t, default: nil) -
  • demogGenderCriteriaValue (type: GoogleApi.AdExchangeBuyer.V14.Model.TargetingValueDemogGenderCriteria.t, default: nil) -
  • longValue (type: String.t, default: nil) - The long value to exclude/include.
  • requestPlatformTargetingValue (type: GoogleApi.AdExchangeBuyer.V14.Model.TargetingValueRequestPlatformTargeting.t, default: nil) -
  • stringValue (type: String.t, default: nil) - The string value to exclude/include.

Attributes

  • dayParts (type: list(GoogleApi.AdExchangeBuyer.V14.Model.TargetingValueDayPartTargetingDayPart.t), default: nil) -
  • timeZoneType (type: String.t, default: nil) -

Attributes

  • dayOfWeek (type: String.t, default: nil) -
  • endHour (type: integer(), default: nil) -
  • endMinute (type: integer(), default: nil) -
  • startHour (type: integer(), default: nil) -
  • startMinute (type: integer(), default: nil) -

Attributes

  • demogAgeCriteriaIds (type: list(String.t), default: nil) -

Attributes

  • demogGenderCriteriaIds (type: list(String.t), default: nil) -

Attributes

  • requestPlatforms (type: list(String.t), default: nil) -

Attributes

  • height (type: integer(), default: nil) - The height of the creative.
  • width (type: integer(), default: nil) - The width of the creative.

Attributes

  • externalDealId (type: String.t, default: nil) - The externalDealId of the deal to be updated.
  • note (type: GoogleApi.AdExchangeBuyer.V14.Model.MarketplaceNote.t, default: nil) - Optional note to be added.
  • proposalRevisionNumber (type: String.t, default: nil) - The current revision number of the proposal to be updated.
  • updateAction (type: String.t, default: nil) - The proposed action on the private auction proposal.

API client metadata for GoogleApi.AdExchangeBuyer.V2beta1.

API calls for all endpoints tagged Accounts.

API calls for all endpoints tagged Bidders.

Handle Tesla connections for GoogleApi.AdExchangeBuyer.V2beta1.

An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail.

Represents size of a single ad slot, or a creative.

Detected ad technology provider information.

A request for associating a deal and a creative.

Request message for adding a note to a given proposal.

Output only. The app type the restriction applies to for mobile device.

Output only. The auction type the restriction applies to.

The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel;

The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status.

Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.

The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status.

Request to cancel an ongoing negotiation.

A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified.

A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.

An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.

Request message for indicating that the proposal's setup step is complete.

Contains information on how a buyer or seller can be reached.

Output only. Shows any corrections that were applied to this creative.

A creative and its classification data.

The association between a creative and a deal.

Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals.

Specifies the size of the creative.

Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager.

The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status.

Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week.

Specifies the day part targeting criteria.

A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.

Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true.

Message captures metadata about the serving status of a deal.

The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher.

Message contains details about how the deals will be paced.

Output only. The reason and details for a disapproval.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".

The number of filtered bids with the specified dimension values that have the specified creative.

The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail.

Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.

An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.

The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.

Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager.

Response message for listing the metrics that are measured in number of bids.

Response message for listing all reasons that bid responses resulted in an error.

Response message for listing all reasons that bid responses were considered to have no applicable bids.

Attributes

  • invitations (type: list(GoogleApi.AdExchangeBuyer.V2beta1.Model.ClientUserInvitation.t), default: nil) - The returned list of client users.
  • nextPageToken (type: String.t, default: nil) - A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.

Attributes

  • nextPageToken (type: String.t, default: nil) - A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.
  • users (type: list(GoogleApi.AdExchangeBuyer.V2beta1.Model.ClientUser.t), default: nil) - The returned list of client users.

Attributes

  • clients (type: list(GoogleApi.AdExchangeBuyer.V2beta1.Model.Client.t), default: nil) - The returned list of clients.
  • nextPageToken (type: String.t, default: nil) - A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results.

Response message for listing all creatives associated with a given filtered bid reason.

Response message for listing all details associated with a given filtered bid reason.

A response for listing creative and deal associations

Response message for listing filter sets.

Response message for listing all reasons that bid requests were filtered and not sent to the buyer.

Response message for listing all reasons that bids were filtered from the auction.

Response message for listing the metrics that are measured in number of impressions.

Response message for listing all reasons that bids lost in the auction.

Response message for listing all reasons for which a buyer was not billed for a winning bid.

Response message for listing products visible to the buyer.

Response message for listing proposals.

Response message for profiles visible to the buyer.

Output only. The Geo criteria the restriction applies to.

Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.

A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled).

Represents an amount of money with its currency type.

The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status.

Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request.

Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request.

A proposal may be associated to several notes.

Represents targeting information for operating systems.

Request message to pause serving for an already-finalized proposal.

Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed.

Output only. The type of platform the restriction applies to.

Represents a price and a pricing type for a product / deal.

Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 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.

Buyers are allowed to store certain types of private data in a proposal/deal.

Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.

Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise.

Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.

A mobile application that contains a external app ID, name, and app store.

An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set.

A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30

A request for removing the association between a deal and a creative.

Request message to resume (unpause) serving for an already-finalized proposal.

A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row.

Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID.

The serving context for this restriction.

Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).

Message depicting the size of the creative. The units of width and height depend on the type of the targeting.

A request for stopping notifications for changes to creative Status.

Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting.

A polymorphic targeting value used as part of Shared Targeting.

Represents targeting about various types of technology.

An interval of time, with an absolute start and end.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.

Represents targeting information about video.

A request for watching changes to creative Status.