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



4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4518

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



4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4664

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



3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3689

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



3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3009

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



3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3933

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



615
616
617
618
619
620
621
622
623
624
625
626
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 615

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



3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3356

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



3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3054

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



2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2932

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



3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3096

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



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

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



2164
2165
2166
2167
2168
2169
2170
2171
2172
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2164

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



2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2199

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



2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2236

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



2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2687

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



3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3183

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



2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2969

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



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3732

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



4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4070

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



3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3773

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



3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3393

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



2653
2654
2655
2656
2657
2658
2659
2660
2661
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2653

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



2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2721

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



3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3140

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



4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4024

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



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

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



4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4406

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



3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3224

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



4706
4707
4708
4709
4710
4711
4712
4713
4714
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4706

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



4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4894

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



446
447
448
449
450
451
452
453
454
455
456
457
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 446

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



4555
4556
4557
4558
4559
4560
4561
4562
4563
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4555

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



2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2618

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



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

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



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

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



3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3477

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



4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4125

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



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5233

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



5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5379

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

#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



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1883

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



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3813

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



3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3266

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



4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4170

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



4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4743

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



4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4932

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



481
482
483
484
485
486
487
488
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 481

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



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1189

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



1364
1365
1366
1367
1368
1369
1370
1371
1372
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1364

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



2092
2093
2094
2095
2096
2097
2098
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2092

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



2276
2277
2278
2279
2280
2281
2282
2283
2284
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2276

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



2758
2759
2760
2761
2762
2763
2764
2765
2766
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2758

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



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

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



3852
3853
3854
3855
3856
3857
3858
3859
3860
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3852

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



4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4212

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



5412
5413
5414
5415
5416
5417
5418
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5412

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



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

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



1396
1397
1398
1399
1400
1401
1402
1403
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1396

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



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1988

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



5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5273

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_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



512
513
514
515
516
517
518
519
520
521
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 512

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



816
817
818
819
820
821
822
823
824
825
826
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 816

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



899
900
901
902
903
904
905
906
907
908
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 899

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



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1009

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



1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1430

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



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1579

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



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1730

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



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2311

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



2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2790

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



3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3546

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



4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4249

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



4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4441

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



4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4590

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_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::SubscriptionPurchase

Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry 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.

  • 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



4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4783

def get_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}', options)
  command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchase::Representation
  command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionPurchase
  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

#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



4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4969

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



5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5119

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



5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5312

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



1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1917

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



4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4625

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



544
545
546
547
548
549
550
551
552
553
554
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 544

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



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2350

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_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



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

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



726
727
728
729
730
731
732
733
734
735
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 726

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



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1271

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



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1464

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



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1764

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



2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2026

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



2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2395

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



3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3318

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



2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2832

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



4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4299

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



3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3589

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



5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5078

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



5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5159

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



5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5346

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



5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5447

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



3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3891

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



933
934
935
936
937
938
939
940
941
942
943
944
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 933

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



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1051

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



1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1501

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



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1616

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



1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1801

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



2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2125

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



2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2441

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



2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2888

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



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

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



4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4361

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



5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5483

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



4482
4483
4484
4485
4486
4487
4488
4489
4490
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4482

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

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

This method returns an undefined value.

Deprecated: Use orders.refund instead. Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

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.

  • 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



4822
4823
4824
4825
4826
4827
4828
4829
4830
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4822

def refund_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}:refund', 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

#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



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

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



5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5196

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

#revoke_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.revoke instead. Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring.

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.

  • 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



4859
4860
4861
4862
4863
4864
4865
4866
4867
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4859

def revoke_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}:revoke', 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

#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



5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 5005

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



969
970
971
972
973
974
975
976
977
978
979
980
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 969

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



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1095

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



1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1541

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



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

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



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1841

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



2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2492

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

#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



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 687

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



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

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



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 858

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



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1141

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



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1319

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_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



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2536

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

#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



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2580

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

#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



578
579
580
581
582
583
584
585
586
587
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 578

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