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

Constructor Details

#initialize ⇒ AdSenseService

Returns a new instance of AdSenseService.



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

def initialize
  super('https://www.googleapis.com/', '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 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.



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

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.



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



383
384
385
386
387
388
389
390
391
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 383

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1143

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) —

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

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

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

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



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 663

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 724

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) —

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

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

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

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



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1470

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1529

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



81
82
83
84
85
86
87
88
89
90
91
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 81

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 204

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 245

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_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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1015

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



977
978
979
980
981
982
983
984
985
986
987
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 977

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1215

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 162

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 291

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 557

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 508

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



597
598
599
600
601
602
603
604
605
606
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 597

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 770

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



120
121
122
123
124
125
126
127
128
129
130
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 120

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



939
940
941
942
943
944
945
946
947
948
949
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 939

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1105

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1304

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1258

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1341
1342
1343
1344
1345
1346
1347
1348
1349
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1341

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1373
1374
1375
1376
1377
1378
1379
1380
1381
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1373

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1405

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

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

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'generated/google/apis/adsense_v1_4/service.rb', line 1690

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