Class: Google::Apis::AdmobV1::AdMobService

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

Overview

AdMob API

The Google AdMob API lets you programmatically get reports on earnings.

Examples:

require 'google/apis/admob_v1'

Admob = Google::Apis::AdmobV1 # Alias the module
service = Admob::AdMobService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeAdMobService

Returns a new instance of AdMobService.


45
46
47
48
# File 'generated/google/apis/admob_v1/service.rb', line 45

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

Instance Attribute Details

#keyString

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/admob_v1/service.rb', line 38

def key
  @key
end

#quota_userString

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.


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

def quota_user
  @quota_user
end

Instance Method Details

#generate_mediation_report(parent, generate_mediation_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1::GenerateMediationReportResponse

Generates an AdMob Mediation report based on the provided report specification.

Parameters:

  • parent (String)

    Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654

  • generate_mediation_report_request_object (Google::Apis::AdmobV1::GenerateMediationReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


140
141
142
143
144
145
146
147
148
149
150
# File 'generated/google/apis/admob_v1/service.rb', line 140

def generate_mediation_report(parent, generate_mediation_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/mediationReport:generate', options)
  command.request_representation = Google::Apis::AdmobV1::GenerateMediationReportRequest::Representation
  command.request_object = generate_mediation_report_request_object
  command.response_representation = Google::Apis::AdmobV1::GenerateMediationReportResponse::Representation
  command.response_class = Google::Apis::AdmobV1::GenerateMediationReportResponse
  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

#generate_network_report(parent, generate_network_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1::GenerateNetworkReportResponse

Generates an AdMob Network report based on the provided report specification.

Parameters:

  • parent (String)

    Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654

  • generate_network_report_request_object (Google::Apis::AdmobV1::GenerateNetworkReportRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


175
176
177
178
179
180
181
182
183
184
185
# File 'generated/google/apis/admob_v1/service.rb', line 175

def generate_network_report(parent, generate_network_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/networkReport:generate', options)
  command.request_representation = Google::Apis::AdmobV1::GenerateNetworkReportRequest::Representation
  command.request_object = generate_network_report_request_object
  command.response_representation = Google::Apis::AdmobV1::GenerateNetworkReportResponse::Representation
  command.response_class = Google::Apis::AdmobV1::GenerateNetworkReportResponse
  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

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

Gets information about the specified AdMob publisher account.

Parameters:

  • name (String)

    Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654

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


71
72
73
74
75
76
77
78
79
# File 'generated/google/apis/admob_v1/service.rb', line 71

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AdmobV1::PublisherAccount::Representation
  command.response_class = Google::Apis::AdmobV1::PublisherAccount
  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_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1::ListPublisherAccountsResponse

Lists the AdMob publisher account accessible with the client credential. Currently, all credentials have access to at most one AdMob account.

Parameters:

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of accounts to return.

  • page_token (String) (defaults to: nil)

    The value returned by the last ListPublisherAccountsResponse; indicates that this is a continuation of a prior ListPublisherAccounts call, and that the system should return the next page of data.

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


106
107
108
109
110
111
112
113
114
115
# File 'generated/google/apis/admob_v1/service.rb', line 106

def list_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/accounts', options)
  command.response_representation = Google::Apis::AdmobV1::ListPublisherAccountsResponse::Representation
  command.response_class = Google::Apis::AdmobV1::ListPublisherAccountsResponse
  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