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

#initialize ⇒ AndroidPublisherService

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

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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



3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3702

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) —

    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



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

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



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

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



3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3189

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



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 224

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



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

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



2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2612

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



3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3234

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



2122
2123
2124
2125
2126
2127
2128
2129
2130
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2122

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



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2157

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



2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2194

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



2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2988

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



3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3326

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



3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3029

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



2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2649

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



3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3280

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



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

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

#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



262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 262

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_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Cancels a user's subscription purchase. The subscription remains valid until its 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.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



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

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

#commit_edit(package_name, edit_id, 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_not_sent_for_review (Boolean) (defaults to: nil) —

    Indicates that the changes in this edit will not be reviewed until they are explicitly sent for review from 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



408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 408

def commit_edit(package_name, edit_id, 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['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



3739
3740
3741
3742
3743
3744
3745
3746
3747
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3739

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



2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2576

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



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

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



1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1650

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



2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2017

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 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. The latest version is 2022/02.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2733

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 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. The latest version is 2022/02.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should 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



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

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



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

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



4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4444

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



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

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



3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3069

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



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

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

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



3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3886

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

#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



442
443
444
445
446
447
448
449
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 442

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



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1150

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



1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1322

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



2050
2051
2052
2053
2054
2055
2056
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2050

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



2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2234

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



2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2771

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



3108
3109
3110
3111
3112
3113
3114
3115
3116
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3108

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



3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3468

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



4477
4478
4479
4480
4481
4482
4483
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4477

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



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

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



1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1354

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



334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 334

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



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

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



4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4338

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



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

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



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

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



860
861
862
863
864
865
866
867
868
869
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 860

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



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

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



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1388

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



1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1537

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



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1688

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



2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2269

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



2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2802

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



3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3505

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



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

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

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



3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3926

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



4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4034

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



4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4184

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



4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4377

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



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

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

#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



505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 505

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



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

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



371
372
373
374
375
376
377
378
379
380
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 371

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



611
612
613
614
615
616
617
618
619
620
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 611

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



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

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



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

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



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1422

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



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1722

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



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

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



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

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



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

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



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2845

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



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

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



4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4224

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



4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4411

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



4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4512

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



3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3147

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



894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 894

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



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1012

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



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1459

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



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1574

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



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

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



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2083

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



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2399

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_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 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. The latest version is 2022/02.

  • 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



2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2902

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 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. The latest version is 2022/02.

  • 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



3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3617

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



4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4548

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



3666
3667
3668
3669
3670
3671
3672
3673
3674
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3666

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.

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



3964
3965
3966
3967
3968
3969
3970
3971
3972
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3964

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



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

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



4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4261

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.

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



4000
4001
4002
4003
4004
4005
4006
4007
4008
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 4000

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



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

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



930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 930

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



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

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



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

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



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1613

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



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

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



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2450

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



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

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



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 734

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



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 819

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



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

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

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

    Selector specifying which fields to include in a partial response.

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

    Available 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



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1278

def upload_edit_image(package_name, edit_id, language, image_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}/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['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



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

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



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

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



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

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