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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAndroidPublisherService

Returns a new instance of AndroidPublisherService.



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

def initialize
  super('https://androidpublisher.googleapis.com/', '',
        client_name: 'google-apis-androidpublisher_v3',
        client_version: Google::Apis::AndroidpublisherV3::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



40
41
42
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 40

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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



45
46
47
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 45

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



2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2873

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



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

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



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

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



2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2519

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

#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



359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 359

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

Archives a subscription. Can only be done if at least one base plan was active in the past, and no base plan is available for new or existing subscribers currently. This action is irreversible, and the subscription ID will remain reserved.

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



2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2115

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

#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



2986
2987
2988
2989
2990
2991
2992
2993
2994
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2986

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



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

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

#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



2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2076

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



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

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



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

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 version of the available regions being used for the specified resource. The current 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



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

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 version of the available regions being used for the specified resource. The current 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



2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2569

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



3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3389

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



3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3535

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

#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



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

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



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

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



3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3022

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



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

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



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

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



1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1106

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



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

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

This method returns an undefined value.

Deletes an in-app product (i.e. a managed product or a subscriptions).

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:

  • 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



1757
1758
1759
1760
1761
1762
1763
1764
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1757

def delete_inappproduct(package_name, sku, 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['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



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

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



2436
2437
2438
2439
2440
2441
2442
2443
2444
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2436

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



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2656

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



3568
3569
3570
3571
3572
3573
3574
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3568

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



975
976
977
978
979
980
981
982
983
984
985
986
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 975

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



1138
1139
1140
1141
1142
1143
1144
1145
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1138

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

#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



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1585

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



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

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



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

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



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

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



561
562
563
564
565
566
567
568
569
570
571
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 561

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



644
645
646
647
648
649
650
651
652
653
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 644

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



754
755
756
757
758
759
760
761
762
763
764
765
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 754

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



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1172

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



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

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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1435

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.

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



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1788

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



2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2227

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



2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2693

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



2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2910

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



3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3062

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



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3170

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



3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3275

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



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

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

#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



288
289
290
291
292
293
294
295
296
297
298
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 288

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 (i.e. a managed product or a subscriptions).

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



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1824

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



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

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



394
395
396
397
398
399
400
401
402
403
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 394

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



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

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



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

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



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1206

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



1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1469

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



1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1623

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.

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



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1867

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.

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

  • 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



2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2741

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)

    Whether archived subscriptions should be included in the response. 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



2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2271

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

  • 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



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

def list_purchase_voidedpurchases(package_name, end_time: 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['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



3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3315

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



3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3502

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



3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3603

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 who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.

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



2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2477

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



678
679
680
681
682
683
684
685
686
687
688
689
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 678

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



796
797
798
799
800
801
802
803
804
805
806
807
808
809
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 796

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



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1243

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



1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1358

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.

  • 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



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1505

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



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

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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Patches an in-app product (i.e. a managed product or a subscriptions).

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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the 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
1918
1919
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1907

def patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: 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['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, 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)
  • regions_version_version (String) (defaults to: nil)

    Required. A string representing version of the available regions being used for the specified resource. The current 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



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

def patch_monetization_subscription(package_name, product_id, subscription_object = 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['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, 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)
  • regions_version_version (String) (defaults to: nil)

    Required. A string representing version of the available regions being used for the specified resource. The current 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



2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2790

def patch_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, subscription_offer_object = 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['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



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3639

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 1 year 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



2837
2838
2839
2840
2841
2842
2843
2844
2845
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2837

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



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

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

#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



3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3352

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



3136
3137
3138
3139
3140
3141
3142
3143
3144
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 3136

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

#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



714
715
716
717
718
719
720
721
722
723
724
725
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 714

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



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

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



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

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



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1397

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.

  • 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



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1544

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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Updates an in-app product (i.e. a managed product or a subscriptions).

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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1951

def update_inappproduct(package_name, sku, in_app_product_object = nil, allow_missing: nil, auto_convert_missing_prices: 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['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



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

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)

    Must be set to true if the app bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB).

  • 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



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 518

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



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 603

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



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 886

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



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1062

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



1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 1994

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



2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 2038

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



322
323
324
325
326
327
328
329
330
331
# File 'lib/google/apis/androidpublisher_v3/service.rb', line 322

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