Class: Google::Apis::AdexchangebuyerV1_4::AdExchangeBuyerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/adexchangebuyer_v1_4/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_4'

Adexchangebuyer = Google::Apis::AdexchangebuyerV1_4 # 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

#initialize ⇒ AdExchangeBuyerService

Returns a new instance of AdExchangeBuyerService.



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

def initialize
  super('https://www.googleapis.com/', 'adexchangebuyer/v1.4/')
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/adexchangebuyer_v1_4/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. 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_4/service.rb', line 45

def quota_user
  @quota_user
end

#user_ip ⇒ String

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_4/service.rb', line 50

def user_ip
  @user_ip
end

Instance Method Details

#add_creative_deal(account_id, buyer_creative_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Add a deal id association for the creative.

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.

  • deal_id (String) —

    The id of the deal id to associate with 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:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



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

def add_creative_deal(, buyer_creative_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
  command.params['dealId'] = deal_id unless deal_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

#delete_marketplacedeal_order_deals(proposal_id, delete_order_deals_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::DeleteOrderDealsResponse

Delete the specified deals from the proposal

Parameters:

  • proposal_id (String) —

    The proposalId to delete deals from.

  • delete_order_deals_request_object (Google::Apis::AdexchangebuyerV1_4::DeleteOrderDealsRequest) (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:



667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 667

def delete_marketplacedeal_order_deals(proposal_id, delete_order_deals_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'proposals/{proposalId}/deals/delete', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::DeleteOrderDealsRequest::Representation
  command.request_object = delete_order_deals_request_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::DeleteOrderDealsResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::DeleteOrderDealsResponse
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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:



986
987
988
989
990
991
992
993
994
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 986

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_4::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_4/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_4::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_4::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:



229
230
231
232
233
234
235
236
237
238
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 229

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_4::BillingInfo::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_4::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:



300
301
302
303
304
305
306
307
308
309
310
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 300

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_4::Budget::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_4::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:



463
464
465
466
467
468
469
470
471
472
473
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 463

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_4::Creative::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_pretargeting_config(account_id, config_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::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:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1022

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_4::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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

#get_product(product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::Product

Gets the requested product by id.

Parameters:

  • product_id (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. 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:



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

def get_product(product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'products/{productId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Product::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::Product
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_proposal(proposal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::Proposal

Get a proposal given its id

Parameters:

  • proposal_id (String) —

    Id of the proposal 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:



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

def get_proposal(proposal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'proposals/{proposalId}', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Proposal::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::Proposal
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  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_4::Creative

Submit a new creative.

Parameters:

  • creative_object (Google::Apis::AdexchangebuyerV1_4::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:



498
499
500
501
502
503
504
505
506
507
508
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 498

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_4::Creative::Representation
  command.request_object = creative_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Creative::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_marketplacedeal(proposal_id, add_order_deals_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::AddOrderDealsResponse

Add new deals for the specified proposal

Parameters:

  • proposal_id (String) —

    proposalId for which deals need to be added.

  • add_order_deals_request_object (Google::Apis::AdexchangebuyerV1_4::AddOrderDealsRequest) (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:



705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 705

def insert_marketplacedeal(proposal_id, add_order_deals_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'proposals/{proposalId}/deals/insert', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::AddOrderDealsRequest::Representation
  command.request_object = add_order_deals_request_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::AddOrderDealsResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::AddOrderDealsResponse
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_marketplacenote(proposal_id, add_order_notes_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::AddOrderNotesResponse

Add notes to the proposal

Parameters:

  • proposal_id (String) —

    The proposalId to add notes for.

  • add_order_notes_request_object (Google::Apis::AdexchangebuyerV1_4::AddOrderNotesRequest) (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:



820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 820

def insert_marketplacenote(proposal_id, add_order_notes_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'proposals/{proposalId}/notes/insert', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::AddOrderNotesRequest::Representation
  command.request_object = add_order_notes_request_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::AddOrderNotesResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::AddOrderNotesResponse
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  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_4::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_4::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:



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1059

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_4::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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

#insert_proposal(create_orders_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::CreateOrdersResponse

Create the given list of proposals

Parameters:

  • create_orders_request_object (Google::Apis::AdexchangebuyerV1_4::CreateOrdersRequest) (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:



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1317

def insert_proposal(create_orders_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'proposals/insert', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::CreateOrdersRequest::Representation
  command.request_object = create_orders_request_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::CreateOrdersResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::CreateOrdersResponse
  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_4::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_4/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_4::AccountsList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_4::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:



263
264
265
266
267
268
269
270
271
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 263

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_4::BillingInfoList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_creative_deals(account_id, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::CreativeDealIds

Lists the external deal ids associated with the creative.

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:



591
592
593
594
595
596
597
598
599
600
601
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 591

def list_creative_deals(, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'creatives/{accountId}/{buyerCreativeId}/listDeals', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::CreativeDealIds::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::CreativeDealIds
  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

#list_creatives(account_id: nil, buyer_creative_id: nil, deals_status_filter: nil, max_results: nil, open_auction_status_filter: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::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.

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

    When specified, only creatives having the given deals status 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.

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

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

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

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



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 549

def list_creatives(account_id: nil, buyer_creative_id: nil, deals_status_filter: nil, max_results: nil, open_auction_status_filter: nil, page_token: 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_4::CreativesList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::CreativesList
  command.query['accountId'] =  unless .nil?
  command.query['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
  command.query['dealsStatusFilter'] = deals_status_filter unless deals_status_filter.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['openAuctionStatusFilter'] = open_auction_status_filter unless open_auction_status_filter.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_marketplacedeals(proposal_id, pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::GetOrderDealsResponse

List all the deals for a given proposal

Parameters:

  • proposal_id (String) —

    The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.

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

    Query string to retrieve specific deals.

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



745
746
747
748
749
750
751
752
753
754
755
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 745

def list_marketplacedeals(proposal_id, pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'proposals/{proposalId}/deals', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::GetOrderDealsResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::GetOrderDealsResponse
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['pqlQuery'] = pql_query unless pql_query.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_marketplacenotes(proposal_id, pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::GetOrderNotesResponse

Get all the notes associated with a proposal

Parameters:

  • proposal_id (String) —

    The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.

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

    Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar% "

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



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

def list_marketplacenotes(proposal_id, pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'proposals/{proposalId}/notes', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::GetOrderNotesResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::GetOrderNotesResponse
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['pqlQuery'] = pql_query unless pql_query.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_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_4::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:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 945

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_4::PerformanceReportList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_4::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:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1096

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_4::PretargetingConfigList::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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

#list_pub_profiles(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::GetPublisherProfilesByAccountIdResponse

Gets the requested publisher profile(s) by publisher accountId.

Parameters:

  • account_id (Fixnum) —

    The accountId of the publisher to get profiles 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:



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1517

def list_pub_profiles(, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'publisher/{accountId}/profiles', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::GetPublisherProfilesByAccountIdResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::GetPublisherProfilesByAccountIdResponse
  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, confirm_unsafe_account_change: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::Account

Updates an existing account. This method supports patch semantics.

Parameters:

  • id (Fixnum) —

    The account id

  • account_object (Google::Apis::AdexchangebuyerV1_4::Account) (defaults to: nil)
  • confirm_unsafe_account_change (Boolean) (defaults to: nil) —

    Confirmation for erasing bidder and cookie matching urls.

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



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 150

def (id,  = nil, confirm_unsafe_account_change: 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_4::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::Account
  command.params['id'] = id unless id.nil?
  command.query['confirmUnsafeAccountChange'] =  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_budget(account_id, billing_id, budget_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::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_4::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:



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 341

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_4::Budget::Representation
  command.request_object = budget_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Budget::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_4::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_4::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:



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

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_4::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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

#patch_proposal(proposal_id, revision_number, update_action, proposal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::Proposal

Update the given proposal. This method supports patch semantics.

Parameters:

  • proposal_id (String) —

    The proposal id to update.

  • revision_number (String) —

    The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.

  • update_action (String) —

    The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.

  • proposal_object (Google::Apis::AdexchangebuyerV1_4::Proposal) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. 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:



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1362

def patch_proposal(proposal_id, revision_number, update_action, proposal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'proposals/{proposalId}/{revisionNumber}/{updateAction}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::Proposal::Representation
  command.request_object = proposal_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Proposal::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::Proposal
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.params['revisionNumber'] = revision_number unless revision_number.nil?
  command.params['updateAction'] = update_action unless update_action.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

#proposal_setup_complete(proposal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Update the given proposal to indicate that setup has been completed.

Parameters:

  • proposal_id (String) —

    The proposal id for which the setup is complete

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



1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1436

def proposal_setup_complete(proposal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'proposals/{proposalId}/setupcomplete', options)
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_creative_deal(account_id, buyer_creative_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove a deal id associated with the creative.

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.

  • deal_id (String) —

    The id of the deal id to disassociate with 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:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



631
632
633
634
635
636
637
638
639
640
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 631

def remove_creative_deal(, buyer_creative_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
  command.params['dealId'] = deal_id unless deal_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

#search_products(pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::GetOffersResponse

Gets the requested product.

Parameters:

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

    The pql query used to query for products.

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



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

def search_products(pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'products/search', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::GetOffersResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::GetOffersResponse
  command.query['pqlQuery'] = pql_query unless pql_query.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

#search_proposals(pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::GetOrdersResponse

Search for proposals using pql query

Parameters:

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

    Query string to retrieve specific proposals.

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



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1401

def search_proposals(pql_query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'proposals/search', options)
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::GetOrdersResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::GetOrdersResponse
  command.query['pqlQuery'] = pql_query unless pql_query.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, confirm_unsafe_account_change: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::Account

Updates an existing account.

Parameters:

  • id (Fixnum) —

    The account id

  • account_object (Google::Apis::AdexchangebuyerV1_4::Account) (defaults to: nil)
  • confirm_unsafe_account_change (Boolean) (defaults to: nil) —

    Confirmation for erasing bidder and cookie matching urls.

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



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

def (id,  = nil, confirm_unsafe_account_change: 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_4::Account::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Account::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::Account
  command.params['id'] = id unless id.nil?
  command.query['confirmUnsafeAccountChange'] =  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

#update_budget(account_id, billing_id, budget_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::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_4::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:



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 383

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_4::Budget::Representation
  command.request_object = budget_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Budget::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_marketplace_private_auction_proposal(private_auction_id, update_private_auction_proposal_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Update a given private auction proposal

Parameters:

  • private_auction_id (String) —

    The private auction id to be updated.

  • update_private_auction_proposal_request_object (Google::Apis::AdexchangebuyerV1_4::UpdatePrivateAuctionProposalRequest) (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:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



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

def update_marketplace_private_auction_proposal(private_auction_id, update_private_auction_proposal_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'privateauction/{privateAuctionId}/updateproposal', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::UpdatePrivateAuctionProposalRequest::Representation
  command.request_object = update_private_auction_proposal_request_object
  command.params['privateAuctionId'] = private_auction_id unless private_auction_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_marketplacedeal(proposal_id, edit_all_order_deals_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::EditAllOrderDealsResponse

Replaces all the deals in the proposal with the passed in deals

Parameters:

  • proposal_id (String) —

    The proposalId to edit deals on.

  • edit_all_order_deals_request_object (Google::Apis::AdexchangebuyerV1_4::EditAllOrderDealsRequest) (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:



782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 782

def update_marketplacedeal(proposal_id, edit_all_order_deals_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'proposals/{proposalId}/deals/update', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::EditAllOrderDealsRequest::Representation
  command.request_object = edit_all_order_deals_request_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::EditAllOrderDealsResponse::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::EditAllOrderDealsResponse
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  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_4::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_4::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:



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

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_4::PretargetingConfig::Representation
  command.request_object = pretargeting_config_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::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_proposal(proposal_id, revision_number, update_action, proposal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexchangebuyerV1_4::Proposal

Update the given proposal

Parameters:

  • proposal_id (String) —

    The proposal id to update.

  • revision_number (String) —

    The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.

  • update_action (String) —

    The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.

  • proposal_object (Google::Apis::AdexchangebuyerV1_4::Proposal) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. 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:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'generated/google/apis/adexchangebuyer_v1_4/service.rb', line 1478

def update_proposal(proposal_id, revision_number, update_action, proposal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'proposals/{proposalId}/{revisionNumber}/{updateAction}', options)
  command.request_representation = Google::Apis::AdexchangebuyerV1_4::Proposal::Representation
  command.request_object = proposal_object
  command.response_representation = Google::Apis::AdexchangebuyerV1_4::Proposal::Representation
  command.response_class = Google::Apis::AdexchangebuyerV1_4::Proposal
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.params['revisionNumber'] = revision_number unless revision_number.nil?
  command.params['updateAction'] = update_action unless update_action.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