Class: Google::Apis::AuthorizedbuyersmarketplaceV1::AuthorizedBuyersMarketplaceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/authorizedbuyersmarketplace_v1/service.rb

Overview

Authorized Buyers Marketplace API

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

Examples:

require 'google/apis/authorizedbuyersmarketplace_v1'

Authorizedbuyersmarketplace = Google::Apis::AuthorizedbuyersmarketplaceV1 # Alias the module
service = Authorizedbuyersmarketplace::AuthorizedBuyersMarketplaceService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://authorizedbuyersmarketplace.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AuthorizedBuyersMarketplaceService

Returns a new instance of AuthorizedBuyersMarketplaceService.



48
49
50
51
52
53
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-authorizedbuyersmarketplace_v1',
        client_version: Google::Apis::AuthorizedbuyersmarketplaceV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



41
42
43
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



46
47
48
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#accept_proposal(name, accept_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

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:

  • name (String) —

    Name of the proposal. Format: buyers/accountId/proposals/proposalId``

  • accept_proposal_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::AcceptProposalRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1112

def accept_proposal(name, accept_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:accept', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AcceptProposalRequest::Representation
  command.request_object = accept_proposal_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#activate_client(name, activate_client_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Client

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:

  • name (String) —

    Required. Format: buyers/buyerAccountId/clients/clientAccountId``

  • activate_client_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 426

def activate_client(name, activate_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:activate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientRequest::Representation
  command.request_object = activate_client_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#activate_client_user(name, activate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser

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:

  • name (String) —

    Required. Format: buyers/buyerAccountId/clients/clientAccountId/ clientUsers/userId``

  • activate_client_user_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 652

def activate_client_user(name, activate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:activate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ActivateClientUserRequest::Representation
  command.request_object = activate_client_user_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_finalized_deal_creative(deal, add_creative_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal

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:

  • deal (String) —

    Required. Name of the finalized deal in the format of: buyers/accountId/ finalizedDeals/dealId``

  • add_creative_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::AddCreativeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 868

def add_finalized_deal_creative(deal, add_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+deal}:addCreative', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AddCreativeRequest::Representation
  command.request_object = add_creative_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
  command.params['deal'] = deal unless deal.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_proposal_note(proposal, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.

Parameters:

  • proposal (String) —

    Name of the proposal. Format: buyers/accountId/proposals/proposalId``

  • add_note_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::AddNoteRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1146

def add_proposal_note(proposal, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+proposal}:addNote', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AddNoteRequest::Representation
  command.request_object = add_note_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
  command.params['proposal'] = proposal unless proposal.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_deals(parent, batch_update_deals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse

Batch updates multiple deals in the same proposal.

Parameters:

  • parent (String) —

    Required. The name of the proposal containing the deals to batch update. Format: buyers/accountId/proposals/proposalId

  • batch_update_deals_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1387

def batch_update_deals(parent, batch_update_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/deals:batchUpdate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsRequest::Representation
  command.request_object = batch_update_deals_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::BatchUpdateDealsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_proposal_negotiation(proposal, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

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:

  • proposal (String) —

    Name of the proposal. Format: buyers/accountId/proposals/proposalId``

  • cancel_negotiation_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::CancelNegotiationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1186

def cancel_proposal_negotiation(proposal, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+proposal}:cancelNegotiation', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::CancelNegotiationRequest::Representation
  command.request_object = cancel_negotiation_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
  command.params['proposal'] = proposal unless proposal.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_buyer_client(parent, client_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Client

Creates a new client.

Parameters:

  • parent (String) —

    Required. The name of the buyer. Format: buyers/accountId``

  • client_object (Google::Apis::AuthorizedbuyersmarketplaceV1::Client) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 459

def create_buyer_client(parent, client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/clients', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_buyer_client_user(parent, client_user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser

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:

  • parent (String) —

    Required. The name of the client. Format: buyers/accountId/clients/ clientAccountId``

  • client_user_object (Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 687

def create_buyer_client_user(parent, client_user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/users', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
  command.request_object = client_user_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deactivate_client(name, deactivate_client_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::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.

Parameters:

  • name (String) —

    Required. Format: buyers/buyerAccountId/clients/clientAccountId``

  • deactivate_client_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 494

def deactivate_client(name, deactivate_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:deactivate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientRequest::Representation
  command.request_object = deactivate_client_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deactivate_client_user(name, deactivate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser

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:

  • name (String) —

    Required. Format: buyers/buyerAccountId/clients/clientAccountId/ clientUsers/userId``

  • deactivate_client_user_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientUserRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 724

def deactivate_client_user(name, deactivate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:deactivate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::DeactivateClientUserRequest::Representation
  command.request_object = deactivate_client_user_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_buyer_client_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Empty

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:

  • name (String) —

    Required. Format: buyers/buyerAccountId/clients/clientAccountId/ clientUsers/userId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



759
760
761
762
763
764
765
766
767
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 759

def delete_buyer_client_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Empty::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_auction_package(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage

Gets an auction package given its name.

Parameters:

  • name (String) —

    Required. Name of auction package to get. Format: buyers/accountId/ auctionPackages/auctionPackageId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



193
194
195
196
197
198
199
200
201
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 193

def get_buyer_auction_package(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_client(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Client

Gets a client with a given resource name.

Parameters:

  • name (String) —

    Required. Format: buyers/accountId/clients/clientAccountId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



526
527
528
529
530
531
532
533
534
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 526

def get_buyer_client(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_client_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser

Retrieves an existing client user.

Parameters:

  • name (String) —

    Required. Format: buyers/buyerAccountId/clients/clientAccountId/ clientUsers/userId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



790
791
792
793
794
795
796
797
798
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 790

def get_buyer_client_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ClientUser
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_finalized_deal(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal

Gets a finalized deal given its name.

Parameters:

  • name (String) —

    Required. Format: buyers/accountId/finalizedDeals/dealId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



900
901
902
903
904
905
906
907
908
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 900

def get_buyer_finalized_deal(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_proposal(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

Gets a proposal using its resource name. The proposal is returned at the latest revision.

Parameters:

  • name (String) —

    Required. Name of the proposal. Format: buyers/accountId/proposals/ proposalId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1220

def get_buyer_proposal(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_proposal_deal(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Deal

Gets a deal given its name. The deal is returned at its head revision.

Parameters:

  • name (String) —

    Required. Format: buyers/accountId/proposals/proposalId/deals/dealId

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1419

def get_buyer_proposal_deal(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_buyer_publisher_profile(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile

Gets the requested publisher profile by name.

Parameters:

  • name (String) —

    Required. Name of the publisher profile. Format: buyers/buyerId/ publisherProfiles/publisherProfileId``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1544

def get_buyer_publisher_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::PublisherProfile
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_bidder_auction_packages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse

List the auction packages. Buyers can use the URL path "/v1/buyers/accountId/ auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/accountId/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

Parameters:

  • parent (String) —

    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.

  • filter (String) (defaults to: nil) —

    Optional. Optional query string using the Cloud API list filtering syntax. Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds

  • order_by (String) (defaults to: nil) —

    Optional. An optional query string to sort auction packages using the Cloud API sorting syntax. 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

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server may return fewer results than requested. Max allowed page size is 500.

  • page_token (String) (defaults to: nil) —

    The page token as returned. ListAuctionPackagesResponse.nextPageToken

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 98

def list_bidder_auction_packages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/auctionPackages', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_bidder_finalized_deals(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse

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:

  • parent (String) —

    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.

  • filter (String) (defaults to: nil) —

    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

  • order_by (String) (defaults to: nil) —

    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

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    The page token as returned from ListFinalizedDealsResponse.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 158

def list_bidder_finalized_deals(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/finalizedDeals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_auction_packages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse

List the auction packages. Buyers can use the URL path "/v1/buyers/accountId/ auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/accountId/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

Parameters:

  • parent (String) —

    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.

  • filter (String) (defaults to: nil) —

    Optional. Optional query string using the Cloud API list filtering syntax. Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds

  • order_by (String) (defaults to: nil) —

    Optional. An optional query string to sort auction packages using the Cloud API sorting syntax. 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

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server may return fewer results than requested. Max allowed page size is 500.

  • page_token (String) (defaults to: nil) —

    The page token as returned. ListAuctionPackagesResponse.nextPageToken

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 246

def list_buyer_auction_packages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/auctionPackages', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_client_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse

Lists all client users for a specified client.

Parameters:

  • parent (String) —

    Required. The name of the client. Format: buyers/buyerAccountId/clients/ clientAccountId``

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. If left blank, a default page size of 500 will be applied.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 827

def list_buyer_client_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/users', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientUsersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_clients(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse

Lists all the clients for the current buyer.

Parameters:

  • parent (String) —

    Required. The name of the buyer. Format: buyers/accountId``

  • filter (String) (defaults to: nil) —

    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 be partnerClientId = "1234", in order to get only the client whose partnerClientId is "1234" in the response.
  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. If left blank, a default page size of 500 will be applied.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 569

def list_buyer_clients(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/clients', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListClientsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_finalized_deals(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse

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:

  • parent (String) —

    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.

  • filter (String) (defaults to: nil) —

    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

  • order_by (String) (defaults to: nil) —

    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

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    The page token as returned from ListFinalizedDealsResponse.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 956

def list_buyer_finalized_deals(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/finalizedDeals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListFinalizedDealsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_proposal_deals(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse

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:

  • parent (String) —

    Required. The name of the proposal containing the deals to retrieve. Format: buyers/accountId/proposals/proposalId

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    The page token as returned from ListDealsResponse.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1457

def list_buyer_proposal_deals(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListDealsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_proposals(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse

Lists proposals. A filter expression using Cloud API list filtering syntax may be specified to filter the results.

Parameters:

  • parent (String) —

    Required. Parent that owns the collection of proposals Format: buyers/ accountId``

  • filter (String) (defaults to: nil) —

    Optional query string using the Cloud API list filtering syntax Supported columns for filtering are: * displayName * dealType * updateTime * state

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.

  • page_token (String) (defaults to: nil) —

    The page token as returned from ListProposalsResponse.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1262

def list_buyer_proposals(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/proposals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListProposalsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_buyer_publisher_profiles(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse

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:

  • parent (String) —

    Required. Parent that owns the collection of publisher profiles Format: buyers/buyerId``

  • filter (String) (defaults to: nil) —

    Optional query string using the Cloud API list filtering syntax.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    The page token as returned from a previous ListPublisherProfilesResponse.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1586

def list_buyer_publisher_profiles(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/publisherProfiles', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::ListPublisherProfilesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_buyer_client(name, client_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Client

Updates an existing client.

Parameters:

  • name (String) —

    Output only. The resource name of the client. Format: buyers/accountId/ clients/clientAccountId``

  • client_object (Google::Apis::AuthorizedbuyersmarketplaceV1::Client) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 614

def patch_buyer_client(name, client_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Client
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_buyer_proposal(name, proposal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

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:

  • name (String) —

    Immutable. The name of the proposal serving as a unique identifier. Format: buyers/accountId/proposals/proposalId

  • proposal_object (Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1313

def patch_buyer_proposal(name, proposal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.request_object = proposal_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_buyer_proposal_deal(name, deal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Deal

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:

  • name (String) —

    Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/accountId/proposals/proposalId/ deals/dealId

  • deal_object (Google::Apis::AuthorizedbuyersmarketplaceV1::Deal) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1510

def patch_buyer_proposal_deal(name, deal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal::Representation
  command.request_object = deal_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Deal
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pause_finalized_deal(name, pause_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal

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.

Parameters:

  • name (String) —

    Required. Format: buyers/accountId/finalizedDeals/dealId``

  • pause_finalized_deal_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::PauseFinalizedDealRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 994

def pause_finalized_deal(name, pause_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:pause', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::PauseFinalizedDealRequest::Representation
  command.request_object = pause_finalized_deal_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resume_finalized_deal(name, resume_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal

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.

Parameters:

  • name (String) —

    Required. Format: buyers/accountId/finalizedDeals/dealId``

  • resume_finalized_deal_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::ResumeFinalizedDealRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1031

def resume_finalized_deal(name, resume_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resume', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::ResumeFinalizedDealRequest::Representation
  command.request_object = resume_finalized_deal_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#send_proposal_rfp(buyer, send_rfp_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

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:

  • buyer (String) —

    Required. The current buyer who is sending the RFP in the format: buyers/ accountId``.

  • send_rfp_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::SendRfpRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1353

def send_proposal_rfp(buyer, send_rfp_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+buyer}/proposals:sendRfp', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SendRfpRequest::Representation
  command.request_object = send_rfp_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal
  command.params['buyer'] = buyer unless buyer.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_finalized_deal_ready_to_serve(deal, set_ready_to_serve_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal

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:

  • deal (String) —

    Required. Format: buyers/accountId/finalizedDeals/dealId``

  • set_ready_to_serve_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::SetReadyToServeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1072

def set_finalized_deal_ready_to_serve(deal, set_ready_to_serve_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+deal}:setReadyToServe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SetReadyToServeRequest::Representation
  command.request_object = set_ready_to_serve_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::FinalizedDeal
  command.params['deal'] = deal unless deal.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#subscribe_auction_package(name, subscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage

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:

  • name (String) —

    Required. Name of the auction package. Format: buyers/accountId/ auctionPackages/auctionPackageId``

  • subscribe_auction_package_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeAuctionPackageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 284

def subscribe_auction_package(name, subscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:subscribe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeAuctionPackageRequest::Representation
  command.request_object = subscribe_auction_package_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#subscribe_auction_package_clients(auction_package, subscribe_clients_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage

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:

  • auction_package (String) —

    Required. Name of the auction package. Format: buyers/accountId/ auctionPackages/auctionPackageId``

  • subscribe_clients_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeClientsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 321

def subscribe_auction_package_clients(auction_package, subscribe_clients_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+auctionPackage}:subscribeClients', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::SubscribeClientsRequest::Representation
  command.request_object = subscribe_clients_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
  command.params['auctionPackage'] = auction_package unless auction_package.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unsubscribe_auction_package(name, unsubscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage

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:

  • name (String) —

    Required. Name of the auction package. Format: buyers/accountId/ auctionPackages/auctionPackageId``

  • unsubscribe_auction_package_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeAuctionPackageRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 357

def unsubscribe_auction_package(name, unsubscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:unsubscribe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeAuctionPackageRequest::Representation
  command.request_object = unsubscribe_auction_package_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unsubscribe_auction_package_clients(auction_package, unsubscribe_clients_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage

Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.

Parameters:

  • auction_package (String) —

    Required. Name of the auction package. Format: buyers/accountId/ auctionPackages/auctionPackageId``

  • unsubscribe_clients_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeClientsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 392

def unsubscribe_auction_package_clients(auction_package, unsubscribe_clients_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+auctionPackage}:unsubscribeClients', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::UnsubscribeClientsRequest::Representation
  command.request_object = unsubscribe_clients_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1::AuctionPackage
  command.params['auctionPackage'] = auction_package unless auction_package.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end