Class: Google::Apis::AndroidpublisherV3::AndroidPublisherService

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

Overview

Google Play Android Developer API

Lets Android application developers access their Google Play accounts. At a high level, the expected workflow is to "insert" an Edit, make changes as necessary, and then "commit" it.

Examples:

require 'google/apis/androidpublisher_v3'

Androidpublisher = Google::Apis::AndroidpublisherV3 # Alias the module
service = Androidpublisher::AndroidPublisherService.new

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAndroidPublisherService

Returns a new instance of AndroidPublisherService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-androidpublisher_v3',
        client_version: Google::Apis::AndroidpublisherV3::GEM_VERSION)
  @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.



42
43
44
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 42

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.



47
48
49
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_purchase_product(package_name, product_id, token, product_purchases_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Acknowledges a purchase of an inapp item.

Parameters:

  • package_name (String)

    The package name of the application the inapp product was sold in (for example, 'com.some.thing').

  • product_id (String)

    The inapp product SKU (for example, 'com.some.thing.inapp1').

  • token (String)

    The token provided to the user's device when the inapp product was purchased.

  • product_purchases_acknowledge_request_object (Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4884

def acknowledge_purchase_product(package_name, product_id, token, product_purchases_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest::Representation
  command.request_object = product_purchases_acknowledge_request_object
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['token'] = token unless 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

#acknowledge_purchase_subscription(package_name, subscription_id, token, subscription_purchases_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Acknowledges a subscription purchase.

Parameters:

  • package_name (String)

    The package name of the application for which this subscription was purchased ( for example, 'com.some.thing').

  • subscription_id (String)

    Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, ' monthly001').

  • token (String)

    The token provided to the user's device when the subscription was purchased.

  • subscription_purchases_acknowledge_request_object (Google::Apis::AndroidpublisherV3::SubscriptionPurchasesAcknowledgeRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5030

def acknowledge_purchase_subscription(package_name, subscription_id, token, subscription_purchases_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchasesAcknowledgeRequest::Representation
  command.request_object = subscription_purchases_acknowledge_request_object
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['subscriptionId'] = subscription_id unless subscription_id.nil?
  command.params['token'] = token unless 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

#activate_base_plan(package_name, product_id, base_plan_id, activate_base_plan_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Subscription

Activates a base plan. Once activated, base plans will be available to new subscribers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the base plan to activate.

  • product_id (String)

    Required. The parent subscription (ID) of the base plan to activate.

  • base_plan_id (String)

    Required. The unique base plan ID of the base plan to activate.

  • activate_base_plan_request_object (Google::Apis::AndroidpublisherV3::ActivateBasePlanRequest) (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



4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4019

def activate_base_plan(package_name, product_id, base_plan_id, activate_base_plan_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ActivateBasePlanRequest::Representation
  command.request_object = activate_base_plan_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Subscription
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#activate_one_time_product_offer(package_name, product_id, purchase_option_id, offer_id, activate_one_time_product_offer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::OneTimeProductOffer

Activates a one-time product offer.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to activate.

  • product_id (String)

    Required. The parent one-time product (ID) of the offer to activate.

  • purchase_option_id (String)

    Required. The parent purchase option (ID) of the offer to activate.

  • offer_id (String)

    Required. The offer ID of the offer to activate.

  • activate_one_time_product_offer_request_object (Google::Apis::AndroidpublisherV3::ActivateOneTimeProductOfferRequest) (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



3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3339

def activate_one_time_product_offer(package_name, product_id, purchase_option_id, offer_id, activate_one_time_product_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:activate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ActivateOneTimeProductOfferRequest::Representation
  command.request_object = activate_one_time_product_offer_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::OneTimeProductOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::OneTimeProductOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#activate_subscription_offer(package_name, product_id, base_plan_id, offer_id, activate_subscription_offer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionOffer

Activates a subscription offer. Once activated, subscription offers will be available to new subscribers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to activate.

  • product_id (String)

    Required. The parent subscription (ID) of the offer to activate.

  • base_plan_id (String)

    Required. The parent base plan (ID) of the offer to activate.

  • offer_id (String)

    Required. The unique offer ID of the offer to activate.

  • activate_subscription_offer_request_object (Google::Apis::AndroidpublisherV3::ActivateSubscriptionOfferRequest) (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



4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4263

def activate_subscription_offer(package_name, product_id, base_plan_id, offer_id, activate_subscription_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ActivateSubscriptionOfferRequest::Representation
  command.request_object = activate_subscription_offer_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_apprecovery_targeting(package_name, app_recovery_id, add_targeting_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AddTargetingResponse

Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded.

Parameters:

  • package_name (String)

    Required. Package name of the app for which recovery action is to be updated.

  • app_recovery_id (Fixnum)

    Required. ID corresponding to the app recovery action.

  • add_targeting_request_object (Google::Apis::AndroidpublisherV3::AddTargetingRequest) (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



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

def add_apprecovery_targeting(package_name, app_recovery_id, add_targeting_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:addTargeting', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::AddTargetingRequest::Representation
  command.request_object = add_targeting_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::AddTargetingResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AddTargetingResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#addexternallyhosted_edit_apk(package_name, edit_id, apks_add_externally_hosted_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ApksAddExternallyHostedResponse

Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to organizations using Managed Play whose application is configured to restrict distribution to the organizations.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • apks_add_externally_hosted_request_object (Google::Apis::AndroidpublisherV3::ApksAddExternallyHostedRequest) (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



945
946
947
948
949
950
951
952
953
954
955
956
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 945

def addexternallyhosted_edit_apk(package_name, edit_id, apks_add_externally_hosted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/externallyHosted', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ApksAddExternallyHostedRequest::Representation
  command.request_object = apks_add_externally_hosted_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ApksAddExternallyHostedResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ApksAddExternallyHostedResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#archive_subscription(package_name, product_id, archive_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Subscription

Deprecated: subscription archiving is not supported.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the app of the subscription to delete.

  • product_id (String)

    Required. The unique product ID of the subscription to delete.

  • archive_subscription_request_object (Google::Apis::AndroidpublisherV3::ArchiveSubscriptionRequest) (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



3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3686

def archive_subscription(package_name, product_id, archive_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ArchiveSubscriptionRequest::Representation
  command.request_object = archive_subscription_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Subscription
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_delete_one_time_product_offers(package_name, product_id, purchase_option_id, batch_delete_one_time_product_offers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes one or more one-time product offers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offers to delete. Must be equal to the package_name field on all the OneTimeProductOffer resources.

  • product_id (String)

    Required. The product ID of the parent one-time product, if all offers to delete belong to the same product. If this request spans multiple one-time products, set this field to "-".

  • purchase_option_id (String)

    Required. The parent purchase option (ID) for which the offers should be deleted. May be specified as '-' to update offers from multiple purchase options.

  • batch_delete_one_time_product_offers_request_object (Google::Apis::AndroidpublisherV3::BatchDeleteOneTimeProductOffersRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3384

def batch_delete_one_time_product_offers(package_name, product_id, purchase_option_id, batch_delete_one_time_product_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchDelete', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchDeleteOneTimeProductOffersRequest::Representation
  command.request_object = batch_delete_one_time_product_offers_request_object
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_delete_purchase_options(package_name, product_id, batch_delete_purchase_options_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes purchase options across one or multiple one-time products. By default this operation will fail if there are any existing offers under the deleted purchase options. Use the force parameter to override the default behavior.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the purchase options to delete.

  • product_id (String)

    Required. The product ID of the parent one-time product, if all purchase options to delete belong to the same one-time product. If this batch delete spans multiple one-time products, set this field to "-".

  • batch_delete_purchase_options_request_object (Google::Apis::AndroidpublisherV3::BatchDeletePurchaseOptionsRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3262

def batch_delete_purchase_options(package_name, product_id, batch_delete_purchase_options_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchDelete', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchDeletePurchaseOptionsRequest::Representation
  command.request_object = batch_delete_purchase_options_request_object
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_get_one_time_product_offers(package_name, product_id, purchase_option_id, batch_get_one_time_product_offers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductOffersResponse

Reads one or more one-time product offers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources.

  • product_id (String)

    Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-".

  • purchase_option_id (String)

    Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options.

  • batch_get_one_time_product_offers_request_object (Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductOffersRequest) (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



3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3426

def batch_get_one_time_product_offers(package_name, product_id, purchase_option_id, batch_get_one_time_product_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchGet', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductOffersRequest::Representation
  command.request_object = batch_get_one_time_product_offers_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductOffersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductOffersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_get_subscription_offers(package_name, product_id, base_plan_id, batch_get_subscription_offers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse

Reads one or more subscription offers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the requests.

  • product_id (String)

    Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.

  • base_plan_id (String)

    Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans.

  • batch_get_subscription_offers_request_object (Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersRequest) (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



4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4308

def batch_get_subscription_offers(package_name, product_id, base_plan_id, batch_get_subscription_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersRequest::Representation
  command.request_object = batch_get_subscription_offers_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_inappproduct_delete(package_name, inappproducts_batch_delete_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should not be used to delete subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • inappproducts_batch_delete_request_object (Google::Apis::AndroidpublisherV3::InappproductsBatchDeleteRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



2494
2495
2496
2497
2498
2499
2500
2501
2502
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2494

def batch_inappproduct_delete(package_name, inappproducts_batch_delete_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts:batchDelete', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchDeleteRequest::Representation
  command.request_object = inappproducts_batch_delete_request_object
  command.params['packageName'] = package_name unless package_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

#batch_inappproduct_get(package_name, sku: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse

Reads multiple in-app products, which can be managed products or subscriptions. This method should not be used to retrieve subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

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

    Unique identifier for the in-app products.

  • 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



2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2529

def batch_inappproduct_get(package_name, sku: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts:batchGet', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['sku'] = sku unless sku.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_inappproduct_update(package_name, inappproducts_batch_update_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse

Updates or inserts one or more in-app products (managed products or subscriptions). Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput. This method should no longer be used to update subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • inappproducts_batch_update_request_object (Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateRequest) (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



2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2566

def batch_inappproduct_update(package_name, inappproducts_batch_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts:batchUpdate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateRequest::Representation
  command.request_object = inappproducts_batch_update_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse
  command.params['packageName'] = package_name unless package_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

#batch_monetization_onetimeproduct_get(package_name, product_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductsResponse

Reads one or more one-time products.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the products should be retrieved. Must be equal to the package_name field on all requests.

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

    Required. A list of up to 100 product IDs to retrieve. All IDs must be different.

  • 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



3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3017

def batch_monetization_onetimeproduct_get(package_name, product_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchGet', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchGetOneTimeProductsResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['productIds'] = product_ids unless product_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_monetization_onetimeproduct_purchase_option_offer_update_states(package_name, product_id, purchase_option_id, batch_update_one_time_product_offer_states_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOfferStatesResponse

Updates a batch of one-time product offer states.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated one-time product offers.

  • product_id (String)

    Required. The product ID of the parent one-time product, if all updated offers belong to the same one-time product. If this batch update spans multiple one- time products, set this field to "-".

  • purchase_option_id (String)

    Required. The purchase option ID of the parent purchase option, if all updated offers belong to the same purchase option. If this batch update spans multiple purchase options, set this field to "-".

  • batch_update_one_time_product_offer_states_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOfferStatesRequest) (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



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3513

def batch_monetization_onetimeproduct_purchase_option_offer_update_states(package_name, product_id, purchase_option_id, batch_update_one_time_product_offer_states_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdateStates', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOfferStatesRequest::Representation
  command.request_object = batch_update_one_time_product_offer_states_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOfferStatesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOfferStatesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_monetization_onetimeproduct_purchase_option_update_states(package_name, product_id, batch_update_purchase_option_states_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdatePurchaseOptionStatesResponse

Activates or deactivates purchase options across one or multiple one-time products.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated purchase options.

  • product_id (String)

    Required. The product ID of the parent one-time product, if all updated purchase options belong to the same one-time product. If this batch update spans multiple one-time products, set this field to "-".

  • batch_update_purchase_option_states_request_object (Google::Apis::AndroidpublisherV3::BatchUpdatePurchaseOptionStatesRequest) (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



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3299

def batch_monetization_onetimeproduct_purchase_option_update_states(package_name, product_id, batch_update_purchase_option_states_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions:batchUpdateStates', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdatePurchaseOptionStatesRequest::Representation
  command.request_object = batch_update_purchase_option_states_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdatePurchaseOptionStatesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdatePurchaseOptionStatesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_monetization_subscription_base_plan_migrate_prices(package_name, product_id, batch_migrate_base_plan_prices_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse

Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the package_name field on all the Subscription resources.

  • product_id (String)

    Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.

  • batch_migrate_base_plan_prices_request_object (Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesRequest) (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



4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4062

def batch_monetization_subscription_base_plan_migrate_prices(package_name, product_id, batch_migrate_base_plan_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchMigratePrices', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesRequest::Representation
  command.request_object = batch_migrate_base_plan_prices_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_monetization_subscription_base_plan_offer_update_states(package_name, product_id, base_plan_id, batch_update_subscription_offer_states_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse

Updates a batch of subscription offer states. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.

  • product_id (String)

    Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.

  • base_plan_id (String)

    Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.

  • batch_update_subscription_offer_states_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesRequest) (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



4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4400

def batch_monetization_subscription_base_plan_offer_update_states(package_name, product_id, base_plan_id, batch_update_subscription_offer_states_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesRequest::Representation
  command.request_object = batch_update_subscription_offer_states_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_monetization_subscription_base_plan_update_states(package_name, product_id, batch_update_base_plan_states_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse

Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated base plans.

  • product_id (String)

    Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set.

  • batch_update_base_plan_states_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesRequest) (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



4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4103

def batch_monetization_subscription_base_plan_update_states(package_name, product_id, batch_update_base_plan_states_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesRequest::Representation
  command.request_object = batch_update_base_plan_states_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_monetization_subscription_get(package_name, product_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse

Reads one or more subscriptions.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the package_name field on all the requests.

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

    Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different.

  • 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



3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3723

def batch_monetization_subscription_get(package_name, product_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions:batchGet', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['productIds'] = product_ids unless product_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_onetimeproduct_delete_one_time_products(package_name, batch_delete_one_time_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes one or more one-time products.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the one-time products should be deleted. Must be equal to the package_name field on all the OneTimeProduct resources.

  • batch_delete_one_time_products_request_object (Google::Apis::AndroidpublisherV3::BatchDeleteOneTimeProductsRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2983

def batch_onetimeproduct_delete_one_time_products(package_name, batch_delete_one_time_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchDelete', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchDeleteOneTimeProductsRequest::Representation
  command.request_object = batch_delete_one_time_products_request_object
  command.params['packageName'] = package_name unless package_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

#batch_onetimeproduct_update_one_time_products(package_name, batch_update_one_time_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductsResponse

Creates or updates one or more one-time products.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the one-time products should be updated. Must be equal to the package_name field on all the OneTimeProduct resources.

  • batch_update_one_time_products_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductsRequest) (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



3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3051

def batch_onetimeproduct_update_one_time_products(package_name, batch_update_one_time_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts:batchUpdate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductsRequest::Representation
  command.request_object = batch_update_one_time_products_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductsResponse
  command.params['packageName'] = package_name unless package_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

#batch_update_one_time_product_offers(package_name, product_id, purchase_option_id, batch_update_one_time_product_offers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOffersResponse

Creates or updates one or more one-time product offers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources.

  • product_id (String)

    Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-".

  • purchase_option_id (String)

    Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options.

  • batch_update_one_time_product_offers_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOffersRequest) (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



3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3470

def batch_update_one_time_product_offers(package_name, product_id, purchase_option_id, batch_update_one_time_product_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOffersRequest::Representation
  command.request_object = batch_update_one_time_product_offers_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOffersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateOneTimeProductOffersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_subscription_offers(package_name, product_id, base_plan_id, batch_update_subscription_offers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse

Updates a batch of subscription offers. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the updated subscription offers. Must be equal to the package_name field on all the updated SubscriptionOffer resources.

  • product_id (String)

    Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.

  • base_plan_id (String)

    Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.

  • batch_update_subscription_offers_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersRequest) (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



4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4354

def batch_update_subscription_offers(package_name, product_id, base_plan_id, batch_update_subscription_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersRequest::Representation
  command.request_object = batch_update_subscription_offers_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_subscriptions(package_name, batch_update_subscriptions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse

Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the package_name field on all the Subscription resources.

  • batch_update_subscriptions_request_object (Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsRequest) (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



3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3759

def batch_update_subscriptions(package_name, batch_update_subscriptions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsRequest::Representation
  command.request_object = batch_update_subscriptions_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse
  command.params['packageName'] = package_name unless package_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

#batchget_order(package_name, order_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse

Get order details for a list of orders.

Parameters:

  • package_name (String)

    Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').

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

    Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct.

  • 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



4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4736

def batchget_order(package_name, order_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/orders:batchGet', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['orderIds'] = order_ids unless order_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_apprecovery_app_recovery(package_name, app_recovery_id, cancel_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse

Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.

Parameters:

  • package_name (String)

    Required. Package name of the app for which recovery action cancellation is requested.

  • app_recovery_id (Fixnum)

    Required. ID corresponding to the app recovery action.

  • cancel_app_recovery_request_object (Google::Apis::AndroidpublisherV3::CancelAppRecoveryRequest) (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



294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 294

def cancel_apprecovery_app_recovery(package_name, app_recovery_id, cancel_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::CancelAppRecoveryRequest::Representation
  command.request_object = cancel_app_recovery_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_one_time_product_offer(package_name, product_id, purchase_option_id, offer_id, cancel_one_time_product_offer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::OneTimeProductOffer

Cancels a one-time product offer.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to cancel.

  • product_id (String)

    Required. The parent one-time product (ID) of the offer to cancel.

  • purchase_option_id (String)

    Required. The parent purchase option (ID) of the offer to cancel.

  • offer_id (String)

    Required. The offer ID of the offer to cancel.

  • cancel_one_time_product_offer_request_object (Google::Apis::AndroidpublisherV3::CancelOneTimeProductOfferRequest) (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



3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3554

def cancel_one_time_product_offer(package_name, product_id, purchase_option_id, offer_id, cancel_one_time_product_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:cancel', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::CancelOneTimeProductOfferRequest::Representation
  command.request_object = cancel_one_time_product_offer_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::OneTimeProductOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::OneTimeProductOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.

Parameters:

  • package_name (String)

    The package name of the application for which this subscription was purchased ( for example, 'com.some.thing').

  • subscription_id (String)

    Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, ' monthly001').

  • token (String)

    The token provided to the user's device when the subscription was purchased.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



5072
5073
5074
5075
5076
5077
5078
5079
5080
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5072

def cancel_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['subscriptionId'] = subscription_id unless subscription_id.nil?
  command.params['token'] = token unless 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

#cancel_subscriptionsv2_subscription_purchase(package_name, token, cancel_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::CancelSubscriptionPurchaseResponse

Cancel a subscription purchase for the user.

Parameters:

  • package_name (String)

    Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').

  • token (String)

    Required. The token provided to the user's device when the subscription was purchased.

  • cancel_subscription_purchase_request_object (Google::Apis::AndroidpublisherV3::CancelSubscriptionPurchaseRequest) (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



5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5148

def cancel_subscriptionsv2_subscription_purchase(package_name, token, cancel_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancel', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::CancelSubscriptionPurchaseRequest::Representation
  command.request_object = cancel_subscription_purchase_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::CancelSubscriptionPurchaseResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::CancelSubscriptionPurchaseResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['token'] = token unless 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

#commit_edit(package_name, edit_id, changes_in_review_behavior: nil, changes_not_sent_for_review: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppEdit

Commits an app edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • changes_in_review_behavior (String) (defaults to: nil)

    Optional. Specify how the API should behave if there are changes currently in review. If this value is not set, it will default to " CANCEL_IN_REVIEW_AND_SUBMIT", which will cancel the changes in review and then send all the changes for publishing.

  • changes_not_sent_for_review (Boolean) (defaults to: nil)

    When a rejection happens, the parameter will make sure that the changes in this edit won't be reviewed until they are explicitly sent for review from within the Google Play Console UI. These changes will be added to any other changes that are not yet sent for review.

  • 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



776
777
778
779
780
781
782
783
784
785
786
787
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 776

def commit_edit(package_name, edit_id, changes_in_review_behavior: nil, changes_not_sent_for_review: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}:commit', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppEdit
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['changesInReviewBehavior'] = changes_in_review_behavior unless changes_in_review_behavior.nil?
  command.query['changesNotSentForReview'] = changes_not_sent_for_review unless changes_not_sent_for_review.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#consume_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Consumes a purchase for an inapp item.

Parameters:

  • package_name (String)

    The package name of the application the inapp product was sold in (for example, 'com.some.thing').

  • product_id (String)

    The inapp product SKU (for example, 'com.some.thing.inapp1').

  • token (String)

    The token provided to the user's device when the inapp product was purchased.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4921
4922
4923
4924
4925
4926
4927
4928
4929
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4921

def consume_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['token'] = token unless 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

#convert_monetization_region_prices(package_name, convert_region_prices_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse

Calculates the region prices, using today's exchange rate and country-specific pricing patterns, based on the price in the request for a set of regions.

Parameters:

  • package_name (String)

    Required. The app package name.

  • convert_region_prices_request_object (Google::Apis::AndroidpublisherV3::ConvertRegionPricesRequest) (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



2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2948

def convert_monetization_region_prices(package_name, convert_region_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/pricing:convertRegionPrices', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ConvertRegionPricesRequest::Representation
  command.request_object = convert_region_prices_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse
  command.params['packageName'] = package_name unless package_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

#create_application_device_tier_config(package_name, device_tier_config_object = nil, allow_unknown_devices: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::DeviceTierConfig

Creates a new device tier config for an app.

Parameters:

  • package_name (String)

    Package name of the app.

  • device_tier_config_object (Google::Apis::AndroidpublisherV3::DeviceTierConfig) (defaults to: nil)
  • allow_unknown_devices (Boolean) (defaults to: nil)

    Whether the service should accept device IDs that are unknown to Play's device catalog.

  • 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



113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 113

def create_application_device_tier_config(package_name, device_tier_config_object = nil, allow_unknown_devices: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/deviceTierConfigs', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::DeviceTierConfig::Representation
  command.request_object = device_tier_config_object
  command.response_representation = Google::Apis::AndroidpublisherV3::DeviceTierConfig::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::DeviceTierConfig
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['allowUnknownDevices'] = allow_unknown_devices unless allow_unknown_devices.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_apprecovery_draft_app_recovery(package_name, create_draft_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppRecoveryAction

Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action.

Parameters:

  • package_name (String)

    Required. Package name of the app on which recovery action is performed.

  • create_draft_app_recovery_request_object (Google::Apis::AndroidpublisherV3::CreateDraftAppRecoveryRequest) (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



329
330
331
332
333
334
335
336
337
338
339
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 329

def create_apprecovery_draft_app_recovery(package_name, create_draft_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::CreateDraftAppRecoveryRequest::Representation
  command.request_object = create_draft_app_recovery_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::AppRecoveryAction::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppRecoveryAction
  command.params['packageName'] = package_name unless package_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

#create_edit_track(package_name, edit_id, track_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Track

Creates a new track.

Parameters:

  • package_name (String)

    Required. Package name of the app.

  • edit_id (String)

    Required. Identifier of the edit.

  • track_config_object (Google::Apis::AndroidpublisherV3::TrackConfig) (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



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2022

def create_edit_track(package_name, edit_id, track_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::TrackConfig::Representation
  command.request_object = track_config_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Track
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_grant(parent, grant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Grant

Grant access for a user to the given package.

Parameters:

  • parent (String)

    Required. The user which needs permission. Format: developers/developer/ users/user

  • grant_object (Google::Apis::AndroidpublisherV3::Grant) (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



2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2389

def create_grant(parent, grant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/grants', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
  command.request_object = grant_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Grant
  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_monetization_subscription(package_name, subscription_object = nil, product_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Subscription

Creates a new subscription. Newly added base plans will remain in draft state until activated.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscription should be created. Must be equal to the package_name field on the Subscription resource.

  • subscription_object (Google::Apis::AndroidpublisherV3::Subscription) (defaults to: nil)
  • product_id (String) (defaults to: nil)

    Required. The ID to use for the subscription. For the requirements on this format, see the documentation of the product_id field on the Subscription resource.

  • regions_version_version (String) (defaults to: nil)

    Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.

  • 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



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3807

def create_monetization_subscription(package_name, subscription_object = nil, product_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.request_object = subscription_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Subscription
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['productId'] = product_id unless product_id.nil?
  command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.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_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, subscription_offer_object = nil, offer_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionOffer

Creates a new subscription offer. Only auto-renewing base plans can have subscription offers. The offer state will be DRAFT until it is activated.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the offer should be created. Must be equal to the package_name field on the Subscription resource.

  • product_id (String)

    Required. The parent subscription (ID) for which the offer should be created. Must be equal to the product_id field on the SubscriptionOffer resource.

  • base_plan_id (String)

    Required. The parent base plan (ID) for which the offer should be created. Must be equal to the base_plan_id field on the SubscriptionOffer resource.

  • subscription_offer_object (Google::Apis::AndroidpublisherV3::SubscriptionOffer) (defaults to: nil)
  • offer_id (String) (defaults to: nil)

    Required. The ID to use for the offer. For the requirements on this format, see the documentation of the offer_id field on the SubscriptionOffer resource.

  • regions_version_version (String) (defaults to: nil)

    Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.

  • 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



4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4455

def create_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, subscription_offer_object = nil, offer_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.request_object = subscription_offer_object
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['offerId'] = offer_id unless offer_id.nil?
  command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.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_systemapk_variant(package_name, version_code, variant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Variant

Creates an APK which is suitable for inclusion in a system image from an already uploaded Android App Bundle.

Parameters:

  • package_name (String)

    Package name of the app.

  • version_code (Fixnum)

    The version code of the App Bundle.

  • variant_object (Google::Apis::AndroidpublisherV3::Variant) (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



5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5487

def create_systemapk_variant(package_name, version_code, variant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Variant::Representation
  command.request_object = variant_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Variant::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Variant
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['versionCode'] = version_code unless version_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

#create_user(parent, user_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::User

Grant access for a user to the given developer account.

Parameters:

  • parent (String)

    Required. The developer account to add the user to. Format: developers/ developer

  • user_object (Google::Apis::AndroidpublisherV3::User) (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



5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5633

def create_user(parent, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/users', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AndroidpublisherV3::User::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::User
  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

#createappstorehostedapp_appstoreappsreview(app_store_package_name, create_app_store_hosted_app_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::CreateAppStoreHostedAppResponse

Creates an app store hosted app. This must be called before any other RPCs for this hosted app.

Parameters:

  • app_store_package_name (String)

    Required. Package name of the third-party app store.

  • create_app_store_hosted_app_request_object (Google::Apis::AndroidpublisherV3::CreateAppStoreHostedAppRequest) (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



436
437
438
439
440
441
442
443
444
445
446
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 436

def createappstorehostedapp_appstoreappsreview(app_store_package_name, create_app_store_hosted_app_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps:create', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::CreateAppStoreHostedAppRequest::Representation
  command.request_object = create_app_store_hosted_app_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::CreateAppStoreHostedAppResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::CreateAppStoreHostedAppResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_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

#createexternaltransaction_externaltransaction(parent, external_transaction_object = nil, external_transaction_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExternalTransaction

Creates a new external transaction.

Parameters:

  • parent (String)

    Required. The parent resource where this external transaction will be created. Format: applications/package_name

  • external_transaction_object (Google::Apis::AndroidpublisherV3::ExternalTransaction) (defaults to: nil)
  • external_transaction_id (String) (defaults to: nil)

    Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-zA-Z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked.

  • 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



2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2213

def createexternaltransaction_externaltransaction(parent, external_transaction_object = nil, external_transaction_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/externalTransactions', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
  command.request_object = external_transaction_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
  command.params['parent'] = parent unless parent.nil?
  command.query['externalTransactionId'] = external_transaction_id unless external_transaction_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#data_application_safety(package_name, safety_labels_update_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse

Writes the Safety Labels declaration of an app.

Parameters:

  • package_name (String)

    Required. Package name of the app.

  • safety_labels_update_request_object (Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateRequest) (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



77
78
79
80
81
82
83
84
85
86
87
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 77

def data_application_safety(package_name, safety_labels_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/dataSafety', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateRequest::Representation
  command.request_object = safety_labels_update_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse
  command.params['packageName'] = package_name unless package_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

#deactivate_base_plan(package_name, product_id, base_plan_id, deactivate_base_plan_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Subscription

Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the base plan to deactivate.

  • product_id (String)

    Required. The parent subscription (ID) of the base plan to deactivate.

  • base_plan_id (String)

    Required. The unique base plan ID of the base plan to deactivate.

  • deactivate_base_plan_request_object (Google::Apis::AndroidpublisherV3::DeactivateBasePlanRequest) (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



4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4143

def deactivate_base_plan(package_name, product_id, base_plan_id, deactivate_base_plan_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateBasePlanRequest::Representation
  command.request_object = deactivate_base_plan_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Subscription
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deactivate_one_time_product_offer(package_name, product_id, purchase_option_id, offer_id, deactivate_one_time_product_offer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::OneTimeProductOffer

Deactivates a one-time product offer.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to deactivate.

  • product_id (String)

    Required. The parent one-time product (ID) of the offer to deactivate.

  • purchase_option_id (String)

    Required. The parent purchase option (ID) of the offer to deactivate.

  • offer_id (String)

    Required. The offer ID of the offer to deactivate.

  • deactivate_one_time_product_offer_request_object (Google::Apis::AndroidpublisherV3::DeactivateOneTimeProductOfferRequest) (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



3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3596

def deactivate_one_time_product_offer(package_name, product_id, purchase_option_id, offer_id, deactivate_one_time_product_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:deactivate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateOneTimeProductOfferRequest::Representation
  command.request_object = deactivate_one_time_product_offer_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::OneTimeProductOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::OneTimeProductOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deactivate_subscription_offer(package_name, product_id, base_plan_id, offer_id, deactivate_subscription_offer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionOffer

Deactivates a subscription offer. Once deactivated, existing subscribers will maintain their subscription, but the offer will become unavailable to new subscribers.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to deactivate.

  • product_id (String)

    Required. The parent subscription (ID) of the offer to deactivate.

  • base_plan_id (String)

    Required. The parent base plan (ID) of the offer to deactivate.

  • offer_id (String)

    Required. The unique offer ID of the offer to deactivate.

  • deactivate_subscription_offer_request_object (Google::Apis::AndroidpublisherV3::DeactivateSubscriptionOfferRequest) (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



4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4500

def deactivate_subscription_offer(package_name, product_id, base_plan_id, offer_id, deactivate_subscription_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateSubscriptionOfferRequest::Representation
  command.request_object = deactivate_subscription_offer_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#defer_purchase_subscription(package_name, subscription_id, token, subscription_purchases_defer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferResponse

Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.

Parameters:

  • package_name (String)

    The package name of the application for which this subscription was purchased ( for example, 'com.some.thing').

  • subscription_id (String)

    The purchased subscription ID (for example, 'monthly001').

  • token (String)

    The token provided to the user's device when the subscription was purchased.

  • subscription_purchases_defer_request_object (Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferRequest) (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



5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5109

def defer_purchase_subscription(package_name, subscription_id, token, subscription_purchases_defer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferRequest::Representation
  command.request_object = subscription_purchases_defer_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['subscriptionId'] = subscription_id unless subscription_id.nil?
  command.params['token'] = token unless 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

#defer_subscriptionsv2_subscription_purchase(package_name, token, defer_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::DeferSubscriptionPurchaseResponse

Defers the renewal of a subscription.

Parameters:

  • package_name (String)

    Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').

  • token (String)

    Required. The token provided to the user's device when the subscription was purchased.

  • defer_subscription_purchase_request_object (Google::Apis::AndroidpublisherV3::DeferSubscriptionPurchaseRequest) (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



5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5186

def defer_subscriptionsv2_subscription_purchase(package_name, token, defer_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:defer', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::DeferSubscriptionPurchaseRequest::Representation
  command.request_object = defer_subscription_purchase_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::DeferSubscriptionPurchaseResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::DeferSubscriptionPurchaseResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['token'] = token unless 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

#delete_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an app edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



811
812
813
814
815
816
817
818
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 811

def delete_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/edits/{editId}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_edit_image(package_name, edit_id, language, image_type, image_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the image (specified by id) from the edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German).

  • image_type (String)

    Type of the Image.

  • image_id (String)

    Unique identifier an image within the set of images attached to this edit.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1519

def delete_edit_image(package_name, edit_id, language, image_type, image_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}/{imageId}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.nil?
  command.params['imageType'] = image_type unless image_type.nil?
  command.params['imageId'] = image_id unless image_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_edit_listing(package_name, edit_id, language, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a localized store listing.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German).

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



1694
1695
1696
1697
1698
1699
1700
1701
1702
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1694

def delete_edit_listing(package_name, edit_id, language, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_grant(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes all access for the user to the given package or developer account.

Parameters:

  • name (String)

    Required. The name of the grant to delete. Format: developers/developer/ users/email/grants/package_name

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



2422
2423
2424
2425
2426
2427
2428
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2422

def delete_grant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/{+name}', options)
  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

#delete_inappproduct(package_name, sku, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an in-app product (a managed product or a subscription). This method should no longer be used to delete subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • sku (String)

    Unique identifier for the in-app product.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



2606
2607
2608
2609
2610
2611
2612
2613
2614
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2606

def delete_inappproduct(package_name, sku, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['sku'] = sku unless sku.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_monetization_onetimeproduct(package_name, product_id, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a one-time product.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the one-time product to delete.

  • product_id (String)

    Required. The one-time product ID of the one-time product to delete.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3088

def delete_monetization_onetimeproduct(package_name, product_id, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the app of the subscription to delete.

  • product_id (String)

    Required. The unique product ID of the subscription to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

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



3845
3846
3847
3848
3849
3850
3851
3852
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3845

def delete_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_monetization_subscription_base_plan(package_name, product_id, base_plan_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a base plan. Can only be done for draft base plans. This action is irreversible.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the base plan to delete.

  • product_id (String)

    Required. The parent subscription (ID) of the base plan to delete.

  • base_plan_id (String)

    Required. The unique offer ID of the base plan to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

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



4182
4183
4184
4185
4186
4187
4188
4189
4190
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4182

def delete_monetization_subscription_base_plan(package_name, product_id, base_plan_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a subscription offer. Can only be done for draft offers. This action is irreversible.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to delete.

  • product_id (String)

    Required. The parent subscription (ID) of the offer to delete.

  • base_plan_id (String)

    Required. The parent base plan (ID) of the offer to delete.

  • offer_id (String)

    Required. The unique offer ID of the offer to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

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



4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4542

def delete_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes all access for the user to the given developer account.

Parameters:

  • name (String)

    Required. The name of the user to delete. Format: developers/developer/users/ email

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



5666
5667
5668
5669
5670
5671
5672
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5666

def delete_user(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/{+name}', options)
  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

#deleteall_edit_image(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ImagesDeleteAllResponse

Deletes all images for the specified language and image type. Returns an empty response if no images are found.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). Providing a language that is not supported by the App is a no-op.

  • image_type (String)

    Type of the Image. Providing an image type that refers to no images is a no-op.

  • 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



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1560

def deleteall_edit_image(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ImagesDeleteAllResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ImagesDeleteAllResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.nil?
  command.params['imageType'] = image_type unless image_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deleteall_edit_listing(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes all store listings.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



1726
1727
1728
1729
1730
1731
1732
1733
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1726

def deleteall_edit_listing(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deploy_apprecovery_app_recovery(package_name, app_recovery_id, deploy_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse

Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE.

Parameters:

  • package_name (String)

    Required. Package name of the app for which recovery action is deployed.

  • app_recovery_id (Fixnum)

    Required. ID corresponding to the app recovery action to deploy.

  • deploy_app_recovery_request_object (Google::Apis::AndroidpublisherV3::DeployAppRecoveryRequest) (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



366
367
368
369
370
371
372
373
374
375
376
377
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 366

def deploy_apprecovery_app_recovery(package_name, app_recovery_id, deploy_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:deploy', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::DeployAppRecoveryRequest::Representation
  command.request_object = deploy_app_recovery_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_generatedapk(package_name, version_code, download_id, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Downloads a single signed APK generated from an app bundle.

Parameters:

  • package_name (String)

    Package name of the app.

  • version_code (Fixnum)

    Version code of the app bundle.

  • download_id (String)

    Download ID, which uniquely identifies the APK to download. Can be obtained from the response of generatedapks.list method.

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

  • download_dest (IO, String) (defaults to: nil)

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2318

def download_generatedapk(package_name, version_code, download_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download', options)
  else
    command = make_download_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download', options)
    command.download_dest = download_dest
  end
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['versionCode'] = version_code unless version_code.nil?
  command.params['downloadId'] = download_id unless download_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_systemapk_variant(package_name, version_code, variant_id, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Downloads a previously created system APK which is suitable for inclusion in a system image.

Parameters:

  • package_name (String)

    Package name of the app.

  • version_code (Fixnum)

    The version code of the App Bundle.

  • variant_id (Fixnum)

    The ID of a previously created system APK variant.

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

  • download_dest (IO, String) (defaults to: nil)

    IO stream or filename to receive content download

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5527

def download_systemapk_variant(package_name, version_code, variant_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}:download', options)
  else
    command = make_download_command(:get, 'androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}:download', options)
    command.download_dest = download_dest
  end
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['versionCode'] = version_code unless version_code.nil?
  command.params['variantId'] = variant_id unless variant_id.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_application_device_tier_config(package_name, device_tier_config_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::DeviceTierConfig

Returns a particular device tier config.

Parameters:

  • package_name (String)

    Package name of the app.

  • device_tier_config_id (Fixnum)

    Required. Id of an existing device tier config.

  • 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



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

def get_application_device_tier_config(package_name, device_tier_config_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/deviceTierConfigs/{deviceTierConfigId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::DeviceTierConfig::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::DeviceTierConfig
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['deviceTierConfigId'] = device_tier_config_id unless device_tier_config_id.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_appstorecatalog_recentappview(app_store_package_name, play_app_package_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::RecentAppView

Returns metadata about a recently updated app.

Parameters:

  • app_store_package_name (String)

    Required. The package name of the app store on behalf of which the request is made.

  • play_app_package_name (String)

    Required. The package name of the requested Play app.

  • 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



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

def get_appstorecatalog_recentappview(app_store_package_name, play_app_package_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentAppViews/{playAppPackageName}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::RecentAppView::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::RecentAppView
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_name.nil?
  command.params['playAppPackageName'] = play_app_package_name unless play_app_package_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_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppEdit

Gets an app edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



842
843
844
845
846
847
848
849
850
851
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 842

def get_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppEdit
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_edit_countryavailability(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::TrackCountryAvailability

Gets country availability.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    The track to read from.

  • 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



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1146

def get_edit_countryavailability(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/countryAvailability/{track}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::TrackCountryAvailability::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::TrackCountryAvailability
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.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_edit_detail(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppDetails

Gets details of an app.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1229

def get_edit_detail(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/details', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::AppDetails::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppDetails
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFile

Fetches the expansion file configuration for the specified APK.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • apk_version_code (Fixnum)

    The version code of the APK whose expansion file configuration is being read or modified.

  • expansion_file_type (String)

    The file type of the file configuration which is being read or modified.

  • 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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1339

def get_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ExpansionFile::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExpansionFile
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil?
  command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.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_edit_listing(package_name, edit_id, language, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Listing

Gets a localized store listing.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German).

  • 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



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1760

def get_edit_listing(package_name, edit_id, language, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Listing::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Listing
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.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_edit_tester(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Testers

Gets testers. Note: Testers resource does not support email lists.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    The track to read from.

  • 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



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1909

def get_edit_tester(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Testers::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Testers
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.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_edit_track(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Track

Gets a track.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    Identifier of the track. More on track name

  • 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



2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2060

def get_edit_track(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Track
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.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_inappproduct(package_name, sku, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Gets an in-app product, which can be a managed product or a subscription. This method should no longer be used to retrieve subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • sku (String)

    Unique identifier for the in-app product.

  • 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



2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2641

def get_inappproduct(package_name, sku, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['sku'] = sku unless sku.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_monetization_onetimeproduct(package_name, product_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::OneTimeProduct

Reads a single one-time product.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the product to retrieve.

  • product_id (String)

    Required. The product ID of the product to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • 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



3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3120

def get_monetization_onetimeproduct(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::OneTimeProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::OneTimeProduct
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.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_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Subscription

Reads a single subscription.

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the subscription to get.

  • product_id (String)

    Required. The unique product ID of the subscription to get.

  • 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



3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3876

def get_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Subscription
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.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_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionOffer

Reads a single offer

Parameters:

  • package_name (String)

    Required. The parent app (package name) of the offer to get.

  • product_id (String)

    Required. The parent subscription (ID) of the offer to get.

  • base_plan_id (String)

    Required. The parent base plan (ID) of the offer to get.

  • offer_id (String)

    Required. The unique offer ID of the offer to get.

  • 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



4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4579

def get_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.params['offerId'] = offer_id unless offer_id.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_order(package_name, order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Order

Get order details for a single order.

Parameters:

  • package_name (String)

    Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').

  • order_id (String)

    Required. The order ID provided to the user when the subscription or in-app order was purchased.

  • 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



4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4771

def get_order(package_name, order_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/orders/{orderId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Order::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Order
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['orderId'] = order_id unless order_id.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_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ProductPurchase

Checks the purchase and consumption status of an inapp item.

Parameters:

  • package_name (String)

    The package name of the application the inapp product was sold in (for example, 'com.some.thing').

  • product_id (String)

    The inapp product SKU (for example, 'com.some.thing.inapp1').

  • token (String)

    The token provided to the user's device when the inapp product was purchased.

  • 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



4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4956

def get_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ProductPurchase::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ProductPurchase
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['token'] = token unless 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

#get_purchase_subscriptionsv2(package_name, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2

Get metadata about a subscription

Parameters:

  • package_name (String)

    The package of the application for which this subscription was purchased (for example, 'com.some.thing').

  • token (String)

    Required. The token provided to the user's device when the subscription was purchased.

  • 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



5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5223

def get_purchase_subscriptionsv2(package_name, token, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['token'] = token unless 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

#get_review(package_name, review_id, translation_language: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Review

Gets a single review.

Parameters:

  • package_name (String)

    Package name of the app.

  • review_id (String)

    Unique identifier for a review.

  • translation_language (String) (defaults to: nil)

    Language localization 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



5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5373

def get_review(package_name, review_id, translation_language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/reviews/{reviewId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Review::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Review
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['reviewId'] = review_id unless review_id.nil?
  command.query['translationLanguage'] = translation_language unless translation_language.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_systemapk_variant(package_name, version_code, variant_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Variant

Returns a previously created system APK variant.

Parameters:

  • package_name (String)

    Package name of the app.

  • version_code (Fixnum)

    The version code of the App Bundle.

  • variant_id (Fixnum)

    The ID of a previously created system APK variant.

  • 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



5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5566

def get_systemapk_variant(package_name, version_code, variant_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants/{variantId}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::Variant::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Variant
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['versionCode'] = version_code unless version_code.nil?
  command.params['variantId'] = variant_id unless variant_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#getexternaltransaction_externaltransaction(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExternalTransaction

Gets an existing external transaction.

Parameters:

  • name (String)

    Required. The name of the external transaction to retrieve. Format: applications/package_name/externalTransactions/external_transaction

  • 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



2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2247

def getexternaltransaction_externaltransaction(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/{+name}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
  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

#getproductpurchasev2_purchase_productsv2(package_name, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ProductPurchaseV2

Checks the purchase and consumption status of an inapp item.

Parameters:

  • package_name (String)

    The package name of the application the inapp product was sold in (for example, 'com.some.thing').

  • token (String)

    The token provided to the user's device when the inapp product was purchased.

  • 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



4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4991

def getproductpurchasev2_purchase_productsv2(package_name, token, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/productsv2/tokens/{token}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ProductPurchaseV2::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ProductPurchaseV2
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['token'] = token unless 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

#insert_edit(package_name, app_edit_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppEdit

Creates a new edit for an app.

Parameters:

  • package_name (String)

    Package name of the app.

  • app_edit_object (Google::Apis::AndroidpublisherV3::AppEdit) (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



874
875
876
877
878
879
880
881
882
883
884
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 874

def insert_edit(package_name, app_edit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::AppEdit::Representation
  command.request_object = app_edit_object
  command.response_representation = Google::Apis::AndroidpublisherV3::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppEdit
  command.params['packageName'] = package_name unless package_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

#insert_inappproduct(package_name, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Creates an in-app product (a managed product or a subscription). This method should no longer be used to create subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • in_app_product_object (Google::Apis::AndroidpublisherV3::InAppProduct) (defaults to: nil)
  • auto_convert_missing_prices (Boolean) (defaults to: nil)

    If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

  • 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



2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2680

def insert_inappproduct(package_name, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.request_object = in_app_product_object
  command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.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_application_device_tier_configs(package_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse

Returns created device tier configs, ordered by descending creation time.

Parameters:

  • package_name (String)

    Package name of the app.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of device tier configs to return. The service may return fewer than this value. If unspecified, at most 10 device tier configs will be returned. The maximum value for this field is 100; values above 100 will be coerced to 100. Device tier configs will be ordered by descending creation time.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListDeviceTierConfigs 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



188
189
190
191
192
193
194
195
196
197
198
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 188

def list_application_device_tier_configs(package_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/deviceTierConfigs', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse
  command.params['packageName'] = package_name unless package_name.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_application_track_releases(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListReleaseSummariesResponse

Returns the list of all releases for a given track. This excludes any releases that are obsolete.

Parameters:

  • parent (String)

    Required. The parent track, which owns this collection of releases. Format: applications/package_name/tracks/track

  • 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



222
223
224
225
226
227
228
229
230
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 222

def list_application_track_releases(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/{+parent}/releases', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListReleaseSummariesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListReleaseSummariesResponse
  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_apprecoveries(package_name, version_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse

List all app recovery action resources associated with a particular package name and app version.

Parameters:

  • package_name (String)

    Required. Package name of the app for which list of recovery actions is requested.

  • version_code (Fixnum) (defaults to: nil)

    Required. Version code targeted by the list of recovery actions.

  • 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



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

def list_apprecoveries(package_name, version_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/appRecoveries', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['versionCode'] = version_code unless version_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_appstorecatalog_recentupdateevents(app_store_package_name, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListRecentUpdateEventsResponse

Lists update events for eligible apps in the given time range.

Parameters:

  • app_store_package_name (String)

    Required. The package name of the app store on behalf of which the request is made.

  • end_time (String) (defaults to: nil)

    Required. The end time of the range (exclusive).

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of update events to return. The service may return fewer than this value. If unspecified, at most 100 update events will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

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

  • start_time (String) (defaults to: nil)

    Required. The start time of the range (inclusive).

  • 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



730
731
732
733
734
735
736
737
738
739
740
741
742
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 730

def list_appstorecatalog_recentupdateevents(app_store_package_name, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/appstorecatalog/{appStorePackageName}/recentUpdateEvents', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListRecentUpdateEventsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListRecentUpdateEventsResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_name.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startTime'] = start_time unless start_time.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_edit_apks(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ApksListResponse

Lists all current APKs of the app and edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



980
981
982
983
984
985
986
987
988
989
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 980

def list_edit_apks(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ApksListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ApksListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_edit_bundles(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BundlesListResponse

Lists all current Android App Bundles of the app and edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1056

def list_edit_bundles(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::BundlesListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::BundlesListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_edit_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ImagesListResponse

Lists all images. The response may be empty.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). There must be a store listing for the specified language.

  • image_type (String)

    Type of the Image. Providing an image type that refers to no images will return an empty response.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

  • 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



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1601

def list_edit_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ImagesListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ImagesListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.nil?
  command.params['imageType'] = image_type unless image_type.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_edit_listings(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListingsListResponse

Lists all localized store listings.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1794

def list_edit_listings(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListingsListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListingsListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_edit_tracks(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::TracksListResponse

Lists all tracks.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2094

def list_edit_tracks(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::TracksListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::TracksListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_generatedapks(package_name, version_code, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::GeneratedApksListResponse

Returns download metadata for all APKs that were generated from a given app bundle.

Parameters:

  • package_name (String)

    Package name of the app.

  • version_code (Fixnum)

    Version code of the app bundle.

  • 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



2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2356

def list_generatedapks(package_name, version_code, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::GeneratedApksListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::GeneratedApksListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['versionCode'] = version_code unless version_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_inappproducts(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InappproductsListResponse

Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field tokenPagination.nextPageToken will be set and the caller should provide its value as a token request parameter to retrieve the next page. This method should no longer be used to retrieve subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • max_results (Fixnum) (defaults to: nil)

    Deprecated and ignored. The page size is determined by the server.

  • start_index (Fixnum) (defaults to: nil)

    Deprecated and ignored. Set the token parameter to retrieve the next page.

  • token (String) (defaults to: nil)

    Pagination token. If empty, list starts at the first product.

  • 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



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2725

def list_inappproducts(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::InappproductsListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InappproductsListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['token'] = token unless 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_monetization_onetimeproduct_purchase_option_offers(package_name, product_id, purchase_option_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListOneTimeProductOffersResponse

Lists all offers under a given app, product, or purchase option.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the offers should be read.

  • product_id (String)

    Required. The parent one-time product (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

  • purchase_option_id (String)

    Required. The parent purchase option (ID) for which the offers should be read. May be specified as '-' to read all offers under a one-time product or an app. Must be specified as '-' if product_id is specified as '-'.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of offers to return. The service may return fewer than this value. If unspecified, at most 50 offers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListOneTimeProductsOffers call. Provide this to retrieve the subsequent page. When paginating, product_id, package_name and purchase_option_id provided to ListOneTimeProductsOffersRequest 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



3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3648

def list_monetization_onetimeproduct_purchase_option_offers(package_name, product_id, purchase_option_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListOneTimeProductOffersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListOneTimeProductOffersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['purchaseOptionId'] = purchase_option_id unless purchase_option_id.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_monetization_onetimeproducts(package_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListOneTimeProductsResponse

Lists all one-time products under a given app.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the one-time product should be read.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of one-time product to return. The service may return fewer than this value. If unspecified, at most 50 one-time products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListOneTimeProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOneTimeProducts 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



3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3162

def list_monetization_onetimeproducts(package_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/oneTimeProducts', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListOneTimeProductsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListOneTimeProductsResponse
  command.params['packageName'] = package_name unless package_name.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_monetization_subscription_base_plan_offers(package_name, product_id, base_plan_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse

Lists all offers under a given subscription.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscriptions should be read.

  • product_id (String)

    Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

  • base_plan_id (String)

    Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListSubscriptionsOffers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptionOffers 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



4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4629

def list_monetization_subscription_base_plan_offers(package_name, product_id, base_plan_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.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_monetization_subscriptions(package_name, page_size: nil, page_token: nil, show_archived: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse

Lists all subscriptions under a given app.

Parameters:

  • package_name (String)

    Required. The parent app (package name) for which the subscriptions should be read.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

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

  • show_archived (Boolean) (defaults to: nil)

    Deprecated: subscription archiving is not supported.

  • 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



3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3919

def list_monetization_subscriptions(package_name, page_size: nil, page_token: nil, show_archived: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showArchived'] = show_archived unless show_archived.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_purchase_voidedpurchases(package_name, end_time: nil, include_quantity_based_partial_refund: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::VoidedPurchasesListResponse

Lists the purchases that were canceled, refunded or charged-back.

Parameters:

  • package_name (String)

    The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').

  • end_time (Fixnum) (defaults to: nil)

    The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

  • include_quantity_based_partial_refund (Boolean) (defaults to: nil)

    Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false.

  • max_results (Fixnum) (defaults to: nil)

    Defines how many results the list operation should return. The default number depends on the resource collection.

  • start_index (Fixnum) (defaults to: nil)

    Defines the index of the first element to return. This can only be used if indexed paging is enabled.

  • start_time (Fixnum) (defaults to: nil)

    The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

  • token (String) (defaults to: nil)

    Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.

  • type (Fixnum) (defaults to: nil)

    The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 1. Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.

  • 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



5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5332

def list_purchase_voidedpurchases(package_name, end_time: nil, include_quantity_based_partial_refund: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::VoidedPurchasesListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::VoidedPurchasesListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['includeQuantityBasedPartialRefund'] = include_quantity_based_partial_refund unless include_quantity_based_partial_refund.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['startTime'] = start_time unless start_time.nil?
  command.query['token'] = token unless token.nil?
  command.query['type'] = type unless type.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_reviews(package_name, max_results: nil, start_index: nil, token: nil, translation_language: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ReviewsListResponse

Lists all reviews.

Parameters:

  • package_name (String)

    Package name of the app.

  • max_results (Fixnum) (defaults to: nil)

    How many results the list operation should return.

  • start_index (Fixnum) (defaults to: nil)

    The index of the first element to return.

  • token (String) (defaults to: nil)

    Pagination token. If empty, list starts at the first review.

  • translation_language (String) (defaults to: nil)

    Language localization 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



5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5413

def list_reviews(package_name, max_results: nil, start_index: nil, token: nil, translation_language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/reviews', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ReviewsListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ReviewsListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['token'] = token unless token.nil?
  command.query['translationLanguage'] = translation_language unless translation_language.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_systemapk_variants(package_name, version_code, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SystemApksListResponse

Returns the list of previously created system APK variants.

Parameters:

  • package_name (String)

    Package name of the app.

  • version_code (Fixnum)

    The version code of the App Bundle.

  • 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



5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5600

def list_systemapk_variants(package_name, version_code, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/systemApks/{versionCode}/variants', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::SystemApksListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SystemApksListResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['versionCode'] = version_code unless version_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_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListUsersResponse

Lists all users with access to a developer account.

Parameters:

  • parent (String)

    Required. The developer account to fetch users from. Format: developers/ developer

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. This must be set to -1 to disable pagination.

  • page_token (String) (defaults to: nil)

    A token received from a previous call to this method, in order to retrieve further results.

  • 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



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5701

def list_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/{+parent}/users', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::ListUsersResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ListUsersResponse
  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

#migrate_monetization_subscription_base_plan_prices(package_name, product_id, base_plan_id, migrate_base_plan_prices_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse

Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.

Parameters:

  • package_name (String)

    Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.

  • product_id (String)

    Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.

  • base_plan_id (String)

    Required. The unique base plan ID of the base plan to update prices on.

  • migrate_base_plan_prices_request_object (Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesRequest) (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



4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4221

def migrate_monetization_subscription_base_plan_prices(package_name, product_id, base_plan_id, migrate_base_plan_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesRequest::Representation
  command.request_object = migrate_base_plan_prices_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.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_edit_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppDetails

Patches details of an app.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • app_details_object (Google::Apis::AndroidpublisherV3::AppDetails) (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



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1263

def patch_edit_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/details', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::AppDetails::Representation
  command.request_object = app_details_object
  command.response_representation = Google::Apis::AndroidpublisherV3::AppDetails::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppDetails
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.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_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFile

Patches the APK's expansion file configuration to reference another APK's expansion file. To add a new expansion file use the Upload method.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • apk_version_code (Fixnum)

    The version code of the APK whose expansion file configuration is being read or modified.

  • expansion_file_type (String)

    The file type of the expansion file configuration which is being updated.

  • expansion_file_object (Google::Apis::AndroidpublisherV3::ExpansionFile) (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



1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1381

def patch_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ExpansionFile::Representation
  command.request_object = expansion_file_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ExpansionFile::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExpansionFile
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil?
  command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.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_edit_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Listing

Patches a localized store listing.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German).

  • listing_object (Google::Apis::AndroidpublisherV3::Listing) (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



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1831

def patch_edit_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Listing::Representation
  command.request_object = listing_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Listing::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Listing
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.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_edit_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Testers

Patches testers. Note: Testers resource does not support email lists.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    The track to update.

  • testers_object (Google::Apis::AndroidpublisherV3::Testers) (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



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1946

def patch_edit_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Testers::Representation
  command.request_object = testers_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Testers::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Testers
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.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_edit_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Track

Patches a track.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    Identifier of the track. More on track name

  • track_object (Google::Apis::AndroidpublisherV3::Track) (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



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2131

def patch_edit_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Track::Representation
  command.request_object = track_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Track
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.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_grant(name, grant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Grant

Updates access for the user to the given package.

Parameters:

  • name (String)

    Required. Resource name for this grant, following the pattern "developers/ developer/users/email/grants/package_name". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.

  • grant_object (Google::Apis::AndroidpublisherV3::Grant) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to be updated.

  • 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



2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2455

def patch_grant(name, grant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/{+name}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
  command.request_object = grant_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Grant
  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

#patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Patches an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • sku (String)

    Unique identifier for the in-app product.

  • in_app_product_object (Google::Apis::AndroidpublisherV3::InAppProduct) (defaults to: nil)
  • auto_convert_missing_prices (Boolean) (defaults to: nil)

    If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

  • 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



2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2771

def patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.request_object = in_app_product_object
  command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['sku'] = sku unless sku.nil?
  command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.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_monetization_onetimeproduct(package_name, product_id, one_time_product_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::OneTimeProduct

Creates or updates a one-time product.

Parameters:

  • package_name (String)

    Required. Immutable. Package name of the parent app.

  • product_id (String)

    Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (. ).

  • one_time_product_object (Google::Apis::AndroidpublisherV3::OneTimeProduct) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.

  • regions_version_version (String) (defaults to: nil)

    Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.

  • update_mask (String) (defaults to: nil)

    Required. The list of fields to be updated.

  • 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



3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3218

def patch_monetization_onetimeproduct(package_name, product_id, one_time_product_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/onetimeproducts/{productId}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::OneTimeProduct::Representation
  command.request_object = one_time_product_object
  command.response_representation = Google::Apis::AndroidpublisherV3::OneTimeProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::OneTimeProduct
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
  command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.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

#patch_monetization_subscription(package_name, product_id, subscription_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Subscription

Updates an existing subscription.

Parameters:

  • package_name (String)

    Immutable. Package name of the parent app.

  • product_id (String)

    Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.

  • subscription_object (Google::Apis::AndroidpublisherV3::Subscription) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

  • regions_version_version (String) (defaults to: nil)

    Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.

  • update_mask (String) (defaults to: nil)

    Required. The list of fields to be updated.

  • 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



3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3976

def patch_monetization_subscription(package_name, product_id, subscription_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.request_object = subscription_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Subscription
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
  command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.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

#patch_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, subscription_offer_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionOffer

Updates an existing subscription offer.

Parameters:

  • package_name (String)

    Required. Immutable. The package name of the app the parent subscription belongs to.

  • product_id (String)

    Required. Immutable. The ID of the parent subscription this offer belongs to.

  • base_plan_id (String)

    Required. Immutable. The ID of the base plan to which this offer is an extension.

  • offer_id (String)

    Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

  • subscription_offer_object (Google::Apis::AndroidpublisherV3::SubscriptionOffer) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

  • regions_version_version (String) (defaults to: nil)

    Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in this article. Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.

  • update_mask (String) (defaults to: nil)

    Required. The list of fields to be updated.

  • 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



4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4691

def patch_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, subscription_offer_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.request_object = subscription_offer_object
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
  command.params['offerId'] = offer_id unless offer_id.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
  command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.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

#patch_user(name, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::User

Updates access for the user to the developer account.

Parameters:

  • name (String)

    Required. Resource name for this user, following the pattern "developers/ developer/users/email".

  • user_object (Google::Apis::AndroidpublisherV3::User) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to be updated.

  • 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



5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5737

def patch_user(name, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'androidpublisher/v3/{+name}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AndroidpublisherV3::User::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::User
  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

#refund_order(package_name, order_id, revoke: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.

Parameters:

  • package_name (String)

    The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').

  • order_id (String)

    The order ID provided to the user when the subscription or in-app order was purchased.

  • revoke (Boolean) (defaults to: nil)

    Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional).

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

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4812
4813
4814
4815
4816
4817
4818
4819
4820
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4812

def refund_order(package_name, order_id, revoke: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund', options)
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['revoke'] = revoke unless revoke.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#refundexternaltransaction_externaltransaction(name, refund_external_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExternalTransaction

Refunds or partially refunds an existing external transaction.

Parameters:

  • name (String)

    Required. The name of the external transaction that will be refunded. Format: applications/package_name/externalTransactions/external_transaction

  • refund_external_transaction_request_object (Google::Apis::AndroidpublisherV3::RefundExternalTransactionRequest) (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



2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2279

def refundexternaltransaction_externaltransaction(name, refund_external_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/{+name}:refund', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::RefundExternalTransactionRequest::Representation
  command.request_object = refund_external_transaction_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
  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

#reply_review(package_name, review_id, reviews_reply_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ReviewsReplyResponse

Replies to a single review, or updates an existing reply.

Parameters:

  • package_name (String)

    Package name of the app.

  • review_id (String)

    Unique identifier for a review.

  • reviews_reply_request_object (Google::Apis::AndroidpublisherV3::ReviewsReplyRequest) (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



5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5450

def reply_review(package_name, review_id, reviews_reply_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/reviews/{reviewId}:reply', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ReviewsReplyRequest::Representation
  command.request_object = reviews_reply_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ReviewsReplyResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ReviewsReplyResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['reviewId'] = review_id unless review_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reviewrefund_order(package_name, order_id, orders_review_refund_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Provide refund preference and purchase usage for a chargeback request

Parameters:

  • package_name (String)

    Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').

  • order_id (String)

    Required. The order ID provided to the user when the subscription or in-app order was purchased.

  • orders_review_refund_request_object (Google::Apis::AndroidpublisherV3::OrdersReviewRefundRequest) (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:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

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



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4847

def reviewrefund_order(package_name, order_id, orders_review_refund_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/orders/{orderId}:reviewrefund', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::OrdersReviewRefundRequest::Representation
  command.request_object = orders_review_refund_request_object
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#revoke_subscriptionsv2_subscription_purchase(package_name, token, revoke_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse

Revoke a subscription purchase for the user.

Parameters:

  • package_name (String)

    Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').

  • token (String)

    Required. The token provided to the user's device when the subscription was purchased.

  • revoke_subscription_purchase_request_object (Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseRequest) (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



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5259

def revoke_subscriptionsv2_subscription_purchase(package_name, token, revoke_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseRequest::Representation
  command.request_object = revoke_subscription_purchase_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['token'] = token unless 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

#update_edit_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppDetails

Updates details of an app.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • app_details_object (Google::Apis::AndroidpublisherV3::AppDetails) (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



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1299

def update_edit_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/details', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::AppDetails::Representation
  command.request_object = app_details_object
  command.response_representation = Google::Apis::AndroidpublisherV3::AppDetails::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppDetails
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFile

Updates the APK's expansion file configuration to reference another APK's expansion file. To add a new expansion file use the Upload method.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • apk_version_code (Fixnum)

    The version code of the APK whose expansion file configuration is being read or modified.

  • expansion_file_type (String)

    The file type of the file configuration which is being read or modified.

  • expansion_file_object (Google::Apis::AndroidpublisherV3::ExpansionFile) (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



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1425

def update_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::ExpansionFile::Representation
  command.request_object = expansion_file_object
  command.response_representation = Google::Apis::AndroidpublisherV3::ExpansionFile::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExpansionFile
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil?
  command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_edit_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Listing

Creates or updates a localized store listing.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German).

  • listing_object (Google::Apis::AndroidpublisherV3::Listing) (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



1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1871

def update_edit_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Listing::Representation
  command.request_object = listing_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Listing::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Listing
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_edit_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Testers

Updates testers. Note: Testers resource does not support email lists.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    The track to update.

  • testers_object (Google::Apis::AndroidpublisherV3::Testers) (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



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1985

def update_edit_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/testers/{track}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Testers::Representation
  command.request_object = testers_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Testers::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Testers
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_edit_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Track

Updates a track.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • track (String)

    Identifier of the track. More on track name

  • track_object (Google::Apis::AndroidpublisherV3::Track) (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



2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2171

def update_edit_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks/{track}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::Track::Representation
  command.request_object = track_object
  command.response_representation = Google::Apis::AndroidpublisherV3::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Track
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['track'] = track unless track.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_inappproduct(package_name, sku, in_app_product_object = nil, allow_missing: nil, auto_convert_missing_prices: nil, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Updates an in-app product (a managed product or a subscription). This method should no longer be used to update subscriptions. See this article for more information.

Parameters:

  • package_name (String)

    Package name of the app.

  • sku (String)

    Unique identifier for the in-app product.

  • in_app_product_object (Google::Apis::AndroidpublisherV3::InAppProduct) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    If set to true, and the in-app product with the given package_name and sku doesn't exist, the in-app product will be created.

  • auto_convert_missing_prices (Boolean) (defaults to: nil)

    If true the prices for all regions targeted by the parent app that don't have a price specified for this in-app product will be auto converted to the target currency based on the default price. Defaults to false.

  • latency_tolerance (String) (defaults to: nil)

    Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.

  • 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



2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2822

def update_inappproduct(package_name, sku, in_app_product_object = nil, allow_missing: nil, auto_convert_missing_prices: nil, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.request_object = in_app_product_object
  command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['sku'] = sku unless sku.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
  command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#updateappstorehostedapp_appstoreappsreview(app_store_package_name, update_app_store_hosted_app_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppResponse

Updates details for an app hosted on an app store. Use this to provide details for a new app, or to update details for an existing app. The update will be sent for review immediately after creation.

Parameters:

  • app_store_package_name (String)

    Required. Package name of the third-party app store.

  • update_app_store_hosted_app_request_object (Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppRequest) (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



471
472
473
474
475
476
477
478
479
480
481
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 471

def updateappstorehostedapp_appstoreappsreview(app_store_package_name, update_app_store_hosted_app_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps:update', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppRequest::Representation
  command.request_object = update_app_store_hosted_app_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_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

#updateappstorehostedapppublishstatus_appstoreappsreview(app_store_package_name, package_name, update_app_store_hosted_app_publish_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppPublishStatusResponse

Updates the publish status of an app store hosted app. The default state after calling UpdateAppStoreHostedApp is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.

Parameters:

  • app_store_package_name (String)

    Required. Package name of the third-party app store.

  • package_name (String)

    Required. Package name of the app.

  • update_app_store_hosted_app_publish_status_request_object (Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppPublishStatusRequest) (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



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

def updateappstorehostedapppublishstatus_appstoreappsreview(app_store_package_name, package_name, update_app_store_hosted_app_publish_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}:updateAppStoreHostedAppPublishStatus', options)
  command.request_representation = Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppPublishStatusRequest::Representation
  command.request_object = update_app_store_hosted_app_publish_status_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppPublishStatusResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::UpdateAppStoreHostedAppPublishStatusResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_name.nil?
  command.params['packageName'] = package_name unless package_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

#upload_edit_apk(package_name, edit_id, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Apk

Uploads an APK and adds to the current edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1017

def upload_edit_apk(package_name, edit_id, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::Apk::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Apk
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, device_tier_config_id: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::Bundle

Uploads a new Android App Bundle to this edit. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See Timeouts and Errors for an example in java.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • ack_bundle_installation_warning (Boolean) (defaults to: nil)

    Deprecated. The installation warning has been removed, it's not necessary to set this field anymore.

  • device_tier_config_id (String) (defaults to: nil)

    Device tier config (DTC) to be used for generating deliverables (APKs). Contains id of the DTC or "LATEST" for last uploaded DTC.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1103

def upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, device_tier_config_id: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::Bundle::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::Bundle
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['ackBundleInstallationWarning'] = ack_bundle_installation_warning unless ack_bundle_installation_warning.nil?
  command.query['deviceTierConfigId'] = device_tier_config_id unless device_tier_config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_edit_deobfuscationfile(package_name, edit_id, apk_version_code, deobfuscation_file_type, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::DeobfuscationFilesUploadResponse

Uploads a new deobfuscation file and attaches to the specified APK.

Parameters:

  • package_name (String)

    Unique identifier for the Android app.

  • edit_id (String)

    Unique identifier for this edit.

  • apk_version_code (Fixnum)

    The version code of the APK whose Deobfuscation File is being uploaded.

  • deobfuscation_file_type (String)

    The type of the deobfuscation file.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1188

def upload_edit_deobfuscationfile(package_name, edit_id, apk_version_code, deobfuscation_file_type, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::DeobfuscationFilesUploadResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::DeobfuscationFilesUploadResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil?
  command.params['deobfuscationFileType'] = deobfuscation_file_type unless deobfuscation_file_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFilesUploadResponse

Uploads a new expansion file and attaches to the specified APK.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • apk_version_code (Fixnum)

    The version code of the APK whose expansion file configuration is being read or modified.

  • expansion_file_type (String)

    The file type of the expansion file configuration which is being updated.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1471

def upload_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::ExpansionFilesUploadResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ExpansionFilesUploadResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil?
  command.params['expansionFileType'] = expansion_file_type unless expansion_file_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_edit_image(package_name, edit_id, language, image_type, ai_generated_state: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ImagesUploadResponse

Uploads an image of the specified language and image type, and adds to the edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • language (String)

    Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). Providing a language that is not supported by the App is a no-op.

  • image_type (String)

    Type of the Image.

  • ai_generated_state (String) (defaults to: nil)

    Optional. Whether the image was generated by AI. Attested by the developer.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1649

def upload_edit_image(package_name, edit_id, language, image_type, ai_generated_state: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/listings/{language}/{imageType}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::ImagesUploadResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::ImagesUploadResponse
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.params['language'] = language unless language.nil?
  command.params['imageType'] = image_type unless image_type.nil?
  command.query['aiGeneratedState'] = ai_generated_state unless ai_generated_state.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#uploadapk_appstoreappsreview(app_store_package_name, package_name, upload_apk_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::UploadApkResponse

Upload an APK file for the hosted app. Returns an ID to track this APK.

Parameters:

  • app_store_package_name (String)

    Required. Package name of the third-party app store.

  • package_name (String)

    Required. Package name of the app.

  • upload_apk_request_object (Google::Apis::AndroidpublisherV3::UploadApkRequest) (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.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 548

def uploadapk_appstoreappsreview(app_store_package_name, package_name, upload_apk_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/apks:upload', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::AndroidpublisherV3::UploadApkRequest::Representation
  command.request_object = upload_apk_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::UploadApkResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::UploadApkResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_name.nil?
  command.params['packageName'] = package_name unless package_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

#uploadapk_internalappsharingartifact(package_name, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact

Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See Timeouts and Errors for an example in java.

Parameters:

  • package_name (String)

    Package name of the app.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2866

def uploadapk_internalappsharingartifact(package_name, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact
  command.params['packageName'] = package_name unless package_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

#uploadappstoreapppolicydeclarationfile_appstoreappsreview(app_store_package_name, package_name, upload_app_store_app_policy_declaration_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::UploadAppStoreAppPolicyDeclarationFileResponse

Upload a policy declaration file for the hosted app. Returns an ID to track the file.

Parameters:

  • app_store_package_name (String)

    Required. Package name of the third-party app store.

  • package_name (String)

    Required. Package name of the app.

  • upload_app_store_app_policy_declaration_file_request_object (Google::Apis::AndroidpublisherV3::UploadAppStoreAppPolicyDeclarationFileRequest) (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.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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
607
608
609
610
611
612
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 595

def uploadappstoreapppolicydeclarationfile_appstoreappsreview(app_store_package_name, package_name, upload_app_store_app_policy_declaration_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/policyDeclarationFiles:upload', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::AndroidpublisherV3::UploadAppStoreAppPolicyDeclarationFileRequest::Representation
  command.request_object = upload_app_store_app_policy_declaration_file_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::UploadAppStoreAppPolicyDeclarationFileResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::UploadAppStoreAppPolicyDeclarationFileResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_name.nil?
  command.params['packageName'] = package_name unless package_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

#uploadbundle_internalappsharingartifact(package_name, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact

Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See Timeouts and Errors for an example in java.

Parameters:

  • package_name (String)

    Package name of the app.

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

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2910

def uploadbundle_internalappsharingartifact(package_name, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact
  command.params['packageName'] = package_name unless package_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

#uploadimage_appstoreappsreview(app_store_package_name, package_name, upload_image_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::UploadImageResponse

Upload a screenshot or app icon for the hosted app. Returns an ID to track the image.

Parameters:

  • app_store_package_name (String)

    Required. Package name of the third-party app store.

  • package_name (String)

    Required. Package name of the app.

  • upload_image_request_object (Google::Apis::AndroidpublisherV3::UploadImageRequest) (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.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

  • 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



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 642

def uploadimage_appstoreappsreview(app_store_package_name, package_name, upload_image_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload', options)
  else
    command = make_upload_command(:post, 'androidpublisher/v3/appstore/{appStorePackageName}/apps/{packageName}/images:upload', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::AndroidpublisherV3::UploadImageRequest::Representation
  command.request_object = upload_image_request_object
  command.response_representation = Google::Apis::AndroidpublisherV3::UploadImageResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::UploadImageResponse
  command.params['appStorePackageName'] = app_store_package_name unless app_store_package_name.nil?
  command.params['packageName'] = package_name unless package_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

#validate_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::AppEdit

Validates an app edit.

Parameters:

  • package_name (String)

    Package name of the app.

  • edit_id (String)

    Identifier of the edit.

  • 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



908
909
910
911
912
913
914
915
916
917
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 908

def validate_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}:validate', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::AppEdit
  command.params['packageName'] = package_name unless package_name.nil?
  command.params['editId'] = edit_id unless edit_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end