Class: Google::Apis::AdmobV1beta::AdMobService

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

Overview

AdMob API

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

Examples:

require 'google/apis/admob_v1beta'

Admob = Google::Apis::AdmobV1beta # 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_v1beta/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-admob_v1beta',
        client_version: Google::Apis::AdmobV1beta::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_v1beta/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_v1beta/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#batch_create_ad_unit_mappings(parent, batch_create_ad_unit_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse

Batch create the ad unit mappings under the specific AdMob account. The maximum allowed batch size is 100. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. The AdMob account which owns this collection of ad unit mappings. Format: accounts/publisher_id See https://support.google.com/admob/answer/ 2784578 for instructions on how to find your AdMob publisher ID.

  • batch_create_ad_unit_mappings_request_object (Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsRequest) (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_v1beta/service.rb', line 229

def batch_create_ad_unit_mappings(parent, batch_create_ad_unit_mappings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/adUnitMappings:batchCreate', options)
  command.request_representation = Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsRequest::Representation
  command.request_object = batch_create_ad_unit_mappings_request_object
  command.response_representation = Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::BatchCreateAdUnitMappingsResponse
  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

#create_account_ad_unit(parent, ad_unit_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::AdUnit

Creates an ad unit under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. Resource name of the account to create the specified ad unit for. Example: accounts/pub-9876543210987654

  • ad_unit_object (Google::Apis::AdmobV1beta::AdUnit) (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_v1beta/service.rb', line 265

def (parent, ad_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/adUnits', options)
  command.request_representation = Google::Apis::AdmobV1beta::AdUnit::Representation
  command.request_object = ad_unit_object
  command.response_representation = Google::Apis::AdmobV1beta::AdUnit::Representation
  command.response_class = Google::Apis::AdmobV1beta::AdUnit
  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

#create_account_ad_unit_ad_unit_mapping(parent, ad_unit_mapping_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::AdUnitMapping

Create an ad unit mapping under the specific AdMob account and ad unit. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. The parent which owns the ad unit mapping. Format: accounts/ publisher_id/adUnits/ad_unit_id

  • ad_unit_mapping_object (Google::Apis::AdmobV1beta::AdUnitMapping) (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



342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 342

def (parent, ad_unit_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/adUnitMappings', options)
  command.request_representation = Google::Apis::AdmobV1beta::AdUnitMapping::Representation
  command.request_object = ad_unit_mapping_object
  command.response_representation = Google::Apis::AdmobV1beta::AdUnitMapping::Representation
  command.response_class = Google::Apis::AdmobV1beta::AdUnitMapping
  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

#create_account_app(parent, app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::App

Creates an app under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. Resource name of the account for which the app is being created. Example: accounts/pub-9876543210987654

  • app_object (Google::Apis::AdmobV1beta::App) (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



428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 428

def (parent, app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/apps', options)
  command.request_representation = Google::Apis::AdmobV1beta::App::Representation
  command.request_object = app_object
  command.response_representation = Google::Apis::AdmobV1beta::App::Representation
  command.response_class = Google::Apis::AdmobV1beta::App
  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

#create_account_mediation_group(parent, mediation_group_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::MediationGroup

Create a mediation group under the specific AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. The parent which owns the mediation group. Format: accounts/ publisher_id

  • mediation_group_object (Google::Apis::AdmobV1beta::MediationGroup) (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



539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 539

def (parent, mediation_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/mediationGroups', options)
  command.request_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
  command.request_object = mediation_group_object
  command.response_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
  command.response_class = Google::Apis::AdmobV1beta::MediationGroup
  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

#create_account_mediation_group_mediation_ab_experiment(parent, mediation_ab_experiment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::MediationAbExperiment

Create an A/B testing experiment for a specified AdMob account and a mediation group. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. The parent which owns the mediation group. Format: accounts/ publisher_id/mediationGroups/mediation_group_id

  • mediation_ab_experiment_object (Google::Apis::AdmobV1beta::MediationAbExperiment) (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



685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 685

def (parent, mediation_ab_experiment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/mediationAbExperiments', options)
  command.request_representation = Google::Apis::AdmobV1beta::MediationAbExperiment::Representation
  command.request_object = mediation_ab_experiment_object
  command.response_representation = Google::Apis::AdmobV1beta::MediationAbExperiment::Representation
  command.response_class = Google::Apis::AdmobV1beta::MediationAbExperiment
  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_campaign_report(parent, generate_campaign_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::GenerateCampaignReportResponse

Generates Campaign Report based on provided specifications.

Parameters:

  • parent (String) —

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

  • generate_campaign_report_request_object (Google::Apis::AdmobV1beta::GenerateCampaignReportRequest) (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



503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 503

def generate_campaign_report(parent, generate_campaign_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/campaignReport:generate', options)
  command.request_representation = Google::Apis::AdmobV1beta::GenerateCampaignReportRequest::Representation
  command.request_object = generate_campaign_report_request_object
  command.response_representation = Google::Apis::AdmobV1beta::GenerateCampaignReportResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::GenerateCampaignReportResponse
  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_mediation_report(parent, generate_mediation_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::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::AdmobV1beta::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



758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 758

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



794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 794

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

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

List the adapters of the ad source.

Parameters:

  • parent (String) —

    Required. The parent which owns this collection of adapters. Format: accounts/ publisher_id/adSources/ad_source_id

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

    The maximum number of adapters to return. If unspecified or 0, at most 10,000 adapters 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) —

    A page token, received from a previous ListAdapters call. Provide this to retrieve the subsequent page.

  • 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



191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 191

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/adapters', options)
  command.response_representation = Google::Apis::AdmobV1beta::ListAdaptersResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::ListAdaptersResponse
  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_ad_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::ListAdSourcesResponse

List the ad sources.

Parameters:

  • parent (String) —

    Required. The parent which owns this collection of ad sources. Format: accounts/publisher_id

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

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

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

    A page token, received from a previous ListAdSources call. Provide this to retrieve the subsequent page.

  • 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



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

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/adSources', options)
  command.response_representation = Google::Apis::AdmobV1beta::ListAdSourcesResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::ListAdSourcesResponse
  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_ad_unit_ad_unit_mappings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse

List ad unit mappings under the specified AdMob account and ad unit. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

    Required. The parent which owns this collection of ad unit mappings. Format: accounts/publisher_id/adUnits/ad_unit_id

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

    The filter string that uses EBNF grammar syntax. Possible field to filter by is: - " DISPLAY_NAME" Possible filter function is: - IN: Used to filter fields that represent a singleton including "DISPLAY_NAME". The filter functions can be added together using AND. OR functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test Ad Unit Mapping 1", "Test Ad Unit Mapping 2")

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

    The maximum number of ad unit mappings to return. If unspecified or 0, at most 10,000 ad unit mappings 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) —

    A page token, received from a previous ListAdUnitMappings call. Provide this to retrieve the subsequent page.

  • 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



391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 391

def (parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/adUnitMappings', options)
  command.response_representation = Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::ListAdUnitMappingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.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_ad_units(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::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



306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 306

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



469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 469

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/apps', options)
  command.response_representation = Google::Apis::AdmobV1beta::ListAppsResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::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_account_mediation_groups(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::ListMediationGroupsResponse

List mediation groups under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • parent (String) —

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

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

    The filter string that uses EBNF grammar syntax. Possible fields to filter by are: - " AD_SOURCE_IDS" - "AD_UNIT_IDS" - "APP_IDS" - "DISPLAY_NAME" - "FORMAT" - " MEDIATION_GROUP_ID" - "PLATFORM" - "STATE" - "TARGETED_REGION_CODES" Possible filter functions are: - IN: Used to filter fields that represent a singleton including "MEDIATION_GROUP_ID", "DISPLAY_NAME", "STATE", "PLATFORM", and " FORMAT". - CONTAINS_ANY: Used to filter fields that represent a collection including "AD_SOURCE_IDS", "AD_UNIT_IDS", "APP_IDS", and " TARGETED_REGION_CODES". The filter functions can be added together using AND. OR functionality is not supported. Example: filter: IN(DISPLAY_NAME, "Test Group 1", "Test Group 2") AND IN(PLATFORM, "ANDROID") AND CONTAINS_ANY( AD_SOURCE_IDS, "5450213213286189855")

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

    The maximum number of mediation groups to return. If unspecified or 0, at most 10,000 mediation groups 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 ListMediationGroupsResponse; indicates that this is a continuation of a prior ListMediationGroups 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



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

def (parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/mediationGroups', options)
  command.response_representation = Google::Apis::AdmobV1beta::ListMediationGroupsResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::ListMediationGroupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.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::AdmobV1beta::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_v1beta/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, 'v1beta/accounts', options)
  command.response_representation = Google::Apis::AdmobV1beta::ListPublisherAccountsResponse::Representation
  command.response_class = Google::Apis::AdmobV1beta::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

#patch_account_mediation_group(name, mediation_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::MediationGroup

Update the specified mediation group under the specified AdMob account. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • name (String) —

    Resource name for this mediation group. Format is: accounts/publisher_id/ mediationGroups/mediation_group_id Example: accounts/pub-9876543210987654/ mediationGroups/0123456789

  • mediation_group_object (Google::Apis::AdmobV1beta::MediationGroup) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    List of mediation group fields to be updated. Updates to repeated fields such as items in a list will fully replace the existing value(s) with the new value( s). Updates to individual values in a map can be done by indexing by the key. The following field masks are supported for mediation group updates: - " mediation_group_lines[\"mediation_group_line_id\"]" clang-format off - " mediation_group_lines[\"mediation_group_line_id\"].ad_unit_mappings[\" ad_unit_id\"]" clang-format on - "mediation_group_lines[\" mediation_group_line_id\"].cpm_micros" - "mediation_group_lines[\" mediation_group_line_id\"].cpm_mode" - "mediation_group_lines[\" mediation_group_line_id\"].state" - "mediation_group_lines[\" mediation_group_line_id\"].display_name" - "targeting.ad_unit_ids" To update a mediation group with a new mediation group line, use a distinct negative number for the "mediation_group_line_id". For Example: update_mask paths: " mediation_group_lines[\"123456789012345\"].cpm_micros"

  • 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



648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 648

def (name, mediation_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
  command.request_object = mediation_group_object
  command.response_representation = Google::Apis::AdmobV1beta::MediationGroup::Representation
  command.response_class = Google::Apis::AdmobV1beta::MediationGroup
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_mediation_ab_experiment(name, stop_mediation_ab_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdmobV1beta::MediationAbExperiment

Stop the mediation A/B experiment and choose a variant. This method has limited access. If you see a 403 permission denied error, please reach out to your account manager for access.

Parameters:

  • name (String) —

    Name of the mediation group, the experiment for which to choose a variant for. Example: accounts/pub-9876543210987654/mediationGroups/0123456789/ mediationAbExperiments

  • stop_mediation_ab_experiment_request_object (Google::Apis::AdmobV1beta::StopMediationAbExperimentRequest) (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



722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/google/apis/admob_v1beta/service.rb', line 722

def stop_mediation_ab_experiment(name, stop_mediation_ab_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+name}:stop', options)
  command.request_representation = Google::Apis::AdmobV1beta::StopMediationAbExperimentRequest::Representation
  command.request_object = stop_mediation_ab_experiment_request_object
  command.response_representation = Google::Apis::AdmobV1beta::MediationAbExperiment::Representation
  command.response_class = Google::Apis::AdmobV1beta::MediationAbExperiment
  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