authorizedbuyersmarketplace/v1 library

Authorized Buyers Marketplace API - v1

The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.

For more information, see developers.google.com/authorized-buyers/apis/marketplace/reference/rest/

Create an instance of AuthorizedBuyersMarketplaceApi to access these resources:

Classes

AcceptProposalRequest
Request to accept a proposal.
AddCreativeRequest
Request message for adding creative to be used in the bidding process for the finalized deal.
AddNoteRequest
Request to add a note.
AdSize
Represents size of a single ad slot, or a creative.
AuctionPackage
Defines a segment of inventory that buyer wants to buy.
AuthorizedBuyersMarketplaceApi
The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.
BatchUpdateDealsRequest
Request message for batch updating deals.
BatchUpdateDealsResponse
Response message for batch updating deals.
BiddersAuctionPackagesResource
BiddersFinalizedDealsResource
BiddersResource
BuyersAuctionPackagesResource
BuyersClientsResource
BuyersClientsUsersResource
BuyersFinalizedDealsResource
BuyersProposalsDealsResource
BuyersProposalsResource
BuyersPublisherProfilesResource
BuyersResource
Client
A client represents an agency, a brand, or an advertiser customer of the buyer.
ClientUser
A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
Contact
Contains information on how a buyer or seller can be reached.
CreativeRequirements
Message captures data about the creatives in the deal.
CriteriaTargeting
Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.
DayPart
Defines targeting for a period of time on a specific week day.
DayPartTargeting
Represents Daypart targeting.
Deal
A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status.
DealPausingInfo
Information related to deal pausing.
DeliveryControl
Message contains details about how the deal will be paced.
FinalizedDeal
A finalized deal is a snapshot of the deal when both buyer and seller accept the deal.
FirstPartyMobileApplicationTargeting
Represents a list of targeted and excluded mobile application IDs that publishers own.
FrequencyCap
Message contains details about publisher-set frequency caps of the delivery.
InventorySizeTargeting
Represents the size of an ad unit that can be targeted on a bid request.
InventoryTypeTargeting
Targeting of the inventory types a bid request can originate from.
ListAuctionPackagesResponse
Response message for listing auction packages.
ListClientsResponse
Response message for the list method.
ListClientUsersResponse
Response message for the list method.
ListDealsResponse
Response message for listing deals in a proposal.
ListFinalizedDealsResponse
Response message for listing finalized deals.
ListProposalsResponse
Response message for listing proposals.
ListPublisherProfilesResponse
Response message for profiles visible to the buyer.
MarketplaceTargeting
Targeting represents different criteria that can be used to target deals or auction packages.
MediaPlanner
Describes a single Media Planner account.
MobileApplicationTargeting
Mobile application targeting settings.
Note
A text note attached to the proposal to facilitate the communication between buyers and sellers.
OperatingSystemTargeting
Represents targeting information for operating systems.
PauseFinalizedDealRequest
Request message for pausing a finalized deal.
PlacementTargeting
Represents targeting about where the ads can appear, for example, certain sites or mobile applications.
PreferredDealTerms
Pricing terms for Preferred Deals.
Price
Represents a price and a pricing type for a deal.
PrivateAuctionTerms
Pricing terms for Private Auctions.
PrivateData
Buyers are allowed to store certain types of private data in a proposal or deal.
ProgrammaticGuaranteedTerms
Pricing terms for Programmatic Guaranteed Deals.
Proposal
Represents a proposal in the Marketplace.
PublisherProfile
The values in the publisher profile are supplied by the publisher.
PublisherProfileMobileApplication
A mobile application that contains a external app ID, name, and app store.
RtbMetrics
Real-time bidding metrics.
SendRfpRequest
Request to send an RFP.
SubscribeClientsRequest
Request message for SubscribeAuctionPackageClients.
TechnologyTargeting
Represents targeting about various types of technology.
UnsubscribeClientsRequest
Request message for UnsubscribeAuctionPackage.
UpdateDealRequest
Request message for updating the deal at the given revision number.
UriTargeting
Represents a list of targeted and excluded URLs (for example, google.com).
VideoTargeting
Represents targeting information about video.

Typedefs

ActivateClientRequest = $Empty
Request message for activating a client.
ActivateClientUserRequest = $Empty
Request message for activating a client user.
CancelNegotiationRequest = $Empty
Request to cancel an ongoing negotiation.
DeactivateClientRequest = $Empty
Request message for disabling a client.
DeactivateClientUserRequest = $Empty
Request message for deactivating a client user.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Money = $Money
Represents an amount of money with its currency type.
ResumeFinalizedDealRequest = $Empty
Request message for resuming a finalized deal.
SetReadyToServeRequest = $Empty
Request message for setting ready to serve for a finalized deal.
SubscribeAuctionPackageRequest = $Empty
Request message for SubscribeAuctionPackage.
TimeOfDay = $TimeOfDay
Represents a time of day.
TimeZone = $TimeZone
Represents a time zone from the IANA Time Zone Database.
UnsubscribeAuctionPackageRequest = $Empty
Request message for UnsubscribeAuctionPackage.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.