Namespace Google.Apis.AuthorizedBuyersMarketplace.v1alpha
Classes
AuthorizedBuyersMarketplaceBaseServiceRequest<TResponse>
A base abstract class for AuthorizedBuyersMarketplace requests.
AuthorizedBuyersMarketplaceService
The AuthorizedBuyersMarketplace Service.
AuthorizedBuyersMarketplaceService.Scope
Available OAuth 2.0 scopes for use with the Authorized Buyers Marketplace API.
AuthorizedBuyersMarketplaceService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Authorized Buyers Marketplace API.
BiddersResource
The "bidders" collection of methods.
BiddersResource.AuctionPackagesResource
The "auctionPackages" collection of methods.
BiddersResource.AuctionPackagesResource.ListRequest
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
BiddersResource.FinalizedDealsResource
The "finalizedDeals" collection of methods.
BiddersResource.FinalizedDealsResource.ListRequest
Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
BuyersResource
The "buyers" collection of methods.
BuyersResource.AuctionPackagesResource
The "auctionPackages" collection of methods.
BuyersResource.AuctionPackagesResource.GetRequest
Gets an auction package given its name.
BuyersResource.AuctionPackagesResource.ListRequest
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
BuyersResource.AuctionPackagesResource.SubscribeClientsRequest
Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.
BuyersResource.AuctionPackagesResource.SubscribeRequest
Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.
BuyersResource.AuctionPackagesResource.UnsubscribeClientsRequest
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
BuyersResource.AuctionPackagesResource.UnsubscribeRequest
Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.
BuyersResource.ClientsResource
The "clients" collection of methods.
BuyersResource.ClientsResource.ActivateRequest
Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
BuyersResource.ClientsResource.CreateRequest
Creates a new client.
BuyersResource.ClientsResource.DeactivateRequest
Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
BuyersResource.ClientsResource.GetRequest
Gets a client with a given resource name.
BuyersResource.ClientsResource.ListRequest
Lists all the clients for the current buyer.
BuyersResource.ClientsResource.PatchRequest
Updates an existing client.
BuyersResource.ClientsResource.UsersResource
The "users" collection of methods.
BuyersResource.ClientsResource.UsersResource.ActivateRequest
Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
BuyersResource.ClientsResource.UsersResource.CreateRequest
Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
BuyersResource.ClientsResource.UsersResource.DeactivateRequest
Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
BuyersResource.ClientsResource.UsersResource.DeleteRequest
Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
BuyersResource.ClientsResource.UsersResource.GetRequest
Retrieves an existing client user.
BuyersResource.ClientsResource.UsersResource.ListRequest
Lists all client users for a specified client.
BuyersResource.DataSegmentsResource
The "dataSegments" collection of methods.
BuyersResource.DataSegmentsResource.ActivateRequest
Activates a data segment.
BuyersResource.DataSegmentsResource.CreateRequest
Creates a data segment owned by the listed curator. The data segment will be created in the ACTIVE
state, meaning it will be immediately available for buyers to use in preferred deals, private auction
deals, and auction packages.
BuyersResource.DataSegmentsResource.DeactivateRequest
Deactivates a data segment.
BuyersResource.DataSegmentsResource.GetRequest
Gets a data segment given its name.
BuyersResource.DataSegmentsResource.ListRequest
List the data segments owned by a curator.
BuyersResource.DataSegmentsResource.PatchRequest
Updates a data segment.
BuyersResource.FinalizedDealsResource
The "finalizedDeals" collection of methods.
BuyersResource.FinalizedDealsResource.AddCreativeRequest
Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
BuyersResource.FinalizedDealsResource.GetRequest
Gets a finalized deal given its name.
BuyersResource.FinalizedDealsResource.ListRequest
Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
BuyersResource.FinalizedDealsResource.PauseRequest
Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.
BuyersResource.FinalizedDealsResource.ResumeRequest
Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.
BuyersResource.FinalizedDealsResource.SetReadyToServeRequest
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as
they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are
ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use
this method, finalized deals belonging to the bidder and its child seats don't start serving until after
you call setReadyToServe
, and after the deals become active. For example, you can use this method to
delay receiving bid requests until your creative is ready. This method only applies to programmatic
guaranteed deals.
BuyersResource.ProposalsResource
The "proposals" collection of methods.
BuyersResource.ProposalsResource.AcceptRequest
Accepts the proposal at the given revision number. If the revision number in the request is behind the
latest from the server, an error message will be returned. This call updates the Proposal.state from
BUYER_ACCEPTANCE_REQUESTED
to FINALIZED
; it has no side effect if the Proposal.state is already
FINALIZED
and throws exception if the Proposal.state is not either BUYER_ACCEPTANCE_REQUESTED
or
FINALIZED
. Accepting a proposal means the buyer understands and accepts the
Proposal.terms_and_conditions proposed by the seller.
BuyersResource.ProposalsResource.AddNoteRequest
Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
BuyersResource.ProposalsResource.CancelNegotiationRequest
Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the
proposal has been finalized. If the proposal has not been finalized before, calling this method will set
the Proposal.state to TERMINATED
and increment the Proposal.proposal_revision. If the proposal has
been finalized before and is under renegotiation now, calling this method will reset the Proposal.state
to FINALIZED
and increment the Proposal.proposal_revision. This method does not support private
auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
BuyersResource.ProposalsResource.DealsResource
The "deals" collection of methods.
BuyersResource.ProposalsResource.DealsResource.BatchUpdateRequest
Batch updates multiple deals in the same proposal.
BuyersResource.ProposalsResource.DealsResource.GetRequest
Gets a deal given its name. The deal is returned at its head revision.
BuyersResource.ProposalsResource.DealsResource.ListRequest
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
BuyersResource.ProposalsResource.DealsResource.PatchRequest
Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
BuyersResource.ProposalsResource.GetRequest
Gets a proposal using its resource name. The proposal is returned at the latest revision.
BuyersResource.ProposalsResource.ListRequest
Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.
BuyersResource.ProposalsResource.PatchRequest
Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
BuyersResource.ProposalsResource.SendRfpRequest
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain
inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and
a message to the publisher. Once the RFP is sent, a proposal in SELLER_REVIEW_REQUESTED
state will be
created and returned in the response. The publisher may review your request and respond with detailed
deals in the proposal.
BuyersResource.PublisherProfilesResource
The "publisherProfiles" collection of methods.
BuyersResource.PublisherProfilesResource.GetRequest
Gets the requested publisher profile by name.
BuyersResource.PublisherProfilesResource.ListRequest
Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.
Enums
AuthorizedBuyersMarketplaceBaseServiceRequest<TResponse>.AltEnum
Data format for response.
AuthorizedBuyersMarketplaceBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.