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

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

Overview

DoubleClick Search API

Reports and modifies your advertising data in DoubleClick Search (for example, campaigns, ad groups, keywords, and conversions).

Examples:

require 'google/apis/doubleclicksearch_v2'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ DoubleclicksearchService

Returns a new instance of DoubleclicksearchService



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

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

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



39
40
41
 
# File 'generated/google/apis/doubleclicksearch_v2/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/doubleclicksearch_v2/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/doubleclicksearch_v2/service.rb', line 50

def user_ip
  @user_ip
end

Instance Method Details

#generate_report(report_request_object = nil, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def generate_report(report_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.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, fields: nil, quota_user: nil, user_ip: 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) —

    Numeric ID of the ad group.

  • ad_id (Fixnum) —

    Numeric ID of the ad.

  • campaign_id (Fixnum) —

    Numeric ID of the campaign.

  • criterion_id (Fixnum) —

    Numeric ID of the criterion.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'generated/google/apis/doubleclicksearch_v2/service.rb', line 101

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

#get_report(report_id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_report(report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_report_file(report_id, report_fragment, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

  • download_dest (IO, String) —

    IO stream or filename to receive content download

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

    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:



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

def get_report_file(report_id, report_fragment, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command =  make_simple_command(:get, 'reports/{reportId}/files/{reportFragment}', options)
  else
    command = make_download_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



145
146
147
148
149
150
151
152
153
154
155
 
# File 'generated/google/apis/doubleclicksearch_v2/service.rb', line 145

def insert_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_saved_columns(agency_id, advertiser_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_conversion(advertiser_id, agency_id, end_date, engine_account_id, row_count, start_date, start_row, conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DoubleclicksearchV2::ConversionList

Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.

Parameters:

  • advertiser_id (Fixnum) —

    Numeric ID of the advertiser.

  • agency_id (Fixnum) —

    Numeric ID of the agency.

  • end_date (Fixnum) —

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

  • engine_account_id (Fixnum) —

    Numeric ID of the engine account.

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'generated/google/apis/doubleclicksearch_v2/service.rb', line 195

def patch_conversion(advertiser_id, agency_id, end_date, , row_count, start_date, start_row, conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '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['advertiserId'] = advertiser_id unless advertiser_id.nil?
  command.query['agencyId'] = agency_id unless agency_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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#request_report(report_request_object = nil, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



421
422
423
424
425
426
427
428
429
430
431
 
# File 'generated/google/apis/doubleclicksearch_v2/service.rb', line 421

def request_report(report_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



237
238
239
240
241
242
243
244
245
246
247
 
# File 'generated/google/apis/doubleclicksearch_v2/service.rb', line 237

def update_conversion(conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

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

  • user_ip (String) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



273
274
275
276
277
278
279
280
281
282
283
 
# File 'generated/google/apis/doubleclicksearch_v2/service.rb', line 273

def update_conversion_availability(update_availability_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end