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.
Request to accept a proposal.
Creates a new client buyer.
Gets a client buyer with a given client account ID.
Creates and sends out an email invitation to access an Ad Exchange client buyer account.
Retrieves an existing client user invitation.
Lists all the client users invitations for a client with a given account ID.
Lists all the clients for the current sponsor buyer.
Updates an existing client buyer.
Retrieves an existing client user.
Lists all the known client users for a specified sponsor buyer account ID.
Updates an existing client user. Only the user status can be changed on update.
Creates a creative.
Associate an existing deal with a creative.
List all creative-deal associations.
Remove the association between a deal and a creative.
Gets a creative.
Lists creatives.
Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.
Updates a creative.
Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.
List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.
Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
Update given deals to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
A builder providing access to all methods supported on
account resources.
It is not used directly, but through the
AdExchangeBuyerII hub.
Gets the requested product by ID.
List all products visible to the buyer (optionally filtered by the specified PQL query).
Mark the proposal as accepted at the given revision number. If the number does not match the server’s revision number an ABORTED error message will be returned. This call updates the proposal_state from PROPOSED to BUYER_ACCEPTED, or from SELLER_ACCEPTED to FINALIZED. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.
Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.
Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.
You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API. This call updates the is_setup_completed field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To mark an individual deal as ready to serve, call buyers.finalizedDeals.setReadyToServe in the Marketplace API.
Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.
Gets a proposal given its ID. The proposal is returned at its head revision.
List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats’ proposals by specifying the ChildSeat’s accountId in the request path.
Update the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.
Update the given proposal to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all deals in the proposal. Note that if the has_seller_paused bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.
Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision, an ABORTED error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a deal_id, the server will assign a new unique ID and create the deal. If passed-in deal has a deal_id, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a deal_id not present at head.
Gets the requested publisher profile by id.
List all publisher profiles visible to the buyer
Central instance to access all AdExchangeBuyerII related resource activities
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.
Lists all metrics that are measured in terms of number of bids.
List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
Creates the specified filter set for the account with the given account ID.
Deletes the requested filter set from the account with the given account ID.
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
List all reasons for which bids were filtered, with the number of bids filtered for each reason.
List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
Retrieves the requested filter set for the account with the given account ID.
Lists all metrics that are measured in terms of number of impressions.
Lists all filter sets for the account with the given account ID.
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
Lists all metrics that are measured in terms of number of bids.
List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
Creates the specified filter set for the account with the given account ID.
Deletes the requested filter set from the account with the given account ID.
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
List all reasons for which bids were filtered, with the number of bids filtered for each reason.
List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
Retrieves the requested filter set for the account with the given account ID.
Lists all metrics that are measured in terms of number of impressions.
Lists all filter sets for the account with the given account ID.
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
A builder providing access to all methods supported on
bidder resources.
It is not used directly, but through the
AdExchangeBuyerII hub.
Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.
Lists all metrics that are measured in terms of number of bids.
List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
Creates the specified filter set for the account with the given account ID.
Deletes the requested filter set from the account with the given account ID.
List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
List all reasons for which bids were filtered, with the number of bids filtered for each reason.
List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
Retrieves the requested filter set for the account with the given account ID.
Lists all metrics that are measured in terms of number of impressions.
Lists all filter sets for the account with the given account ID.
List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
A builder providing access to all methods supported on
buyer resources.
It is not used directly, but through the
AdExchangeBuyerII hub.
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 through 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, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * 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 (for example, 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); }
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, for example, “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 (for example, 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.
Frequency cap.
Terms for Programmatic Guaranteed Deals.
HTML content for a creative.
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.
There is no detailed description.
There is no detailed description.
There is no detailed description.
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 creatives.
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 (for example, when sampled).
Mobile application targeting settings.
Represents an amount of money with its currency type.
Native content for a creative.
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.
A proposal may be associated to several notes.
Represents targeting information for operating systems.
Request message to pause serving for finalized deals.
Request message to pause serving for an already-finalized proposal.
Represents targeting about where the ads can appear, for example, 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.
A product is a segment of inventory that a seller wants to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.
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’t update, create, or otherwise modify Private Auction deals through the API. Fields are updatable unless noted otherwise.
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, for example, 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 already-finalized deals.
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.
Output only. A security context.
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 versus 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 (for example, 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.
Video content for a creative.
Represents targeting information about video.
A request for watching changes to creative Status.