2024-07-23
▼ ▲ authorizedbuyersmarketplace.buyers.auctionPackages.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`
Pattern: ^buyers/[^/]+/auctionPackages/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets an auction package given its name.
▼ ▲ authorizedbuyersmarketplace.buyers.auctionPackages.list
Path: v1alpha/{+parent}/auctionPackages
Flat Path: v1alpha/buyers/{buyersId}/auctionPackages
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned. ListAuctionPackagesResponse.nextPageToken
Location: query
Type: string
filter
Description: Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
Location: query
Type: string
orderBy
Description: Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.auctionPackages.subscribe
Path: v1alpha/{+name}:subscribe
Flat Path: v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe
HTTP Method: POST
Parameters:
name
Description: Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`
Pattern: ^buyers/[^/]+/auctionPackages/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe
Path: v1alpha/{+name}:unsubscribe
Flat Path: v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe
HTTP Method: POST
Parameters:
name
Description: Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`
Pattern: ^buyers/[^/]+/auctionPackages/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients
Path: v1alpha/{+auctionPackage}:subscribeClients
Flat Path: v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients
HTTP Method: POST
Parameters:
auctionPackage
Description: Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`
Pattern: ^buyers/[^/]+/auctionPackages/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: auctionPackage
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients
Path: v1alpha/{+auctionPackage}:unsubscribeClients
Flat Path: v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients
HTTP Method: POST
Parameters:
auctionPackage
Description: Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`
Pattern: ^buyers/[^/]+/auctionPackages/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: auctionPackage
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}
HTTP Method: GET
Parameters:
name
Description: Required. Format: `buyers/{accountId}/clients/{clientAccountId}`
Pattern: ^buyers/[^/]+/clients/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets a client with a given resource name.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.list
Path: v1alpha/{+parent}/clients
Flat Path: v1alpha/buyers/{buyersId}/clients
HTTP Method: GET
Parameters:
parent
Description: Required. The name of the buyer. Format: `buyers/{accountId}`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. If left blank, a default page size of 500 will be applied.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.
Location: query
Type: string
filter
Description: Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Lists all the clients for the current buyer.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.create
Path: v1alpha/{+parent}/clients
Flat Path: v1alpha/buyers/{buyersId}/clients
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the buyer. Format: `buyers/{accountId}`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Creates a new client.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
Pattern: ^buyers/[^/]+/clients/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Updates an existing client.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.activate
Path: v1alpha/{+name}:activate
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}:activate
HTTP Method: POST
Parameters:
name
Description: Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
Pattern: ^buyers/[^/]+/clients/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.deactivate
Path: v1alpha/{+name}:deactivate
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}:deactivate
HTTP Method: POST
Parameters:
name
Description: Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
Pattern: ^buyers/[^/]+/clients/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.users.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}
HTTP Method: GET
Parameters:
name
Description: Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
Pattern: ^buyers/[^/]+/clients/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Retrieves an existing client user.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.users.list
Path: v1alpha/{+parent}/users
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}/users
HTTP Method: GET
Parameters:
parent
Description: Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
Pattern: ^buyers/[^/]+/clients/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. If left blank, a default page size of 500 will be applied.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Lists all client users for a specified client.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.users.create
Path: v1alpha/{+parent}/users
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}/users
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
Pattern: ^buyers/[^/]+/clients/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.users.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
Pattern: ^buyers/[^/]+/clients/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.users.activate
Path: v1alpha/{+name}:activate
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate
HTTP Method: POST
Parameters:
name
Description: Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
Pattern: ^buyers/[^/]+/clients/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.clients.users.deactivate
Path: v1alpha/{+name}:deactivate
Flat Path: v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate
HTTP Method: POST
Parameters:
name
Description: Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
Pattern: ^buyers/[^/]+/clients/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.dataSegments.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
Pattern: ^buyers/[^/]+/dataSegments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets a data segment given its name.
▼ ▲ authorizedbuyersmarketplace.buyers.dataSegments.list
Path: v1alpha/{+parent}/dataSegments
Flat Path: v1alpha/buyers/{buyersId}/dataSegments
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: List the data segments owned by a curator.
▼ ▲ authorizedbuyersmarketplace.buyers.dataSegments.create
Path: v1alpha/{+parent}/dataSegments
Flat Path: v1alpha/buyers/{buyersId}/dataSegments
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.dataSegments.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
Pattern: ^buyers/[^/]+/dataSegments/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Updates a data segment.
▼ ▲ authorizedbuyersmarketplace.buyers.dataSegments.activate
Path: v1alpha/{+name}:activate
Flat Path: v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:activate
HTTP Method: POST
Parameters:
name
Description: Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
Pattern: ^buyers/[^/]+/dataSegments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Activates a data segment.
▼ ▲ authorizedbuyersmarketplace.buyers.dataSegments.deactivate
Path: v1alpha/{+name}:deactivate
Flat Path: v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:deactivate
HTTP Method: POST
Parameters:
name
Description: Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
Pattern: ^buyers/[^/]+/dataSegments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Deactivates a data segment.
▼ ▲ authorizedbuyersmarketplace.buyers.finalizedDeals.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}
HTTP Method: GET
Parameters:
name
Description: Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`
Pattern: ^buyers/[^/]+/finalizedDeals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets a finalized deal given its name.
▼ ▲ authorizedbuyersmarketplace.buyers.finalizedDeals.list
Path: v1alpha/{+parent}/finalizedDeals
Flat Path: v1alpha/buyers/{buyersId}/finalizedDeals
HTTP Method: GET
Parameters:
parent
Description: Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
Location: query
Type: string
orderBy
Description: An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
Location: query
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned from ListFinalizedDealsResponse.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.finalizedDeals.pause
Path: v1alpha/{+name}:pause
Flat Path: v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause
HTTP Method: POST
Parameters:
name
Description: Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`
Pattern: ^buyers/[^/]+/finalizedDeals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.finalizedDeals.resume
Path: v1alpha/{+name}:resume
Flat Path: v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume
HTTP Method: POST
Parameters:
name
Description: Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`
Pattern: ^buyers/[^/]+/finalizedDeals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative
Path: v1alpha/{+deal}:addCreative
Flat Path: v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative
HTTP Method: POST
Parameters:
deal
Description: Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`
Pattern: ^buyers/[^/]+/finalizedDeals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: deal
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe
Path: v1alpha/{+deal}:setReadyToServe
Flat Path: v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe
HTTP Method: POST
Parameters:
deal
Description: Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`
Pattern: ^buyers/[^/]+/finalizedDeals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: deal
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets a proposal using its resource name. The proposal is returned at the latest revision.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.list
Path: v1alpha/{+parent}/proposals
Flat Path: v1alpha/buyers/{buyersId}/proposals
HTTP Method: GET
Parameters:
parent
Description: Required. Parent that owns the collection of proposals Format: `buyers/{accountId}`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state
Location: query
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned from ListProposalsResponse.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation
Path: v1alpha/{+proposal}:cancelNegotiation
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation
HTTP Method: POST
Parameters:
proposal
Description: Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: proposal
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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'.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.accept
Path: v1alpha/{+name}:accept
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}:accept
HTTP Method: POST
Parameters:
name
Description: Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.addNote
Path: v1alpha/{+proposal}:addNote
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}:addNote
HTTP Method: POST
Parameters:
proposal
Description: Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: proposal
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.sendRfp
Path: v1alpha/{+buyer}/proposals:sendRfp
Flat Path: v1alpha/buyers/{buyersId}/proposals:sendRfp
HTTP Method: POST
Parameters:
buyer
Description: Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`.
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: buyer
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.deals.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}
HTTP Method: GET
Parameters:
name
Description: Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
Pattern: ^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets a deal given its name. The deal is returned at its head revision.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.deals.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
Pattern: ^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.deals.batchUpdate
Path: v1alpha/{+parent}/deals:batchUpdate
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals:batchUpdate
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Batch updates multiple deals in the same proposal.
▼ ▲ authorizedbuyersmarketplace.buyers.proposals.deals.list
Path: v1alpha/{+parent}/deals
Flat Path: v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals
HTTP Method: GET
Parameters:
parent
Description: Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}
Pattern: ^buyers/[^/]+/proposals/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned from ListDealsResponse.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
▼ ▲ authorizedbuyersmarketplace.buyers.publisherProfiles.get
Path: v1alpha/{+name}
Flat Path: v1alpha/buyers/{buyersId}/publisherProfiles/{publisherProfilesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`
Pattern: ^buyers/[^/]+/publisherProfiles/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: Gets the requested publisher profile by name.
▼ ▲ authorizedbuyersmarketplace.buyers.publisherProfiles.list
Path: v1alpha/{+parent}/publisherProfiles
Flat Path: v1alpha/buyers/{buyersId}/publisherProfiles
HTTP Method: GET
Parameters:
parent
Description: Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}`
Pattern: ^buyers/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned from a previous ListPublisherProfilesResponse.
Location: query
Type: string
filter
Description: Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.bidders.auctionPackages.list
Path: v1alpha/{+parent}/auctionPackages
Flat Path: v1alpha/bidders/{biddersId}/auctionPackages
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.
Pattern: ^bidders/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned. ListAuctionPackagesResponse.nextPageToken
Location: query
Type: string
filter
Description: Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
Location: query
Type: string
orderBy
Description: Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.
▼ ▲ authorizedbuyersmarketplace.bidders.finalizedDeals.list
Path: v1alpha/{+parent}/finalizedDeals
Flat Path: v1alpha/bidders/{biddersId}/finalizedDeals
HTTP Method: GET
Parameters:
parent
Description: Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.
Pattern: ^bidders/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
Location: query
Type: string
orderBy
Description: An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
Location: query
Type: string
pageSize
Description: Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
Location: query
Type: integer
Format: int32
pageToken
Description: The page token as returned from ListFinalizedDealsResponse.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
Description: 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.