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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AuthorizedBuyersMarketplaceService

Returns a new instance of AuthorizedBuyersMarketplaceService.

[View source]

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

def initialize
  super('https://authorizedbuyersmarketplace.googleapis.com/', '',
        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.


39
40
41
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 39

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.


44
45
46
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 44

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

[View source]

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

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

[View source]

348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 348

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

[View source]

574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 574

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

[View source]

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

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.

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

[View source]

1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1066

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

[View source]

1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1307

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

[View source]

1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1106

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

[View source]

381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 381

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

[View source]

609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 609

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

[View source]

416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 416

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

[View source]

646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 646

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

[View source]

681
682
683
684
685
686
687
688
689
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 681

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

[View source]

134
135
136
137
138
139
140
141
142
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 134

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

[View source]

448
449
450
451
452
453
454
455
456
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 448

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

[View source]

712
713
714
715
716
717
718
719
720
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 712

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

[View source]

822
823
824
825
826
827
828
829
830
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 822

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 name. The proposal is returned at most recent revision. 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

[View source]

1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1140

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

[View source]

1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1339

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

[View source]

1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1464

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_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 * 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 Example: 'deal.displayName, deal.updateTime desc'

  • 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

[View source]

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

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, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ListAuctionPackagesResponse

List the auction packages subscribed by a buyer and its clients.

Parameters:

  • parent (String) —

    Required. Name of the parent buyer that can access the auction package. Format: buyers/accountId``

  • 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

[View source]

170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 170

def list_buyer_auction_packages(parent, 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['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

[View source]

749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 749

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

[View source]

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

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 * 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 Example: 'deal.displayName, deal.updateTime desc'

  • 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

[View source]

878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 878

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

[View source]

1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1377

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 (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are being renegotiated; to retrieve these use the finalizedProposals resource.

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

[View source]

1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1182

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

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

[View source]

1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1504

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

[View source]

536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 536

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 from 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

[View source]

1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1233

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

[View source]

1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1430

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.

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

[View source]

916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 916

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.

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

[View source]

952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 952

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

[View source]

1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 1273

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

[View source]

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

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

[View source]

206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 206

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

[View source]

243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 243

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

[View source]

279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 279

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

[View source]

314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/service.rb', line 314

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