Class: Google::Apis::AdsenseV1_4::AdSenseService

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

Overview

AdSense Management API

Accesses AdSense publishers' inventory and generates performance reports.

Examples:

require 'google/apis/adsense_v1_4'

Adsense = Google::Apis::AdsenseV1_4 # Alias the module
service = Adsense::AdSenseService.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 ⇒ AdSenseService

Returns a new instance of AdSenseService.



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

def initialize
  super('https://www.googleapis.com/', 'adsense/v1.4/')
  @batch_path = 'batch/adsense/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.



38
39
40
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 43

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



47
48
49
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

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

This method returns an undefined value.

Dismiss (delete) the specified alert from the specified publisher AdSense account.

Parameters:

  • account_id (String) —

    Account which contains the ad unit.

  • alert_id (String) —

    Alert to delete.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



402
403
404
405
406
407
408
409
410
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 402

def (, alert_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'accounts/{accountId}/alerts/{alertId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['alertId'] = alert_id unless alert_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_alert(alert_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Dismiss (delete) the specified alert from the publisher's AdSense account.

Parameters:

  • alert_id (String) —

    Alert to delete.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1128

def delete_alert(alert_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'alerts/{alertId}', options)
  command.params['alertId'] = alert_id unless alert_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

#generate_account_report(account_id, start_date, end_date, currency: nil, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, use_timezone_reporting: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::GenerateReportResponse

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

Parameters:

  • account_id (String) —

    Account upon which to report.

  • start_date (String) —

    Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

  • end_date (String) —

    End of the date range to report on in "YYYY-MM-DD" format, inclusive.

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

    Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

    Dimensions to base the report on.

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

    Filters to be run on the report.

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

    Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

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

    The maximum number of rows of report data to return.

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

    Numeric columns to include in the report.

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

    The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

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

    Index of the first row of report data to return.

  • use_timezone_reporting (Boolean) (defaults to: nil) —

    Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 670

def (, start_date, end_date, currency: nil, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, use_timezone_reporting: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'accounts/{accountId}/reports', options)
  else
    command = make_download_command(:get, 'accounts/{accountId}/reports', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::AdsenseV1_4::GenerateReportResponse::Representation
  command.response_class = Google::Apis::AdsenseV1_4::GenerateReportResponse
  command.params['accountId'] =  unless .nil?
  command.query['currency'] = currency unless currency.nil?
  command.query['dimension'] = dimension unless dimension.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['metric'] = metric unless metric.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['startDate'] = start_date unless start_date.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['useTimezoneReporting'] = use_timezone_reporting unless use_timezone_reporting.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

#generate_account_saved_report(account_id, saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::GenerateReportResponse

Generate an AdSense report based on the saved report ID sent in the query parameters.

Parameters:

  • account_id (String) —

    Account to which the saved reports belong.

  • saved_report_id (String) —

    The saved report to retrieve.

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

    Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

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

    The maximum number of rows of report data to return.

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

    Index of the first row of report data to return.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 729

def (, saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/reports/{savedReportId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::GenerateReportResponse::Representation
  command.response_class = Google::Apis::AdsenseV1_4::GenerateReportResponse
  command.params['accountId'] =  unless .nil?
  command.params['savedReportId'] = saved_report_id unless saved_report_id.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['startIndex'] = start_index unless start_index.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

#generate_report(start_date, end_date, account_id: nil, currency: nil, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, use_timezone_reporting: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::GenerateReportResponse

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

Parameters:

  • start_date (String) —

    Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

  • end_date (String) —

    End of the date range to report on in "YYYY-MM-DD" format, inclusive.

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

    Accounts upon which to report.

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

    Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

    Dimensions to base the report on.

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

    Filters to be run on the report.

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

    Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

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

    The maximum number of rows of report data to return.

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

    Numeric columns to include in the report.

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

    The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

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

    Index of the first row of report data to return.

  • use_timezone_reporting (Boolean) (defaults to: nil) —

    Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1439

def generate_report(start_date, end_date, account_id: nil, currency: nil, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, use_timezone_reporting: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'reports', options)
  else
    command = make_download_command(:get, 'reports', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::AdsenseV1_4::GenerateReportResponse::Representation
  command.response_class = Google::Apis::AdsenseV1_4::GenerateReportResponse
  command.query['accountId'] =  unless .nil?
  command.query['currency'] = currency unless currency.nil?
  command.query['dimension'] = dimension unless dimension.nil?
  command.query['endDate'] = end_date unless end_date.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['metric'] = metric unless metric.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['startDate'] = start_date unless start_date.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['useTimezoneReporting'] = use_timezone_reporting unless use_timezone_reporting.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

#generate_saved_report(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::GenerateReportResponse

Generate an AdSense report based on the saved report ID sent in the query parameters.

Parameters:

  • saved_report_id (String) —

    The saved report to retrieve.

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

    Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

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

    The maximum number of rows of report data to return.

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

    Index of the first row of report data to return.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1496

def generate_saved_report(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'reports/{savedReportId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::GenerateReportResponse::Representation
  command.response_class = Google::Apis::AdsenseV1_4::GenerateReportResponse
  command.params['savedReportId'] = saved_report_id unless saved_report_id.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['startIndex'] = start_index unless start_index.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(account_id, tree: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Account

Get information about the selected AdSense account.

Parameters:

  • account_id (String) —

    Account to get information about.

  • tree (Boolean) (defaults to: nil) —

    Whether the tree of sub accounts should be returned.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



78
79
80
81
82
83
84
85
86
87
88
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 78

def (, tree: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Account::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Account
  command.params['accountId'] =  unless .nil?
  command.query['tree'] = tree unless tree.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_ad_unit(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdUnit

Gets the specified ad unit in the specified ad client for the specified account.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client for which to get the ad unit.

  • ad_unit_id (String) —

    Ad unit to retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 231

def (, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdUnit::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdUnit
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['adUnitId'] = ad_unit_id unless ad_unit_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_ad_unit_ad_code(account_id, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdCode

Get ad code for the specified ad unit.

Parameters:

  • account_id (String) —

    Account which contains the ad client.

  • ad_client_id (String) —

    Ad client with contains the ad unit.

  • ad_unit_id (String) —

    Ad unit to get the code for.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 270

def (, ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdCode::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdCode
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['adUnitId'] = ad_unit_id unless ad_unit_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_adclient_ad_code(account_id, ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdCode

Get Auto ad code for a given ad client.

Parameters:

  • account_id (String) —

    Account which contains the ad client.

  • ad_client_id (String) —

    Ad client to get the code for.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, ad_client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adcode', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdCode::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdCode
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_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_custom_channel(account_id, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::CustomChannel

Get the specified custom channel from the specified ad client for the specified account.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client which contains the custom channel.

  • custom_channel_id (String) —

    Custom channel to retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 477

def (, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::CustomChannel::Representation
  command.response_class = Google::Apis::AdsenseV1_4::CustomChannel
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['customChannelId'] = custom_channel_id unless custom_channel_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_saved_ad_style(account_id, saved_ad_style_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::SavedAdStyle

List a specific saved ad style for the specified account.

Parameters:

  • account_id (String) —

    Account for which to get the saved ad style.

  • saved_ad_style_id (String) —

    Saved ad style to retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



810
811
812
813
814
815
816
817
818
819
820
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 810

def (, saved_ad_style_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/savedadstyles/{savedAdStyleId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::SavedAdStyle::Representation
  command.response_class = Google::Apis::AdsenseV1_4::SavedAdStyle
  command.params['accountId'] =  unless .nil?
  command.params['savedAdStyleId'] = saved_ad_style_id unless saved_ad_style_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_ad_code_ad_unit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdCode

Get ad code for the specified ad unit.

Parameters:

  • ad_client_id (String) —

    Ad client with contains the ad unit.

  • ad_unit_id (String) —

    Ad unit to get the code for.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1006

def get_ad_code_ad_unit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}/adcode', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdCode::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdCode
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['adUnitId'] = ad_unit_id unless ad_unit_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_ad_unit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdUnit

Gets the specified ad unit in the specified ad client.

Parameters:

  • ad_client_id (String) —

    Ad client for which to get the ad unit.

  • ad_unit_id (String) —

    Ad unit to retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



970
971
972
973
974
975
976
977
978
979
980
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 970

def get_ad_unit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdUnit::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdUnit
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['adUnitId'] = ad_unit_id unless ad_unit_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_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::CustomChannel

Get the specified custom channel from the specified ad client.

Parameters:

  • ad_client_id (String) —

    Ad client which contains the custom channel.

  • custom_channel_id (String) —

    Custom channel to retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1196

def get_custom_channel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::CustomChannel::Representation
  command.response_class = Google::Apis::AdsenseV1_4::CustomChannel
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['customChannelId'] = custom_channel_id unless custom_channel_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_saved_ad_style(saved_ad_style_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::SavedAdStyle

Get a specific saved ad style from the user's account.

Parameters:

  • saved_ad_style_id (String) —

    Saved ad style to retrieve.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1571

def get_saved_ad_style(saved_ad_style_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'savedadstyles/{savedAdStyleId}', options)
  command.response_representation = Google::Apis::AdsenseV1_4::SavedAdStyle::Representation
  command.response_class = Google::Apis::AdsenseV1_4::SavedAdStyle
  command.params['savedAdStyleId'] = saved_ad_style_id unless saved_ad_style_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_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdClients

List all ad clients in the specified account.

Parameters:

  • account_id (String) —

    Account for which to list ad clients.

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

    The maximum number of ad clients to include in the response, used for paging.

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

def (, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdClients::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdClients
  command.params['accountId'] =  unless .nil?
  command.query['maxResults'] = max_results unless max_results.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_account_ad_unit_custom_channels(account_id, ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::CustomChannels

List all custom channels which the specified ad unit belongs to.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client which contains the ad unit.

  • ad_unit_id (String) —

    Ad unit for which to list custom channels.

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

    The maximum number of custom channels to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 362

def (, ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels', options)
  command.response_representation = Google::Apis::AdsenseV1_4::CustomChannels::Representation
  command.response_class = Google::Apis::AdsenseV1_4::CustomChannels
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_account_ad_units(account_id, ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdUnits

List all ad units in the specified ad client for the specified account.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client for which to list ad units.

  • include_inactive (Boolean) (defaults to: nil) —

    Whether to include inactive ad units. Default: true.

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

    The maximum number of ad units to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 314

def (, ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/adunits', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdUnits::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdUnits
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.query['includeInactive'] = include_inactive unless include_inactive.nil?
  command.query['maxResults'] = max_results unless max_results.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_account_alerts(account_id, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Alerts

List the alerts for the specified AdSense account.

Parameters:

  • account_id (String) —

    Account for which to retrieve the alerts.

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

    The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



438
439
440
441
442
443
444
445
446
447
448
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 438

def (, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/alerts', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Alerts::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Alerts
  command.params['accountId'] =  unless .nil?
  command.query['locale'] = locale unless locale.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_account_custom_channel_ad_units(account_id, ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdUnits

List all ad units in the specified custom channel.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client which contains the custom channel.

  • custom_channel_id (String) —

    Custom channel for which to list ad units.

  • include_inactive (Boolean) (defaults to: nil) —

    Whether to include inactive ad units. Default: true.

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

    The maximum number of ad units to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 568

def (, ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdUnits::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdUnits
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
  command.query['includeInactive'] = include_inactive unless include_inactive.nil?
  command.query['maxResults'] = max_results unless max_results.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_account_custom_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::CustomChannels

List all custom channels in the specified ad client for the specified account.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client for which to list custom channels.

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

    The maximum number of custom channels to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 521

def (, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels', options)
  command.response_representation = Google::Apis::AdsenseV1_4::CustomChannels::Representation
  command.response_class = Google::Apis::AdsenseV1_4::CustomChannels
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_account_payments(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Payments

List the payments for the specified AdSense account.

Parameters:

  • account_id (String) —

    Account for which to retrieve the payments.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



606
607
608
609
610
611
612
613
614
615
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 606

def (, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/payments', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Payments::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Payments
  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_account_saved_ad_styles(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::SavedAdStyles

List all saved ad styles in the specified account.

Parameters:

  • account_id (String) —

    Account for which to list saved ad styles.

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

    The maximum number of saved ad styles to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 851

def (, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/savedadstyles', options)
  command.response_representation = Google::Apis::AdsenseV1_4::SavedAdStyles::Representation
  command.response_class = Google::Apis::AdsenseV1_4::SavedAdStyles
  command.params['accountId'] =  unless .nil?
  command.query['maxResults'] = max_results unless max_results.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_account_saved_reports(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::SavedReports

List all saved reports in the specified AdSense account.

Parameters:

  • account_id (String) —

    Account to which the saved reports belong.

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

    The maximum number of saved reports to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 773

def (, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/reports/saved', options)
  command.response_representation = Google::Apis::AdsenseV1_4::SavedReports::Representation
  command.response_class = Google::Apis::AdsenseV1_4::SavedReports
  command.params['accountId'] =  unless .nil?
  command.query['maxResults'] = max_results unless max_results.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_account_url_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::UrlChannels

List all URL channels in the specified ad client for the specified account.

Parameters:

  • account_id (String) —

    Account to which the ad client belongs.

  • ad_client_id (String) —

    Ad client for which to list URL channels.

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

    The maximum number of URL channels to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 894

def (, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/urlchannels', options)
  command.response_representation = Google::Apis::AdsenseV1_4::UrlChannels::Representation
  command.response_class = Google::Apis::AdsenseV1_4::UrlChannels
  command.params['accountId'] =  unless .nil?
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Accounts

List all accounts available to this AdSense account.

Parameters:

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

    The maximum number of accounts to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



115
116
117
118
119
120
121
122
123
124
125
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 115

def list_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'accounts', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Accounts::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Accounts
  command.query['maxResults'] = max_results unless max_results.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_ad_clients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdClients

List all ad clients in this AdSense account.

Parameters:

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

    The maximum number of ad clients to include in the response, used for paging.

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



934
935
936
937
938
939
940
941
942
943
944
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 934

def list_ad_clients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdClients::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdClients
  command.query['maxResults'] = max_results unless max_results.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_ad_unit_custom_channels(ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::CustomChannels

List all custom channels which the specified ad unit belongs to.

Parameters:

  • ad_client_id (String) —

    Ad client which contains the ad unit.

  • ad_unit_id (String) —

    Ad unit for which to list custom channels.

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

    The maximum number of custom channels to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1092

def list_ad_unit_custom_channels(ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}/customchannels', options)
  command.response_representation = Google::Apis::AdsenseV1_4::CustomChannels::Representation
  command.response_class = Google::Apis::AdsenseV1_4::CustomChannels
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_ad_units(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdUnits

List all ad units in the specified ad client for this AdSense account.

Parameters:

  • ad_client_id (String) —

    Ad client for which to list ad units.

  • include_inactive (Boolean) (defaults to: nil) —

    Whether to include inactive ad units. Default: true.

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

    The maximum number of ad units to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1047

def list_ad_units(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/adunits', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdUnits::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdUnits
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.query['includeInactive'] = include_inactive unless include_inactive.nil?
  command.query['maxResults'] = max_results unless max_results.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_alerts(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Alerts

List the alerts for this AdSense account.

Parameters:

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

    The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1161

def list_alerts(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'alerts', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Alerts::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Alerts
  command.query['locale'] = locale unless locale.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_custom_channel_ad_units(ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::AdUnits

List all ad units in the specified custom channel.

Parameters:

  • ad_client_id (String) —

    Ad client which contains the custom channel.

  • custom_channel_id (String) —

    Custom channel for which to list ad units.

  • include_inactive (Boolean) (defaults to: nil) —

    Whether to include inactive ad units. Default: true.

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

    The maximum number of ad units to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_custom_channel_ad_units(ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}/adunits', options)
  command.response_representation = Google::Apis::AdsenseV1_4::AdUnits::Representation
  command.response_class = Google::Apis::AdsenseV1_4::AdUnits
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
  command.query['includeInactive'] = include_inactive unless include_inactive.nil?
  command.query['maxResults'] = max_results unless max_results.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_custom_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::CustomChannels

List all custom channels in the specified ad client for this AdSense account.

Parameters:

  • ad_client_id (String) —

    Ad client for which to list custom channels.

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

    The maximum number of custom channels to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1237

def list_custom_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/customchannels', options)
  command.response_representation = Google::Apis::AdsenseV1_4::CustomChannels::Representation
  command.response_class = Google::Apis::AdsenseV1_4::CustomChannels
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.query['maxResults'] = max_results unless max_results.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_metadata_dimensions(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Metadata

List the metadata for the dimensions available to this AdSense account.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1316

def list_metadata_dimensions(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'metadata/dimensions', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Metadata::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Metadata
  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_metadata_metrics(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Metadata

List the metadata for the metrics available to this AdSense account.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1346

def list_metadata_metrics(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'metadata/metrics', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Metadata::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Metadata
  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_payments(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::Payments

List the payments for this AdSense account.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1376

def list_payments(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'payments', options)
  command.response_representation = Google::Apis::AdsenseV1_4::Payments::Representation
  command.response_class = Google::Apis::AdsenseV1_4::Payments
  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_ad_styles(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::SavedAdStyles

List all saved ad styles in the user's account.

Parameters:

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

    The maximum number of saved ad styles to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1609

def list_saved_ad_styles(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'savedadstyles', options)
  command.response_representation = Google::Apis::AdsenseV1_4::SavedAdStyles::Representation
  command.response_class = Google::Apis::AdsenseV1_4::SavedAdStyles
  command.query['maxResults'] = max_results unless max_results.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_saved_reports(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::SavedReports

List all saved reports in this AdSense account.

Parameters:

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

    The maximum number of saved reports to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1537

def list_saved_reports(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'reports/saved', options)
  command.response_representation = Google::Apis::AdsenseV1_4::SavedReports::Representation
  command.response_class = Google::Apis::AdsenseV1_4::SavedReports
  command.query['maxResults'] = max_results unless max_results.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_url_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV1_4::UrlChannels

List all URL channels in the specified ad client for this AdSense account.

Parameters:

  • ad_client_id (String) —

    Ad client for which to list URL channels.

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

    The maximum number of URL channels to include in the response, used for paging.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1649

def list_url_channels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'adclients/{adClientId}/urlchannels', options)
  command.response_representation = Google::Apis::AdsenseV1_4::UrlChannels::Representation
  command.response_class = Google::Apis::AdsenseV1_4::UrlChannels
  command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
  command.query['maxResults'] = max_results unless max_results.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