Class: Google::Apis::DoubleclicksearchV2::DoubleclicksearchService

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

Overview

Search Ads 360 API

The Search Ads 360 API allows developers to automate uploading conversions and downloading reports from Search Ads 360.

Examples:

require 'google/apis/doubleclicksearch_v2'

Doubleclicksearch = Google::Apis::DoubleclicksearchV2 # Alias the module
service = Doubleclicksearch::DoubleclicksearchService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DoubleclicksearchService

Returns a new instance of DoubleclicksearchService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-doubleclicksearch_v2',
        client_version: Google::Apis::DoubleclicksearchV2::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



41
42
43
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



46
47
48
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#generate_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::Report

Generates and returns a report immediately.

Parameters:

  • report_request_object (Google::Apis::DoubleclicksearchV2::ReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 291

def generate_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'doubleclicksearch/v2/reports/generate', options)
  command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation
  command.request_object = report_request_object
  command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::Report
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_conversion(agency_id, advertiser_id, engine_account_id, end_date, row_count, start_date, start_row, ad_group_id: nil, ad_id: nil, campaign_id: nil, criterion_id: nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::ConversionList

Retrieves a list of conversions from a DoubleClick Search engine account.

Parameters:

  • agency_id (Fixnum) —

    Numeric ID of the agency.

  • advertiser_id (Fixnum) —

    Numeric ID of the advertiser.

  • engine_account_id (Fixnum) —

    Numeric ID of the engine account.

  • end_date (Fixnum) —

    Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.

  • row_count (Fixnum) —

    The number of conversions to return per call.

  • start_date (Fixnum) —

    First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.

  • start_row (Fixnum) —

    The 0-based starting index for retrieving conversions results.

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

    Numeric ID of the ad group.

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

    Numeric ID of the ad.

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

    Numeric ID of the campaign.

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

    Numeric ID of the criterion.

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

    Customer ID of a client account in the new Search Ads 360 experience.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 97

def get_conversion(agency_id, advertiser_id, , end_date, row_count, start_date, start_row, ad_group_id: nil, ad_id: nil, campaign_id: nil, criterion_id: nil, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion', options)
  command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
  command.params['agencyId'] = agency_id unless agency_id.nil?
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.params['engineAccountId'] =  unless .nil?
  command.query['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.query['adId'] = ad_id unless ad_id.nil?
  command.query['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['criterionId'] = criterion_id unless criterion_id.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['rowCount'] = row_count unless row_count.nil?
  command.query['startDate'] = start_date unless start_date.nil?
  command.query['startRow'] = start_row unless start_row.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_conversion_by_customer_id(customer_id, end_date, row_count, start_date, start_row, ad_group_id: nil, ad_id: nil, advertiser_id: nil, agency_id: nil, campaign_id: nil, criterion_id: nil, engine_account_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::ConversionList

Retrieves a list of conversions from a DoubleClick Search engine account.

Parameters:

  • customer_id (String) —

    Customer ID of a client account in the new Search Ads 360 experience.

  • end_date (Fixnum) —

    Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.

  • row_count (Fixnum) —

    The number of conversions to return per call.

  • start_date (Fixnum) —

    First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.

  • start_row (Fixnum) —

    The 0-based starting index for retrieving conversions results.

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

    Numeric ID of the ad group.

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

    Numeric ID of the ad.

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

    Numeric ID of the advertiser.

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

    Numeric ID of the agency.

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

    Numeric ID of the campaign.

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

    Numeric ID of the criterion.

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

    Numeric ID of the engine account.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 160

def get_conversion_by_customer_id(customer_id, end_date, row_count, start_date, start_row, ad_group_id: nil, ad_id: nil, advertiser_id: nil, agency_id: nil, campaign_id: nil, criterion_id: nil, engine_account_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'doubleclicksearch/v2/customer/{customerId}/conversion', options)
  command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
  command.params['customerId'] = customer_id unless customer_id.nil?
  command.query['adGroupId'] = ad_group_id unless ad_group_id.nil?
  command.query['adId'] = ad_id unless ad_id.nil?
  command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['agencyId'] = agency_id unless agency_id.nil?
  command.query['campaignId'] = campaign_id unless campaign_id.nil?
  command.query['criterionId'] = criterion_id unless criterion_id.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['engineAccountId'] =  unless .nil?
  command.query['rowCount'] = row_count unless row_count.nil?
  command.query['startDate'] = start_date unless start_date.nil?
  command.query['startRow'] = start_row unless start_row.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_report(report_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::Report

Polls for the status of a report request.

Parameters:

  • report_id (String) —

    ID of the report request being polled.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



322
323
324
325
326
327
328
329
330
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 322

def get_report(report_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'doubleclicksearch/v2/reports/{reportId}', options)
  command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::Report
  command.params['reportId'] = report_id unless report_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_report_file(report_id, report_fragment, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Downloads a report file encoded in UTF-8.

Parameters:

  • report_id (String) —

    ID of the report.

  • report_fragment (Fixnum) —

    The index of the report fragment to download.

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

  • download_dest (IO, String) (defaults to: nil) —

    IO stream or filename to receive content download

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

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 356

def get_report_file(report_id, report_fragment, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}', options)
  else
    command = make_download_command(:get, 'doubleclicksearch/v2/reports/{reportId}/files/{reportFragment}', options)
    command.download_dest = download_dest
  end
  command.params['reportId'] = report_id unless report_id.nil?
  command.params['reportFragment'] = report_fragment unless report_fragment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_report_id_mapping_file(agency_id, advertiser_id, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::IdMappingFile

Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.

Parameters:

  • agency_id (Fixnum) —

    Legacy SA360 agency ID.

  • advertiser_id (Fixnum) —

    Legacy SA360 advertiser 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.

  • download_dest (IO, String) (defaults to: nil) —

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 397

def get_report_id_mapping_file(agency_id, advertiser_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/idmapping', options)
  else
    command = make_download_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/idmapping', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DoubleclicksearchV2::IdMappingFile::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::IdMappingFile
  command.params['agencyId'] = agency_id unless agency_id.nil?
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::ConversionList

Inserts a batch of new conversions into DoubleClick Search.

Parameters:

  • conversion_list_object (Google::Apis::DoubleclicksearchV2::ConversionList) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 200

def insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'doubleclicksearch/v2/conversion', options)
  command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
  command.request_object = conversion_list_object
  command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::SavedColumnList

Retrieve the list of saved columns for a specified advertiser.

Parameters:

  • agency_id (Fixnum) —

    DS ID of the agency.

  • advertiser_id (Fixnum) —

    DS ID of the advertiser.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



465
466
467
468
469
470
471
472
473
474
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 465

def list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'doubleclicksearch/v2/agency/{agencyId}/advertiser/{advertiserId}/savedcolumns', options)
  command.response_representation = Google::Apis::DoubleclicksearchV2::SavedColumnList::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::SavedColumnList
  command.params['agencyId'] = agency_id unless agency_id.nil?
  command.params['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#request_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::Report

Inserts a report request into the reporting system.

Parameters:

  • report_request_object (Google::Apis::DoubleclicksearchV2::ReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 432

def request_report(report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'doubleclicksearch/v2/reports', options)
  command.request_representation = Google::Apis::DoubleclicksearchV2::ReportRequest::Representation
  command.request_object = report_request_object
  command.response_representation = Google::Apis::DoubleclicksearchV2::Report::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::Report
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::ConversionList

Updates a batch of conversions in DoubleClick Search.

Parameters:

  • conversion_list_object (Google::Apis::DoubleclicksearchV2::ConversionList) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'doubleclicksearch/v2/conversion', options)
  command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
  command.request_object = conversion_list_object
  command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse

Updates the availabilities of a batch of floodlight activities in DoubleClick Search.

Parameters:

  • update_availability_request_object (Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/google/apis/doubleclicksearch_v2/service.rb', line 261

def update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'doubleclicksearch/v2/conversion/updateAvailability', options)
  command.request_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityRequest::Representation
  command.request_object = update_availability_request_object
  command.response_representation = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse::Representation
  command.response_class = Google::Apis::DoubleclicksearchV2::UpdateAvailabilityResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end