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

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

Overview

AdMob API

The AdMob API allows publishers to programmatically get information about their AdMob account.

Examples:

require 'google/apis/admob_v1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://admob.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdMobService

Returns a new instance of AdMobService.



48
49
50
51
52
53
 
# File 'lib/google/apis/admob_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-admob_v1',
        client_version: Google::Apis::AdmobV1::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.



41
42
43
 
# File 'lib/google/apis/admob_v1/service.rb', line 41

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.



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

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. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.

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:

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



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/admob_v1/service.rb', line 229

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. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.

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:

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



265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/google/apis/admob_v1/service.rb', line 265

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:

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



76
77
78
79
80
81
82
83
84
 
# File 'lib/google/apis/admob_v1/service.rb', line 76

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_account_ad_units(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1::ListAdUnitsResponse

List the ad units under the specified AdMob account.

Parameters:

  • parent (String) —

    Required. Resource name of the account to list ad units for. Example: accounts/ pub-9876543210987654

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

    The maximum number of ad units to return. If unspecified or 0, at most 10,000 ad units will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.

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

    The value returned by the last ListAdUnitsResponse; indicates that this is a continuation of a prior ListAdUnits 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:

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



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/google/apis/admob_v1/service.rb', line 152

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

List the apps under the specified AdMob account.

Parameters:

  • parent (String) —

    Required. Resource name of the account to list apps for. Example: accounts/pub- 9876543210987654

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

    The maximum number of apps to return. If unspecified or 0, at most 10,000 apps will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.

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

    The value returned by the last ListAppsResponse; indicates that this is a continuation of a prior ListApps 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:

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



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/apis/admob_v1/service.rb', line 193

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

Lists the AdMob publisher account that was most recently signed in to from the AdMob UI. For more information, see https://support.google.com/admob/answer/ 10243672.

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:

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



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/admob_v1/service.rb', line 112

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