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

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

Overview

Ad Exchange Buyer API II

Accesses the latest features for managing Ad Exchange 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:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ AdExchangeBuyerIIService

Returns a new instance of AdExchangeBuyerIIService



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

def initialize
  super('https://adexchangebuyer.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



39
40
41
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



44
45
46
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 728

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

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



73
74
75
76
77
78
79
80
81
82
83
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 73

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 221

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) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 477

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_filter_set(account_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

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

    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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 862

def (, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta1/accounts/{accountId}/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['accountId'] =  unless .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_account_filter_set(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to delete.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



898
899
900
901
902
903
904
905
906
907
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 898

def (, filter_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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(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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



107
108
109
110
111
112
113
114
115
116
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 107

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



259
260
261
262
263
264
265
266
267
268
269
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 259

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



347
348
349
350
351
352
353
354
355
356
357
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 347

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



512
513
514
515
516
517
518
519
520
521
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 512

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_filter_set(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to get.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



932
933
934
935
936
937
938
939
940
941
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 932

def (, filter_set_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_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) —

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

  • page_token (String) —

    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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 309

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) —

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

  • page_token (String) —

    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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 396

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, 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) —

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

  • page_token (String) —

    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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



147
148
149
150
151
152
153
154
155
156
157
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 147

def (, page_size: nil, page_token: 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['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) —

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

  • page_token (String) —

    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) —

    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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 787

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) —

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

  • page_token (String) —

    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) —

    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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 571

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_filter_set_bid_metrics(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.bidMetrics.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1017

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_bid_response_errors(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.bidResponseErrors.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1063

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_bid_responses_without_bids(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.bidResponsesWithoutBids.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1109

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_filtered_bid_creatives(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • 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) —

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

  • page_token (String) —

    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 accounts.filterSets.filteredBids.creatives.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1253

def (, filter_set_id, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_id.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_account_filter_set_filtered_bid_details(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • 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) —

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

  • page_token (String) —

    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 accounts.filterSets.filteredBids.details.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1306

def (, filter_set_id, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_id.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_account_filter_set_filtered_bid_requests(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.filteredBidRequests.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1155

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_filtered_bids(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.filteredBids.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_impression_metrics(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.impressionMetrics.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_losing_bids(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.losingBids.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1398

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_set_non_billable_winning_bids(account_id, filter_set_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • filter_set_id (Fixnum) —

    The ID of the filter set to apply.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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 accounts.filterSets.nonBillableWinningBids.list method.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1444

def (, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_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_account_filter_sets(account_id, 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:

  • account_id (Fixnum) —

    Account ID of the buyer.

  • page_size (Fixnum) —

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

  • page_token (String) —

    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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



973
974
975
976
977
978
979
980
981
982
983
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 973

def (, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse
  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

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 824

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

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 183

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 436

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 692

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