Class: Google::Apis::Adexchangebuyer2V2beta1::AdExchangeBuyerIIService

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

Overview

Ad Exchange Buyer API II

Accesses the latest features for managing Authorized Buyers accounts, Real- Time Bidding configurations and auction metrics, and Marketplace programmatic deals.

Examples:

require 'google/apis/adexchangebuyer2_v2beta1'

Adexchangebuyer2 = Google::Apis::Adexchangebuyer2V2beta1 # Alias the module
service = Adexchangebuyer2::AdExchangeBuyerIIService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdExchangeBuyerIIService

Returns a new instance of AdExchangeBuyerIIService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-adexchangebuyer2_v2beta1',
        client_version: Google::Apis::Adexchangebuyer2V2beta1::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.



42
43
44
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 42

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.



47
48
49
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

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

Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an ABORTED error message will be returned. This call updates the proposal_state from PROPOSED to BUYER_ACCEPTED, or from SELLER_ACCEPTED to FINALIZED. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The ID of the proposal to accept.

  • accept_proposal_request_object (Google::Apis::Adexchangebuyer2V2beta1::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



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

def accept_proposal(, proposal_id, accept_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:accept', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AcceptProposalRequest::Representation
  command.request_object = accept_proposal_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.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_deal_association(account_id, creative_id, add_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Associate an existing deal with a creative.

Parameters:

  • account_id (String) —

    The account the creative belongs to.

  • creative_id (String) —

    The ID of the creative associated with the deal.

  • add_deal_association_request_object (Google::Apis::Adexchangebuyer2V2beta1::AddDealAssociationRequest) (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



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

def add_deal_association(, creative_id, add_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AddDealAssociationRequest::Representation
  command.request_object = add_deal_association_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.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(account_id, proposal_id, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Note

Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The ID of the proposal to attach the note to.

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



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1084

def add_proposal_note(, proposal_id, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:addNote', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AddNoteRequest::Representation
  command.request_object = add_note_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Note::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Note
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.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(account_id, proposal_id, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The ID of the proposal to cancel negotiation for.

  • cancel_negotiation_request_object (Google::Apis::Adexchangebuyer2V2beta1::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



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1122

def cancel_proposal_negotiation(, proposal_id, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:cancelNegotiation', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::CancelNegotiationRequest::Representation
  command.request_object = cancel_negotiation_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_proposal_setup(account_id, proposal_id, complete_setup_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API. This call updates the is_setup_completed field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To mark an individual deal as ready to serve, call buyers. finalizedDeals.setReadyToServe in the Marketplace API.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The ID of the proposal to mark as setup completed.

  • complete_setup_request_object (Google::Apis::Adexchangebuyer2V2beta1::CompleteSetupRequest) (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



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

def complete_proposal_setup(, proposal_id, complete_setup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:completeSetup', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::CompleteSetupRequest::Representation
  command.request_object = complete_setup_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.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_account_client(account_id, client_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Client

Creates a new client buyer.

Parameters:

  • account_id (Fixnum) —

    Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)

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



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 78

def (, client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/clients', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client
  command.params['accountId'] =  unless .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_account_client_invitation(account_id, client_account_id, client_user_invitation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation

Creates and sends out an email invitation to access an Ad Exchange client buyer account.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user should be associated with. (required)

  • client_user_invitation_object (Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation) (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



229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 229

def (, , client_user_invitation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
  command.request_object = client_user_invitation_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .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_account_creative(account_id, creative_object = nil, duplicate_id_mode: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Creative

Creates a creative.

Parameters:

  • account_id (String) —

    The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

  • creative_object (Google::Apis::Adexchangebuyer2V2beta1::Creative) (defaults to: nil)
  • duplicate_id_mode (String) (defaults to: nil) —

    Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).

  • 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



472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 472

def (, creative_object = nil, duplicate_id_mode: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative
  command.params['accountId'] =  unless .nil?
  command.query['duplicateIdMode'] = duplicate_id_mode unless duplicate_id_mode.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_account_proposal(account_id, proposal_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_object (Google::Apis::Adexchangebuyer2V2beta1::Proposal) (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



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1201

def (, proposal_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.request_object = proposal_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .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_bidder_account_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Creates the specified filter set for the account with the given account ID.

Parameters:

  • owner_name (String) —

    Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

  • filter_set_object (Google::Apis::Adexchangebuyer2V2beta1::FilterSet) (defaults to: nil)
  • is_transient (Boolean) (defaults to: nil) —

    Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.

  • 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



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1519

def (owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.request_object = filter_set_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  command.params['ownerName'] = owner_name unless owner_name.nil?
  command.query['isTransient'] = is_transient unless is_transient.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_bidder_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Creates the specified filter set for the account with the given account ID.

Parameters:

  • owner_name (String) —

    Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

  • filter_set_object (Google::Apis::Adexchangebuyer2V2beta1::FilterSet) (defaults to: nil)
  • is_transient (Boolean) (defaults to: nil) —

    Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.

  • 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



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2133

def create_bidder_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.request_object = filter_set_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  command.params['ownerName'] = owner_name unless owner_name.nil?
  command.query['isTransient'] = is_transient unless is_transient.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_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Creates the specified filter set for the account with the given account ID.

Parameters:

  • owner_name (String) —

    Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

  • filter_set_object (Google::Apis::Adexchangebuyer2V2beta1::FilterSet) (defaults to: nil)
  • is_transient (Boolean) (defaults to: nil) —

    Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.

  • 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



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2747

def create_buyer_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.request_object = filter_set_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  command.params['ownerName'] = owner_name unless owner_name.nil?
  command.query['isTransient'] = is_transient unless is_transient.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_bidder_account_filter_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Deletes the requested filter set from the account with the given account ID.

Parameters:

  • name (String) —

    Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/ filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • 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



1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1556

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

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

Deletes the requested filter set from the account with the given account ID.

Parameters:

  • name (String) —

    Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/ filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • 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



2170
2171
2172
2173
2174
2175
2176
2177
2178
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2170

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

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

Deletes the requested filter set from the account with the given account ID.

Parameters:

  • name (String) —

    Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/ filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • 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



2784
2785
2786
2787
2788
2789
2790
2791
2792
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2784

def delete_buyer_filter_set(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::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_account_client(account_id, client_account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Client

Gets a client buyer with a given client account ID.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer to retrieve. (required)

  • 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



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 112

def (, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .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_account_client_invitation(account_id, client_account_id, invitation_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation

Retrieves an existing client user invitation.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)

  • invitation_id (Fixnum) —

    Numerical identifier of the user invitation to retrieve. (required)

  • 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



267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 267

def (, , invitation_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.params['invitationId'] = invitation_id unless invitation_id.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_account_client_user(account_id, client_account_id, user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUser

Retrieves an existing client user.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)

  • user_id (Fixnum) —

    Numerical identifier of the user to retrieve. (required)

  • 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



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

def (, , user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUser
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.params['userId'] = user_id unless user_id.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_account_creative(account_id, creative_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Creative

Gets a creative.

Parameters:

  • account_id (String) —

    The account the creative belongs to.

  • creative_id (String) —

    The ID of the creative to retrieve.

  • 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



507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 507

def (, creative_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives/{creativeId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.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_account_product(account_id, product_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Product

Gets the requested product by ID.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • product_id (String) —

    The ID for the product to get the head revision for.

  • 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



963
964
965
966
967
968
969
970
971
972
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 963

def (, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/products/{productId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Product::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Product
  command.params['accountId'] =  unless .nil?
  command.params['productId'] = product_id unless product_id.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_account_proposal(account_id, proposal_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Gets a proposal given its ID. The proposal is returned at its head revision.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The unique ID of the proposal

  • 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



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

def (, proposal_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/proposals/{proposalId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.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_account_publisher_profile(account_id, publisher_profile_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::PublisherProfile

Gets the requested publisher profile by id.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • publisher_profile_id (String) —

    The id for the publisher profile to get.

  • 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



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1443

def (, publisher_profile_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/publisherProfiles/{publisherProfileId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::PublisherProfile::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::PublisherProfile
  command.params['accountId'] =  unless .nil?
  command.params['publisherProfileId'] = publisher_profile_id unless publisher_profile_id.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_bidder_account_filter_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Retrieves the requested filter set for the account with the given account ID.

Parameters:

  • name (String) —

    Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/ accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/ filterSets/abc

  • 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



1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1591

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  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_bidder_filter_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Retrieves the requested filter set for the account with the given account ID.

Parameters:

  • name (String) —

    Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/ accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/ filterSets/abc

  • 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



2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2205

def get_bidder_filter_set(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  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_filter_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Retrieves the requested filter set for the account with the given account ID.

Parameters:

  • name (String) —

    Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/ accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/ filterSets/abc

  • 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



2819
2820
2821
2822
2823
2824
2825
2826
2827
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2819

def get_buyer_filter_set(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  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_account_client_invitations(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse

Lists all the client users invitations for a client with a given account ID.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (String) —

    Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the - character to list all the invitations for all the clients of a given sponsor buyer.

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

    Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.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



311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 311

def (, , page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .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_account_client_users(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse

Lists all the known client users for a specified sponsor buyer account ID.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the sponsor buyer of the client to list users for. ( required)

  • client_account_id (String) —

    The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the - character to list all the client users for all the clients of a given sponsor buyer.

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

    Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

  • 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 accounts.clients.users.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



394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 394

def (, , page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUsersResponse
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .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_account_clients(account_id, page_size: nil, page_token: nil, partner_client_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse

Lists all the clients for the current sponsor buyer.

Parameters:

  • account_id (Fixnum) —

    Unique numerical account ID of the sponsor buyer to list the clients for.

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

    Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

  • 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 accounts.clients.list method.

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

    Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.

  • 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



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 154

def (, page_size: nil, page_token: nil, partner_client_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse
  command.params['accountId'] =  unless .nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['partnerClientId'] = partner_client_id unless partner_client_id.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_account_creative_deal_associations(account_id, creative_id, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse

List all creative-deal associations.

Parameters:

  • account_id (String) —

    The account to list the associations from. Specify "-" to list all creatives the current user has access to.

  • creative_id (String) —

    The creative ID to list the associations from. Specify "-" to list all creatives under the above account.

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

    Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.

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

    An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=account_id_string - creativeId=creative_id_string - dealsId=* deals_id_string* - dealsStatus:approved, conditionally_approved, disapproved, not_checked - openAuctionStatus:approved, conditionally_approved, disapproved, not_checked Example: 'dealsId=12345 AND dealsStatus:disapproved'

  • 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



760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 760

def (, creative_id, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListDealAssociationsResponse
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.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_account_creatives(account_id, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse

Lists creatives.

Parameters:

  • account_id (String) —

    The account to list the creatives from. Specify "-" to list all creatives the current user has access to.

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

    Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.

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

    An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=* account_id_string* - creativeId=creative_id_string - dealsStatus: approved, conditionally_approved, disapproved, not_checked - openAuctionStatus: approved, conditionally_approved, disapproved, not_checked - attribute: a numeric attribute from the list of attributes - disapprovalReason: a reason from DisapprovalReason Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'

  • 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



557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 557

def (, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/creatives', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativesResponse
  command.params['accountId'] =  unless .nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.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_account_finalized_proposals(account_id, filter: nil, filter_syntax: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse

List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

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

    An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.

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

    Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

  • 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



843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 843

def (, filter: nil, filter_syntax: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/finalizedProposals', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse
  command.params['accountId'] =  unless .nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['filterSyntax'] = filter_syntax unless filter_syntax.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_account_products(account_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListProductsResponse

List all products visible to the buyer (optionally filtered by the specified PQL query).

Parameters:

  • account_id (String) —

    Account ID of the buyer.

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

    An optional PQL query used to query for products. See https://developers. google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion. inclusions, cannot be filtered.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    The page token as returned from ListProductsResponse.

  • 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



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1005

def (, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/products', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListProductsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListProductsResponse
  command.params['accountId'] =  unless .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_account_proposals(account_id, filter: nil, filter_syntax: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse

List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

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

    An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.

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

    Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

  • 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



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1282

def (, filter: nil, filter_syntax: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/proposals', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse
  command.params['accountId'] =  unless .nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['filterSyntax'] = filter_syntax unless filter_syntax.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_account_publisher_profiles(account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse

List all publisher profiles visible to the buyer

Parameters:

  • account_id (String) —

    Account ID of the buyer.

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

    Specify the number of results to include per page.

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

    The page token as return from 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



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1478

def (, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/publisherProfiles', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse
  command.params['accountId'] =  unless .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_account_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse

Lists all metrics that are measured in terms of number of bids.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.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



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1676

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse

List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.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



1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1721

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse

List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.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



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1766

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse

List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • creative_status_id (Fixnum) —

    The ID of the creative status for which to retrieve a breakdown by creative. See creative-status-codes.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse. nextPageToken returned from the previous call to the filteredBids.creatives. 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



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1906

def (filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.nil?
  command.params['creativeStatusId'] = creative_status_id unless creative_status_id.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_account_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse

List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • creative_status_id (Fixnum) —

    The ID of the creative status for which to retrieve a breakdown by detail. See creative-status-codes. Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.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



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1957

def (filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.nil?
  command.params['creativeStatusId'] = creative_status_id unless creative_status_id.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_account_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse

List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.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



1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1811

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse

List all reasons for which bids were filtered, with the number of bids filtered for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.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



1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1856

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse

Lists all metrics that are measured in terms of number of impressions.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.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



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2002

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse

List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.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



2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2047

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse

List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.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



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2092

def (filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_account_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse

Lists all filter sets for the account with the given account ID.

Parameters:

  • owner_name (String) —

    Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.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



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1632

def (owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse
  command.params['ownerName'] = owner_name unless owner_name.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_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse

Lists all metrics that are measured in terms of number of bids.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.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



2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2290

def list_bidder_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse

List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.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



2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2335

def list_bidder_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse

List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.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



2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2380

def list_bidder_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse

List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • creative_status_id (Fixnum) —

    The ID of the creative status for which to retrieve a breakdown by creative. See creative-status-codes.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse. nextPageToken returned from the previous call to the filteredBids.creatives. 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



2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2520

def list_bidder_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.nil?
  command.params['creativeStatusId'] = creative_status_id unless creative_status_id.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_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse

List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • creative_status_id (Fixnum) —

    The ID of the creative status for which to retrieve a breakdown by detail. See creative-status-codes. Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.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



2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2571

def list_bidder_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.nil?
  command.params['creativeStatusId'] = creative_status_id unless creative_status_id.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_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse

List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.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



2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2425

def list_bidder_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse

List all reasons for which bids were filtered, with the number of bids filtered for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.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



2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2470

def list_bidder_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse

Lists all metrics that are measured in terms of number of impressions.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.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



2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2616

def list_bidder_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse

List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.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



2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2661

def list_bidder_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse

List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.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



2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2706

def list_bidder_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse

Lists all filter sets for the account with the given account ID.

Parameters:

  • owner_name (String) —

    Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.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



2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2246

def list_bidder_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse
  command.params['ownerName'] = owner_name unless owner_name.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_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse

Lists all metrics that are measured in terms of number of bids.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.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



2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2904

def list_buyer_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse

List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.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



2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2949

def list_buyer_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse

List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.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



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2994

def list_buyer_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse

List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • creative_status_id (Fixnum) —

    The ID of the creative status for which to retrieve a breakdown by creative. See creative-status-codes.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse. nextPageToken returned from the previous call to the filteredBids.creatives. 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



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3134

def list_buyer_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.nil?
  command.params['creativeStatusId'] = creative_status_id unless creative_status_id.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_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse

List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

  • creative_status_id (Fixnum) —

    The ID of the creative status for which to retrieve a breakdown by detail. See creative-status-codes. Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.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



3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3185

def list_buyer_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.nil?
  command.params['creativeStatusId'] = creative_status_id unless creative_status_id.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_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse

List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.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



3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3039

def list_buyer_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse

List all reasons for which bids were filtered, with the number of bids filtered for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.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



3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3084

def list_buyer_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse

Lists all metrics that are measured in terms of number of impressions.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.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



3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3230

def list_buyer_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse

List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.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



3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3275

def list_buyer_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse

List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.

Parameters:

  • filter_set_name (String) —

    Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/ filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.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



3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 3320

def list_buyer_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse
  command.params['filterSetName'] = filter_set_name unless filter_set_name.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_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse

Lists all filter sets for the account with the given account ID.

Parameters:

  • owner_name (String) —

    Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

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

    Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

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

    A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.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



2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 2860

def list_buyer_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse
  command.params['ownerName'] = owner_name unless owner_name.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

#pause_finalized_proposal_proposal_deals(account_id, proposal_id, pause_proposal_deals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The proposal_id of the proposal containing the deals.

  • pause_proposal_deals_request_object (Google::Apis::Adexchangebuyer2V2beta1::PauseProposalDealsRequest) (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



886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 886

def pause_finalized_proposal_proposal_deals(, proposal_id, pause_proposal_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::PauseProposalDealsRequest::Representation
  command.request_object = pause_proposal_deals_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.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_proposal(account_id, proposal_id, pause_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Update the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The ID of the proposal to pause.

  • pause_proposal_request_object (Google::Apis::Adexchangebuyer2V2beta1::PauseProposalRequest) (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



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1323

def pause_proposal(, proposal_id, pause_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:pause', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::PauseProposalRequest::Representation
  command.request_object = pause_proposal_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_deal_association(account_id, creative_id, remove_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Remove the association between a deal and a creative.

Parameters:

  • account_id (String) —

    The account the creative belongs to.

  • creative_id (String) —

    The ID of the creative associated with the deal.

  • remove_deal_association_request_object (Google::Apis::Adexchangebuyer2V2beta1::RemoveDealAssociationRequest) (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



797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 797

def remove_deal_association(, creative_id, remove_deal_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::RemoveDealAssociationRequest::Representation
  command.request_object = remove_deal_association_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.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_proposal_proposal_deals(account_id, proposal_id, resume_proposal_deals_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Update given deals to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The proposal_id of the proposal containing the deals.

  • resume_proposal_deals_request_object (Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalDealsRequest) (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



928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 928

def resume_finalized_proposal_proposal_deals(, proposal_id, resume_proposal_deals_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalDealsRequest::Representation
  command.request_object = resume_proposal_deals_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.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_proposal(account_id, proposal_id, resume_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Update the given proposal to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all deals in the proposal. Note that if the has_seller_paused bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The ID of the proposal to resume.

  • resume_proposal_request_object (Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalRequest) (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



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1364

def resume_proposal(, proposal_id, resume_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:resume', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalRequest::Representation
  command.request_object = resume_proposal_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_watching_creative(account_id, creative_id, stop_watching_creative_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.

Parameters:

  • account_id (String) —

    The account of the creative to stop notifications for.

  • creative_id (String) —

    The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.

  • stop_watching_creative_request_object (Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest) (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



595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 595

def stop_watching_creative(, creative_id, stop_watching_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest::Representation
  command.request_object = stop_watching_creative_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_client(account_id, client_account_id, client_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Client

Updates an existing client buyer.

Parameters:

  • account_id (Fixnum) —

    Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)

  • client_account_id (Fixnum) —

    Unique numerical account ID of the client to update. (required)

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



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

def (, , client_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.request_object = client_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Client
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_client_user(account_id, client_account_id, user_id, client_user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ClientUser

Updates an existing client user. Only the user status can be changed on update.

Parameters:

  • account_id (Fixnum) —

    Numerical account ID of the client's sponsor buyer. (required)

  • client_account_id (Fixnum) —

    Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)

  • user_id (Fixnum) —

    Numerical identifier of the user to retrieve. (required)

  • client_user_object (Google::Apis::Adexchangebuyer2V2beta1::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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 433

def (, , user_id, client_user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation
  command.request_object = client_user_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ClientUser::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ClientUser
  command.params['accountId'] =  unless .nil?
  command.params['clientAccountId'] =  unless .nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_creative(account_id, creative_id, creative_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Creative

Updates a creative.

Parameters:

  • account_id (String) —

    The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

  • creative_id (String) —

    The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.

  • creative_object (Google::Apis::Adexchangebuyer2V2beta1::Creative) (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



633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 633

def (, creative_id, creative_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/creatives/{creativeId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Creative::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Creative
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_account_proposal(account_id, proposal_id, proposal_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Proposal

Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision, an ABORTED error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a deal_id, the server will assign a new unique ID and create the deal. If passed-in deal has a deal_id, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a deal_id not present at head.

Parameters:

  • account_id (String) —

    Account ID of the buyer.

  • proposal_id (String) —

    The unique ID of the proposal.

  • proposal_object (Google::Apis::Adexchangebuyer2V2beta1::Proposal) (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



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1408

def (, proposal_id, proposal_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/proposals/{proposalId}', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.request_object = proposal_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
  command.params['accountId'] =  unless .nil?
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#watch_creative(account_id, creative_id, watch_creative_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::Empty

Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.

Parameters:

  • account_id (String) —

    The account of the creative to watch.

  • creative_id (String) —

    The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.

  • watch_creative_request_object (Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest) (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



673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/apis/adexchangebuyer2_v2beta1/service.rb', line 673

def watch_creative(, creative_id, watch_creative_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/creatives/{creativeId}:watch', options)
  command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest::Representation
  command.request_object = watch_creative_request_object
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end