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, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 388

def add_deal_association(, creative_id, add_deal_association_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_account_client(account_id, client_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1246

def (, client_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_account_client_invitation(account_id, client_account_id, client_user_invitation_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1371

def (, , client_user_invitation_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_account_creative(account_id, creative_object = nil, duplicate_id_mode: nil, quota_user: nil, fields: 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).

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 180

def (, creative_object = nil, duplicate_id_mode: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_account_filter_set(account_id, filter_set_object = nil, is_transient: nil, quota_user: nil, fields: 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.

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_object = nil, is_transient: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_account_filter_set(account_id, filter_set_id, quota_user: nil, fields: 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.

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_account_client(account_id, client_account_id, quota_user: nil, fields: 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)

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1135

def (, , quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_account_client_invitation(account_id, client_account_id, invitation_id, quota_user: nil, fields: 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)

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, , invitation_id, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_account_client_user(account_id, client_account_id, user_id, quota_user: nil, fields: 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)

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1459

def (, , user_id, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_account_creative(account_id, creative_id, quota_user: nil, fields: 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.

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



294
295
296
297
298
299
300
301
302
303
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 294

def (, creative_id, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_account_filter_set(account_id, filter_set_id, quota_user: nil, fields: 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.

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_client_invitations(account_id, client_account_id, page_size: nil, page_token: nil, quota_user: nil, fields: 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.

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1333

def (, , page_size: nil, page_token: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_client_users(account_id, client_account_id, page_size: nil, page_token: nil, quota_user: nil, fields: 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.

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1421

def (, , page_size: nil, page_token: nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_clients(account_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1175

def (, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_creative_deal_associations(account_id, creative_id, page_token: nil, page_size: nil, query: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

  • 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'

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 351

def (, creative_id, page_token: nil, page_size: nil, query: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['query'] = query unless query.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_creatives(account_id, page_token: nil, page_size: nil, query: nil, quota_user: nil, fields: 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_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.

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

  • 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'

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 140

def (, page_token: nil, page_size: nil, query: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['query'] = query unless query.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_bid_metrics(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_bid_response_errors(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1008

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_bid_responses_without_bids(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1054

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_filtered_bid_creative_details(account_id, filter_set_id, creative_status_id, creative_id, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusAndCreativeBreakdownByDetailResponse

List all details associated with a specific reason for which bids were filtered and a specific creative that was filtered for that reason, 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.

  • creative_id (String) —

    The creative ID for which to retrieve a breakdown by detail.

  • page_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusAndCreativeBreakdownByDetailResponse.nextPageToken returned from the previous call to the accounts.filterSets.filteredBids.creatives.details.list method.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, creative_status_id, creative_id, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{creativeId}/details', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusAndCreativeBreakdownByDetailResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusAndCreativeBreakdownByDetailResponse
  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.params['creativeId'] = creative_id unless creative_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_filtered_bid_creatives(account_id, filter_set_id, creative_status_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 670

def (, filter_set_id, creative_status_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_filtered_bid_details(account_id, filter_set_id, creative_status_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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.

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

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 778

def (, filter_set_id, creative_status_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_filtered_bid_requests(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1100

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_filtered_bids(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 618

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_filtered_impressions(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Adexchangebuyer2V2beta1::ListFilteredImpressionsResponse

List all reasons that caused an impression to be filtered (i.e. not considered as an inventory match), with the number of impressions that were 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_token (String) —

    A token identifying a page of results the server should return. Typically, this is the value of ListFilteredImpressionsResponse.nextPageToken returned from the previous call to the accounts.filterSets.filteredImpressions.list method.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredImpressions', options)
  command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredImpressionsResponse::Representation
  command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredImpressionsResponse
  command.params['accountId'] =  unless .nil?
  command.params['filterSetId'] = filter_set_id unless filter_set_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_impression_metrics(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 917

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_set_losing_bids(account_id, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 872

def (, filter_set_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_account_filter_sets(account_id, page_token: nil, page_size: nil, quota_user: nil, fields: 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_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.rtbBreakout.filterSets.list method.

  • page_size (Fixnum) —

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



535
536
537
538
539
540
541
542
543
544
545
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 535

def (, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#remove_deal_association(account_id, creative_id, remove_deal_association_request_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 424

def remove_deal_association(, creative_id, remove_deal_association_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#stop_watching_creative(account_id, creative_id, stop_watching_creative_request_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 218

def stop_watching_creative(, creative_id, stop_watching_creative_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_account_client(account_id, client_account_id, client_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1211

def (, , client_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_account_client_user(account_id, client_account_id, user_id, client_user_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 1498

def (, , user_id, client_user_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_account_creative(account_id, creative_id, creative_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 80

def (, creative_id, creative_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#watch_creative(account_id, creative_id, watch_creative_request_object = nil, quota_user: nil, fields: 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)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • 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
270
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/service.rb', line 259

def watch_creative(, creative_id, watch_creative_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end