google-apis-androidpublisher_v3 0.34.0 → 0.83.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +203 -0
- data/OVERVIEW.md +2 -2
- data/lib/google/apis/androidpublisher_v3/classes.rb +5465 -1679
- data/lib/google/apis/androidpublisher_v3/gem_version.rb +3 -3
- data/lib/google/apis/androidpublisher_v3/representations.rb +2491 -525
- data/lib/google/apis/androidpublisher_v3/service.rb +1103 -81
- metadata +7 -10
@@ -34,6 +34,8 @@ module Google
|
|
34
34
|
#
|
35
35
|
# @see https://developers.google.com/android-publisher
|
36
36
|
class AndroidPublisherService < Google::Apis::Core::BaseService
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "https://androidpublisher.$UNIVERSE_DOMAIN$/"
|
38
|
+
|
37
39
|
# @return [String]
|
38
40
|
# API key. Your API key identifies your project and provides you with API access,
|
39
41
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
@@ -45,12 +47,45 @@ module Google
|
|
45
47
|
attr_accessor :quota_user
|
46
48
|
|
47
49
|
def initialize
|
48
|
-
super(
|
50
|
+
super(DEFAULT_ENDPOINT_TEMPLATE, '',
|
49
51
|
client_name: 'google-apis-androidpublisher_v3',
|
50
52
|
client_version: Google::Apis::AndroidpublisherV3::GEM_VERSION)
|
51
53
|
@batch_path = 'batch'
|
52
54
|
end
|
53
55
|
|
56
|
+
# Writes the Safety Labels declaration of an app.
|
57
|
+
# @param [String] package_name
|
58
|
+
# Required. Package name of the app.
|
59
|
+
# @param [Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateRequest] safety_labels_update_request_object
|
60
|
+
# @param [String] fields
|
61
|
+
# Selector specifying which fields to include in a partial response.
|
62
|
+
# @param [String] quota_user
|
63
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
64
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
65
|
+
# @param [Google::Apis::RequestOptions] options
|
66
|
+
# Request-specific options
|
67
|
+
#
|
68
|
+
# @yield [result, err] Result & error if block supplied
|
69
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse] parsed result object
|
70
|
+
# @yieldparam err [StandardError] error object if request failed
|
71
|
+
#
|
72
|
+
# @return [Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse]
|
73
|
+
#
|
74
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
75
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
76
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
77
|
+
def data_application_safety(package_name, safety_labels_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
78
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/dataSafety', options)
|
79
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateRequest::Representation
|
80
|
+
command.request_object = safety_labels_update_request_object
|
81
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse::Representation
|
82
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse
|
83
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
84
|
+
command.query['fields'] = fields unless fields.nil?
|
85
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
86
|
+
execute_or_queue_command(command, &block)
|
87
|
+
end
|
88
|
+
|
54
89
|
# Creates a new device tier config for an app.
|
55
90
|
# @param [String] package_name
|
56
91
|
# Package name of the app.
|
@@ -162,15 +197,198 @@ module Google
|
|
162
197
|
execute_or_queue_command(command, &block)
|
163
198
|
end
|
164
199
|
|
200
|
+
# Incrementally update targeting for a recovery action. Note that only the
|
201
|
+
# criteria selected during the creation of recovery action can be expanded.
|
202
|
+
# @param [String] package_name
|
203
|
+
# Required. Package name of the app for which recovery action is to be updated.
|
204
|
+
# @param [Fixnum] app_recovery_id
|
205
|
+
# Required. ID corresponding to the app recovery action.
|
206
|
+
# @param [Google::Apis::AndroidpublisherV3::AddTargetingRequest] add_targeting_request_object
|
207
|
+
# @param [String] fields
|
208
|
+
# Selector specifying which fields to include in a partial response.
|
209
|
+
# @param [String] quota_user
|
210
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
211
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
212
|
+
# @param [Google::Apis::RequestOptions] options
|
213
|
+
# Request-specific options
|
214
|
+
#
|
215
|
+
# @yield [result, err] Result & error if block supplied
|
216
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::AddTargetingResponse] parsed result object
|
217
|
+
# @yieldparam err [StandardError] error object if request failed
|
218
|
+
#
|
219
|
+
# @return [Google::Apis::AndroidpublisherV3::AddTargetingResponse]
|
220
|
+
#
|
221
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
222
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
223
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
224
|
+
def add_apprecovery_targeting(package_name, app_recovery_id, add_targeting_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
225
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:addTargeting', options)
|
226
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::AddTargetingRequest::Representation
|
227
|
+
command.request_object = add_targeting_request_object
|
228
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::AddTargetingResponse::Representation
|
229
|
+
command.response_class = Google::Apis::AndroidpublisherV3::AddTargetingResponse
|
230
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
231
|
+
command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
|
232
|
+
command.query['fields'] = fields unless fields.nil?
|
233
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
234
|
+
execute_or_queue_command(command, &block)
|
235
|
+
end
|
236
|
+
|
237
|
+
# Cancel an already executing app recovery action. Note that this action changes
|
238
|
+
# status of the recovery action to CANCELED.
|
239
|
+
# @param [String] package_name
|
240
|
+
# Required. Package name of the app for which recovery action cancellation is
|
241
|
+
# requested.
|
242
|
+
# @param [Fixnum] app_recovery_id
|
243
|
+
# Required. ID corresponding to the app recovery action.
|
244
|
+
# @param [Google::Apis::AndroidpublisherV3::CancelAppRecoveryRequest] cancel_app_recovery_request_object
|
245
|
+
# @param [String] fields
|
246
|
+
# Selector specifying which fields to include in a partial response.
|
247
|
+
# @param [String] quota_user
|
248
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
249
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
250
|
+
# @param [Google::Apis::RequestOptions] options
|
251
|
+
# Request-specific options
|
252
|
+
#
|
253
|
+
# @yield [result, err] Result & error if block supplied
|
254
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse] parsed result object
|
255
|
+
# @yieldparam err [StandardError] error object if request failed
|
256
|
+
#
|
257
|
+
# @return [Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse]
|
258
|
+
#
|
259
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
260
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
261
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
262
|
+
def cancel_apprecovery_app_recovery(package_name, app_recovery_id, cancel_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
263
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel', options)
|
264
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::CancelAppRecoveryRequest::Representation
|
265
|
+
command.request_object = cancel_app_recovery_request_object
|
266
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse::Representation
|
267
|
+
command.response_class = Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse
|
268
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
269
|
+
command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
|
270
|
+
command.query['fields'] = fields unless fields.nil?
|
271
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
272
|
+
execute_or_queue_command(command, &block)
|
273
|
+
end
|
274
|
+
|
275
|
+
# Create an app recovery action with recovery status as DRAFT. Note that this
|
276
|
+
# action does not execute the recovery action.
|
277
|
+
# @param [String] package_name
|
278
|
+
# Required. Package name of the app on which recovery action is performed.
|
279
|
+
# @param [Google::Apis::AndroidpublisherV3::CreateDraftAppRecoveryRequest] create_draft_app_recovery_request_object
|
280
|
+
# @param [String] fields
|
281
|
+
# Selector specifying which fields to include in a partial response.
|
282
|
+
# @param [String] quota_user
|
283
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
284
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
285
|
+
# @param [Google::Apis::RequestOptions] options
|
286
|
+
# Request-specific options
|
287
|
+
#
|
288
|
+
# @yield [result, err] Result & error if block supplied
|
289
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::AppRecoveryAction] parsed result object
|
290
|
+
# @yieldparam err [StandardError] error object if request failed
|
291
|
+
#
|
292
|
+
# @return [Google::Apis::AndroidpublisherV3::AppRecoveryAction]
|
293
|
+
#
|
294
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
295
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
296
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
297
|
+
def create_apprecovery_draft_app_recovery(package_name, create_draft_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
298
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries', options)
|
299
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::CreateDraftAppRecoveryRequest::Representation
|
300
|
+
command.request_object = create_draft_app_recovery_request_object
|
301
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::AppRecoveryAction::Representation
|
302
|
+
command.response_class = Google::Apis::AndroidpublisherV3::AppRecoveryAction
|
303
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
304
|
+
command.query['fields'] = fields unless fields.nil?
|
305
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
306
|
+
execute_or_queue_command(command, &block)
|
307
|
+
end
|
308
|
+
|
309
|
+
# Deploy an already created app recovery action with recovery status DRAFT. Note
|
310
|
+
# that this action activates the recovery action for all targeted users and
|
311
|
+
# changes its status to ACTIVE.
|
312
|
+
# @param [String] package_name
|
313
|
+
# Required. Package name of the app for which recovery action is deployed.
|
314
|
+
# @param [Fixnum] app_recovery_id
|
315
|
+
# Required. ID corresponding to the app recovery action to deploy.
|
316
|
+
# @param [Google::Apis::AndroidpublisherV3::DeployAppRecoveryRequest] deploy_app_recovery_request_object
|
317
|
+
# @param [String] fields
|
318
|
+
# Selector specifying which fields to include in a partial response.
|
319
|
+
# @param [String] quota_user
|
320
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
321
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
322
|
+
# @param [Google::Apis::RequestOptions] options
|
323
|
+
# Request-specific options
|
324
|
+
#
|
325
|
+
# @yield [result, err] Result & error if block supplied
|
326
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse] parsed result object
|
327
|
+
# @yieldparam err [StandardError] error object if request failed
|
328
|
+
#
|
329
|
+
# @return [Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse]
|
330
|
+
#
|
331
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
332
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
333
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
334
|
+
def deploy_apprecovery_app_recovery(package_name, app_recovery_id, deploy_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
335
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:deploy', options)
|
336
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::DeployAppRecoveryRequest::Representation
|
337
|
+
command.request_object = deploy_app_recovery_request_object
|
338
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse::Representation
|
339
|
+
command.response_class = Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse
|
340
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
341
|
+
command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
|
342
|
+
command.query['fields'] = fields unless fields.nil?
|
343
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
344
|
+
execute_or_queue_command(command, &block)
|
345
|
+
end
|
346
|
+
|
347
|
+
# List all app recovery action resources associated with a particular package
|
348
|
+
# name and app version.
|
349
|
+
# @param [String] package_name
|
350
|
+
# Required. Package name of the app for which list of recovery actions is
|
351
|
+
# requested.
|
352
|
+
# @param [Fixnum] version_code
|
353
|
+
# Required. Version code targeted by the list of recovery actions.
|
354
|
+
# @param [String] fields
|
355
|
+
# Selector specifying which fields to include in a partial response.
|
356
|
+
# @param [String] quota_user
|
357
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
358
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
359
|
+
# @param [Google::Apis::RequestOptions] options
|
360
|
+
# Request-specific options
|
361
|
+
#
|
362
|
+
# @yield [result, err] Result & error if block supplied
|
363
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse] parsed result object
|
364
|
+
# @yieldparam err [StandardError] error object if request failed
|
365
|
+
#
|
366
|
+
# @return [Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse]
|
367
|
+
#
|
368
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
369
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
370
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
371
|
+
def list_apprecoveries(package_name, version_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
372
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/appRecoveries', options)
|
373
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse::Representation
|
374
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse
|
375
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
376
|
+
command.query['versionCode'] = version_code unless version_code.nil?
|
377
|
+
command.query['fields'] = fields unless fields.nil?
|
378
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
379
|
+
execute_or_queue_command(command, &block)
|
380
|
+
end
|
381
|
+
|
165
382
|
# Commits an app edit.
|
166
383
|
# @param [String] package_name
|
167
384
|
# Package name of the app.
|
168
385
|
# @param [String] edit_id
|
169
386
|
# Identifier of the edit.
|
170
387
|
# @param [Boolean] changes_not_sent_for_review
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
388
|
+
# When a rejection happens, the parameter will make sure that the changes in
|
389
|
+
# this edit won't be reviewed until they are explicitly sent for review from
|
390
|
+
# within the Google Play Console UI. These changes will be added to any other
|
391
|
+
# changes that are not yet sent for review.
|
174
392
|
# @param [String] fields
|
175
393
|
# Selector specifying which fields to include in a partial response.
|
176
394
|
# @param [String] quota_user
|
@@ -488,9 +706,8 @@ module Google
|
|
488
706
|
# @param [String] edit_id
|
489
707
|
# Identifier of the edit.
|
490
708
|
# @param [Boolean] ack_bundle_installation_warning
|
491
|
-
#
|
492
|
-
#
|
493
|
-
# typically 100 MB).
|
709
|
+
# Deprecated. The installation warning has been removed, it's not necessary to
|
710
|
+
# set this field anymore.
|
494
711
|
# @param [String] device_tier_config_id
|
495
712
|
# Device tier config (DTC) to be used for generating deliverables (APKs).
|
496
713
|
# Contains id of the DTC or "LATEST" for last uploaded DTC.
|
@@ -1408,13 +1625,50 @@ module Google
|
|
1408
1625
|
execute_or_queue_command(command, &block)
|
1409
1626
|
end
|
1410
1627
|
|
1628
|
+
# Creates a new track.
|
1629
|
+
# @param [String] package_name
|
1630
|
+
# Required. Package name of the app.
|
1631
|
+
# @param [String] edit_id
|
1632
|
+
# Required. Identifier of the edit.
|
1633
|
+
# @param [Google::Apis::AndroidpublisherV3::TrackConfig] track_config_object
|
1634
|
+
# @param [String] fields
|
1635
|
+
# Selector specifying which fields to include in a partial response.
|
1636
|
+
# @param [String] quota_user
|
1637
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1638
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1639
|
+
# @param [Google::Apis::RequestOptions] options
|
1640
|
+
# Request-specific options
|
1641
|
+
#
|
1642
|
+
# @yield [result, err] Result & error if block supplied
|
1643
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Track] parsed result object
|
1644
|
+
# @yieldparam err [StandardError] error object if request failed
|
1645
|
+
#
|
1646
|
+
# @return [Google::Apis::AndroidpublisherV3::Track]
|
1647
|
+
#
|
1648
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1649
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1650
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1651
|
+
def create_edit_track(package_name, edit_id, track_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1652
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/tracks', options)
|
1653
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::TrackConfig::Representation
|
1654
|
+
command.request_object = track_config_object
|
1655
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Track::Representation
|
1656
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Track
|
1657
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
1658
|
+
command.params['editId'] = edit_id unless edit_id.nil?
|
1659
|
+
command.query['fields'] = fields unless fields.nil?
|
1660
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1661
|
+
execute_or_queue_command(command, &block)
|
1662
|
+
end
|
1663
|
+
|
1411
1664
|
# Gets a track.
|
1412
1665
|
# @param [String] package_name
|
1413
1666
|
# Package name of the app.
|
1414
1667
|
# @param [String] edit_id
|
1415
1668
|
# Identifier of the edit.
|
1416
1669
|
# @param [String] track
|
1417
|
-
# Identifier of the track.
|
1670
|
+
# Identifier of the track. [More on track name](https://developers.google.com/
|
1671
|
+
# android-publisher/tracks#ff-track-name)
|
1418
1672
|
# @param [String] fields
|
1419
1673
|
# Selector specifying which fields to include in a partial response.
|
1420
1674
|
# @param [String] quota_user
|
@@ -1483,7 +1737,8 @@ module Google
|
|
1483
1737
|
# @param [String] edit_id
|
1484
1738
|
# Identifier of the edit.
|
1485
1739
|
# @param [String] track
|
1486
|
-
# Identifier of the track.
|
1740
|
+
# Identifier of the track. [More on track name](https://developers.google.com/
|
1741
|
+
# android-publisher/tracks#ff-track-name)
|
1487
1742
|
# @param [Google::Apis::AndroidpublisherV3::Track] track_object
|
1488
1743
|
# @param [String] fields
|
1489
1744
|
# Selector specifying which fields to include in a partial response.
|
@@ -1522,7 +1777,8 @@ module Google
|
|
1522
1777
|
# @param [String] edit_id
|
1523
1778
|
# Identifier of the edit.
|
1524
1779
|
# @param [String] track
|
1525
|
-
# Identifier of the track.
|
1780
|
+
# Identifier of the track. [More on track name](https://developers.google.com/
|
1781
|
+
# android-publisher/tracks#ff-track-name)
|
1526
1782
|
# @param [Google::Apis::AndroidpublisherV3::Track] track_object
|
1527
1783
|
# @param [String] fields
|
1528
1784
|
# Selector specifying which fields to include in a partial response.
|
@@ -1555,6 +1811,112 @@ module Google
|
|
1555
1811
|
execute_or_queue_command(command, &block)
|
1556
1812
|
end
|
1557
1813
|
|
1814
|
+
# Creates a new external transaction.
|
1815
|
+
# @param [String] parent
|
1816
|
+
# Required. The parent resource where this external transaction will be created.
|
1817
|
+
# Format: applications/`package_name`
|
1818
|
+
# @param [Google::Apis::AndroidpublisherV3::ExternalTransaction] external_transaction_object
|
1819
|
+
# @param [String] external_transaction_id
|
1820
|
+
# Required. The id to use for the external transaction. Must be unique across
|
1821
|
+
# all other transactions for the app. This value should be 1-63 characters and
|
1822
|
+
# valid characters are /a-zA-Z0-9_-/. Do not use this field to store any
|
1823
|
+
# Personally Identifiable Information (PII) such as emails. Attempting to store
|
1824
|
+
# PII in this field may result in requests being blocked.
|
1825
|
+
# @param [String] fields
|
1826
|
+
# Selector specifying which fields to include in a partial response.
|
1827
|
+
# @param [String] quota_user
|
1828
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1829
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1830
|
+
# @param [Google::Apis::RequestOptions] options
|
1831
|
+
# Request-specific options
|
1832
|
+
#
|
1833
|
+
# @yield [result, err] Result & error if block supplied
|
1834
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ExternalTransaction] parsed result object
|
1835
|
+
# @yieldparam err [StandardError] error object if request failed
|
1836
|
+
#
|
1837
|
+
# @return [Google::Apis::AndroidpublisherV3::ExternalTransaction]
|
1838
|
+
#
|
1839
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1840
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1841
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1842
|
+
def createexternaltransaction_externaltransaction(parent, external_transaction_object = nil, external_transaction_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1843
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/externalTransactions', options)
|
1844
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1845
|
+
command.request_object = external_transaction_object
|
1846
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1847
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
|
1848
|
+
command.params['parent'] = parent unless parent.nil?
|
1849
|
+
command.query['externalTransactionId'] = external_transaction_id unless external_transaction_id.nil?
|
1850
|
+
command.query['fields'] = fields unless fields.nil?
|
1851
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1852
|
+
execute_or_queue_command(command, &block)
|
1853
|
+
end
|
1854
|
+
|
1855
|
+
# Gets an existing external transaction.
|
1856
|
+
# @param [String] name
|
1857
|
+
# Required. The name of the external transaction to retrieve. Format:
|
1858
|
+
# applications/`package_name`/externalTransactions/`external_transaction`
|
1859
|
+
# @param [String] fields
|
1860
|
+
# Selector specifying which fields to include in a partial response.
|
1861
|
+
# @param [String] quota_user
|
1862
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1863
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1864
|
+
# @param [Google::Apis::RequestOptions] options
|
1865
|
+
# Request-specific options
|
1866
|
+
#
|
1867
|
+
# @yield [result, err] Result & error if block supplied
|
1868
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ExternalTransaction] parsed result object
|
1869
|
+
# @yieldparam err [StandardError] error object if request failed
|
1870
|
+
#
|
1871
|
+
# @return [Google::Apis::AndroidpublisherV3::ExternalTransaction]
|
1872
|
+
#
|
1873
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1874
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1875
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1876
|
+
def getexternaltransaction_externaltransaction(name, fields: nil, quota_user: nil, options: nil, &block)
|
1877
|
+
command = make_simple_command(:get, 'androidpublisher/v3/{+name}', options)
|
1878
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1879
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
|
1880
|
+
command.params['name'] = name unless name.nil?
|
1881
|
+
command.query['fields'] = fields unless fields.nil?
|
1882
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1883
|
+
execute_or_queue_command(command, &block)
|
1884
|
+
end
|
1885
|
+
|
1886
|
+
# Refunds or partially refunds an existing external transaction.
|
1887
|
+
# @param [String] name
|
1888
|
+
# Required. The name of the external transaction that will be refunded. Format:
|
1889
|
+
# applications/`package_name`/externalTransactions/`external_transaction`
|
1890
|
+
# @param [Google::Apis::AndroidpublisherV3::RefundExternalTransactionRequest] refund_external_transaction_request_object
|
1891
|
+
# @param [String] fields
|
1892
|
+
# Selector specifying which fields to include in a partial response.
|
1893
|
+
# @param [String] quota_user
|
1894
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1895
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1896
|
+
# @param [Google::Apis::RequestOptions] options
|
1897
|
+
# Request-specific options
|
1898
|
+
#
|
1899
|
+
# @yield [result, err] Result & error if block supplied
|
1900
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ExternalTransaction] parsed result object
|
1901
|
+
# @yieldparam err [StandardError] error object if request failed
|
1902
|
+
#
|
1903
|
+
# @return [Google::Apis::AndroidpublisherV3::ExternalTransaction]
|
1904
|
+
#
|
1905
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1906
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1907
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1908
|
+
def refundexternaltransaction_externaltransaction(name, refund_external_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1909
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+name}:refund', options)
|
1910
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::RefundExternalTransactionRequest::Representation
|
1911
|
+
command.request_object = refund_external_transaction_request_object
|
1912
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1913
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
|
1914
|
+
command.params['name'] = name unless name.nil?
|
1915
|
+
command.query['fields'] = fields unless fields.nil?
|
1916
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1917
|
+
execute_or_queue_command(command, &block)
|
1918
|
+
end
|
1919
|
+
|
1558
1920
|
# Downloads a single signed APK generated from an app bundle.
|
1559
1921
|
# @param [String] package_name
|
1560
1922
|
# Package name of the app.
|
@@ -1732,11 +2094,15 @@ module Google
|
|
1732
2094
|
execute_or_queue_command(command, &block)
|
1733
2095
|
end
|
1734
2096
|
|
1735
|
-
# Deletes
|
2097
|
+
# Deletes in-app products (managed products or subscriptions). Set the
|
2098
|
+
# latencyTolerance field on nested requests to
|
2099
|
+
# PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update
|
2100
|
+
# throughput. This method should not be used to delete subscriptions. See [this
|
2101
|
+
# article](https://android-developers.googleblog.com/2023/06/changes-to-google-
|
2102
|
+
# play-developer-api-june-2023.html) for more information.
|
1736
2103
|
# @param [String] package_name
|
1737
2104
|
# Package name of the app.
|
1738
|
-
# @param [
|
1739
|
-
# Unique identifier for the in-app product.
|
2105
|
+
# @param [Google::Apis::AndroidpublisherV3::InappproductsBatchDeleteRequest] inappproducts_batch_delete_request_object
|
1740
2106
|
# @param [String] fields
|
1741
2107
|
# Selector specifying which fields to include in a partial response.
|
1742
2108
|
# @param [String] quota_user
|
@@ -1754,20 +2120,24 @@ module Google
|
|
1754
2120
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1755
2121
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1756
2122
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1757
|
-
def
|
1758
|
-
command = make_simple_command(:
|
2123
|
+
def batch_inappproduct_delete(package_name, inappproducts_batch_delete_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2124
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts:batchDelete', options)
|
2125
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchDeleteRequest::Representation
|
2126
|
+
command.request_object = inappproducts_batch_delete_request_object
|
1759
2127
|
command.params['packageName'] = package_name unless package_name.nil?
|
1760
|
-
command.params['sku'] = sku unless sku.nil?
|
1761
2128
|
command.query['fields'] = fields unless fields.nil?
|
1762
2129
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1763
2130
|
execute_or_queue_command(command, &block)
|
1764
2131
|
end
|
1765
2132
|
|
1766
|
-
#
|
2133
|
+
# Reads multiple in-app products, which can be managed products or subscriptions.
|
2134
|
+
# This method should not be used to retrieve subscriptions. See [this article](
|
2135
|
+
# https://android-developers.googleblog.com/2023/06/changes-to-google-play-
|
2136
|
+
# developer-api-june-2023.html) for more information.
|
1767
2137
|
# @param [String] package_name
|
1768
2138
|
# Package name of the app.
|
1769
|
-
# @param [String] sku
|
1770
|
-
# Unique identifier for the in-app
|
2139
|
+
# @param [Array<String>, String] sku
|
2140
|
+
# Unique identifier for the in-app products.
|
1771
2141
|
# @param [String] fields
|
1772
2142
|
# Selector specifying which fields to include in a partial response.
|
1773
2143
|
# @param [String] quota_user
|
@@ -1777,33 +2147,34 @@ module Google
|
|
1777
2147
|
# Request-specific options
|
1778
2148
|
#
|
1779
2149
|
# @yield [result, err] Result & error if block supplied
|
1780
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
2150
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse] parsed result object
|
1781
2151
|
# @yieldparam err [StandardError] error object if request failed
|
1782
2152
|
#
|
1783
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
2153
|
+
# @return [Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse]
|
1784
2154
|
#
|
1785
2155
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1786
2156
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1787
2157
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1788
|
-
def
|
1789
|
-
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts
|
1790
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::
|
1791
|
-
command.response_class = Google::Apis::AndroidpublisherV3::
|
2158
|
+
def batch_inappproduct_get(package_name, sku: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2159
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts:batchGet', options)
|
2160
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse::Representation
|
2161
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InappproductsBatchGetResponse
|
1792
2162
|
command.params['packageName'] = package_name unless package_name.nil?
|
1793
|
-
command.
|
2163
|
+
command.query['sku'] = sku unless sku.nil?
|
1794
2164
|
command.query['fields'] = fields unless fields.nil?
|
1795
2165
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1796
2166
|
execute_or_queue_command(command, &block)
|
1797
2167
|
end
|
1798
2168
|
|
1799
|
-
#
|
2169
|
+
# Updates or inserts one or more in-app products (managed products or
|
2170
|
+
# subscriptions). Set the latencyTolerance field on nested requests to
|
2171
|
+
# PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update
|
2172
|
+
# throughput. This method should no longer be used to update subscriptions. See [
|
2173
|
+
# this article](https://android-developers.googleblog.com/2023/06/changes-to-
|
2174
|
+
# google-play-developer-api-june-2023.html) for more information.
|
1800
2175
|
# @param [String] package_name
|
1801
2176
|
# Package name of the app.
|
1802
|
-
# @param [Google::Apis::AndroidpublisherV3::
|
1803
|
-
# @param [Boolean] auto_convert_missing_prices
|
1804
|
-
# If true the prices for all regions targeted by the parent app that don't have
|
1805
|
-
# a price specified for this in-app product will be auto converted to the target
|
1806
|
-
# currency based on the default price. Defaults to false.
|
2177
|
+
# @param [Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateRequest] inappproducts_batch_update_request_object
|
1807
2178
|
# @param [String] fields
|
1808
2179
|
# Selector specifying which fields to include in a partial response.
|
1809
2180
|
# @param [String] quota_user
|
@@ -1813,38 +2184,154 @@ module Google
|
|
1813
2184
|
# Request-specific options
|
1814
2185
|
#
|
1815
2186
|
# @yield [result, err] Result & error if block supplied
|
1816
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
2187
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse] parsed result object
|
1817
2188
|
# @yieldparam err [StandardError] error object if request failed
|
1818
2189
|
#
|
1819
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
2190
|
+
# @return [Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse]
|
1820
2191
|
#
|
1821
2192
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1822
2193
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1823
2194
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1824
|
-
def
|
1825
|
-
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts', options)
|
1826
|
-
command.request_representation = Google::Apis::AndroidpublisherV3::
|
1827
|
-
command.request_object =
|
1828
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::
|
1829
|
-
command.response_class = Google::Apis::AndroidpublisherV3::
|
2195
|
+
def batch_inappproduct_update(package_name, inappproducts_batch_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2196
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts:batchUpdate', options)
|
2197
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateRequest::Representation
|
2198
|
+
command.request_object = inappproducts_batch_update_request_object
|
2199
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse::Representation
|
2200
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InappproductsBatchUpdateResponse
|
1830
2201
|
command.params['packageName'] = package_name unless package_name.nil?
|
1831
|
-
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
1832
2202
|
command.query['fields'] = fields unless fields.nil?
|
1833
2203
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1834
2204
|
execute_or_queue_command(command, &block)
|
1835
2205
|
end
|
1836
2206
|
|
1837
|
-
#
|
2207
|
+
# Deletes an in-app product (a managed product or a subscription). This method
|
2208
|
+
# should no longer be used to delete subscriptions. See [this article](https://
|
2209
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
2210
|
+
# june-2023.html) for more information.
|
2211
|
+
# @param [String] package_name
|
2212
|
+
# Package name of the app.
|
2213
|
+
# @param [String] sku
|
2214
|
+
# Unique identifier for the in-app product.
|
2215
|
+
# @param [String] latency_tolerance
|
2216
|
+
# Optional. The latency tolerance for the propagation of this product update.
|
2217
|
+
# Defaults to latency-sensitive.
|
2218
|
+
# @param [String] fields
|
2219
|
+
# Selector specifying which fields to include in a partial response.
|
2220
|
+
# @param [String] quota_user
|
2221
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2222
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2223
|
+
# @param [Google::Apis::RequestOptions] options
|
2224
|
+
# Request-specific options
|
2225
|
+
#
|
2226
|
+
# @yield [result, err] Result & error if block supplied
|
2227
|
+
# @yieldparam result [NilClass] No result returned for this method
|
2228
|
+
# @yieldparam err [StandardError] error object if request failed
|
2229
|
+
#
|
2230
|
+
# @return [void]
|
2231
|
+
#
|
2232
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2233
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2234
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2235
|
+
def delete_inappproduct(package_name, sku, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2236
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
2237
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2238
|
+
command.params['sku'] = sku unless sku.nil?
|
2239
|
+
command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
|
2240
|
+
command.query['fields'] = fields unless fields.nil?
|
2241
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2242
|
+
execute_or_queue_command(command, &block)
|
2243
|
+
end
|
2244
|
+
|
2245
|
+
# Gets an in-app product, which can be a managed product or a subscription. This
|
2246
|
+
# method should no longer be used to retrieve subscriptions. See [this article](
|
2247
|
+
# https://android-developers.googleblog.com/2023/06/changes-to-google-play-
|
2248
|
+
# developer-api-june-2023.html) for more information.
|
2249
|
+
# @param [String] package_name
|
2250
|
+
# Package name of the app.
|
2251
|
+
# @param [String] sku
|
2252
|
+
# Unique identifier for the in-app product.
|
2253
|
+
# @param [String] fields
|
2254
|
+
# Selector specifying which fields to include in a partial response.
|
2255
|
+
# @param [String] quota_user
|
2256
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2257
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2258
|
+
# @param [Google::Apis::RequestOptions] options
|
2259
|
+
# Request-specific options
|
2260
|
+
#
|
2261
|
+
# @yield [result, err] Result & error if block supplied
|
2262
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InAppProduct] parsed result object
|
2263
|
+
# @yieldparam err [StandardError] error object if request failed
|
2264
|
+
#
|
2265
|
+
# @return [Google::Apis::AndroidpublisherV3::InAppProduct]
|
2266
|
+
#
|
2267
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2268
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2269
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2270
|
+
def get_inappproduct(package_name, sku, fields: nil, quota_user: nil, options: nil, &block)
|
2271
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
2272
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2273
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
2274
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2275
|
+
command.params['sku'] = sku unless sku.nil?
|
2276
|
+
command.query['fields'] = fields unless fields.nil?
|
2277
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2278
|
+
execute_or_queue_command(command, &block)
|
2279
|
+
end
|
2280
|
+
|
2281
|
+
# Creates an in-app product (a managed product or a subscription). This method
|
2282
|
+
# should no longer be used to create subscriptions. See [this article](https://
|
2283
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
2284
|
+
# june-2023.html) for more information.
|
2285
|
+
# @param [String] package_name
|
2286
|
+
# Package name of the app.
|
2287
|
+
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
2288
|
+
# @param [Boolean] auto_convert_missing_prices
|
2289
|
+
# If true the prices for all regions targeted by the parent app that don't have
|
2290
|
+
# a price specified for this in-app product will be auto converted to the target
|
2291
|
+
# currency based on the default price. Defaults to false.
|
2292
|
+
# @param [String] fields
|
2293
|
+
# Selector specifying which fields to include in a partial response.
|
2294
|
+
# @param [String] quota_user
|
2295
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2296
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2297
|
+
# @param [Google::Apis::RequestOptions] options
|
2298
|
+
# Request-specific options
|
2299
|
+
#
|
2300
|
+
# @yield [result, err] Result & error if block supplied
|
2301
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InAppProduct] parsed result object
|
2302
|
+
# @yieldparam err [StandardError] error object if request failed
|
2303
|
+
#
|
2304
|
+
# @return [Google::Apis::AndroidpublisherV3::InAppProduct]
|
2305
|
+
#
|
2306
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2307
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2308
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2309
|
+
def insert_inappproduct(package_name, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2310
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts', options)
|
2311
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2312
|
+
command.request_object = in_app_product_object
|
2313
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2314
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
2315
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2316
|
+
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
2317
|
+
command.query['fields'] = fields unless fields.nil?
|
2318
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2319
|
+
execute_or_queue_command(command, &block)
|
2320
|
+
end
|
2321
|
+
|
2322
|
+
# Lists all in-app products - both managed products and subscriptions. If an app
|
1838
2323
|
# has a large number of in-app products, the response may be paginated. In this
|
1839
2324
|
# case the response field `tokenPagination.nextPageToken` will be set and the
|
1840
2325
|
# caller should provide its value as a `token` request parameter to retrieve the
|
1841
|
-
# next page.
|
2326
|
+
# next page. This method should no longer be used to retrieve subscriptions. See
|
2327
|
+
# [this article](https://android-developers.googleblog.com/2023/06/changes-to-
|
2328
|
+
# google-play-developer-api-june-2023.html) for more information.
|
1842
2329
|
# @param [String] package_name
|
1843
2330
|
# Package name of the app.
|
1844
2331
|
# @param [Fixnum] max_results
|
1845
2332
|
# Deprecated and ignored. The page size is determined by the server.
|
1846
2333
|
# @param [Fixnum] start_index
|
1847
|
-
# Deprecated and ignored. Set the `token` parameter to
|
2334
|
+
# Deprecated and ignored. Set the `token` parameter to retrieve the next page.
|
1848
2335
|
# @param [String] token
|
1849
2336
|
# Pagination token. If empty, list starts at the first product.
|
1850
2337
|
# @param [String] fields
|
@@ -1877,7 +2364,10 @@ module Google
|
|
1877
2364
|
execute_or_queue_command(command, &block)
|
1878
2365
|
end
|
1879
2366
|
|
1880
|
-
# Patches an in-app product (
|
2367
|
+
# Patches an in-app product (a managed product or a subscription). This method
|
2368
|
+
# should no longer be used to update subscriptions. See [this article](https://
|
2369
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
2370
|
+
# june-2023.html) for more information.
|
1881
2371
|
# @param [String] package_name
|
1882
2372
|
# Package name of the app.
|
1883
2373
|
# @param [String] sku
|
@@ -1887,6 +2377,9 @@ module Google
|
|
1887
2377
|
# If true the prices for all regions targeted by the parent app that don't have
|
1888
2378
|
# a price specified for this in-app product will be auto converted to the target
|
1889
2379
|
# currency based on the default price. Defaults to false.
|
2380
|
+
# @param [String] latency_tolerance
|
2381
|
+
# Optional. The latency tolerance for the propagation of this product update.
|
2382
|
+
# Defaults to latency-sensitive.
|
1890
2383
|
# @param [String] fields
|
1891
2384
|
# Selector specifying which fields to include in a partial response.
|
1892
2385
|
# @param [String] quota_user
|
@@ -1904,7 +2397,7 @@ module Google
|
|
1904
2397
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1905
2398
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1906
2399
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1907
|
-
def patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2400
|
+
def patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1908
2401
|
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
1909
2402
|
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
1910
2403
|
command.request_object = in_app_product_object
|
@@ -1913,12 +2406,16 @@ module Google
|
|
1913
2406
|
command.params['packageName'] = package_name unless package_name.nil?
|
1914
2407
|
command.params['sku'] = sku unless sku.nil?
|
1915
2408
|
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
2409
|
+
command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
|
1916
2410
|
command.query['fields'] = fields unless fields.nil?
|
1917
2411
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1918
2412
|
execute_or_queue_command(command, &block)
|
1919
2413
|
end
|
1920
2414
|
|
1921
|
-
# Updates an in-app product (
|
2415
|
+
# Updates an in-app product (a managed product or a subscription). This method
|
2416
|
+
# should no longer be used to update subscriptions. See [this article](https://
|
2417
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
2418
|
+
# june-2023.html) for more information.
|
1922
2419
|
# @param [String] package_name
|
1923
2420
|
# Package name of the app.
|
1924
2421
|
# @param [String] sku
|
@@ -1931,6 +2428,9 @@ module Google
|
|
1931
2428
|
# If true the prices for all regions targeted by the parent app that don't have
|
1932
2429
|
# a price specified for this in-app product will be auto converted to the target
|
1933
2430
|
# currency based on the default price. Defaults to false.
|
2431
|
+
# @param [String] latency_tolerance
|
2432
|
+
# Optional. The latency tolerance for the propagation of this product update.
|
2433
|
+
# Defaults to latency-sensitive.
|
1934
2434
|
# @param [String] fields
|
1935
2435
|
# Selector specifying which fields to include in a partial response.
|
1936
2436
|
# @param [String] quota_user
|
@@ -1948,7 +2448,7 @@ module Google
|
|
1948
2448
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1949
2449
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1950
2450
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1951
|
-
def update_inappproduct(package_name, sku, in_app_product_object = nil, allow_missing: nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2451
|
+
def update_inappproduct(package_name, sku, in_app_product_object = nil, allow_missing: nil, auto_convert_missing_prices: nil, latency_tolerance: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1952
2452
|
command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
1953
2453
|
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
1954
2454
|
command.request_object = in_app_product_object
|
@@ -1958,6 +2458,7 @@ module Google
|
|
1958
2458
|
command.params['sku'] = sku unless sku.nil?
|
1959
2459
|
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
1960
2460
|
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
2461
|
+
command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
|
1961
2462
|
command.query['fields'] = fields unless fields.nil?
|
1962
2463
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1963
2464
|
execute_or_queue_command(command, &block)
|
@@ -2085,10 +2586,7 @@ module Google
|
|
2085
2586
|
execute_or_queue_command(command, &block)
|
2086
2587
|
end
|
2087
2588
|
|
2088
|
-
#
|
2089
|
-
# in the past, and no base plan is available for new or existing subscribers
|
2090
|
-
# currently. This action is irreversible, and the subscription ID will remain
|
2091
|
-
# reserved.
|
2589
|
+
# Deprecated: subscription archiving is not supported.
|
2092
2590
|
# @param [String] package_name
|
2093
2591
|
# Required. The parent app (package name) of the app of the subscription to
|
2094
2592
|
# delete.
|
@@ -2125,6 +2623,78 @@ module Google
|
|
2125
2623
|
execute_or_queue_command(command, &block)
|
2126
2624
|
end
|
2127
2625
|
|
2626
|
+
# Reads one or more subscriptions.
|
2627
|
+
# @param [String] package_name
|
2628
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
2629
|
+
# retrieved. Must be equal to the package_name field on all the requests.
|
2630
|
+
# @param [Array<String>, String] product_ids
|
2631
|
+
# Required. A list of up to 100 subscription product IDs to retrieve. All the
|
2632
|
+
# IDs must be different.
|
2633
|
+
# @param [String] fields
|
2634
|
+
# Selector specifying which fields to include in a partial response.
|
2635
|
+
# @param [String] quota_user
|
2636
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2637
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2638
|
+
# @param [Google::Apis::RequestOptions] options
|
2639
|
+
# Request-specific options
|
2640
|
+
#
|
2641
|
+
# @yield [result, err] Result & error if block supplied
|
2642
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse] parsed result object
|
2643
|
+
# @yieldparam err [StandardError] error object if request failed
|
2644
|
+
#
|
2645
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse]
|
2646
|
+
#
|
2647
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2648
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2649
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2650
|
+
def batch_monetization_subscription_get(package_name, product_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2651
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions:batchGet', options)
|
2652
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse::Representation
|
2653
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionsResponse
|
2654
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2655
|
+
command.query['productIds'] = product_ids unless product_ids.nil?
|
2656
|
+
command.query['fields'] = fields unless fields.nil?
|
2657
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2658
|
+
execute_or_queue_command(command, &block)
|
2659
|
+
end
|
2660
|
+
|
2661
|
+
# Updates a batch of subscriptions. Set the latencyTolerance field on nested
|
2662
|
+
# requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve
|
2663
|
+
# maximum update throughput.
|
2664
|
+
# @param [String] package_name
|
2665
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
2666
|
+
# updated. Must be equal to the package_name field on all the Subscription
|
2667
|
+
# resources.
|
2668
|
+
# @param [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsRequest] batch_update_subscriptions_request_object
|
2669
|
+
# @param [String] fields
|
2670
|
+
# Selector specifying which fields to include in a partial response.
|
2671
|
+
# @param [String] quota_user
|
2672
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2673
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2674
|
+
# @param [Google::Apis::RequestOptions] options
|
2675
|
+
# Request-specific options
|
2676
|
+
#
|
2677
|
+
# @yield [result, err] Result & error if block supplied
|
2678
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse] parsed result object
|
2679
|
+
# @yieldparam err [StandardError] error object if request failed
|
2680
|
+
#
|
2681
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse]
|
2682
|
+
#
|
2683
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2684
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2685
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2686
|
+
def batch_update_subscriptions(package_name, batch_update_subscriptions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2687
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate', options)
|
2688
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsRequest::Representation
|
2689
|
+
command.request_object = batch_update_subscriptions_request_object
|
2690
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse::Representation
|
2691
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionsResponse
|
2692
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2693
|
+
command.query['fields'] = fields unless fields.nil?
|
2694
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2695
|
+
execute_or_queue_command(command, &block)
|
2696
|
+
end
|
2697
|
+
|
2128
2698
|
# Creates a new subscription. Newly added base plans will remain in draft state
|
2129
2699
|
# until activated.
|
2130
2700
|
# @param [String] package_name
|
@@ -2136,8 +2706,14 @@ module Google
|
|
2136
2706
|
# format, see the documentation of the product_id field on the Subscription
|
2137
2707
|
# resource.
|
2138
2708
|
# @param [String] regions_version_version
|
2139
|
-
# Required. A string representing version of
|
2140
|
-
# for the specified resource.
|
2709
|
+
# Required. A string representing the version of available regions being used
|
2710
|
+
# for the specified resource. Regional prices and latest supported version for
|
2711
|
+
# the resource have to be specified according to the information published in [
|
2712
|
+
# this article](https://support.google.com/googleplay/android-developer/answer/
|
2713
|
+
# 10532353). Each time the supported locations substantially change, the version
|
2714
|
+
# will be incremented. Using this field will ensure that creating and updating
|
2715
|
+
# the resource with an older region's version and set of regional prices and
|
2716
|
+
# currencies will succeed even though a new version is available.
|
2141
2717
|
# @param [String] fields
|
2142
2718
|
# Selector specifying which fields to include in a partial response.
|
2143
2719
|
# @param [String] quota_user
|
@@ -2249,8 +2825,7 @@ module Google
|
|
2249
2825
|
# provided to `ListSubscriptions` must match the call that provided the page
|
2250
2826
|
# token.
|
2251
2827
|
# @param [Boolean] show_archived
|
2252
|
-
#
|
2253
|
-
# false.
|
2828
|
+
# Deprecated: subscription archiving is not supported.
|
2254
2829
|
# @param [String] fields
|
2255
2830
|
# Selector specifying which fields to include in a partial response.
|
2256
2831
|
# @param [String] quota_user
|
@@ -2290,9 +2865,22 @@ module Google
|
|
2290
2865
|
# underscores (_) and dots (.). It must start with a lower-case letter or number,
|
2291
2866
|
# and be between 1 and 40 (inclusive) characters in length.
|
2292
2867
|
# @param [Google::Apis::AndroidpublisherV3::Subscription] subscription_object
|
2868
|
+
# @param [Boolean] allow_missing
|
2869
|
+
# Optional. If set to true, and the subscription with the given package_name and
|
2870
|
+
# product_id doesn't exist, the subscription will be created. If a new
|
2871
|
+
# subscription is created, update_mask is ignored.
|
2872
|
+
# @param [String] latency_tolerance
|
2873
|
+
# Optional. The latency tolerance for the propagation of this product update.
|
2874
|
+
# Defaults to latency-sensitive.
|
2293
2875
|
# @param [String] regions_version_version
|
2294
|
-
# Required. A string representing version of
|
2295
|
-
# for the specified resource.
|
2876
|
+
# Required. A string representing the version of available regions being used
|
2877
|
+
# for the specified resource. Regional prices and latest supported version for
|
2878
|
+
# the resource have to be specified according to the information published in [
|
2879
|
+
# this article](https://support.google.com/googleplay/android-developer/answer/
|
2880
|
+
# 10532353). Each time the supported locations substantially change, the version
|
2881
|
+
# will be incremented. Using this field will ensure that creating and updating
|
2882
|
+
# the resource with an older region's version and set of regional prices and
|
2883
|
+
# currencies will succeed even though a new version is available.
|
2296
2884
|
# @param [String] update_mask
|
2297
2885
|
# Required. The list of fields to be updated.
|
2298
2886
|
# @param [String] fields
|
@@ -2312,7 +2900,7 @@ module Google
|
|
2312
2900
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2313
2901
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2314
2902
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2315
|
-
def patch_monetization_subscription(package_name, product_id, subscription_object = nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2903
|
+
def patch_monetization_subscription(package_name, product_id, subscription_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2316
2904
|
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
2317
2905
|
command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2318
2906
|
command.request_object = subscription_object
|
@@ -2320,6 +2908,8 @@ module Google
|
|
2320
2908
|
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2321
2909
|
command.params['packageName'] = package_name unless package_name.nil?
|
2322
2910
|
command.params['productId'] = product_id unless product_id.nil?
|
2911
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2912
|
+
command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
|
2323
2913
|
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
2324
2914
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2325
2915
|
command.query['fields'] = fields unless fields.nil?
|
@@ -2367,6 +2957,89 @@ module Google
|
|
2367
2957
|
execute_or_queue_command(command, &block)
|
2368
2958
|
end
|
2369
2959
|
|
2960
|
+
# Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance
|
2961
|
+
# field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT
|
2962
|
+
# to achieve maximum update throughput.
|
2963
|
+
# @param [String] package_name
|
2964
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
2965
|
+
# created or updated. Must be equal to the package_name field on all the
|
2966
|
+
# Subscription resources.
|
2967
|
+
# @param [String] product_id
|
2968
|
+
# Required. The product ID of the parent subscription, if all updated offers
|
2969
|
+
# belong to the same subscription. If this batch update spans multiple
|
2970
|
+
# subscriptions, set this field to "-". Must be set.
|
2971
|
+
# @param [Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesRequest] batch_migrate_base_plan_prices_request_object
|
2972
|
+
# @param [String] fields
|
2973
|
+
# Selector specifying which fields to include in a partial response.
|
2974
|
+
# @param [String] quota_user
|
2975
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2976
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2977
|
+
# @param [Google::Apis::RequestOptions] options
|
2978
|
+
# Request-specific options
|
2979
|
+
#
|
2980
|
+
# @yield [result, err] Result & error if block supplied
|
2981
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse] parsed result object
|
2982
|
+
# @yieldparam err [StandardError] error object if request failed
|
2983
|
+
#
|
2984
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse]
|
2985
|
+
#
|
2986
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2987
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2988
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2989
|
+
def batch_monetization_subscription_base_plan_migrate_prices(package_name, product_id, batch_migrate_base_plan_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2990
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchMigratePrices', options)
|
2991
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesRequest::Representation
|
2992
|
+
command.request_object = batch_migrate_base_plan_prices_request_object
|
2993
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse::Representation
|
2994
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchMigrateBasePlanPricesResponse
|
2995
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2996
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2997
|
+
command.query['fields'] = fields unless fields.nil?
|
2998
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2999
|
+
execute_or_queue_command(command, &block)
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# Activates or deactivates base plans across one or multiple subscriptions. Set
|
3003
|
+
# the latencyTolerance field on nested requests to
|
3004
|
+
# PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update
|
3005
|
+
# throughput.
|
3006
|
+
# @param [String] package_name
|
3007
|
+
# Required. The parent app (package name) of the updated base plans.
|
3008
|
+
# @param [String] product_id
|
3009
|
+
# Required. The product ID of the parent subscription, if all updated base plans
|
3010
|
+
# belong to the same subscription. If this batch update spans multiple
|
3011
|
+
# subscriptions, set this field to "-". Must be set.
|
3012
|
+
# @param [Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesRequest] batch_update_base_plan_states_request_object
|
3013
|
+
# @param [String] fields
|
3014
|
+
# Selector specifying which fields to include in a partial response.
|
3015
|
+
# @param [String] quota_user
|
3016
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3017
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3018
|
+
# @param [Google::Apis::RequestOptions] options
|
3019
|
+
# Request-specific options
|
3020
|
+
#
|
3021
|
+
# @yield [result, err] Result & error if block supplied
|
3022
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse] parsed result object
|
3023
|
+
# @yieldparam err [StandardError] error object if request failed
|
3024
|
+
#
|
3025
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse]
|
3026
|
+
#
|
3027
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3028
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3029
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3030
|
+
def batch_monetization_subscription_base_plan_update_states(package_name, product_id, batch_update_base_plan_states_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3031
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans:batchUpdateStates', options)
|
3032
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesRequest::Representation
|
3033
|
+
command.request_object = batch_update_base_plan_states_request_object
|
3034
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse::Representation
|
3035
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateBasePlanStatesResponse
|
3036
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3037
|
+
command.params['productId'] = product_id unless product_id.nil?
|
3038
|
+
command.query['fields'] = fields unless fields.nil?
|
3039
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3040
|
+
execute_or_queue_command(command, &block)
|
3041
|
+
end
|
3042
|
+
|
2370
3043
|
# Deactivates a base plan. Once deactivated, the base plan will become
|
2371
3044
|
# unavailable to new subscribers, but existing subscribers will maintain their
|
2372
3045
|
# subscription
|
@@ -2443,11 +3116,9 @@ module Google
|
|
2443
3116
|
execute_or_queue_command(command, &block)
|
2444
3117
|
end
|
2445
3118
|
|
2446
|
-
# Migrates subscribers
|
2447
|
-
#
|
2448
|
-
#
|
2449
|
-
# historical price older than the supplied timestamp. Subscribers who do not
|
2450
|
-
# agree to the new price will have their subscription ended at the next renewal.
|
3119
|
+
# Migrates subscribers from one or more legacy price cohorts to the current
|
3120
|
+
# price. Requests result in Google Play notifying affected subscribers. Only up
|
3121
|
+
# to 250 simultaneous legacy price cohorts are supported.
|
2451
3122
|
# @param [String] package_name
|
2452
3123
|
# Required. Package name of the parent app. Must be equal to the package_name
|
2453
3124
|
# field on the Subscription resource.
|
@@ -2531,6 +3202,142 @@ module Google
|
|
2531
3202
|
execute_or_queue_command(command, &block)
|
2532
3203
|
end
|
2533
3204
|
|
3205
|
+
# Reads one or more subscription offers.
|
3206
|
+
# @param [String] package_name
|
3207
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
3208
|
+
# created or updated. Must be equal to the package_name field on all the
|
3209
|
+
# requests.
|
3210
|
+
# @param [String] product_id
|
3211
|
+
# Required. The product ID of the parent subscription, if all updated offers
|
3212
|
+
# belong to the same subscription. If this request spans multiple subscriptions,
|
3213
|
+
# set this field to "-". Must be set.
|
3214
|
+
# @param [String] base_plan_id
|
3215
|
+
# Required. The parent base plan (ID) for which the offers should be read. May
|
3216
|
+
# be specified as '-' to read offers from multiple base plans.
|
3217
|
+
# @param [Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersRequest] batch_get_subscription_offers_request_object
|
3218
|
+
# @param [String] fields
|
3219
|
+
# Selector specifying which fields to include in a partial response.
|
3220
|
+
# @param [String] quota_user
|
3221
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3222
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3223
|
+
# @param [Google::Apis::RequestOptions] options
|
3224
|
+
# Request-specific options
|
3225
|
+
#
|
3226
|
+
# @yield [result, err] Result & error if block supplied
|
3227
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse] parsed result object
|
3228
|
+
# @yieldparam err [StandardError] error object if request failed
|
3229
|
+
#
|
3230
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse]
|
3231
|
+
#
|
3232
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3233
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3234
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3235
|
+
def batch_get_subscription_offers(package_name, product_id, base_plan_id, batch_get_subscription_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3236
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet', options)
|
3237
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersRequest::Representation
|
3238
|
+
command.request_object = batch_get_subscription_offers_request_object
|
3239
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse::Representation
|
3240
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchGetSubscriptionOffersResponse
|
3241
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3242
|
+
command.params['productId'] = product_id unless product_id.nil?
|
3243
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
3244
|
+
command.query['fields'] = fields unless fields.nil?
|
3245
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3246
|
+
execute_or_queue_command(command, &block)
|
3247
|
+
end
|
3248
|
+
|
3249
|
+
# Updates a batch of subscription offers. Set the latencyTolerance field on
|
3250
|
+
# nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to
|
3251
|
+
# achieve maximum update throughput.
|
3252
|
+
# @param [String] package_name
|
3253
|
+
# Required. The parent app (package name) of the updated subscription offers.
|
3254
|
+
# Must be equal to the package_name field on all the updated SubscriptionOffer
|
3255
|
+
# resources.
|
3256
|
+
# @param [String] product_id
|
3257
|
+
# Required. The product ID of the parent subscription, if all updated offers
|
3258
|
+
# belong to the same subscription. If this request spans multiple subscriptions,
|
3259
|
+
# set this field to "-". Must be set.
|
3260
|
+
# @param [String] base_plan_id
|
3261
|
+
# Required. The parent base plan (ID) for which the offers should be updated.
|
3262
|
+
# May be specified as '-' to update offers from multiple base plans.
|
3263
|
+
# @param [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersRequest] batch_update_subscription_offers_request_object
|
3264
|
+
# @param [String] fields
|
3265
|
+
# Selector specifying which fields to include in a partial response.
|
3266
|
+
# @param [String] quota_user
|
3267
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3268
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3269
|
+
# @param [Google::Apis::RequestOptions] options
|
3270
|
+
# Request-specific options
|
3271
|
+
#
|
3272
|
+
# @yield [result, err] Result & error if block supplied
|
3273
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse] parsed result object
|
3274
|
+
# @yieldparam err [StandardError] error object if request failed
|
3275
|
+
#
|
3276
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse]
|
3277
|
+
#
|
3278
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3279
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3280
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3281
|
+
def batch_update_subscription_offers(package_name, product_id, base_plan_id, batch_update_subscription_offers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3282
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdate', options)
|
3283
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersRequest::Representation
|
3284
|
+
command.request_object = batch_update_subscription_offers_request_object
|
3285
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse::Representation
|
3286
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOffersResponse
|
3287
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3288
|
+
command.params['productId'] = product_id unless product_id.nil?
|
3289
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
3290
|
+
command.query['fields'] = fields unless fields.nil?
|
3291
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3292
|
+
execute_or_queue_command(command, &block)
|
3293
|
+
end
|
3294
|
+
|
3295
|
+
# Updates a batch of subscription offer states. Set the latencyTolerance field
|
3296
|
+
# on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to
|
3297
|
+
# achieve maximum update throughput.
|
3298
|
+
# @param [String] package_name
|
3299
|
+
# Required. The parent app (package name) of the updated subscription offers.
|
3300
|
+
# Must be equal to the package_name field on all the updated SubscriptionOffer
|
3301
|
+
# resources.
|
3302
|
+
# @param [String] product_id
|
3303
|
+
# Required. The product ID of the parent subscription, if all updated offers
|
3304
|
+
# belong to the same subscription. If this request spans multiple subscriptions,
|
3305
|
+
# set this field to "-". Must be set.
|
3306
|
+
# @param [String] base_plan_id
|
3307
|
+
# Required. The parent base plan (ID) for which the offers should be updated.
|
3308
|
+
# May be specified as '-' to update offers from multiple base plans.
|
3309
|
+
# @param [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesRequest] batch_update_subscription_offer_states_request_object
|
3310
|
+
# @param [String] fields
|
3311
|
+
# Selector specifying which fields to include in a partial response.
|
3312
|
+
# @param [String] quota_user
|
3313
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3314
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3315
|
+
# @param [Google::Apis::RequestOptions] options
|
3316
|
+
# Request-specific options
|
3317
|
+
#
|
3318
|
+
# @yield [result, err] Result & error if block supplied
|
3319
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse] parsed result object
|
3320
|
+
# @yieldparam err [StandardError] error object if request failed
|
3321
|
+
#
|
3322
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse]
|
3323
|
+
#
|
3324
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3325
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3326
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3327
|
+
def batch_monetization_subscription_base_plan_offer_update_states(package_name, product_id, base_plan_id, batch_update_subscription_offer_states_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3328
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates', options)
|
3329
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesRequest::Representation
|
3330
|
+
command.request_object = batch_update_subscription_offer_states_request_object
|
3331
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse::Representation
|
3332
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchUpdateSubscriptionOfferStatesResponse
|
3333
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3334
|
+
command.params['productId'] = product_id unless product_id.nil?
|
3335
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
3336
|
+
command.query['fields'] = fields unless fields.nil?
|
3337
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3338
|
+
execute_or_queue_command(command, &block)
|
3339
|
+
end
|
3340
|
+
|
2534
3341
|
# Creates a new subscription offer. Only auto-renewing base plans can have
|
2535
3342
|
# subscription offers. The offer state will be DRAFT until it is activated.
|
2536
3343
|
# @param [String] package_name
|
@@ -2547,8 +3354,14 @@ module Google
|
|
2547
3354
|
# Required. The ID to use for the offer. For the requirements on this format,
|
2548
3355
|
# see the documentation of the offer_id field on the SubscriptionOffer resource.
|
2549
3356
|
# @param [String] regions_version_version
|
2550
|
-
# Required. A string representing version of
|
2551
|
-
# for the specified resource.
|
3357
|
+
# Required. A string representing the version of available regions being used
|
3358
|
+
# for the specified resource. Regional prices and latest supported version for
|
3359
|
+
# the resource have to be specified according to the information published in [
|
3360
|
+
# this article](https://support.google.com/googleplay/android-developer/answer/
|
3361
|
+
# 10532353). Each time the supported locations substantially change, the version
|
3362
|
+
# will be incremented. Using this field will ensure that creating and updating
|
3363
|
+
# the resource with an older region's version and set of regional prices and
|
3364
|
+
# currencies will succeed even though a new version is available.
|
2552
3365
|
# @param [String] fields
|
2553
3366
|
# Selector specifying which fields to include in a partial response.
|
2554
3367
|
# @param [String] quota_user
|
@@ -2709,9 +3522,11 @@ module Google
|
|
2709
3522
|
# read.
|
2710
3523
|
# @param [String] product_id
|
2711
3524
|
# Required. The parent subscription (ID) for which the offers should be read.
|
3525
|
+
# May be specified as '-' to read all offers under an app.
|
2712
3526
|
# @param [String] base_plan_id
|
2713
3527
|
# Required. The parent base plan (ID) for which the offers should be read. May
|
2714
|
-
# be specified as '-' to read all offers under a subscription.
|
3528
|
+
# be specified as '-' to read all offers under a subscription or an app. Must be
|
3529
|
+
# specified as '-' if product_id is specified as '-'.
|
2715
3530
|
# @param [Fixnum] page_size
|
2716
3531
|
# The maximum number of subscriptions to return. The service may return fewer
|
2717
3532
|
# than this value. If unspecified, at most 50 subscriptions will be returned.
|
@@ -2765,9 +3580,22 @@ module Google
|
|
2765
3580
|
# Required. Immutable. Unique ID of this subscription offer. Must be unique
|
2766
3581
|
# within the base plan.
|
2767
3582
|
# @param [Google::Apis::AndroidpublisherV3::SubscriptionOffer] subscription_offer_object
|
3583
|
+
# @param [Boolean] allow_missing
|
3584
|
+
# Optional. If set to true, and the subscription offer with the given
|
3585
|
+
# package_name, product_id, base_plan_id and offer_id doesn't exist, an offer
|
3586
|
+
# will be created. If a new offer is created, update_mask is ignored.
|
3587
|
+
# @param [String] latency_tolerance
|
3588
|
+
# Optional. The latency tolerance for the propagation of this product update.
|
3589
|
+
# Defaults to latency-sensitive.
|
2768
3590
|
# @param [String] regions_version_version
|
2769
|
-
# Required. A string representing version of
|
2770
|
-
# for the specified resource.
|
3591
|
+
# Required. A string representing the version of available regions being used
|
3592
|
+
# for the specified resource. Regional prices and latest supported version for
|
3593
|
+
# the resource have to be specified according to the information published in [
|
3594
|
+
# this article](https://support.google.com/googleplay/android-developer/answer/
|
3595
|
+
# 10532353). Each time the supported locations substantially change, the version
|
3596
|
+
# will be incremented. Using this field will ensure that creating and updating
|
3597
|
+
# the resource with an older region's version and set of regional prices and
|
3598
|
+
# currencies will succeed even though a new version is available.
|
2771
3599
|
# @param [String] update_mask
|
2772
3600
|
# Required. The list of fields to be updated.
|
2773
3601
|
# @param [String] fields
|
@@ -2787,7 +3615,7 @@ module Google
|
|
2787
3615
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2788
3616
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2789
3617
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2790
|
-
def patch_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, subscription_offer_object = nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3618
|
+
def patch_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, subscription_offer_object = nil, allow_missing: nil, latency_tolerance: nil, regions_version_version: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2791
3619
|
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
2792
3620
|
command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2793
3621
|
command.request_object = subscription_offer_object
|
@@ -2797,6 +3625,8 @@ module Google
|
|
2797
3625
|
command.params['productId'] = product_id unless product_id.nil?
|
2798
3626
|
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2799
3627
|
command.params['offerId'] = offer_id unless offer_id.nil?
|
3628
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
3629
|
+
command.query['latencyTolerance'] = latency_tolerance unless latency_tolerance.nil?
|
2800
3630
|
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
2801
3631
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2802
3632
|
command.query['fields'] = fields unless fields.nil?
|
@@ -2804,8 +3634,80 @@ module Google
|
|
2804
3634
|
execute_or_queue_command(command, &block)
|
2805
3635
|
end
|
2806
3636
|
|
2807
|
-
#
|
2808
|
-
#
|
3637
|
+
# Get order details for a list of orders.
|
3638
|
+
# @param [String] package_name
|
3639
|
+
# Required. The package name of the application for which this subscription or
|
3640
|
+
# in-app item was purchased (for example, 'com.some.thing').
|
3641
|
+
# @param [Array<String>, String] order_ids
|
3642
|
+
# Required. The list of order IDs to retrieve order details for. There must be
|
3643
|
+
# between 1 and 1000 (inclusive) order IDs per request. If any order ID is not
|
3644
|
+
# found or does not match the provided package, the entire request will fail
|
3645
|
+
# with an error. The order IDs must be distinct.
|
3646
|
+
# @param [String] fields
|
3647
|
+
# Selector specifying which fields to include in a partial response.
|
3648
|
+
# @param [String] quota_user
|
3649
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3650
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3651
|
+
# @param [Google::Apis::RequestOptions] options
|
3652
|
+
# Request-specific options
|
3653
|
+
#
|
3654
|
+
# @yield [result, err] Result & error if block supplied
|
3655
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse] parsed result object
|
3656
|
+
# @yieldparam err [StandardError] error object if request failed
|
3657
|
+
#
|
3658
|
+
# @return [Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse]
|
3659
|
+
#
|
3660
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3661
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3662
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3663
|
+
def batchget_order(package_name, order_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3664
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/orders:batchGet', options)
|
3665
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse::Representation
|
3666
|
+
command.response_class = Google::Apis::AndroidpublisherV3::BatchGetOrdersResponse
|
3667
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3668
|
+
command.query['orderIds'] = order_ids unless order_ids.nil?
|
3669
|
+
command.query['fields'] = fields unless fields.nil?
|
3670
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3671
|
+
execute_or_queue_command(command, &block)
|
3672
|
+
end
|
3673
|
+
|
3674
|
+
# Get order details for a single order.
|
3675
|
+
# @param [String] package_name
|
3676
|
+
# Required. The package name of the application for which this subscription or
|
3677
|
+
# in-app item was purchased (for example, 'com.some.thing').
|
3678
|
+
# @param [String] order_id
|
3679
|
+
# Required. The order ID provided to the user when the subscription or in-app
|
3680
|
+
# order was purchased.
|
3681
|
+
# @param [String] fields
|
3682
|
+
# Selector specifying which fields to include in a partial response.
|
3683
|
+
# @param [String] quota_user
|
3684
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3685
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3686
|
+
# @param [Google::Apis::RequestOptions] options
|
3687
|
+
# Request-specific options
|
3688
|
+
#
|
3689
|
+
# @yield [result, err] Result & error if block supplied
|
3690
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Order] parsed result object
|
3691
|
+
# @yieldparam err [StandardError] error object if request failed
|
3692
|
+
#
|
3693
|
+
# @return [Google::Apis::AndroidpublisherV3::Order]
|
3694
|
+
#
|
3695
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3696
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3697
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3698
|
+
def get_order(package_name, order_id, fields: nil, quota_user: nil, options: nil, &block)
|
3699
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/orders/{orderId}', options)
|
3700
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Order::Representation
|
3701
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Order
|
3702
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3703
|
+
command.params['orderId'] = order_id unless order_id.nil?
|
3704
|
+
command.query['fields'] = fields unless fields.nil?
|
3705
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3706
|
+
execute_or_queue_command(command, &block)
|
3707
|
+
end
|
3708
|
+
|
3709
|
+
# Refunds a user's subscription or in-app purchase order. Orders older than 3
|
3710
|
+
# years cannot be refunded.
|
2809
3711
|
# @param [String] package_name
|
2810
3712
|
# The package name of the application for which this subscription or in-app item
|
2811
3713
|
# was purchased (for example, 'com.some.thing').
|
@@ -2882,6 +3784,41 @@ module Google
|
|
2882
3784
|
execute_or_queue_command(command, &block)
|
2883
3785
|
end
|
2884
3786
|
|
3787
|
+
# Consumes a purchase for an inapp item.
|
3788
|
+
# @param [String] package_name
|
3789
|
+
# The package name of the application the inapp product was sold in (for example,
|
3790
|
+
# 'com.some.thing').
|
3791
|
+
# @param [String] product_id
|
3792
|
+
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
3793
|
+
# @param [String] token
|
3794
|
+
# The token provided to the user's device when the inapp product was purchased.
|
3795
|
+
# @param [String] fields
|
3796
|
+
# Selector specifying which fields to include in a partial response.
|
3797
|
+
# @param [String] quota_user
|
3798
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3799
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3800
|
+
# @param [Google::Apis::RequestOptions] options
|
3801
|
+
# Request-specific options
|
3802
|
+
#
|
3803
|
+
# @yield [result, err] Result & error if block supplied
|
3804
|
+
# @yieldparam result [NilClass] No result returned for this method
|
3805
|
+
# @yieldparam err [StandardError] error object if request failed
|
3806
|
+
#
|
3807
|
+
# @return [void]
|
3808
|
+
#
|
3809
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3810
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3811
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3812
|
+
def consume_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil, &block)
|
3813
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume', options)
|
3814
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3815
|
+
command.params['productId'] = product_id unless product_id.nil?
|
3816
|
+
command.params['token'] = token unless token.nil?
|
3817
|
+
command.query['fields'] = fields unless fields.nil?
|
3818
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3819
|
+
execute_or_queue_command(command, &block)
|
3820
|
+
end
|
3821
|
+
|
2885
3822
|
# Checks the purchase and consumption status of an inapp item.
|
2886
3823
|
# @param [String] package_name
|
2887
3824
|
# The package name of the application the inapp product was sold in (for example,
|
@@ -2919,12 +3856,48 @@ module Google
|
|
2919
3856
|
execute_or_queue_command(command, &block)
|
2920
3857
|
end
|
2921
3858
|
|
3859
|
+
# Checks the purchase and consumption status of an inapp item.
|
3860
|
+
# @param [String] package_name
|
3861
|
+
# The package name of the application the inapp product was sold in (for example,
|
3862
|
+
# 'com.some.thing').
|
3863
|
+
# @param [String] token
|
3864
|
+
# The token provided to the user's device when the inapp product was purchased.
|
3865
|
+
# @param [String] fields
|
3866
|
+
# Selector specifying which fields to include in a partial response.
|
3867
|
+
# @param [String] quota_user
|
3868
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3869
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3870
|
+
# @param [Google::Apis::RequestOptions] options
|
3871
|
+
# Request-specific options
|
3872
|
+
#
|
3873
|
+
# @yield [result, err] Result & error if block supplied
|
3874
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ProductPurchaseV2] parsed result object
|
3875
|
+
# @yieldparam err [StandardError] error object if request failed
|
3876
|
+
#
|
3877
|
+
# @return [Google::Apis::AndroidpublisherV3::ProductPurchaseV2]
|
3878
|
+
#
|
3879
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3880
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3881
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3882
|
+
def getproductpurchasev2_purchase_productsv2(package_name, token, fields: nil, quota_user: nil, options: nil, &block)
|
3883
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/productsv2/tokens/{token}', options)
|
3884
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ProductPurchaseV2::Representation
|
3885
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ProductPurchaseV2
|
3886
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3887
|
+
command.params['token'] = token unless token.nil?
|
3888
|
+
command.query['fields'] = fields unless fields.nil?
|
3889
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3890
|
+
execute_or_queue_command(command, &block)
|
3891
|
+
end
|
3892
|
+
|
2922
3893
|
# Acknowledges a subscription purchase.
|
2923
3894
|
# @param [String] package_name
|
2924
3895
|
# The package name of the application for which this subscription was purchased (
|
2925
3896
|
# for example, 'com.some.thing').
|
2926
3897
|
# @param [String] subscription_id
|
2927
|
-
#
|
3898
|
+
# Note: Since May 21, 2025, subscription_id is not required, and not recommended
|
3899
|
+
# for subscription with add-ons. The purchased subscription ID (for example, '
|
3900
|
+
# monthly001').
|
2928
3901
|
# @param [String] token
|
2929
3902
|
# The token provided to the user's device when the subscription was purchased.
|
2930
3903
|
# @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesAcknowledgeRequest] subscription_purchases_acknowledge_request_object
|
@@ -2963,7 +3936,9 @@ module Google
|
|
2963
3936
|
# The package name of the application for which this subscription was purchased (
|
2964
3937
|
# for example, 'com.some.thing').
|
2965
3938
|
# @param [String] subscription_id
|
2966
|
-
#
|
3939
|
+
# Note: Since May 21, 2025, subscription_id is not required, and not recommended
|
3940
|
+
# for subscription with add-ons. The purchased subscription ID (for example, '
|
3941
|
+
# monthly001').
|
2967
3942
|
# @param [String] token
|
2968
3943
|
# The token provided to the user's device when the subscription was purchased.
|
2969
3944
|
# @param [String] fields
|
@@ -3033,8 +4008,8 @@ module Google
|
|
3033
4008
|
execute_or_queue_command(command, &block)
|
3034
4009
|
end
|
3035
4010
|
|
3036
|
-
# Checks whether a user's
|
3037
|
-
# time.
|
4011
|
+
# Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's
|
4012
|
+
# subscription purchase is valid and returns its expiry time.
|
3038
4013
|
# @param [String] package_name
|
3039
4014
|
# The package name of the application for which this subscription was purchased (
|
3040
4015
|
# for example, 'com.some.thing').
|
@@ -3071,8 +4046,9 @@ module Google
|
|
3071
4046
|
execute_or_queue_command(command, &block)
|
3072
4047
|
end
|
3073
4048
|
|
3074
|
-
# Refunds a user's subscription purchase,
|
3075
|
-
# until its expiration time and it will
|
4049
|
+
# Deprecated: Use orders.refund instead. Refunds a user's subscription purchase,
|
4050
|
+
# but the subscription remains valid until its expiration time and it will
|
4051
|
+
# continue to recur.
|
3076
4052
|
# @param [String] package_name
|
3077
4053
|
# The package name of the application for which this subscription was purchased (
|
3078
4054
|
# for example, 'com.some.thing').
|
@@ -3107,8 +4083,9 @@ module Google
|
|
3107
4083
|
execute_or_queue_command(command, &block)
|
3108
4084
|
end
|
3109
4085
|
|
3110
|
-
#
|
3111
|
-
#
|
4086
|
+
# Deprecated: Use purchases.subscriptionsv2.revoke instead. Refunds and
|
4087
|
+
# immediately revokes a user's subscription purchase. Access to the subscription
|
4088
|
+
# will be terminated immediately and it will stop recurring.
|
3112
4089
|
# @param [String] package_name
|
3113
4090
|
# The package name of the application for which this subscription was purchased (
|
3114
4091
|
# for example, 'com.some.thing').
|
@@ -3178,6 +4155,44 @@ module Google
|
|
3178
4155
|
execute_or_queue_command(command, &block)
|
3179
4156
|
end
|
3180
4157
|
|
4158
|
+
# Revoke a subscription purchase for the user.
|
4159
|
+
# @param [String] package_name
|
4160
|
+
# Required. The package of the application for which this subscription was
|
4161
|
+
# purchased (for example, 'com.some.thing').
|
4162
|
+
# @param [String] token
|
4163
|
+
# Required. The token provided to the user's device when the subscription was
|
4164
|
+
# purchased.
|
4165
|
+
# @param [Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseRequest] revoke_subscription_purchase_request_object
|
4166
|
+
# @param [String] fields
|
4167
|
+
# Selector specifying which fields to include in a partial response.
|
4168
|
+
# @param [String] quota_user
|
4169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4171
|
+
# @param [Google::Apis::RequestOptions] options
|
4172
|
+
# Request-specific options
|
4173
|
+
#
|
4174
|
+
# @yield [result, err] Result & error if block supplied
|
4175
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse] parsed result object
|
4176
|
+
# @yieldparam err [StandardError] error object if request failed
|
4177
|
+
#
|
4178
|
+
# @return [Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse]
|
4179
|
+
#
|
4180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4183
|
+
def revoke_subscriptionsv2_subscription_purchase(package_name, token, revoke_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4184
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke', options)
|
4185
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseRequest::Representation
|
4186
|
+
command.request_object = revoke_subscription_purchase_request_object
|
4187
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse::Representation
|
4188
|
+
command.response_class = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse
|
4189
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
4190
|
+
command.params['token'] = token unless token.nil?
|
4191
|
+
command.query['fields'] = fields unless fields.nil?
|
4192
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4193
|
+
execute_or_queue_command(command, &block)
|
4194
|
+
end
|
4195
|
+
|
3181
4196
|
# Lists the purchases that were canceled, refunded or charged-back.
|
3182
4197
|
# @param [String] package_name
|
3183
4198
|
# The package name of the application for which voided purchases need to be
|
@@ -3189,6 +4204,12 @@ module Google
|
|
3189
4204
|
# value is current time. Note: This filter is applied on the time at which the
|
3190
4205
|
# record is seen as voided by our systems and not the actual voided time
|
3191
4206
|
# returned in the response.
|
4207
|
+
# @param [Boolean] include_quantity_based_partial_refund
|
4208
|
+
# Optional. Whether to include voided purchases of quantity-based partial
|
4209
|
+
# refunds, which are applicable only to multi-quantity purchases. If true,
|
4210
|
+
# additional voided purchases may be returned with voidedQuantity that indicates
|
4211
|
+
# the refund quantity of a quantity-based partial refund. The default value is
|
4212
|
+
# false.
|
3192
4213
|
# @param [Fixnum] max_results
|
3193
4214
|
# Defines how many results the list operation should return. The default number
|
3194
4215
|
# depends on the resource collection.
|
@@ -3232,12 +4253,13 @@ module Google
|
|
3232
4253
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3233
4254
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3234
4255
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3235
|
-
def list_purchase_voidedpurchases(package_name, end_time: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4256
|
+
def list_purchase_voidedpurchases(package_name, end_time: nil, include_quantity_based_partial_refund: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3236
4257
|
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases', options)
|
3237
4258
|
command.response_representation = Google::Apis::AndroidpublisherV3::VoidedPurchasesListResponse::Representation
|
3238
4259
|
command.response_class = Google::Apis::AndroidpublisherV3::VoidedPurchasesListResponse
|
3239
4260
|
command.params['packageName'] = package_name unless package_name.nil?
|
3240
4261
|
command.query['endTime'] = end_time unless end_time.nil?
|
4262
|
+
command.query['includeQuantityBasedPartialRefund'] = include_quantity_based_partial_refund unless include_quantity_based_partial_refund.nil?
|
3241
4263
|
command.query['maxResults'] = max_results unless max_results.nil?
|
3242
4264
|
command.query['startIndex'] = start_index unless start_index.nil?
|
3243
4265
|
command.query['startTime'] = start_time unless start_time.nil?
|