Class: Google::Apis::AndroidpublisherV2::AndroidPublisherService

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

Overview

Google Play Developer API

Accesses Android application developers' Google Play accounts.

Examples:

require 'google/apis/androidpublisher_v2'

Androidpublisher = Google::Apis::AndroidpublisherV2 # 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

#initializeAndroidPublisherService

Returns a new instance of AndroidPublisherService


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

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

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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


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

def key
  @key
end

#quota_userString

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_v2/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


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

def user_ip
  @user_ip
end

Instance Method Details

#add_externally_hosted_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::AndroidpublisherV2::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::AndroidpublisherV2::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:


536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 536

def add_externally_hosted_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::AndroidpublisherV2::ApksAddExternallyHostedRequest::Representation
  command.request_object = apks_add_externally_hosted_request_object
  command.response_representation = Google::Apis::AndroidpublisherV2::ApksAddExternallyHostedResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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:


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2167

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::AndroidpublisherV2::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_v2/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::AndroidpublisherV2::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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, defer_subscription_purchases_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse

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.

  • defer_subscription_purchases_request_object (Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesRequest) (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:


2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2206

def defer_purchase_subscription(package_name, subscription_id, token, defer_subscription_purchases_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::AndroidpublisherV2::DeferSubscriptionPurchasesRequest::Representation
  command.request_object = defer_subscription_purchases_request_object
  command.response_representation = Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::DeferSubscriptionPurchasesResponse
  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_all_apk_listings(package_name, edit_id, apk_version_code, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes all the APK-specific localized listings for a specified 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.

  • apk_version_code (Fixnum)

    The APK version code whose APK-specific listings should be read or modified.

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


312
313
314
315
316
317
318
319
320
321
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 312

def delete_all_apk_listings(package_name, edit_id, apk_version_code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings', options)
  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.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_all_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::DeleteAllImagesResponse

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:


1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1164

def delete_all_images(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::AndroidpublisherV2::DeleteAllImagesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::DeleteAllImagesResponse
  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

#delete_all_listings(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:


1341
1342
1343
1344
1345
1346
1347
1348
1349
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1341

def delete_all_listings(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

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

This method returns an undefined value.

Deletes the APK-specific localized listing for a specified APK and language code.

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 APK version code whose APK-specific listings should be read or modified.

  • language (String)

    The language code (a BCP-47 language tag) of the APK-specific 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:


273
274
275
276
277
278
279
280
281
282
283
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 273

def delete_apk_listing(package_name, edit_id, apk_version_code, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options)
  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['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_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_v2/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_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:


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1121

def delete_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_in_app_product(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:


1840
1841
1842
1843
1844
1845
1846
1847
1848
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1840

def delete_in_app_product(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

#delete_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:


1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1305

def delete_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

#get_apk_listing(package_name, edit_id, apk_version_code, language, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ApkListing

Fetches the APK-specific localized listing for a specified APK and language code.

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 APK version code whose APK-specific listings should be read or modified.

  • language (String)

    The language code (a BCP-47 language tag) of the APK-specific 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:


355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 355

def get_apk_listing(package_name, edit_id, apk_version_code, language, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options)
  command.response_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ApkListing
  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['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_detail(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


806
807
808
809
810
811
812
813
814
815
816
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 806

def get_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::AndroidpublisherV2::AppDetails::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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_v2/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::AndroidpublisherV2::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_expansion_file(package_name, edit_id, apk_version_code, expansion_file_type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


927
928
929
930
931
932
933
934
935
936
937
938
939
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 927

def get_expansion_file(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::AndroidpublisherV2::ExpansionFile::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_in_app_product(package_name, sku, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1873

def get_in_app_product(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::AndroidpublisherV2::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_listing(package_name, edit_id, language, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1379

def get_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::AndroidpublisherV2::Listing::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2126

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::AndroidpublisherV2::ProductPurchase::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2249

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::AndroidpublisherV2::SubscriptionPurchase::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2421

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::AndroidpublisherV2::Review::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

#get_tester(package_name, edit_id, track, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1546

def get_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::AndroidpublisherV2::Testers::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_track(package_name, edit_id, track, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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:


1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1675

def get_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::AndroidpublisherV2::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

#insert_edit(package_name, app_edit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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_v2/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::AndroidpublisherV2::AppEdit::Representation
  command.request_object = app_edit_object
  command.response_representation = Google::Apis::AndroidpublisherV2::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_in_app_product(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::AndroidpublisherV2::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::AndroidpublisherV2::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:


1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1912

def insert_in_app_product(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::AndroidpublisherV2::InAppProduct::Representation
  command.request_object = in_app_product_object
  command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_apk_listings(package_name, edit_id, apk_version_code, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ListApkListingsResponse

Lists all the APK-specific localized listings for a specified 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.

  • apk_version_code (Fixnum)

    The APK version code whose APK-specific listings should be read or modified.

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


396
397
398
399
400
401
402
403
404
405
406
407
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 396

def list_apk_listings(package_name, edit_id, apk_version_code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings', options)
  command.response_representation = Google::Apis::AndroidpublisherV2::ListApkListingsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ListApkListingsResponse
  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.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_apks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ListApksResponse

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:


575
576
577
578
579
580
581
582
583
584
585
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 575

def list_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::AndroidpublisherV2::ListApksResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ListApksResponse
  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::AndroidpublisherV2::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:


659
660
661
662
663
664
665
666
667
668
669
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 659

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::AndroidpublisherV2::BundlesListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_images(package_name, edit_id, language, image_type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ListImagesResponse

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:


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1208

def list_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::AndroidpublisherV2::ListImagesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ListImagesResponse
  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_in_app_products(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ListInAppProductsResponse

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:


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1953

def list_in_app_products(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::AndroidpublisherV2::ListInAppProductsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ListInAppProductsResponse
  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_listings(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ListListingsResponse

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:


1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1417

def list_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::AndroidpublisherV2::ListListingsResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ListListingsResponse
  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_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::AndroidpublisherV2::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:


2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2380

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::AndroidpublisherV2::VoidedPurchasesListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2461

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::AndroidpublisherV2::ReviewsListResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

#list_tracks(package_name, edit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ListTracksResponse

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:


1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1713

def list_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::AndroidpublisherV2::ListTracksResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ListTracksResponse
  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_apk_listing(package_name, edit_id, apk_version_code, language, apk_listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ApkListing

Updates or creates the APK-specific localized listing for a specified APK and language code. 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 APK version code whose APK-specific listings should be read or modified.

  • language (String)

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

  • apk_listing_object (Google::Apis::AndroidpublisherV2::ApkListing) (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:


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

def patch_apk_listing(package_name, edit_id, apk_version_code, language, apk_listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options)
  command.request_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation
  command.request_object = apk_listing_object
  command.response_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ApkListing
  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['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_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


844
845
846
847
848
849
850
851
852
853
854
855
856
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 844

def patch_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::AndroidpublisherV2::AppDetails::Representation
  command.request_object = app_details_object
  command.response_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_expansion_file(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::AndroidpublisherV2::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::AndroidpublisherV2::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:


973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 973

def patch_expansion_file(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::AndroidpublisherV2::ExpansionFile::Representation
  command.request_object = expansion_file_object
  command.response_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_in_app_product(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::AndroidpublisherV2::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::AndroidpublisherV2::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:


1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1997

def patch_in_app_product(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::AndroidpublisherV2::InAppProduct::Representation
  command.request_object = in_app_product_object
  command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

#patch_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


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

def patch_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::AndroidpublisherV2::Listing::Representation
  command.request_object = listing_object
  command.response_representation = Google::Apis::AndroidpublisherV2::Listing::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1588

def patch_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::AndroidpublisherV2::Testers::Representation
  command.request_object = testers_object
  command.response_representation = Google::Apis::AndroidpublisherV2::Testers::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1755

def patch_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::AndroidpublisherV2::Track::Representation
  command.request_object = track_object
  command.response_representation = Google::Apis::AndroidpublisherV2::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

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


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2088

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:


2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2290

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


2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2501

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::AndroidpublisherV2::ReviewsReplyRequest::Representation
  command.request_object = reviews_reply_request_object
  command.response_representation = Google::Apis::AndroidpublisherV2::ReviewsReplyResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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:


2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2329

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_apk_listing(package_name, edit_id, apk_version_code, language, apk_listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::ApkListing

Updates or creates the APK-specific localized listing for a specified APK and language code.

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 APK version code whose APK-specific listings should be read or modified.

  • language (String)

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

  • apk_listing_object (Google::Apis::AndroidpublisherV2::ApkListing) (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:


491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 491

def update_apk_listing(package_name, edit_id, apk_version_code, language, apk_listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{packageName}/edits/{editId}/apks/{apkVersionCode}/listings/{language}', options)
  command.request_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation
  command.request_object = apk_listing_object
  command.response_representation = Google::Apis::AndroidpublisherV2::ApkListing::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::ApkListing
  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['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_detail(package_name, edit_id, app_details_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


884
885
886
887
888
889
890
891
892
893
894
895
896
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 884

def update_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::AndroidpublisherV2::AppDetails::Representation
  command.request_object = app_details_object
  command.response_representation = Google::Apis::AndroidpublisherV2::AppDetails::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_expansion_file(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::AndroidpublisherV2::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::AndroidpublisherV2::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:


1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1020

def update_expansion_file(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::AndroidpublisherV2::ExpansionFile::Representation
  command.request_object = expansion_file_object
  command.response_representation = Google::Apis::AndroidpublisherV2::ExpansionFile::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_in_app_product(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::AndroidpublisherV2::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::AndroidpublisherV2::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:


2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 2042

def update_in_app_product(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::AndroidpublisherV2::InAppProduct::Representation
  command.request_object = in_app_product_object
  command.response_representation = Google::Apis::AndroidpublisherV2::InAppProduct::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

#update_listing(package_name, edit_id, language, listing_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1503

def update_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::AndroidpublisherV2::Listing::Representation
  command.request_object = listing_object
  command.response_representation = Google::Apis::AndroidpublisherV2::Listing::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_tester(package_name, edit_id, track, testers_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1632

def update_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::AndroidpublisherV2::Testers::Representation
  command.request_object = testers_object
  command.response_representation = Google::Apis::AndroidpublisherV2::Testers::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_track(package_name, edit_id, track, track_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


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

def update_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::AndroidpublisherV2::Track::Representation
  command.request_object = track_object
  command.response_representation = Google::Apis::AndroidpublisherV2::Track::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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

#upload_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::AndroidpublisherV2::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:


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

def upload_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::AndroidpublisherV2::Apk::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 708

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::AndroidpublisherV2::Bundle::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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::AndroidpublisherV2::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:


760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 760

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::AndroidpublisherV2::DeobfuscationFilesUploadResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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_expansion_file(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::AndroidpublisherV2::UploadExpansionFilesResponse

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:


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1069

def upload_expansion_file(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::AndroidpublisherV2::UploadExpansionFilesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::UploadExpansionFilesResponse
  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_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::AndroidpublisherV2::UploadImagesResponse

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:


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
# File 'generated/google/apis/androidpublisher_v2/service.rb', line 1257

def upload_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::AndroidpublisherV2::UploadImagesResponse::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::UploadImagesResponse
  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::AndroidpublisherV2::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_v2/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::AndroidpublisherV2::AppEdit::Representation
  command.response_class = Google::Apis::AndroidpublisherV2::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