View Source GoogleApi.AuthorizedBuyersMarketplace.V1.Api.Buyers (google_api_authorized_buyers_marketplace v0.4.0)
API calls for all endpoints tagged Buyers
.
Summary
Functions
Gets an auction package given its name.
List the auction packages subscribed by a buyer and its clients.
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.
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.
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.
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
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.
Creates a new client.
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.
Gets a client with a given resource name.
Lists all the clients for the current buyer.
Updates an existing client.
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.
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.
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.
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.
Retrieves an existing client user.
Lists all client users for a specified client.
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.
Gets a finalized deal given its name.
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.
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.
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.
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.
Creates a note for this proposal and sends to the seller.
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'.
Batch updates multiple deals in the same proposal.
Gets a deal given its name. The deal is returned at its head revision.
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
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.
Gets a proposal using its resource name. The proposal is returned at the latest revision.
Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.
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.
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.
Gets the requested publisher profile by name.
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.
Functions
authorizedbuyersmarketplace_buyers_auction_packages_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_auction_packages_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an auction package given its name.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of auction package to get. Format:buyers/{accountId}/auctionPackages/{auctionPackageId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_auction_packages_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_auction_packages_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListAuctionPackagesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List the auction packages subscribed by a buyer and its clients.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Name of the parent buyer that can access the auction package. Format:buyers/{accountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Requested page size. The server may return fewer results than requested. Max allowed page size is 500. -
:pageToken
(type:String.t
) - The page token as returned. ListAuctionPackagesResponse.nextPageToken
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListAuctionPackagesResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_auction_packages_subscribe(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_auction_packages_subscribe( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the auction package. Format:buyers/{accountId}/auctionPackages/{auctionPackageId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.SubscribeAuctionPackageRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_auction_packages_subscribe_clients(connection, auction_package, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_auction_packages_subscribe_clients( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
auction_package
(type:String.t
) - Required. Name of the auction package. Format:buyers/{accountId}/auctionPackages/{auctionPackageId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.SubscribeClientsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_auction_packages_unsubscribe(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_auction_packages_unsubscribe( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the auction package. Format:buyers/{accountId}/auctionPackages/{auctionPackageId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.UnsubscribeAuctionPackageRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_auction_packages_unsubscribe_clients(connection, auction_package, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_auction_packages_unsubscribe_clients( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
auction_package
(type:String.t
) - Required. Name of the auction package. Format:buyers/{accountId}/auctionPackages/{auctionPackageId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.UnsubscribeClientsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AuctionPackage{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_activate(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_activate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{buyerAccountId}/clients/{clientAccountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ActivateClientRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new client.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the buyer. Format:buyers/{accountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_deactivate(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_deactivate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{buyerAccountId}/clients/{clientAccountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.DeactivateClientRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a client with a given resource name.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{accountId}/clients/{clientAccountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListClientsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all the clients for the current buyer.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the buyer. Format:buyers/{accountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Query string using the Filtering Syntax 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 bepartnerClientId = "1234"
, in order to get only the client whose partnerClientId is "1234" in the response. -
:pageSize
(type:integer()
) - Requested page size. If left blank, a default page size of 500 will be applied. -
:pageToken
(type:String.t
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListClientsResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an existing client.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The resource name of the client. Format:buyers/{accountId}/clients/{clientAccountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Client{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_users_activate(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_users_activate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ActivateClientUserRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_users_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_users_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the client. Format:buyers/{accountId}/clients/{clientAccountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_users_deactivate(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_users_deactivate( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.DeactivateClientUserRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_users_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_users_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Empty{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_users_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_users_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves an existing client user.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ClientUser{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_clients_users_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_clients_users_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListClientUsersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all client users for a specified client.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the client. Format:buyers/{buyerAccountId}/clients/{clientAccountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Requested page size. If left blank, a default page size of 500 will be applied. -
:pageToken
(type:String.t
) - 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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListClientUsersResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_finalized_deals_add_creative(connection, deal, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_finalized_deals_add_creative( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
deal
(type:String.t
) - Required. Name of the finalized deal in the format of:buyers/{accountId}/finalizedDeals/{dealId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AddCreativeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_finalized_deals_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_finalized_deals_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a finalized deal given its name.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{accountId}/finalizedDeals/{dealId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_finalized_deals_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_finalized_deals_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListFinalizedDealsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - 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 formatbidders/{accountId}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional query string using the Cloud API list filtering syntax Supported columns for filtering are: deal.displayName deal.dealType deal.createTime deal.updateTime deal.flightStartTime deal.flightEndTime deal.eligibleSeatIds dealServingStatus -
:orderBy
(type:String.t
) - An optional query string to sort finalized deals using the Cloud API sorting syntax. 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 Example: 'deal.displayName, deal.updateTime desc' -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - The page token as returned from ListFinalizedDealsResponse.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListFinalizedDealsResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_finalized_deals_pause(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_finalized_deals_pause( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{accountId}/finalizedDeals/{dealId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.PauseFinalizedDealRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_finalized_deals_resume(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_finalized_deals_resume( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format:buyers/{accountId}/finalizedDeals/{dealId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ResumeFinalizedDealRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_finalized_deals_set_ready_to_serve(connection, deal, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_finalized_deals_set_ready_to_serve( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
deal
(type:String.t
) - Required. Format:buyers/{accountId}/finalizedDeals/{dealId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.SetReadyToServeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.FinalizedDeal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_accept(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_accept( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the proposal. Format:buyers/{accountId}/proposals/{proposalId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AcceptProposalRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_add_note(connection, proposal, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_add_note( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a note for this proposal and sends to the seller.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
proposal
(type:String.t
) - Name of the proposal. Format:buyers/{accountId}/proposals/{proposalId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.AddNoteRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_cancel_negotiation(connection, proposal, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_cancel_negotiation( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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'.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
proposal
(type:String.t
) - Name of the proposal. Format:buyers/{accountId}/proposals/{proposalId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.CancelNegotiationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_deals_batch_update(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_deals_batch_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.BatchUpdateDealsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Batch updates multiple deals in the same proposal.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.BatchUpdateDealsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.BatchUpdateDealsResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_deals_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_deals_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Deal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a deal given its name. The deal is returned at its head revision.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Deal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_deals_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_deals_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListDealsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - The page token as returned from ListDealsResponse.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListDealsResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_deals_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_deals_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Deal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Deal.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Deal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a proposal using its resource name. The proposal is returned at the latest revision.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the proposal. Format:buyers/{accountId}/proposals/{proposalId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListProposalsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Parent that owns the collection of proposals Format:buyers/{accountId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional query string using the Cloud API list filtering syntax Supported columns for filtering are: displayName dealType updateTime state -
:pageSize
(type:integer()
) - Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500. -
:pageToken
(type:String.t
) - The page token as returned from ListProposalsResponse.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListProposalsResponse{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - 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. -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_proposals_send_rfp(connection, buyer, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_proposals_send_rfp( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
buyer
(type:String.t
) - Required. The current buyer who is sending the RFP in the format:buyers/{accountId}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Model.SendRfpRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.Proposal{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_publisher_profiles_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_publisher_profiles_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.PublisherProfile.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the requested publisher profile by name.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the publisher profile. Format:buyers/{buyerId}/publisherProfiles/{publisherProfileId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.PublisherProfile{}}
on success -
{:error, info}
on failure
authorizedbuyersmarketplace_buyers_publisher_profiles_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec authorizedbuyersmarketplace_buyers_publisher_profiles_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListPublisherProfilesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.AuthorizedBuyersMarketplace.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Parent that owns the collection of publisher profiles Format:buyers/{buyerId}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax. -
:pageSize
(type:integer()
) - 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. -
:pageToken
(type:String.t
) - The page token as returned from a previous ListPublisherProfilesResponse.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AuthorizedBuyersMarketplace.V1.Model.ListPublisherProfilesResponse{}}
on success -
{:error, info}
on failure