Class: Google::Apis::AdsenseV2::AdsenseService

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

Overview

AdSense Management API

The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.

Examples:

require 'google/apis/adsense_v2'

Adsense = Google::Apis::AdsenseV2 # Alias the module
service = Adsense::AdsenseService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdsenseService

Returns a new instance of AdsenseService.



46
47
48
49
50
51
 
# File 'lib/google/apis/adsense_v2/service.rb', line 46

def initialize
  super('https://adsense.googleapis.com/', '',
        client_name: 'google-apis-adsense_v2',
        client_version: Google::Apis::AdsenseV2::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



39
40
41
 
# File 'lib/google/apis/adsense_v2/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

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.



44
45
46
 
# File 'lib/google/apis/adsense_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#generate_account_report(account, currency_code: nil, date_range: nil, dimensions: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, filters: nil, language_code: nil, limit: nil, metrics: nil, order_by: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ReportResult

Generates an ad hoc report.

Parameters:

  • account (String) —

    Required. The account which owns the collection of reports. Format: accounts/ account

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

    The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

    Date range of the report, if unset the range will be considered CUSTOM.

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

    Dimensions to base the report on.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    Filters to be run on the report.

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

    The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP- 47 language code.

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

    The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports. GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.

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

    Required. Reporting metrics.

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

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

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

    Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/google/apis/adsense_v2/service.rb', line 676

def (, currency_code: nil, date_range: nil, dimensions: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, filters: nil, language_code: nil, limit: nil, metrics: nil, order_by: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+account}/reports:generate', options)
  command.response_representation = Google::Apis::AdsenseV2::ReportResult::Representation
  command.response_class = Google::Apis::AdsenseV2::ReportResult
  command.params['account'] =  unless .nil?
  command.query['currencyCode'] = currency_code unless currency_code.nil?
  command.query['dateRange'] = date_range unless date_range.nil?
  command.query['dimensions'] = dimensions unless dimensions.nil?
  command.query['endDate.day'] = end_date_day unless end_date_day.nil?
  command.query['endDate.month'] = end_date_month unless end_date_month.nil?
  command.query['endDate.year'] = end_date_year unless end_date_year.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['metrics'] = metrics unless metrics.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['reportingTimeZone'] = reporting_time_zone unless reporting_time_zone.nil?
  command.query['startDate.day'] = start_date_day unless start_date_day.nil?
  command.query['startDate.month'] = start_date_month unless start_date_month.nil?
  command.query['startDate.year'] = start_date_year unless start_date_year.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_account_report_csv(account, currency_code: nil, date_range: nil, dimensions: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, filters: nil, language_code: nil, limit: nil, metrics: nil, order_by: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::HttpBody

Generates a csv formatted ad hoc report.

Parameters:

  • account (String) —

    Required. The account which owns the collection of reports. Format: accounts/ account

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

    The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

    Date range of the report, if unset the range will be considered CUSTOM.

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

    Dimensions to base the report on.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    Filters to be run on the report.

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

    The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP- 47 language code.

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

    The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports. GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.

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

    Required. Reporting metrics.

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

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

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

    Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/google/apis/adsense_v2/service.rb', line 772

def (, currency_code: nil, date_range: nil, dimensions: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, filters: nil, language_code: nil, limit: nil, metrics: nil, order_by: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+account}/reports:generateCsv', options)
  command.response_representation = Google::Apis::AdsenseV2::HttpBody::Representation
  command.response_class = Google::Apis::AdsenseV2::HttpBody
  command.params['account'] =  unless .nil?
  command.query['currencyCode'] = currency_code unless currency_code.nil?
  command.query['dateRange'] = date_range unless date_range.nil?
  command.query['dimensions'] = dimensions unless dimensions.nil?
  command.query['endDate.day'] = end_date_day unless end_date_day.nil?
  command.query['endDate.month'] = end_date_month unless end_date_month.nil?
  command.query['endDate.year'] = end_date_year unless end_date_year.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['limit'] = limit unless limit.nil?
  command.query['metrics'] = metrics unless metrics.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['reportingTimeZone'] = reporting_time_zone unless reporting_time_zone.nil?
  command.query['startDate.day'] = start_date_day unless start_date_day.nil?
  command.query['startDate.month'] = start_date_month unless start_date_month.nil?
  command.query['startDate.year'] = start_date_year unless start_date_year.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_account_report_saved(name, currency_code: nil, date_range: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, language_code: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ReportResult

Generates a saved report.

Parameters:

  • name (String) —

    Required. Name of the saved report. Format: accounts/account/reports/report

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

    The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

    Date range of the report, if unset the range will be considered CUSTOM.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP- 47 language code.

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

    Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/google/apis/adsense_v2/service.rb', line 850

def (name, currency_code: nil, date_range: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, language_code: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}/saved:generate', options)
  command.response_representation = Google::Apis::AdsenseV2::ReportResult::Representation
  command.response_class = Google::Apis::AdsenseV2::ReportResult
  command.params['name'] = name unless name.nil?
  command.query['currencyCode'] = currency_code unless currency_code.nil?
  command.query['dateRange'] = date_range unless date_range.nil?
  command.query['endDate.day'] = end_date_day unless end_date_day.nil?
  command.query['endDate.month'] = end_date_month unless end_date_month.nil?
  command.query['endDate.year'] = end_date_year unless end_date_year.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['reportingTimeZone'] = reporting_time_zone unless reporting_time_zone.nil?
  command.query['startDate.day'] = start_date_day unless start_date_day.nil?
  command.query['startDate.month'] = start_date_month unless start_date_month.nil?
  command.query['startDate.year'] = start_date_year unless start_date_year.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_account_report_saved_csv(name, currency_code: nil, date_range: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, language_code: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::HttpBody

Generates a csv formatted saved report.

Parameters:

  • name (String) —

    Required. Name of the saved report. Format: accounts/account/reports/report

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

    The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

    Date range of the report, if unset the range will be considered CUSTOM.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP- 47 language code.

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

    Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

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

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/apis/adsense_v2/service.rb', line 923

def (name, currency_code: nil, date_range: nil, end_date_day: nil, end_date_month: nil, end_date_year: nil, language_code: nil, reporting_time_zone: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}/saved:generateCsv', options)
  command.response_representation = Google::Apis::AdsenseV2::HttpBody::Representation
  command.response_class = Google::Apis::AdsenseV2::HttpBody
  command.params['name'] = name unless name.nil?
  command.query['currencyCode'] = currency_code unless currency_code.nil?
  command.query['dateRange'] = date_range unless date_range.nil?
  command.query['endDate.day'] = end_date_day unless end_date_day.nil?
  command.query['endDate.month'] = end_date_month unless end_date_month.nil?
  command.query['endDate.year'] = end_date_year unless end_date_year.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['reportingTimeZone'] = reporting_time_zone unless reporting_time_zone.nil?
  command.query['startDate.day'] = start_date_day unless start_date_day.nil?
  command.query['startDate.month'] = start_date_month unless start_date_month.nil?
  command.query['startDate.year'] = start_date_year unless start_date_year.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::Account

Gets information about the selected AdSense account.

Parameters:

  • name (String) —

    Required. Account to get information about. Format: accounts/account_id

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



73
74
75
76
77
78
79
80
81
 
# File 'lib/google/apis/adsense_v2/service.rb', line 73

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::AdsenseV2::Account::Representation
  command.response_class = Google::Apis::AdsenseV2::Account
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_adclient_adcode(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::AdClientAdCode

Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see About the AdSense code.

Parameters:

  • name (String) —

    Required. Name of the ad client for which to get the adcode. Format: accounts/ account/adclients/adclient

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



185
186
187
188
189
190
191
192
193
 
# File 'lib/google/apis/adsense_v2/service.rb', line 185

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}/adcode', options)
  command.response_representation = Google::Apis::AdsenseV2::AdClientAdCode::Representation
  command.response_class = Google::Apis::AdsenseV2::AdClientAdCode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_adclient_adunit(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::AdUnit

Gets an ad unit from a specified account and ad client.

Parameters:

  • name (String) —

    Required. AdUnit to get information about. Format: accounts/account_id/ adclient/adclient_id/adunit/adunit_id

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



257
258
259
260
261
262
263
264
265
 
# File 'lib/google/apis/adsense_v2/service.rb', line 257

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::AdsenseV2::AdUnit::Representation
  command.response_class = Google::Apis::AdsenseV2::AdUnit
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_adclient_adunit_adcode(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::AdUnitAdCode

Gets the AdSense code for a given ad unit.

Parameters:

  • name (String) —

    Required. Name of the adunit for which to get the adcode. Format: accounts/ account/adclients/adclient/adunits/adunit

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



288
289
290
291
292
293
294
295
296
 
# File 'lib/google/apis/adsense_v2/service.rb', line 288

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}/adcode', options)
  command.response_representation = Google::Apis::AdsenseV2::AdUnitAdCode::Representation
  command.response_class = Google::Apis::AdsenseV2::AdUnitAdCode
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_adclient_customchannel(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::CustomChannel

Gets information about the selected custom channel.

Parameters:

  • name (String) —

    Required. Name of the custom channel. Format: accounts/account/adclients/ adclient/customchannels/customchannel

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::AdsenseV2::CustomChannel::Representation
  command.response_class = Google::Apis::AdsenseV2::CustomChannel
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_site(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::Site

Gets information about the selected site.

Parameters:

  • name (String) —

    Required. Name of the site. Format: accounts/account/sites/site

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/google/apis/adsense_v2/service.rb', line 1004

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::AdsenseV2::Site::Representation
  command.response_class = Google::Apis::AdsenseV2::Site
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_adclient_adunit_linked_custom_channels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListLinkedCustomChannelsResponse

Lists all the custom channels available for an ad unit.

Parameters:

  • parent (String) —

    Required. The ad unit which owns the collection of custom channels. Format: accounts/account/adclients/adclient/adunits/adunit

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

    The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListLinkedCustomChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLinkedCustomChannels must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/google/apis/adsense_v2/service.rb', line 369

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}:listLinkedCustomChannels', options)
  command.response_representation = Google::Apis::AdsenseV2::ListLinkedCustomChannelsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListLinkedCustomChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_adclient_adunits(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListAdUnitsResponse

Lists all ad units under a specified account and ad client.

Parameters:

  • parent (String) —

    Required. The ad client which owns the collection of ad units. Format: accounts/account/adclients/adclient

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

    The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListAdUnits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAdUnits must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/google/apis/adsense_v2/service.rb', line 327

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/adunits', options)
  command.response_representation = Google::Apis::AdsenseV2::ListAdUnitsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListAdUnitsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_adclient_customchannel_linked_ad_units(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListLinkedAdUnitsResponse

Lists all the ad units available for a custom channel.

Parameters:

  • parent (String) —

    Required. The custom channel which owns the collection of ad units. Format: accounts/account/adclients/adclient/customchannels/customchannel

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

    The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListLinkedAdUnits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLinkedAdUnits must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/google/apis/adsense_v2/service.rb', line 484

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}:listLinkedAdUnits', options)
  command.response_representation = Google::Apis::AdsenseV2::ListLinkedAdUnitsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListLinkedAdUnitsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_adclient_customchannels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListCustomChannelsResponse

Lists all the custom channels available in an ad client.

Parameters:

  • parent (String) —

    Required. The ad client which owns the collection of custom channels. Format: accounts/account/adclients/adclient

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

    The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListCustomChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCustomChannels must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/google/apis/adsense_v2/service.rb', line 442

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/customchannels', options)
  command.response_representation = Google::Apis::AdsenseV2::ListCustomChannelsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListCustomChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_adclient_urlchannels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListUrlChannelsResponse

Lists active url channels.

Parameters:

  • parent (String) —

    Required. The ad client which owns the collection of url channels. Format: accounts/account/adclients/adclient

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

    The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListUrlChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUrlChannels must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/google/apis/adsense_v2/service.rb', line 525

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/urlchannels', options)
  command.response_representation = Google::Apis::AdsenseV2::ListUrlChannelsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListUrlChannelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_adclients(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListAdClientsResponse

Lists all the ad clients available in an account.

Parameters:

  • parent (String) —

    Required. The account which owns the collection of ad clients. Format: accounts/account

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

    The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListAdClients call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAdClients must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/google/apis/adsense_v2/service.rb', line 224

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/adclients', options)
  command.response_representation = Google::Apis::AdsenseV2::ListAdClientsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListAdClientsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_alerts(parent, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListAlertsResponse

Lists all the alerts available in an account.

Parameters:

  • parent (String) —

    Required. The account which owns the collection of alerts. Format: accounts/ account

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

    The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an IETF BCP-47 language code.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



563
564
565
566
567
568
569
570
571
572
 
# File 'lib/google/apis/adsense_v2/service.rb', line 563

def (parent, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/alerts', options)
  command.response_representation = Google::Apis::AdsenseV2::ListAlertsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListAlertsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_child_accounts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListChildAccountsResponse

Lists all accounts directly managed by the given AdSense account.

Parameters:

  • parent (String) —

    Required. The parent account, which owns the child accounts. Format: accounts/ account

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

    The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/apis/adsense_v2/service.rb', line 149

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}:listChildAccounts', options)
  command.response_representation = Google::Apis::AdsenseV2::ListChildAccountsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListChildAccountsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_payments(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListPaymentsResponse

Lists all the payments available for an account.

Parameters:

  • parent (String) —

    Required. The account which owns the collection of payments. Format: accounts/ account

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



595
596
597
598
599
600
601
602
603
 
# File 'lib/google/apis/adsense_v2/service.rb', line 595

def (parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/payments', options)
  command.response_representation = Google::Apis::AdsenseV2::ListPaymentsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListPaymentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_report_saveds(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListSavedReportsResponse

Lists saved reports.

Parameters:

  • parent (String) —

    Required. The account which owns the collection of reports. Format: accounts/ account

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

    The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListPayments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPayments must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/google/apis/adsense_v2/service.rb', line 972

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/reports/saved', options)
  command.response_representation = Google::Apis::AdsenseV2::ListSavedReportsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListSavedReportsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_account_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListSitesResponse

Lists all the sites available in an account.

Parameters:

  • parent (String) —

    Required. The account which owns the collection of sites. Format: accounts/ account

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

    The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListSites call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSites must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/google/apis/adsense_v2/service.rb', line 1043

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/sites', options)
  command.response_representation = Google::Apis::AdsenseV2::ListSitesResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListSitesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#list_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdsenseV2::ListAccountsResponse

Lists all accounts available to this user.

Parameters:

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

    The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

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

    A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/google/apis/adsense_v2/service.rb', line 109

def list_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/accounts', options)
  command.response_representation = Google::Apis::AdsenseV2::ListAccountsResponse::Representation
  command.response_class = Google::Apis::AdsenseV2::ListAccountsResponse
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end