BuyersFinalizedDeals
class BuyersFinalizedDeals extends Resource (View source)
The "finalizedDeals" collection of methods.
Typical usage is:
$authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
$finalizedDeals = $authorizedbuyersmarketplaceService->buyers_finalizedDeals;Methods
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. (finalizedDeals.addCreative)
Gets a finalized deal given its name. (finalizedDeals.get)
Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
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. (finalizedDeals.pause)
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. (finalizedDeals.resume)
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. (finalizedDeals.setReadyToServe)
Details
FinalizedDeal
addCreative(string $deal, AddCreativeRequest $postBody, array $optParams = [])
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. (finalizedDeals.addCreative)
FinalizedDeal
get(string $name, array $optParams = [])
Gets a finalized deal given its name. (finalizedDeals.get)
ListFinalizedDealsResponse
listBuyersFinalizedDeals(string $parent, array $optParams = [])
Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
(finalizedDeals.listBuyersFinalizedDeals)
FinalizedDeal
pause(string $name, PauseFinalizedDealRequest $postBody, array $optParams = [])
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. (finalizedDeals.pause)
FinalizedDeal
resume(string $name, ResumeFinalizedDealRequest $postBody, array $optParams = [])
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. (finalizedDeals.resume)
FinalizedDeal
setReadyToServe(string $deal, SetReadyToServeRequest $postBody, array $optParams = [])
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. (finalizedDeals.setReadyToServe)