Class: Google::Apis::AdexchangebuyerV1_3::AdExchangeBuyerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/adexchangebuyer_v1_3/service.rb

Overview

Ad Exchange Buyer API

Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.

Examples:

require 'google/apis/adexchangebuyer_v1_3'

Adexchangebuyer = Google::Apis::AdexchangebuyerV1_3 # Alias the module
service = Adexchangebuyer::AdExchangeBuyerService.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

Constructor Details

#initializeAdExchangeBuyerService

Returns a new instance of AdExchangeBuyerService.


52
53
54
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 52

def initialize
  super('https://www.googleapis.com/', 'adexchangebuyer/v1.3/')
end

Instance Attribute Details

#keyString

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/adexchangebuyer_v1_3/service.rb', line 39

def key
  @key
end

#quota_userString

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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.


45
46
47
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 45

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.


50
51
52
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 50

def user_ip
  @user_ip
end

Instance Method Details

#delete_pretargeting_config(account_id, config_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing pretargeting config.

Parameters:

  • account_id (String)

    The account id to delete the pretargeting config for.

  • config_id (String)

    The specific id of the configuration to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


659
660
661
662
663
664
665
666
667
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 659

def delete_pretargeting_config(, config_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'pretargetingconfigs/{accountId}/{configId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['configId'] = config_id unless config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_account(id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Account

Gets one account by ID.

Parameters:

  • id (Fixnum)

    The account id

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    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
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 80

def (id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts/{id}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Account
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_billing_info(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::BillingInfo

Returns the billing information for one account specified by account ID.

Parameters:

  • account_id (Fixnum)

    The account id.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_billing_info(, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'billinginfo/{accountId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::BillingInfo::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::BillingInfo
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_budget(account_id, billing_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Budget

Returns the budget information for the adgroup specified by the accountId and billingId.

Parameters:

  • account_id (String)

    The account id to get the budget information for.

  • billing_id (String)

    The billing id to get the budget information for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    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
304
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 294

def get_budget(, billing_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'billinginfo/{accountId}/{billingId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Budget::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Budget
  command.params['accountId'] =  unless .nil?
  command.params['billingId'] = billing_id unless billing_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_creative(account_id, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Creative

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

Parameters:

  • account_id (Fixnum)

    The id for the account that will serve this creative.

  • buyer_creative_id (String)

    The buyer-specific id for this creative.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


418
419
420
421
422
423
424
425
426
427
428
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 418

def get_creative(, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'creatives/{accountId}/{buyerCreativeId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Creative::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Creative
  command.params['accountId'] =  unless .nil?
  command.params['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_direct_deal(id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::DirectDeal

Gets one direct deal by ID.

Parameters:

  • id (String)

    The direct deal id

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


540
541
542
543
544
545
546
547
548
549
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 540

def get_direct_deal(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'directdeals/{id}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::DirectDeal::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::DirectDeal
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_pretargeting_config(account_id, config_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::PretargetingConfig

Gets a specific pretargeting configuration

Parameters:

  • account_id (String)

    The account id to get the pretargeting config for.

  • config_id (String)

    The specific id of the configuration to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


695
696
697
698
699
700
701
702
703
704
705
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 695

def get_pretargeting_config(, config_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'pretargetingconfigs/{accountId}/{configId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig
  command.params['accountId'] =  unless .nil?
  command.params['configId'] = config_id unless config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_creative(creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Creative

Submit a new creative.

Parameters:

  • creative_object (Google::Apis::AdexchangebuyerV1_3::Creative) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


453
454
455
456
457
458
459
460
461
462
463
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 453

def insert_creative(creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'creatives', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Creative::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Creative
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_pretargeting_config(account_id, pretargeting_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::PretargetingConfig

Inserts a new pretargeting configuration.

Parameters:

  • account_id (String)

    The account id to insert the pretargeting config for.

  • pretargeting_config_object (Google::Apis::AdexchangebuyerV1_3::PretargetingConfig) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


732
733
734
735
736
737
738
739
740
741
742
743
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 732

def insert_pretargeting_config(, pretargeting_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'pretargetingconfigs/{accountId}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::AccountsList

Retrieves the authenticated user's list of accounts.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_accounts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'accounts', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::AccountsList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::AccountsList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_billing_infos(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::BillingInfoList

Retrieves a list of billing information for all accounts of the authenticated user.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


257
258
259
260
261
262
263
264
265
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 257

def list_billing_infos(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'billinginfo', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::BillingInfoList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::BillingInfoList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_creatives(account_id: nil, buyer_creative_id: nil, max_results: nil, page_token: nil, status_filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::CreativesList

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

Parameters:

  • account_id (Array<Fixnum>, Fixnum) (defaults to: nil)

    When specified, only creatives for the given account ids are returned.

  • buyer_creative_id (Array<String>, String) (defaults to: nil)

    When specified, only creatives for the given buyer creative ids are returned.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.

  • status_filter (String) (defaults to: nil)

    When specified, only creatives having the given status are returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 501

def list_creatives(account_id: nil, buyer_creative_id: nil, max_results: nil, page_token: nil, status_filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'creatives', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::CreativesList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::CreativesList
  command.query['accountId'] =  unless .nil?
  command.query['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['statusFilter'] = status_filter unless status_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_direct_deals(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::DirectDealsList

Retrieves the authenticated user's list of direct deals.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_direct_deals(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'directdeals', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::DirectDealsList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::DirectDealsList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_performance_reports(account_id, end_date_time, start_date_time, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::PerformanceReportList

Retrieves the authenticated user's list of performance metrics.

Parameters:

  • account_id (String)

    The account id to get the reports.

  • end_date_time (String)

    The end time of the report in ISO 8601 timestamp format using UTC.

  • start_date_time (String)

    The start time of the report in ISO 8601 timestamp format using UTC.

  • max_results (Fixnum) (defaults to: nil)

    Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

  • page_token (String) (defaults to: nil)

    A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    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
630
631
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 618

def list_performance_reports(, end_date_time, start_date_time, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'performancereport', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::PerformanceReportList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::PerformanceReportList
  command.query['accountId'] =  unless .nil?
  command.query['endDateTime'] = end_date_time unless end_date_time.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startDateTime'] = start_date_time unless start_date_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_pretargeting_configs(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::PretargetingConfigList

Retrieves a list of the authenticated user's pretargeting configurations.

Parameters:

  • account_id (String)

    The account id to get the pretargeting configs for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_pretargeting_configs(, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'pretargetingconfigs/{accountId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfigList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::PretargetingConfigList
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Account

Updates an existing account. This method supports patch semantics.

Parameters:

  • id (Fixnum)

    The account id

  • account_object (Google::Apis::AdexchangebuyerV1_3::Account) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def (id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'accounts/{id}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Account
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_budget(account_id, billing_id, budget_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Budget

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

Parameters:

  • account_id (String)

    The account id associated with the budget being updated.

  • billing_id (String)

    The billing id associated with the budget being updated.

  • budget_object (Google::Apis::AdexchangebuyerV1_3::Budget) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 335

def patch_budget(, billing_id, budget_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'billinginfo/{accountId}/{billingId}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::Budget::Representation
  command.request_object = budget_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Budget::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Budget
  command.params['accountId'] =  unless .nil?
  command.params['billingId'] = billing_id unless billing_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_pretargeting_config(account_id, config_id, pretargeting_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::PretargetingConfig

Updates an existing pretargeting config. This method supports patch semantics.

Parameters:

  • account_id (String)

    The account id to update the pretargeting config for.

  • config_id (String)

    The specific id of the configuration to update.

  • pretargeting_config_object (Google::Apis::AdexchangebuyerV1_3::PretargetingConfig) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


807
808
809
810
811
812
813
814
815
816
817
818
819
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 807

def patch_pretargeting_config(, config_id, pretargeting_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'pretargetingconfigs/{accountId}/{configId}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig
  command.params['accountId'] =  unless .nil?
  command.params['configId'] = config_id unless config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Account

Updates an existing account.

Parameters:

  • id (Fixnum)

    The account id

  • account_object (Google::Apis::AdexchangebuyerV1_3::Account) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


186
187
188
189
190
191
192
193
194
195
196
197
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 186

def (id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'accounts/{id}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Account
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_budget(account_id, billing_id, budget_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::Budget

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

Parameters:

  • account_id (String)

    The account id associated with the budget being updated.

  • billing_id (String)

    The billing id associated with the budget being updated.

  • budget_object (Google::Apis::AdexchangebuyerV1_3::Budget) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 377

def update_budget(, billing_id, budget_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'billinginfo/{accountId}/{billingId}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::Budget::Representation
  command.request_object = budget_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::Budget::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::Budget
  command.params['accountId'] =  unless .nil?
  command.params['billingId'] = billing_id unless billing_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_pretargeting_config(account_id, config_id, pretargeting_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_3::PretargetingConfig

Updates an existing pretargeting config.

Parameters:

  • account_id (String)

    The account id to update the pretargeting config for.

  • config_id (String)

    The specific id of the configuration to update.

  • pretargeting_config_object (Google::Apis::AdexchangebuyerV1_3::PretargetingConfig) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


848
849
850
851
852
853
854
855
856
857
858
859
860
# File 'generated/google/apis/adexchangebuyer_v1_3/service.rb', line 848

def update_pretargeting_config(, config_id, pretargeting_config_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'pretargetingconfigs/{accountId}/{configId}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_3::PretargetingConfig
  command.params['accountId'] =  unless .nil?
  command.params['configId'] = config_id unless config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end