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

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/androidpublisher_v3/service.rb

Overview

Google Play Developer API

Accesses Android application developers' Google Play accounts.

Examples:

require 'google/apis/androidpublisher_v3'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ AndroidPublisherService

Returns a new instance of AndroidPublisherService



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

def initialize
  super('https://www.googleapis.com/', 'androidpublisher/v3/applications/')
  @batch_path = 'batch/androidpublisher/v3'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



38
39
40
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 43

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



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

def user_ip
  @user_ip
end

Instance Method Details

#addexternallyhosted_edit_apk(package_name, edit_id, apks_add_externally_hosted_request_object = nil, fields: nil, quota_user: nil, user_ip: 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 enterprises using Google Play for Work whose application is configured to restrict distribution to the enterprise domain.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • apks_add_externally_hosted_request_object (Google::Apis::AndroidpublisherV3::ApksAddExternallyHostedRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 270

def addexternallyhosted_edit_apk(package_name, edit_id, apks_add_externally_hosted_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#cancel_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1901

def cancel_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Commits/applies the changes made in this edit back to the app.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def commit_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1940

def defer_purchase_subscription(package_name, subscription_id, token, subscription_purchases_defer_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



118
119
120
121
122
123
124
125
126
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 118

def delete_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass " de-AT".

  • image_type (String)
  • image_id (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 855

def delete_edit_image(package_name, edit_id, language, image_type, image_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes the specified localized store listing from an edit.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1039

def delete_edit_listing(package_name, edit_id, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Delete an in-app product for an app.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app with the in-app product; for example, " com.spiffygame".

  • sku (String) —

    Unique identifier for the in-app product.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1574

def delete_inappproduct(package_name, sku, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes all images for the specified language and image type.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass " de-AT".

  • image_type (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def deleteall_edit_image(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes all localized listings from an edit.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1075

def deleteall_edit_listing(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Fetches app details for this edit. This includes the default language and developer support contact information.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_edit_detail(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFile

Fetches the Expansion File configuration for the APK specified.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • apk_version_code (Fixnum) —

    The version code of the APK whose Expansion File configuration is being read or modified.

  • expansion_file_type (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 661

def get_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Fetches information about a localized store listing.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1113

def get_edit_listing(package_name, edit_id, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • track (String) —

    The track to read or modify. Acceptable values are: "alpha", "beta", " production", "rollout" or "internal".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1280

def get_edit_tester(package_name, edit_id, track, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Fetches the track configuration for the specified track type. Includes the APK version codes that are in this track.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • track (String) —

    The track to read or modify.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1409

def get_edit_track(package_name, edit_id, track, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Returns information about the in-app product specified.

Parameters:

  • package_name (String)
  • sku (String) —

    Unique identifier for the in-app product.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1607

def get_inappproduct(package_name, sku, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1860

def get_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Returns a single review.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app for which we want reviews; for example, " com.spiffygame".

  • review_id (String)
  • translation_language (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_review(package_name, review_id, translation_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates a new edit for an app, populated with the app's current state.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • app_edit_object (Google::Apis::AndroidpublisherV3::AppEdit) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def insert_edit(package_name, app_edit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Creates a new in-app product for an app.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app; for example, "com.spiffygame".

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1646

def insert_inappproduct(package_name, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_edit_apks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ApksListResponse

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



309
310
311
312
313
314
315
316
317
318
319
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 309

def list_edit_apks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_edit_bundles(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::BundlesListResponse

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_edit_bundles(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Lists all images for the specified language and image type.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass " de-AT".

  • image_type (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 942

def list_edit_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_edit_listings(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ListingsListResponse

Returns all of the localized store listings attached to this edit.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_edit_listings(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_edit_tracks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::TracksListResponse

Lists all the track configurations for this edit.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1447

def list_edit_tracks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InappproductsListResponse

List all the in-app products for an Android app, both subscriptions and managed in-app products..

Parameters:

  • package_name (String) —

    Unique identifier for the Android app with in-app products; for example, "com. spiffygame".

  • max_results (Fixnum)
  • start_index (Fixnum)
  • token (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_inappproducts(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, fields: nil, quota_user: nil, user_ip: 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) —

    The time, in milliseconds since the Epoch, of the newest voided in-app product 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)
  • start_index (Fixnum)
  • start_time (Fixnum) —

    The time, in milliseconds since the Epoch, of the oldest voided in-app product 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)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_purchase_voidedpurchases(package_name, end_time: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ReviewsListResponse

Returns a list of reviews. Only reviews from last week will be returned.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app for which we want reviews; for example, " com.spiffygame".

  • max_results (Fixnum)
  • start_index (Fixnum)
  • token (String)
  • translation_language (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 2195

def list_reviews(package_name, max_results: nil, start_index: nil, token: nil, translation_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates app details for this edit. This method supports patch semantics.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • app_details_object (Google::Apis::AndroidpublisherV3::AppDetails) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def patch_edit_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFile

Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method. This method supports patch semantics.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • apk_version_code (Fixnum) —

    The version code of the APK whose Expansion File configuration is being read or modified.

  • expansion_file_type (String)
  • expansion_file_object (Google::Apis::AndroidpublisherV3::ExpansionFile) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 707

def patch_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates or updates a localized store listing. This method supports patch semantics.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".

  • listing_object (Google::Apis::AndroidpublisherV3::Listing) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1193

def patch_edit_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • track (String) —

    The track to read or modify. Acceptable values are: "alpha", "beta", " production", "rollout" or "internal".

  • testers_object (Google::Apis::AndroidpublisherV3::Testers) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1322

def patch_edit_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • track (String) —

    The track to read or modify.

  • track_object (Google::Apis::AndroidpublisherV3::Track) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1489

def patch_edit_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::InAppProduct

Updates the details of an in-app product. This method supports patch semantics.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app with the in-app product; for example, " com.spiffygame".

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1731

def patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Refund a user's subscription or in-app purchase order.

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1822

def refund_order(package_name, order_id, revoke: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#refund_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



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

def refund_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Reply to a single review, or update an existing reply.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app for which we want reviews; for example, " com.spiffygame".

  • review_id (String)
  • reviews_reply_request_object (Google::Apis::AndroidpublisherV3::ReviewsReplyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def reply_review(package_name, review_id, reviews_reply_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#revoke_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    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:



2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 2063

def revoke_purchase_subscription(package_name, subscription_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates app details for this edit.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • app_details_object (Google::Apis::AndroidpublisherV3::AppDetails) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 618

def update_edit_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFile

Updates the APK's Expansion File configuration to reference another APK's Expansion Files. To add a new Expansion File use the Upload method.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • apk_version_code (Fixnum) —

    The version code of the APK whose Expansion File configuration is being read or modified.

  • expansion_file_type (String)
  • expansion_file_object (Google::Apis::AndroidpublisherV3::ExpansionFile) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def update_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, expansion_file_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates or updates a localized store listing.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing to read or modify. For example, to select Austrian German, pass "de-AT".

  • listing_object (Google::Apis::AndroidpublisherV3::Listing) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1237

def update_edit_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • track (String) —

    The track to read or modify. Acceptable values are: "alpha", "beta", " production", "rollout" or "internal".

  • testers_object (Google::Apis::AndroidpublisherV3::Testers) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1366

def update_edit_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • track (String) —

    The track to read or modify.

  • track_object (Google::Apis::AndroidpublisherV3::Track) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def update_edit_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates the details of an in-app product.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app with the in-app product; for example, " com.spiffygame".

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

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 1776

def update_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 350

def upload_edit_apk(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, '{packageName}/edits/{editId}/apks', options)
  else
    command = make_upload_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, fields: nil, quota_user: nil, user_ip: 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: https:// developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • ack_bundle_installation_warning (Boolean) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 442

def upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, '{packageName}/edits/{editId}/bundles', options)
  else
    command = make_upload_command(:post, '{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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::DeobfuscationFilesUploadResponse

Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced.

Parameters:

  • package_name (String) —

    Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame".

  • 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)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 494

def upload_edit_deobfuscationfile(package_name, edit_id, apk_version_code, deobfuscation_file_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options)
  else
    command = make_upload_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV3::ExpansionFilesUploadResponse

Uploads and attaches a new Expansion File to the APK specified.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • apk_version_code (Fixnum) —

    The version code of the APK whose Expansion File configuration is being read or modified.

  • expansion_file_type (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 803

def upload_edit_expansionfile(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/expansionFiles/{expansionFileType}', options)
  else
    command = make_upload_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Uploads a new image and adds it to the list of images for the specified language and image type.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • language (String) —

    The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass " de-AT".

  • image_type (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 991

def upload_edit_image(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, '{packageName}/edits/{editId}/listings/{language}/{imageType}', options)
  else
    command = make_upload_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.

Parameters:

  • package_name (String) —

    Unique identifier for the Android app that is being updated; for example, "com. spiffygame".

  • edit_id (String) —

    Unique identifier for this edit.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



229
230
231
232
233
234
235
236
237
238
239
 
# File 'generated/google/apis/androidpublisher_v3/service.rb', line 229

def validate_edit(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end