Class: Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AuthorizedBuyersMarketplaceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/authorizedbuyersmarketplace_v1alpha/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_v1alpha'

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

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AuthorizedBuyersMarketplaceService

Returns a new instance of AuthorizedBuyersMarketplaceService.



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

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

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

def quota_user
  @quota_user
end

Instance Method Details

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



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1383

def accept_proposal(name, accept_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:accept', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AcceptProposalRequest::Representation
  command.request_object = accept_proposal_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 470

def activate_client(name, activate_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:activate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ActivateClientRequest::Representation
  command.request_object = activate_client_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 696

def activate_client_user(name, activate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:activate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ActivateClientUserRequest::Representation
  command.request_object = activate_client_user_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#activate_curated_package(name, activate_curated_package_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage

Activates an existing curated package.

Parameters:

  • name (String) —

    Required. The name of the curated package to activate. Format: curators/ accountId/curatedPackages/curatedPackageId``

  • activate_curated_package_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ActivateCuratedPackageRequest) (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



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1893

def activate_curated_package(name, activate_curated_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:activate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ActivateCuratedPackageRequest::Representation
  command.request_object = activate_curated_package_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage
  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_data_segment(name, activate_data_segment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment

Activates a data segment.

Parameters:

  • name (String) —

    Required. Name of data segment to activate. v1alpha format: buyers/accountId /dataSegments/curatorDataSegmentIdv1beta format: `curators/`accountId`/ dataSegments/`curatorDataSegmentId

  • activate_data_segment_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ActivateDataSegmentRequest) (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



906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 906

def activate_data_segment(name, activate_data_segment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:activate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ActivateDataSegmentRequest::Representation
  command.request_object = activate_data_segment_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment
  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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1136

def add_finalized_deal_creative(deal, add_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+deal}:addCreative', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AddCreativeRequest::Representation
  command.request_object = add_creative_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::Proposal

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

Parameters:

  • proposal (String) —

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

  • add_note_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



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

def add_proposal_note(proposal, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+proposal}:addNote', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AddNoteRequest::Representation
  command.request_object = add_note_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1659

def batch_update_deals(parent, batch_update_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/deals:batchUpdate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::BatchUpdateDealsRequest::Representation
  command.request_object = batch_update_deals_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::BatchUpdateDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



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

def cancel_proposal_negotiation(proposal, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+proposal}:cancelNegotiation', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CancelNegotiationRequest::Representation
  command.request_object = cancel_negotiation_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::Client

Creates a new client.

Parameters:

  • parent (String) —

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

  • client_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 503

def create_buyer_client(parent, client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/clients', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 731

def create_buyer_client_user(parent, client_user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/users', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ClientUser::Representation
  command.request_object = client_user_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#create_buyer_data_segment(parent, data_segment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment

Creates a data segment owned by the listed curator. The data segment will be created in the ACTIVE state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.

Parameters:

  • parent (String) —

    Required. The parent resource where this data segment will be created. v1alpha format: buyers/accountIdv1beta format: `curators/`accountId

  • data_segment_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment) (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



942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 942

def create_buyer_data_segment(parent, data_segment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/dataSegments', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.request_object = data_segment_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment
  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_curator_curated_package(parent, curated_package_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage

Creates a new curated package.

Parameters:

  • parent (String) —

    Required. The parent curator account where this curated package will be created. Format: curators/accountId``

  • curated_package_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage) (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



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1927

def create_curator_curated_package(parent, curated_package_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/curatedPackages', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage::Representation
  command.request_object = curated_package_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage
  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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



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

def deactivate_client(name, deactivate_client_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:deactivate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DeactivateClientRequest::Representation
  command.request_object = deactivate_client_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 768

def deactivate_client_user(name, deactivate_client_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:deactivate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DeactivateClientUserRequest::Representation
  command.request_object = deactivate_client_user_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#deactivate_curated_package(name, deactivate_curated_package_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage

Deactivates an existing curated package.

Parameters:

  • name (String) —

    Required. The name of the curated package to deactivate. Format: curators/ accountId/curatedPackages/curatedPackageId``

  • deactivate_curated_package_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DeactivateCuratedPackageRequest) (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



1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1961

def deactivate_curated_package(name, deactivate_curated_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:deactivate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DeactivateCuratedPackageRequest::Representation
  command.request_object = deactivate_curated_package_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage
  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_data_segment(name, deactivate_data_segment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment

Deactivates a data segment.

Parameters:

  • name (String) —

    Required. Name of data segment to deactivate. v1alpha format: buyers/ accountId/dataSegments/curatorDataSegmentIdv1beta format: `curators/` accountId`/dataSegments/`curatorDataSegmentId

  • deactivate_data_segment_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DeactivateDataSegmentRequest) (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



977
978
979
980
981
982
983
984
985
986
987
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 977

def deactivate_data_segment(name, deactivate_data_segment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:deactivate', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DeactivateDataSegmentRequest::Representation
  command.request_object = deactivate_data_segment_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment
  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::AuthorizedbuyersmarketplaceV1alpha::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



803
804
805
806
807
808
809
810
811
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 803

def delete_buyer_client_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Empty::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



237
238
239
240
241
242
243
244
245
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 237

def get_buyer_auction_package(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



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

def get_buyer_client(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



834
835
836
837
838
839
840
841
842
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 834

def get_buyer_client_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ClientUser::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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_data_segment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment

Gets a data segment given its name.

Parameters:

  • name (String) —

    Required. Name of data segment to get. v1alpha format: buyers/accountId/ dataSegments/curatorDataSegmentIdv1beta format: `curators/`accountId`/ dataSegments/`curatorDataSegmentId

  • 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



1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1011

def get_buyer_data_segment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment
  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::AuthorizedbuyersmarketplaceV1alpha::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



1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1168

def get_buyer_finalized_deal(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::Proposal

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

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1491

def get_buyer_proposal(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1691
1692
1693
1694
1695
1696
1697
1698
1699
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1691

def get_buyer_proposal_deal(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Deal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1816

def get_buyer_publisher_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::PublisherProfile::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#get_curator_curated_package(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage

Gets a curated package given its resource name.

Parameters:

  • name (String) —

    Required. The name of the curated package to retrieve. Format: curators/ accountId/curatedPackages/curatedPackageId``

  • 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



1994
1995
1996
1997
1998
1999
2000
2001
2002
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1994

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

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

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

Parameters:

  • parent (String) —

    Required. Name of the parent buyer that can access the auction package. Format: buyers/accountId. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/`accountId.

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

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

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

    Optional. An optional query string to sort auction packages using the Cloud API sorting syntax. If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime

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

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

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

    The page token as returned. ListAuctionPackagesResponse.nextPageToken

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Lists finalized deals. Use the URL path "/v1alpha/buyers/accountId/ finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/accountId/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

Parameters:

  • parent (String) —

    Required. The buyer to list the finalized deals for, in the format: buyers/ accountId. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/`accountId.

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

    Optional query string using the Cloud API list filtering syntax Supported columns for filtering are: * deal.displayName * deal.dealType * deal. createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe

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

    An optional query string to sort finalized deals using the Cloud API sorting syntax. If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal. updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics. bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics. mustBidRateCurrentMonth

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

    Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.

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

    The page token as returned from ListFinalizedDealsResponse.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

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

Parameters:

  • parent (String) —

    Required. Name of the parent buyer that can access the auction package. Format: buyers/accountId. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/`accountId.

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

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

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

    Optional. An optional query string to sort auction packages using the Cloud API sorting syntax. If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime

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

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

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

    The page token as returned. ListAuctionPackagesResponse.nextPageToken

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 290

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

#list_buyer_client_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



871
872
873
874
875
876
877
878
879
880
881
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 871

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, 'v1alpha/{+parent}/users', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListClientUsersResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



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

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, 'v1alpha/{+parent}/clients', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListClientsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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_data_segments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListDataSegmentsResponse

List the data segments owned by a curator.

Parameters:

  • parent (String) —

    Required. Name of the parent curator that can access the data segment. v1alpha format: buyers/accountIdv1beta format: `curators/`accountId

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

    Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.

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

    Optional. The page token as returned. ListDataSegmentsResponse.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



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1048

def list_buyer_data_segments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/dataSegments', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListDataSegmentsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListDataSegmentsResponse
  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_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::AuthorizedbuyersmarketplaceV1alpha::ListFinalizedDealsResponse

Lists finalized deals. Use the URL path "/v1alpha/buyers/accountId/ finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/accountId/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

Parameters:

  • parent (String) —

    Required. The buyer to list the finalized deals for, in the format: buyers/ accountId. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/`accountId.

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

    Optional query string using the Cloud API list filtering syntax Supported columns for filtering are: * deal.displayName * deal.dealType * deal. createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe

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

    An optional query string to sort finalized deals using the Cloud API sorting syntax. If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal. updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics. bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics. mustBidRateCurrentMonth

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

    Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.

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

    The page token as returned from ListFinalizedDealsResponse.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1224

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, 'v1alpha/{+parent}/finalizedDeals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListFinalizedDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1729

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, 'v1alpha/{+parent}/deals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListDealsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::ListProposalsResponse

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

Parameters:

  • parent (String) —

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

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

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

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

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

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

    The page token as returned from ListProposalsResponse.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1533

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, 'v1alpha/{+parent}/proposals', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListProposalsResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::ListPublisherProfilesResponse

Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.

Parameters:

  • parent (String) —

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

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

    Optional query string using the Cloud API list filtering syntax.

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

    Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.

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

    The page token as returned from a previous ListPublisherProfilesResponse.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1858

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, 'v1alpha/{+parent}/publisherProfiles', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListPublisherProfilesResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#list_curator_curated_packages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListCuratedPackagesResponse

Lists curated packages owned by the specified curator.

Parameters:

  • parent (String) —

    Required. The parent curator account which owns this collection of curated packages. Format: curators/accountId``

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

    Optional. Optional query string using the Cloud API list filtering syntax. Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units

    • floorPriceCpm.nanos
  • page_size (Fixnum) (defaults to: nil) —

    Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.

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

    Optional. A page token, received from a previous ListCuratedPackages call. Provide this to retrieve the subsequent page.

  • 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



2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 2038

def list_curator_curated_packages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/curatedPackages', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListCuratedPackagesResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListCuratedPackagesResponse
  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_media_planners(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListMediaPlannersResponse

Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.

Parameters:

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

    Optional query string using the Cloud API list filtering syntax. Supported columns for filtering are: * name

    • displayName * ancestorNames
  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.

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

    A token identifying a page of results the server should return. This value is received from a previous ListMediaPlanners call in ListMediaPlannersResponse. 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



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 2128

def list_media_planners(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/mediaPlanners', options)
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListMediaPlannersResponse::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ListMediaPlannersResponse
  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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 658

def patch_buyer_client(name, client_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Client::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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_data_segment(name, data_segment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment

Updates a data segment.

Parameters:

  • name (String) —

    Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: buyers/accountId/dataSegments/curatorDataSegmentIdv1beta format: ` curators/`curatorAccountId`/dataSegments/`curatorDataSegmentId

  • data_segment_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement( the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.

  • 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



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1094

def patch_buyer_data_segment(name, data_segment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.request_object = data_segment_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::DataSegment
  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::AuthorizedbuyersmarketplaceV1alpha::Proposal

Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as ' Immutable' or 'Output only' yet specified in the UpdateProposalRequest. update_mask will be ignored and left unchanged. Updating a private auction proposal is only allowed for buyer private data, all other fields are immutable.

Parameters:

  • name (String) —

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

  • proposal_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



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

def patch_buyer_proposal(name, proposal_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.request_object = proposal_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1782

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, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Deal::Representation
  command.request_object = deal_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Deal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#patch_curator_curated_package(name, curated_package_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage

Updates an existing curated package.

Parameters:

  • name (String) —

    Identifier. The unique resource name for the curated package. Format: curators/accountId/curatedPackages/curatedPackageId``

  • curated_package_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement ( the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.

  • 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



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 2083

def patch_curator_curated_package(name, curated_package_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage::Representation
  command.request_object = curated_package_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::CuratedPackage
  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::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.

Parameters:

  • name (String) —

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

  • pause_finalized_deal_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



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

def pause_finalized_deal(name, pause_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:pause', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::PauseFinalizedDealRequest::Representation
  command.request_object = pause_finalized_deal_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

Parameters:

  • name (String) —

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

  • resume_finalized_deal_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1299

def resume_finalized_deal(name, resume_finalized_deal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:resume', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::ResumeFinalizedDealRequest::Representation
  command.request_object = resume_finalized_deal_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1625

def send_proposal_rfp(buyer, send_rfp_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+buyer}/proposals:sendRfp', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::SendRfpRequest::Representation
  command.request_object = send_rfp_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::Proposal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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_bidder_finalized_deal_ready_to_serve(deal, set_ready_to_serve_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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. In addition, bidders can use the URL path "/v1alpha/bidders/accountId/finalizedDeals/dealId" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

Parameters:

  • deal (String) —

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

  • set_ready_to_serve_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 204

def set_bidder_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, 'v1alpha/{+deal}:setReadyToServe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::SetReadyToServeRequest::Representation
  command.request_object = set_ready_to_serve_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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

#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::AuthorizedbuyersmarketplaceV1alpha::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. In addition, bidders can use the URL path "/v1alpha/bidders/accountId/finalizedDeals/dealId" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

Parameters:

  • deal (String) —

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

  • set_ready_to_serve_request_object (Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 1343

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, 'v1alpha/{+deal}:setReadyToServe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::SetReadyToServeRequest::Representation
  command.request_object = set_ready_to_serve_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::FinalizedDeal::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 328

def subscribe_auction_package(name, subscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:subscribe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::SubscribeAuctionPackageRequest::Representation
  command.request_object = subscribe_auction_package_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 365

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, 'v1alpha/{+auctionPackage}:subscribeClients', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::SubscribeClientsRequest::Representation
  command.request_object = subscribe_clients_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 401

def unsubscribe_auction_package(name, unsubscribe_auction_package_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:unsubscribe', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::UnsubscribeAuctionPackageRequest::Representation
  command.request_object = unsubscribe_auction_package_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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::AuthorizedbuyersmarketplaceV1alpha::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



436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1alpha/service.rb', line 436

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, 'v1alpha/{+auctionPackage}:unsubscribeClients', options)
  command.request_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::UnsubscribeClientsRequest::Representation
  command.request_object = unsubscribe_clients_request_object
  command.response_representation = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::AuctionPackage::Representation
  command.response_class = Google::Apis::AuthorizedbuyersmarketplaceV1alpha::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