google-apis-androidpublisher_v3 0.1.0 → 0.49.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +200 -0
- data/OVERVIEW.md +3 -3
- data/lib/google/apis/androidpublisher_v3/classes.rb +3813 -330
- data/lib/google/apis/androidpublisher_v3/gem_version.rb +3 -3
- data/lib/google/apis/androidpublisher_v3/representations.rb +2047 -278
- data/lib/google/apis/androidpublisher_v3/service.rb +1594 -164
- data/lib/google/apis/androidpublisher_v3.rb +3 -1
- metadata +17 -11
@@ -22,7 +22,9 @@ module Google
|
|
22
22
|
module AndroidpublisherV3
|
23
23
|
# Google Play Android Developer API
|
24
24
|
#
|
25
|
-
# Lets Android application developers access their Google Play accounts.
|
25
|
+
# Lets Android application developers access their Google Play accounts. At a
|
26
|
+
# high level, the expected workflow is to "insert" an Edit, make changes as
|
27
|
+
# necessary, and then "commit" it.
|
26
28
|
#
|
27
29
|
# @example
|
28
30
|
# require 'google/apis/androidpublisher_v3'
|
@@ -49,11 +51,126 @@ module Google
|
|
49
51
|
@batch_path = 'batch'
|
50
52
|
end
|
51
53
|
|
54
|
+
# Creates a new device tier config for an app.
|
55
|
+
# @param [String] package_name
|
56
|
+
# Package name of the app.
|
57
|
+
# @param [Google::Apis::AndroidpublisherV3::DeviceTierConfig] device_tier_config_object
|
58
|
+
# @param [Boolean] allow_unknown_devices
|
59
|
+
# Whether the service should accept device IDs that are unknown to Play's device
|
60
|
+
# catalog.
|
61
|
+
# @param [String] fields
|
62
|
+
# Selector specifying which fields to include in a partial response.
|
63
|
+
# @param [String] quota_user
|
64
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
65
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
66
|
+
# @param [Google::Apis::RequestOptions] options
|
67
|
+
# Request-specific options
|
68
|
+
#
|
69
|
+
# @yield [result, err] Result & error if block supplied
|
70
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::DeviceTierConfig] parsed result object
|
71
|
+
# @yieldparam err [StandardError] error object if request failed
|
72
|
+
#
|
73
|
+
# @return [Google::Apis::AndroidpublisherV3::DeviceTierConfig]
|
74
|
+
#
|
75
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
76
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
77
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
78
|
+
def create_application_device_tier_config(package_name, device_tier_config_object = nil, allow_unknown_devices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
79
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/deviceTierConfigs', options)
|
80
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::DeviceTierConfig::Representation
|
81
|
+
command.request_object = device_tier_config_object
|
82
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::DeviceTierConfig::Representation
|
83
|
+
command.response_class = Google::Apis::AndroidpublisherV3::DeviceTierConfig
|
84
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
85
|
+
command.query['allowUnknownDevices'] = allow_unknown_devices unless allow_unknown_devices.nil?
|
86
|
+
command.query['fields'] = fields unless fields.nil?
|
87
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
88
|
+
execute_or_queue_command(command, &block)
|
89
|
+
end
|
90
|
+
|
91
|
+
# Returns a particular device tier config.
|
92
|
+
# @param [String] package_name
|
93
|
+
# Package name of the app.
|
94
|
+
# @param [Fixnum] device_tier_config_id
|
95
|
+
# Required. Id of an existing device tier config.
|
96
|
+
# @param [String] fields
|
97
|
+
# Selector specifying which fields to include in a partial response.
|
98
|
+
# @param [String] quota_user
|
99
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
100
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
101
|
+
# @param [Google::Apis::RequestOptions] options
|
102
|
+
# Request-specific options
|
103
|
+
#
|
104
|
+
# @yield [result, err] Result & error if block supplied
|
105
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::DeviceTierConfig] parsed result object
|
106
|
+
# @yieldparam err [StandardError] error object if request failed
|
107
|
+
#
|
108
|
+
# @return [Google::Apis::AndroidpublisherV3::DeviceTierConfig]
|
109
|
+
#
|
110
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
111
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
112
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
113
|
+
def get_application_device_tier_config(package_name, device_tier_config_id, fields: nil, quota_user: nil, options: nil, &block)
|
114
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/deviceTierConfigs/{deviceTierConfigId}', options)
|
115
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::DeviceTierConfig::Representation
|
116
|
+
command.response_class = Google::Apis::AndroidpublisherV3::DeviceTierConfig
|
117
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
118
|
+
command.params['deviceTierConfigId'] = device_tier_config_id unless device_tier_config_id.nil?
|
119
|
+
command.query['fields'] = fields unless fields.nil?
|
120
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
121
|
+
execute_or_queue_command(command, &block)
|
122
|
+
end
|
123
|
+
|
124
|
+
# Returns created device tier configs, ordered by descending creation time.
|
125
|
+
# @param [String] package_name
|
126
|
+
# Package name of the app.
|
127
|
+
# @param [Fixnum] page_size
|
128
|
+
# The maximum number of device tier configs to return. The service may return
|
129
|
+
# fewer than this value. If unspecified, at most 10 device tier configs will be
|
130
|
+
# returned. The maximum value for this field is 100; values above 100 will be
|
131
|
+
# coerced to 100. Device tier configs will be ordered by descending creation
|
132
|
+
# time.
|
133
|
+
# @param [String] page_token
|
134
|
+
# A page token, received from a previous `ListDeviceTierConfigs` call. Provide
|
135
|
+
# this to retrieve the subsequent page.
|
136
|
+
# @param [String] fields
|
137
|
+
# Selector specifying which fields to include in a partial response.
|
138
|
+
# @param [String] quota_user
|
139
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
140
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
141
|
+
# @param [Google::Apis::RequestOptions] options
|
142
|
+
# Request-specific options
|
143
|
+
#
|
144
|
+
# @yield [result, err] Result & error if block supplied
|
145
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse] parsed result object
|
146
|
+
# @yieldparam err [StandardError] error object if request failed
|
147
|
+
#
|
148
|
+
# @return [Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse]
|
149
|
+
#
|
150
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
151
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
152
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
153
|
+
def list_application_device_tier_configs(package_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
154
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/deviceTierConfigs', options)
|
155
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse::Representation
|
156
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListDeviceTierConfigsResponse
|
157
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
158
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
159
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
160
|
+
command.query['fields'] = fields unless fields.nil?
|
161
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
162
|
+
execute_or_queue_command(command, &block)
|
163
|
+
end
|
164
|
+
|
52
165
|
# Commits an app edit.
|
53
166
|
# @param [String] package_name
|
54
167
|
# Package name of the app.
|
55
168
|
# @param [String] edit_id
|
56
169
|
# Identifier of the edit.
|
170
|
+
# @param [Boolean] changes_not_sent_for_review
|
171
|
+
# Indicates that the changes in this edit will not be reviewed until they are
|
172
|
+
# explicitly sent for review from the Google Play Console UI. These changes will
|
173
|
+
# be added to any other changes that are not yet sent for review.
|
57
174
|
# @param [String] fields
|
58
175
|
# Selector specifying which fields to include in a partial response.
|
59
176
|
# @param [String] quota_user
|
@@ -71,12 +188,13 @@ module Google
|
|
71
188
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
72
189
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
73
190
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
74
|
-
def commit_edit(package_name, edit_id, fields: nil, quota_user: nil, options: nil, &block)
|
191
|
+
def commit_edit(package_name, edit_id, changes_not_sent_for_review: nil, fields: nil, quota_user: nil, options: nil, &block)
|
75
192
|
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}:commit', options)
|
76
193
|
command.response_representation = Google::Apis::AndroidpublisherV3::AppEdit::Representation
|
77
194
|
command.response_class = Google::Apis::AndroidpublisherV3::AppEdit
|
78
195
|
command.params['packageName'] = package_name unless package_name.nil?
|
79
196
|
command.params['editId'] = edit_id unless edit_id.nil?
|
197
|
+
command.query['changesNotSentForReview'] = changes_not_sent_for_review unless changes_not_sent_for_review.nil?
|
80
198
|
command.query['fields'] = fields unless fields.nil?
|
81
199
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
82
200
|
execute_or_queue_command(command, &block)
|
@@ -370,9 +488,12 @@ module Google
|
|
370
488
|
# @param [String] edit_id
|
371
489
|
# Identifier of the edit.
|
372
490
|
# @param [Boolean] ack_bundle_installation_warning
|
373
|
-
# Must be set to true if the bundle installation may trigger a warning on
|
374
|
-
# devices (for example, if installation size may be over a threshold,
|
375
|
-
# 100 MB).
|
491
|
+
# Must be set to true if the app bundle installation may trigger a warning on
|
492
|
+
# user devices (for example, if installation size may be over a threshold,
|
493
|
+
# typically 100 MB).
|
494
|
+
# @param [String] device_tier_config_id
|
495
|
+
# Device tier config (DTC) to be used for generating deliverables (APKs).
|
496
|
+
# Contains id of the DTC or "LATEST" for last uploaded DTC.
|
376
497
|
# @param [String] fields
|
377
498
|
# Selector specifying which fields to include in a partial response.
|
378
499
|
# @param [String] quota_user
|
@@ -394,7 +515,7 @@ module Google
|
|
394
515
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
395
516
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
396
517
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
397
|
-
def upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
518
|
+
def upload_edit_bundle(package_name, edit_id, ack_bundle_installation_warning: nil, device_tier_config_id: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
398
519
|
if upload_source.nil?
|
399
520
|
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/bundles', options)
|
400
521
|
else
|
@@ -407,6 +528,43 @@ module Google
|
|
407
528
|
command.params['packageName'] = package_name unless package_name.nil?
|
408
529
|
command.params['editId'] = edit_id unless edit_id.nil?
|
409
530
|
command.query['ackBundleInstallationWarning'] = ack_bundle_installation_warning unless ack_bundle_installation_warning.nil?
|
531
|
+
command.query['deviceTierConfigId'] = device_tier_config_id unless device_tier_config_id.nil?
|
532
|
+
command.query['fields'] = fields unless fields.nil?
|
533
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
534
|
+
execute_or_queue_command(command, &block)
|
535
|
+
end
|
536
|
+
|
537
|
+
# Gets country availability.
|
538
|
+
# @param [String] package_name
|
539
|
+
# Package name of the app.
|
540
|
+
# @param [String] edit_id
|
541
|
+
# Identifier of the edit.
|
542
|
+
# @param [String] track
|
543
|
+
# The track to read from.
|
544
|
+
# @param [String] fields
|
545
|
+
# Selector specifying which fields to include in a partial response.
|
546
|
+
# @param [String] quota_user
|
547
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
548
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
549
|
+
# @param [Google::Apis::RequestOptions] options
|
550
|
+
# Request-specific options
|
551
|
+
#
|
552
|
+
# @yield [result, err] Result & error if block supplied
|
553
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::TrackCountryAvailability] parsed result object
|
554
|
+
# @yieldparam err [StandardError] error object if request failed
|
555
|
+
#
|
556
|
+
# @return [Google::Apis::AndroidpublisherV3::TrackCountryAvailability]
|
557
|
+
#
|
558
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
559
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
560
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
561
|
+
def get_edit_countryavailability(package_name, edit_id, track, fields: nil, quota_user: nil, options: nil, &block)
|
562
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/edits/{editId}/countryAvailability/{track}', options)
|
563
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::TrackCountryAvailability::Representation
|
564
|
+
command.response_class = Google::Apis::AndroidpublisherV3::TrackCountryAvailability
|
565
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
566
|
+
command.params['editId'] = edit_id unless edit_id.nil?
|
567
|
+
command.params['track'] = track unless track.nil?
|
410
568
|
command.query['fields'] = fields unless fields.nil?
|
411
569
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
412
570
|
execute_or_queue_command(command, &block)
|
@@ -1136,7 +1294,7 @@ module Google
|
|
1136
1294
|
execute_or_queue_command(command, &block)
|
1137
1295
|
end
|
1138
1296
|
|
1139
|
-
# Gets testers.
|
1297
|
+
# Gets testers. Note: Testers resource does not support email lists.
|
1140
1298
|
# @param [String] package_name
|
1141
1299
|
# Package name of the app.
|
1142
1300
|
# @param [String] edit_id
|
@@ -1172,7 +1330,7 @@ module Google
|
|
1172
1330
|
execute_or_queue_command(command, &block)
|
1173
1331
|
end
|
1174
1332
|
|
1175
|
-
# Patches testers.
|
1333
|
+
# Patches testers. Note: Testers resource does not support email lists.
|
1176
1334
|
# @param [String] package_name
|
1177
1335
|
# Package name of the app.
|
1178
1336
|
# @param [String] edit_id
|
@@ -1211,7 +1369,7 @@ module Google
|
|
1211
1369
|
execute_or_queue_command(command, &block)
|
1212
1370
|
end
|
1213
1371
|
|
1214
|
-
# Updates testers.
|
1372
|
+
# Updates testers. Note: Testers resource does not support email lists.
|
1215
1373
|
# @param [String] package_name
|
1216
1374
|
# Package name of the app.
|
1217
1375
|
# @param [String] edit_id
|
@@ -1256,7 +1414,8 @@ module Google
|
|
1256
1414
|
# @param [String] edit_id
|
1257
1415
|
# Identifier of the edit.
|
1258
1416
|
# @param [String] track
|
1259
|
-
# Identifier of the track.
|
1417
|
+
# Identifier of the track. [More on track name](https://developers.google.com/
|
1418
|
+
# android-publisher/tracks#ff-track-name)
|
1260
1419
|
# @param [String] fields
|
1261
1420
|
# Selector specifying which fields to include in a partial response.
|
1262
1421
|
# @param [String] quota_user
|
@@ -1325,7 +1484,8 @@ module Google
|
|
1325
1484
|
# @param [String] edit_id
|
1326
1485
|
# Identifier of the edit.
|
1327
1486
|
# @param [String] track
|
1328
|
-
# Identifier of the track.
|
1487
|
+
# Identifier of the track. [More on track name](https://developers.google.com/
|
1488
|
+
# android-publisher/tracks#ff-track-name)
|
1329
1489
|
# @param [Google::Apis::AndroidpublisherV3::Track] track_object
|
1330
1490
|
# @param [String] fields
|
1331
1491
|
# Selector specifying which fields to include in a partial response.
|
@@ -1364,7 +1524,8 @@ module Google
|
|
1364
1524
|
# @param [String] edit_id
|
1365
1525
|
# Identifier of the edit.
|
1366
1526
|
# @param [String] track
|
1367
|
-
# Identifier of the track.
|
1527
|
+
# Identifier of the track. [More on track name](https://developers.google.com/
|
1528
|
+
# android-publisher/tracks#ff-track-name)
|
1368
1529
|
# @param [Google::Apis::AndroidpublisherV3::Track] track_object
|
1369
1530
|
# @param [String] fields
|
1370
1531
|
# Selector specifying which fields to include in a partial response.
|
@@ -1397,11 +1558,17 @@ module Google
|
|
1397
1558
|
execute_or_queue_command(command, &block)
|
1398
1559
|
end
|
1399
1560
|
|
1400
|
-
#
|
1401
|
-
# @param [String]
|
1402
|
-
#
|
1403
|
-
#
|
1404
|
-
#
|
1561
|
+
# Creates a new external transaction.
|
1562
|
+
# @param [String] parent
|
1563
|
+
# Required. The parent resource where this external transaction will be created.
|
1564
|
+
# Format: applications/`package_name`
|
1565
|
+
# @param [Google::Apis::AndroidpublisherV3::ExternalTransaction] external_transaction_object
|
1566
|
+
# @param [String] external_transaction_id
|
1567
|
+
# Required. The id to use for the external transaction. Must be unique across
|
1568
|
+
# all other transactions for the app. This value should be 1-63 characters and
|
1569
|
+
# valid characters are /a-z0-9_-/. Do not use this field to store any Personally
|
1570
|
+
# Identifiable Information (PII) such as emails. Attempting to store PII in this
|
1571
|
+
# field may result in requests being blocked.
|
1405
1572
|
# @param [String] fields
|
1406
1573
|
# Selector specifying which fields to include in a partial response.
|
1407
1574
|
# @param [String] quota_user
|
@@ -1411,28 +1578,31 @@ module Google
|
|
1411
1578
|
# Request-specific options
|
1412
1579
|
#
|
1413
1580
|
# @yield [result, err] Result & error if block supplied
|
1414
|
-
# @yieldparam result [
|
1581
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ExternalTransaction] parsed result object
|
1415
1582
|
# @yieldparam err [StandardError] error object if request failed
|
1416
1583
|
#
|
1417
|
-
# @return [
|
1584
|
+
# @return [Google::Apis::AndroidpublisherV3::ExternalTransaction]
|
1418
1585
|
#
|
1419
1586
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1420
1587
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1421
1588
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1422
|
-
def
|
1423
|
-
command = make_simple_command(:
|
1424
|
-
command.
|
1425
|
-
command.
|
1589
|
+
def createexternaltransaction_externaltransaction(parent, external_transaction_object = nil, external_transaction_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1590
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/externalTransactions', options)
|
1591
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1592
|
+
command.request_object = external_transaction_object
|
1593
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1594
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
|
1595
|
+
command.params['parent'] = parent unless parent.nil?
|
1596
|
+
command.query['externalTransactionId'] = external_transaction_id unless external_transaction_id.nil?
|
1426
1597
|
command.query['fields'] = fields unless fields.nil?
|
1427
1598
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1428
1599
|
execute_or_queue_command(command, &block)
|
1429
1600
|
end
|
1430
1601
|
|
1431
|
-
# Gets an
|
1432
|
-
# @param [String]
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
# Unique identifier for the in-app product.
|
1602
|
+
# Gets an existing external transaction.
|
1603
|
+
# @param [String] name
|
1604
|
+
# Required. The name of the external transaction to retrieve. Format:
|
1605
|
+
# applications/`package_name`/externalTransactions/`external_transaction`
|
1436
1606
|
# @param [String] fields
|
1437
1607
|
# Selector specifying which fields to include in a partial response.
|
1438
1608
|
# @param [String] quota_user
|
@@ -1442,33 +1612,29 @@ module Google
|
|
1442
1612
|
# Request-specific options
|
1443
1613
|
#
|
1444
1614
|
# @yield [result, err] Result & error if block supplied
|
1445
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
1615
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ExternalTransaction] parsed result object
|
1446
1616
|
# @yieldparam err [StandardError] error object if request failed
|
1447
1617
|
#
|
1448
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
1618
|
+
# @return [Google::Apis::AndroidpublisherV3::ExternalTransaction]
|
1449
1619
|
#
|
1450
1620
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1451
1621
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1452
1622
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1453
|
-
def
|
1454
|
-
command = make_simple_command(:get, 'androidpublisher/v3/
|
1455
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::
|
1456
|
-
command.response_class = Google::Apis::AndroidpublisherV3::
|
1457
|
-
command.params['
|
1458
|
-
command.params['sku'] = sku unless sku.nil?
|
1623
|
+
def getexternaltransaction_externaltransaction(name, fields: nil, quota_user: nil, options: nil, &block)
|
1624
|
+
command = make_simple_command(:get, 'androidpublisher/v3/{+name}', options)
|
1625
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1626
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
|
1627
|
+
command.params['name'] = name unless name.nil?
|
1459
1628
|
command.query['fields'] = fields unless fields.nil?
|
1460
1629
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1461
1630
|
execute_or_queue_command(command, &block)
|
1462
1631
|
end
|
1463
1632
|
|
1464
|
-
#
|
1465
|
-
# @param [String]
|
1466
|
-
#
|
1467
|
-
#
|
1468
|
-
# @param [
|
1469
|
-
# If true the prices for all regions targeted by the parent app that don't have
|
1470
|
-
# a price specified for this in-app product will be auto converted to the target
|
1471
|
-
# currency based on the default price. Defaults to false.
|
1633
|
+
# Refunds or partially refunds an existing external transaction.
|
1634
|
+
# @param [String] name
|
1635
|
+
# Required. The name of the external transaction that will be refunded. Format:
|
1636
|
+
# applications/`package_name`/externalTransactions/`external_transaction`
|
1637
|
+
# @param [Google::Apis::AndroidpublisherV3::RefundExternalTransactionRequest] refund_external_transaction_request_object
|
1472
1638
|
# @param [String] fields
|
1473
1639
|
# Selector specifying which fields to include in a partial response.
|
1474
1640
|
# @param [String] quota_user
|
@@ -1478,76 +1644,74 @@ module Google
|
|
1478
1644
|
# Request-specific options
|
1479
1645
|
#
|
1480
1646
|
# @yield [result, err] Result & error if block supplied
|
1481
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
1647
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ExternalTransaction] parsed result object
|
1482
1648
|
# @yieldparam err [StandardError] error object if request failed
|
1483
1649
|
#
|
1484
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
1650
|
+
# @return [Google::Apis::AndroidpublisherV3::ExternalTransaction]
|
1485
1651
|
#
|
1486
1652
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1487
1653
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1488
1654
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1489
|
-
def
|
1490
|
-
command = make_simple_command(:post, 'androidpublisher/v3/
|
1491
|
-
command.request_representation = Google::Apis::AndroidpublisherV3::
|
1492
|
-
command.request_object =
|
1493
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::
|
1494
|
-
command.response_class = Google::Apis::AndroidpublisherV3::
|
1495
|
-
command.params['
|
1496
|
-
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
1655
|
+
def refundexternaltransaction_externaltransaction(name, refund_external_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1656
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+name}:refund', options)
|
1657
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::RefundExternalTransactionRequest::Representation
|
1658
|
+
command.request_object = refund_external_transaction_request_object
|
1659
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ExternalTransaction::Representation
|
1660
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ExternalTransaction
|
1661
|
+
command.params['name'] = name unless name.nil?
|
1497
1662
|
command.query['fields'] = fields unless fields.nil?
|
1498
1663
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1499
1664
|
execute_or_queue_command(command, &block)
|
1500
1665
|
end
|
1501
1666
|
|
1502
|
-
#
|
1667
|
+
# Downloads a single signed APK generated from an app bundle.
|
1503
1668
|
# @param [String] package_name
|
1504
1669
|
# Package name of the app.
|
1505
|
-
# @param [Fixnum]
|
1506
|
-
#
|
1507
|
-
# @param [
|
1508
|
-
#
|
1509
|
-
#
|
1510
|
-
# Pagination token. If empty, list starts at the first product.
|
1670
|
+
# @param [Fixnum] version_code
|
1671
|
+
# Version code of the app bundle.
|
1672
|
+
# @param [String] download_id
|
1673
|
+
# Download ID, which uniquely identifies the APK to download. Can be obtained
|
1674
|
+
# from the response of `generatedapks.list` method.
|
1511
1675
|
# @param [String] fields
|
1512
1676
|
# Selector specifying which fields to include in a partial response.
|
1513
1677
|
# @param [String] quota_user
|
1514
1678
|
# Available to use for quota purposes for server-side applications. Can be any
|
1515
1679
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1680
|
+
# @param [IO, String] download_dest
|
1681
|
+
# IO stream or filename to receive content download
|
1516
1682
|
# @param [Google::Apis::RequestOptions] options
|
1517
1683
|
# Request-specific options
|
1518
1684
|
#
|
1519
1685
|
# @yield [result, err] Result & error if block supplied
|
1520
|
-
# @yieldparam result [
|
1686
|
+
# @yieldparam result [NilClass] No result returned for this method
|
1521
1687
|
# @yieldparam err [StandardError] error object if request failed
|
1522
1688
|
#
|
1523
|
-
# @return [
|
1689
|
+
# @return [void]
|
1524
1690
|
#
|
1525
1691
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1526
1692
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1527
1693
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1528
|
-
def
|
1529
|
-
|
1530
|
-
|
1531
|
-
|
1694
|
+
def download_generatedapk(package_name, version_code, download_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
|
1695
|
+
if download_dest.nil?
|
1696
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download', options)
|
1697
|
+
else
|
1698
|
+
command = make_download_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download', options)
|
1699
|
+
command.download_dest = download_dest
|
1700
|
+
end
|
1532
1701
|
command.params['packageName'] = package_name unless package_name.nil?
|
1533
|
-
command.
|
1534
|
-
command.
|
1535
|
-
command.query['token'] = token unless token.nil?
|
1702
|
+
command.params['versionCode'] = version_code unless version_code.nil?
|
1703
|
+
command.params['downloadId'] = download_id unless download_id.nil?
|
1536
1704
|
command.query['fields'] = fields unless fields.nil?
|
1537
1705
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1538
1706
|
execute_or_queue_command(command, &block)
|
1539
1707
|
end
|
1540
1708
|
|
1541
|
-
#
|
1709
|
+
# Returns download metadata for all APKs that were generated from a given app
|
1710
|
+
# bundle.
|
1542
1711
|
# @param [String] package_name
|
1543
1712
|
# Package name of the app.
|
1544
|
-
# @param [
|
1545
|
-
#
|
1546
|
-
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
1547
|
-
# @param [Boolean] auto_convert_missing_prices
|
1548
|
-
# If true the prices for all regions targeted by the parent app that don't have
|
1549
|
-
# a price specified for this in-app product will be auto converted to the target
|
1550
|
-
# currency based on the default price. Defaults to false.
|
1713
|
+
# @param [Fixnum] version_code
|
1714
|
+
# Version code of the app bundle.
|
1551
1715
|
# @param [String] fields
|
1552
1716
|
# Selector specifying which fields to include in a partial response.
|
1553
1717
|
# @param [String] quota_user
|
@@ -1557,38 +1721,30 @@ module Google
|
|
1557
1721
|
# Request-specific options
|
1558
1722
|
#
|
1559
1723
|
# @yield [result, err] Result & error if block supplied
|
1560
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
1724
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::GeneratedApksListResponse] parsed result object
|
1561
1725
|
# @yieldparam err [StandardError] error object if request failed
|
1562
1726
|
#
|
1563
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
1727
|
+
# @return [Google::Apis::AndroidpublisherV3::GeneratedApksListResponse]
|
1564
1728
|
#
|
1565
1729
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1566
1730
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1567
1731
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1568
|
-
def
|
1569
|
-
command = make_simple_command(:
|
1570
|
-
command.
|
1571
|
-
command.
|
1572
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
1573
|
-
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
1732
|
+
def list_generatedapks(package_name, version_code, fields: nil, quota_user: nil, options: nil, &block)
|
1733
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}', options)
|
1734
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::GeneratedApksListResponse::Representation
|
1735
|
+
command.response_class = Google::Apis::AndroidpublisherV3::GeneratedApksListResponse
|
1574
1736
|
command.params['packageName'] = package_name unless package_name.nil?
|
1575
|
-
command.params['
|
1576
|
-
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
1737
|
+
command.params['versionCode'] = version_code unless version_code.nil?
|
1577
1738
|
command.query['fields'] = fields unless fields.nil?
|
1578
1739
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1579
1740
|
execute_or_queue_command(command, &block)
|
1580
1741
|
end
|
1581
1742
|
|
1582
|
-
#
|
1583
|
-
# @param [String]
|
1584
|
-
#
|
1585
|
-
#
|
1586
|
-
#
|
1587
|
-
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
1588
|
-
# @param [Boolean] auto_convert_missing_prices
|
1589
|
-
# If true the prices for all regions targeted by the parent app that don't have
|
1590
|
-
# a price specified for this in-app product will be auto converted to the target
|
1591
|
-
# currency based on the default price. Defaults to false.
|
1743
|
+
# Grant access for a user to the given package.
|
1744
|
+
# @param [String] parent
|
1745
|
+
# Required. The user which needs permission. Format: developers/`developer`/
|
1746
|
+
# users/`user`
|
1747
|
+
# @param [Google::Apis::AndroidpublisherV3::Grant] grant_object
|
1592
1748
|
# @param [String] fields
|
1593
1749
|
# Selector specifying which fields to include in a partial response.
|
1594
1750
|
# @param [String] quota_user
|
@@ -1598,124 +1754,1189 @@ module Google
|
|
1598
1754
|
# Request-specific options
|
1599
1755
|
#
|
1600
1756
|
# @yield [result, err] Result & error if block supplied
|
1601
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
1757
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Grant] parsed result object
|
1602
1758
|
# @yieldparam err [StandardError] error object if request failed
|
1603
1759
|
#
|
1604
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
1760
|
+
# @return [Google::Apis::AndroidpublisherV3::Grant]
|
1605
1761
|
#
|
1606
1762
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1607
1763
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1608
1764
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1609
|
-
def
|
1610
|
-
command = make_simple_command(:
|
1611
|
-
command.request_representation = Google::Apis::AndroidpublisherV3::
|
1612
|
-
command.request_object =
|
1613
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::
|
1614
|
-
command.response_class = Google::Apis::AndroidpublisherV3::
|
1615
|
-
command.params['
|
1616
|
-
command.params['sku'] = sku unless sku.nil?
|
1617
|
-
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
1765
|
+
def create_grant(parent, grant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1766
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/grants', options)
|
1767
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
1768
|
+
command.request_object = grant_object
|
1769
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
1770
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Grant
|
1771
|
+
command.params['parent'] = parent unless parent.nil?
|
1618
1772
|
command.query['fields'] = fields unless fields.nil?
|
1619
1773
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1620
1774
|
execute_or_queue_command(command, &block)
|
1621
1775
|
end
|
1622
1776
|
|
1623
|
-
#
|
1624
|
-
#
|
1625
|
-
#
|
1626
|
-
#
|
1627
|
-
# errors) for an example in java.
|
1628
|
-
# @param [String] package_name
|
1629
|
-
# Package name of the app.
|
1777
|
+
# Removes all access for the user to the given package or developer account.
|
1778
|
+
# @param [String] name
|
1779
|
+
# Required. The name of the grant to delete. Format: developers/`developer`/
|
1780
|
+
# users/`email`/grants/`package_name`
|
1630
1781
|
# @param [String] fields
|
1631
1782
|
# Selector specifying which fields to include in a partial response.
|
1632
1783
|
# @param [String] quota_user
|
1633
1784
|
# Available to use for quota purposes for server-side applications. Can be any
|
1634
1785
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1635
|
-
# @param [IO, String] upload_source
|
1636
|
-
# IO stream or filename containing content to upload
|
1637
|
-
# @param [String] content_type
|
1638
|
-
# Content type of the uploaded content.
|
1639
1786
|
# @param [Google::Apis::RequestOptions] options
|
1640
1787
|
# Request-specific options
|
1641
1788
|
#
|
1642
1789
|
# @yield [result, err] Result & error if block supplied
|
1643
|
-
# @yieldparam result [
|
1790
|
+
# @yieldparam result [NilClass] No result returned for this method
|
1644
1791
|
# @yieldparam err [StandardError] error object if request failed
|
1645
1792
|
#
|
1646
|
-
# @return [
|
1793
|
+
# @return [void]
|
1647
1794
|
#
|
1648
1795
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1649
1796
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1650
1797
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1651
|
-
def
|
1652
|
-
|
1653
|
-
|
1654
|
-
else
|
1655
|
-
command = make_upload_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk', options)
|
1656
|
-
command.upload_source = upload_source
|
1657
|
-
command.upload_content_type = content_type
|
1658
|
-
end
|
1659
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact::Representation
|
1660
|
-
command.response_class = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact
|
1661
|
-
command.params['packageName'] = package_name unless package_name.nil?
|
1798
|
+
def delete_grant(name, fields: nil, quota_user: nil, options: nil, &block)
|
1799
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/{+name}', options)
|
1800
|
+
command.params['name'] = name unless name.nil?
|
1662
1801
|
command.query['fields'] = fields unless fields.nil?
|
1663
1802
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1664
1803
|
execute_or_queue_command(command, &block)
|
1665
1804
|
end
|
1666
1805
|
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
# @param [
|
1673
|
-
#
|
1806
|
+
# Updates access for the user to the given package.
|
1807
|
+
# @param [String] name
|
1808
|
+
# Required. Resource name for this grant, following the pattern "developers/`
|
1809
|
+
# developer`/users/`email`/grants/`package_name`". If this grant is for a draft
|
1810
|
+
# app, the app ID will be used in this resource name instead of the package name.
|
1811
|
+
# @param [Google::Apis::AndroidpublisherV3::Grant] grant_object
|
1812
|
+
# @param [String] update_mask
|
1813
|
+
# Optional. The list of fields to be updated.
|
1674
1814
|
# @param [String] fields
|
1675
1815
|
# Selector specifying which fields to include in a partial response.
|
1676
1816
|
# @param [String] quota_user
|
1677
1817
|
# Available to use for quota purposes for server-side applications. Can be any
|
1678
1818
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1679
|
-
# @param [IO, String] upload_source
|
1680
|
-
# IO stream or filename containing content to upload
|
1681
|
-
# @param [String] content_type
|
1682
|
-
# Content type of the uploaded content.
|
1683
1819
|
# @param [Google::Apis::RequestOptions] options
|
1684
1820
|
# Request-specific options
|
1685
1821
|
#
|
1686
1822
|
# @yield [result, err] Result & error if block supplied
|
1687
|
-
# @yieldparam result [Google::Apis::AndroidpublisherV3::
|
1823
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Grant] parsed result object
|
1688
1824
|
# @yieldparam err [StandardError] error object if request failed
|
1689
1825
|
#
|
1690
|
-
# @return [Google::Apis::AndroidpublisherV3::
|
1826
|
+
# @return [Google::Apis::AndroidpublisherV3::Grant]
|
1691
1827
|
#
|
1692
1828
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1693
1829
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1694
1830
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1695
|
-
def
|
1696
|
-
|
1697
|
-
|
1698
|
-
|
1699
|
-
|
1700
|
-
|
1701
|
-
|
1702
|
-
|
1703
|
-
command.response_representation = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact::Representation
|
1704
|
-
command.response_class = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact
|
1705
|
-
command.params['packageName'] = package_name unless package_name.nil?
|
1831
|
+
def patch_grant(name, grant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1832
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/{+name}', options)
|
1833
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
1834
|
+
command.request_object = grant_object
|
1835
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
1836
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Grant
|
1837
|
+
command.params['name'] = name unless name.nil?
|
1838
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1706
1839
|
command.query['fields'] = fields unless fields.nil?
|
1707
1840
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1708
1841
|
execute_or_queue_command(command, &block)
|
1709
1842
|
end
|
1710
1843
|
|
1711
|
-
#
|
1844
|
+
# Deletes an in-app product (a managed product or a subscription). This method
|
1845
|
+
# should no longer be used to delete subscriptions. See [this article](https://
|
1846
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
1847
|
+
# june-2023.html) for more information.
|
1712
1848
|
# @param [String] package_name
|
1713
|
-
#
|
1714
|
-
#
|
1715
|
-
#
|
1716
|
-
#
|
1717
|
-
#
|
1718
|
-
# @param [
|
1849
|
+
# Package name of the app.
|
1850
|
+
# @param [String] sku
|
1851
|
+
# Unique identifier for the in-app product.
|
1852
|
+
# @param [String] fields
|
1853
|
+
# Selector specifying which fields to include in a partial response.
|
1854
|
+
# @param [String] quota_user
|
1855
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1856
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1857
|
+
# @param [Google::Apis::RequestOptions] options
|
1858
|
+
# Request-specific options
|
1859
|
+
#
|
1860
|
+
# @yield [result, err] Result & error if block supplied
|
1861
|
+
# @yieldparam result [NilClass] No result returned for this method
|
1862
|
+
# @yieldparam err [StandardError] error object if request failed
|
1863
|
+
#
|
1864
|
+
# @return [void]
|
1865
|
+
#
|
1866
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1867
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1868
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1869
|
+
def delete_inappproduct(package_name, sku, fields: nil, quota_user: nil, options: nil, &block)
|
1870
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
1871
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
1872
|
+
command.params['sku'] = sku unless sku.nil?
|
1873
|
+
command.query['fields'] = fields unless fields.nil?
|
1874
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1875
|
+
execute_or_queue_command(command, &block)
|
1876
|
+
end
|
1877
|
+
|
1878
|
+
# Gets an in-app product, which can be a managed product or a subscription. This
|
1879
|
+
# method should no longer be used to retrieve subscriptions. See [this article](
|
1880
|
+
# https://android-developers.googleblog.com/2023/06/changes-to-google-play-
|
1881
|
+
# developer-api-june-2023.html) for more information.
|
1882
|
+
# @param [String] package_name
|
1883
|
+
# Package name of the app.
|
1884
|
+
# @param [String] sku
|
1885
|
+
# Unique identifier for the in-app product.
|
1886
|
+
# @param [String] fields
|
1887
|
+
# Selector specifying which fields to include in a partial response.
|
1888
|
+
# @param [String] quota_user
|
1889
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1890
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1891
|
+
# @param [Google::Apis::RequestOptions] options
|
1892
|
+
# Request-specific options
|
1893
|
+
#
|
1894
|
+
# @yield [result, err] Result & error if block supplied
|
1895
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InAppProduct] parsed result object
|
1896
|
+
# @yieldparam err [StandardError] error object if request failed
|
1897
|
+
#
|
1898
|
+
# @return [Google::Apis::AndroidpublisherV3::InAppProduct]
|
1899
|
+
#
|
1900
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1901
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1902
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1903
|
+
def get_inappproduct(package_name, sku, fields: nil, quota_user: nil, options: nil, &block)
|
1904
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
1905
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
1906
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
1907
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
1908
|
+
command.params['sku'] = sku unless sku.nil?
|
1909
|
+
command.query['fields'] = fields unless fields.nil?
|
1910
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1911
|
+
execute_or_queue_command(command, &block)
|
1912
|
+
end
|
1913
|
+
|
1914
|
+
# Creates an in-app product (a managed product or a subscription). This method
|
1915
|
+
# should no longer be used to create subscriptions. See [this article](https://
|
1916
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
1917
|
+
# june-2023.html) for more information.
|
1918
|
+
# @param [String] package_name
|
1919
|
+
# Package name of the app.
|
1920
|
+
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
1921
|
+
# @param [Boolean] auto_convert_missing_prices
|
1922
|
+
# If true the prices for all regions targeted by the parent app that don't have
|
1923
|
+
# a price specified for this in-app product will be auto converted to the target
|
1924
|
+
# currency based on the default price. Defaults to false.
|
1925
|
+
# @param [String] fields
|
1926
|
+
# Selector specifying which fields to include in a partial response.
|
1927
|
+
# @param [String] quota_user
|
1928
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1929
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1930
|
+
# @param [Google::Apis::RequestOptions] options
|
1931
|
+
# Request-specific options
|
1932
|
+
#
|
1933
|
+
# @yield [result, err] Result & error if block supplied
|
1934
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InAppProduct] parsed result object
|
1935
|
+
# @yieldparam err [StandardError] error object if request failed
|
1936
|
+
#
|
1937
|
+
# @return [Google::Apis::AndroidpublisherV3::InAppProduct]
|
1938
|
+
#
|
1939
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1940
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1941
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1942
|
+
def insert_inappproduct(package_name, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1943
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/inappproducts', options)
|
1944
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
1945
|
+
command.request_object = in_app_product_object
|
1946
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
1947
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
1948
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
1949
|
+
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
1950
|
+
command.query['fields'] = fields unless fields.nil?
|
1951
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1952
|
+
execute_or_queue_command(command, &block)
|
1953
|
+
end
|
1954
|
+
|
1955
|
+
# Lists all in-app products - both managed products and subscriptions. If an app
|
1956
|
+
# has a large number of in-app products, the response may be paginated. In this
|
1957
|
+
# case the response field `tokenPagination.nextPageToken` will be set and the
|
1958
|
+
# caller should provide its value as a `token` request parameter to retrieve the
|
1959
|
+
# next page. This method should no longer be used to retrieve subscriptions. See
|
1960
|
+
# [this article](https://android-developers.googleblog.com/2023/06/changes-to-
|
1961
|
+
# google-play-developer-api-june-2023.html) for more information.
|
1962
|
+
# @param [String] package_name
|
1963
|
+
# Package name of the app.
|
1964
|
+
# @param [Fixnum] max_results
|
1965
|
+
# Deprecated and ignored. The page size is determined by the server.
|
1966
|
+
# @param [Fixnum] start_index
|
1967
|
+
# Deprecated and ignored. Set the `token` parameter to retrieve the next page.
|
1968
|
+
# @param [String] token
|
1969
|
+
# Pagination token. If empty, list starts at the first product.
|
1970
|
+
# @param [String] fields
|
1971
|
+
# Selector specifying which fields to include in a partial response.
|
1972
|
+
# @param [String] quota_user
|
1973
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1974
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1975
|
+
# @param [Google::Apis::RequestOptions] options
|
1976
|
+
# Request-specific options
|
1977
|
+
#
|
1978
|
+
# @yield [result, err] Result & error if block supplied
|
1979
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InappproductsListResponse] parsed result object
|
1980
|
+
# @yieldparam err [StandardError] error object if request failed
|
1981
|
+
#
|
1982
|
+
# @return [Google::Apis::AndroidpublisherV3::InappproductsListResponse]
|
1983
|
+
#
|
1984
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1985
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1986
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1987
|
+
def list_inappproducts(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1988
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/inappproducts', options)
|
1989
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InappproductsListResponse::Representation
|
1990
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InappproductsListResponse
|
1991
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
1992
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
1993
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
1994
|
+
command.query['token'] = token unless token.nil?
|
1995
|
+
command.query['fields'] = fields unless fields.nil?
|
1996
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1997
|
+
execute_or_queue_command(command, &block)
|
1998
|
+
end
|
1999
|
+
|
2000
|
+
# Patches an in-app product (a managed product or a subscription). This method
|
2001
|
+
# should no longer be used to update subscriptions. See [this article](https://
|
2002
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
2003
|
+
# june-2023.html) for more information.
|
2004
|
+
# @param [String] package_name
|
2005
|
+
# Package name of the app.
|
2006
|
+
# @param [String] sku
|
2007
|
+
# Unique identifier for the in-app product.
|
2008
|
+
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
2009
|
+
# @param [Boolean] auto_convert_missing_prices
|
2010
|
+
# If true the prices for all regions targeted by the parent app that don't have
|
2011
|
+
# a price specified for this in-app product will be auto converted to the target
|
2012
|
+
# currency based on the default price. Defaults to false.
|
2013
|
+
# @param [String] fields
|
2014
|
+
# Selector specifying which fields to include in a partial response.
|
2015
|
+
# @param [String] quota_user
|
2016
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2017
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2018
|
+
# @param [Google::Apis::RequestOptions] options
|
2019
|
+
# Request-specific options
|
2020
|
+
#
|
2021
|
+
# @yield [result, err] Result & error if block supplied
|
2022
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InAppProduct] parsed result object
|
2023
|
+
# @yieldparam err [StandardError] error object if request failed
|
2024
|
+
#
|
2025
|
+
# @return [Google::Apis::AndroidpublisherV3::InAppProduct]
|
2026
|
+
#
|
2027
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2028
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2029
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2030
|
+
def patch_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2031
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
2032
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2033
|
+
command.request_object = in_app_product_object
|
2034
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2035
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
2036
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2037
|
+
command.params['sku'] = sku unless sku.nil?
|
2038
|
+
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
2039
|
+
command.query['fields'] = fields unless fields.nil?
|
2040
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2041
|
+
execute_or_queue_command(command, &block)
|
2042
|
+
end
|
2043
|
+
|
2044
|
+
# Updates an in-app product (a managed product or a subscription). This method
|
2045
|
+
# should no longer be used to update subscriptions. See [this article](https://
|
2046
|
+
# android-developers.googleblog.com/2023/06/changes-to-google-play-developer-api-
|
2047
|
+
# june-2023.html) for more information.
|
2048
|
+
# @param [String] package_name
|
2049
|
+
# Package name of the app.
|
2050
|
+
# @param [String] sku
|
2051
|
+
# Unique identifier for the in-app product.
|
2052
|
+
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
2053
|
+
# @param [Boolean] allow_missing
|
2054
|
+
# If set to true, and the in-app product with the given package_name and sku
|
2055
|
+
# doesn't exist, the in-app product will be created.
|
2056
|
+
# @param [Boolean] auto_convert_missing_prices
|
2057
|
+
# If true the prices for all regions targeted by the parent app that don't have
|
2058
|
+
# a price specified for this in-app product will be auto converted to the target
|
2059
|
+
# currency based on the default price. Defaults to false.
|
2060
|
+
# @param [String] fields
|
2061
|
+
# Selector specifying which fields to include in a partial response.
|
2062
|
+
# @param [String] quota_user
|
2063
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2064
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2065
|
+
# @param [Google::Apis::RequestOptions] options
|
2066
|
+
# Request-specific options
|
2067
|
+
#
|
2068
|
+
# @yield [result, err] Result & error if block supplied
|
2069
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InAppProduct] parsed result object
|
2070
|
+
# @yieldparam err [StandardError] error object if request failed
|
2071
|
+
#
|
2072
|
+
# @return [Google::Apis::AndroidpublisherV3::InAppProduct]
|
2073
|
+
#
|
2074
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2075
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2076
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2077
|
+
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)
|
2078
|
+
command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
2079
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2080
|
+
command.request_object = in_app_product_object
|
2081
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
2082
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
2083
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2084
|
+
command.params['sku'] = sku unless sku.nil?
|
2085
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
2086
|
+
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
2087
|
+
command.query['fields'] = fields unless fields.nil?
|
2088
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2089
|
+
execute_or_queue_command(command, &block)
|
2090
|
+
end
|
2091
|
+
|
2092
|
+
# Uploads an APK to internal app sharing. If you are using the Google API client
|
2093
|
+
# libraries, please increase the timeout of the http request before calling this
|
2094
|
+
# endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](
|
2095
|
+
# https://developers.google.com/api-client-library/java/google-api-java-client/
|
2096
|
+
# errors) for an example in java.
|
2097
|
+
# @param [String] package_name
|
2098
|
+
# Package name of the app.
|
2099
|
+
# @param [String] fields
|
2100
|
+
# Selector specifying which fields to include in a partial response.
|
2101
|
+
# @param [String] quota_user
|
2102
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2103
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2104
|
+
# @param [IO, String] upload_source
|
2105
|
+
# IO stream or filename containing content to upload
|
2106
|
+
# @param [String] content_type
|
2107
|
+
# Content type of the uploaded content.
|
2108
|
+
# @param [Google::Apis::RequestOptions] options
|
2109
|
+
# Request-specific options
|
2110
|
+
#
|
2111
|
+
# @yield [result, err] Result & error if block supplied
|
2112
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact] parsed result object
|
2113
|
+
# @yieldparam err [StandardError] error object if request failed
|
2114
|
+
#
|
2115
|
+
# @return [Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact]
|
2116
|
+
#
|
2117
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2118
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2119
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2120
|
+
def uploadapk_internalappsharingartifact(package_name, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
2121
|
+
if upload_source.nil?
|
2122
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk', options)
|
2123
|
+
else
|
2124
|
+
command = make_upload_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk', options)
|
2125
|
+
command.upload_source = upload_source
|
2126
|
+
command.upload_content_type = content_type
|
2127
|
+
end
|
2128
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact::Representation
|
2129
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact
|
2130
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2131
|
+
command.query['fields'] = fields unless fields.nil?
|
2132
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2133
|
+
execute_or_queue_command(command, &block)
|
2134
|
+
end
|
2135
|
+
|
2136
|
+
# Uploads an app bundle to internal app sharing. If you are using the Google API
|
2137
|
+
# client libraries, please increase the timeout of the http request before
|
2138
|
+
# calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts
|
2139
|
+
# and Errors](https://developers.google.com/api-client-library/java/google-api-
|
2140
|
+
# java-client/errors) for an example in java.
|
2141
|
+
# @param [String] package_name
|
2142
|
+
# Package name of the app.
|
2143
|
+
# @param [String] fields
|
2144
|
+
# Selector specifying which fields to include in a partial response.
|
2145
|
+
# @param [String] quota_user
|
2146
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2147
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2148
|
+
# @param [IO, String] upload_source
|
2149
|
+
# IO stream or filename containing content to upload
|
2150
|
+
# @param [String] content_type
|
2151
|
+
# Content type of the uploaded content.
|
2152
|
+
# @param [Google::Apis::RequestOptions] options
|
2153
|
+
# Request-specific options
|
2154
|
+
#
|
2155
|
+
# @yield [result, err] Result & error if block supplied
|
2156
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact] parsed result object
|
2157
|
+
# @yieldparam err [StandardError] error object if request failed
|
2158
|
+
#
|
2159
|
+
# @return [Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact]
|
2160
|
+
#
|
2161
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2162
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2163
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2164
|
+
def uploadbundle_internalappsharingartifact(package_name, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
2165
|
+
if upload_source.nil?
|
2166
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle', options)
|
2167
|
+
else
|
2168
|
+
command = make_upload_command(:post, 'androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle', options)
|
2169
|
+
command.upload_source = upload_source
|
2170
|
+
command.upload_content_type = content_type
|
2171
|
+
end
|
2172
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact::Representation
|
2173
|
+
command.response_class = Google::Apis::AndroidpublisherV3::InternalAppSharingArtifact
|
2174
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2175
|
+
command.query['fields'] = fields unless fields.nil?
|
2176
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2177
|
+
execute_or_queue_command(command, &block)
|
2178
|
+
end
|
2179
|
+
|
2180
|
+
# Calculates the region prices, using today's exchange rate and country-specific
|
2181
|
+
# pricing patterns, based on the price in the request for a set of regions.
|
2182
|
+
# @param [String] package_name
|
2183
|
+
# Required. The app package name.
|
2184
|
+
# @param [Google::Apis::AndroidpublisherV3::ConvertRegionPricesRequest] convert_region_prices_request_object
|
2185
|
+
# @param [String] fields
|
2186
|
+
# Selector specifying which fields to include in a partial response.
|
2187
|
+
# @param [String] quota_user
|
2188
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2189
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2190
|
+
# @param [Google::Apis::RequestOptions] options
|
2191
|
+
# Request-specific options
|
2192
|
+
#
|
2193
|
+
# @yield [result, err] Result & error if block supplied
|
2194
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse] parsed result object
|
2195
|
+
# @yieldparam err [StandardError] error object if request failed
|
2196
|
+
#
|
2197
|
+
# @return [Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse]
|
2198
|
+
#
|
2199
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2200
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2201
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2202
|
+
def convert_monetization_region_prices(package_name, convert_region_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2203
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/pricing:convertRegionPrices', options)
|
2204
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ConvertRegionPricesRequest::Representation
|
2205
|
+
command.request_object = convert_region_prices_request_object
|
2206
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse::Representation
|
2207
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse
|
2208
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2209
|
+
command.query['fields'] = fields unless fields.nil?
|
2210
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2211
|
+
execute_or_queue_command(command, &block)
|
2212
|
+
end
|
2213
|
+
|
2214
|
+
# Archives a subscription. Can only be done if at least one base plan was active
|
2215
|
+
# in the past, and no base plan is available for new or existing subscribers
|
2216
|
+
# currently. This action is irreversible, and the subscription ID will remain
|
2217
|
+
# reserved.
|
2218
|
+
# @param [String] package_name
|
2219
|
+
# Required. The parent app (package name) of the app of the subscription to
|
2220
|
+
# delete.
|
2221
|
+
# @param [String] product_id
|
2222
|
+
# Required. The unique product ID of the subscription to delete.
|
2223
|
+
# @param [Google::Apis::AndroidpublisherV3::ArchiveSubscriptionRequest] archive_subscription_request_object
|
2224
|
+
# @param [String] fields
|
2225
|
+
# Selector specifying which fields to include in a partial response.
|
2226
|
+
# @param [String] quota_user
|
2227
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2228
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2229
|
+
# @param [Google::Apis::RequestOptions] options
|
2230
|
+
# Request-specific options
|
2231
|
+
#
|
2232
|
+
# @yield [result, err] Result & error if block supplied
|
2233
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
2234
|
+
# @yieldparam err [StandardError] error object if request failed
|
2235
|
+
#
|
2236
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
2237
|
+
#
|
2238
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2239
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2240
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2241
|
+
def archive_subscription(package_name, product_id, archive_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2242
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive', options)
|
2243
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ArchiveSubscriptionRequest::Representation
|
2244
|
+
command.request_object = archive_subscription_request_object
|
2245
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2246
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2247
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2248
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2249
|
+
command.query['fields'] = fields unless fields.nil?
|
2250
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2251
|
+
execute_or_queue_command(command, &block)
|
2252
|
+
end
|
2253
|
+
|
2254
|
+
# Creates a new subscription. Newly added base plans will remain in draft state
|
2255
|
+
# until activated.
|
2256
|
+
# @param [String] package_name
|
2257
|
+
# Required. The parent app (package name) for which the subscription should be
|
2258
|
+
# created. Must be equal to the package_name field on the Subscription resource.
|
2259
|
+
# @param [Google::Apis::AndroidpublisherV3::Subscription] subscription_object
|
2260
|
+
# @param [String] product_id
|
2261
|
+
# Required. The ID to use for the subscription. For the requirements on this
|
2262
|
+
# format, see the documentation of the product_id field on the Subscription
|
2263
|
+
# resource.
|
2264
|
+
# @param [String] regions_version_version
|
2265
|
+
# Required. The latest version is 2022/02.
|
2266
|
+
# @param [String] fields
|
2267
|
+
# Selector specifying which fields to include in a partial response.
|
2268
|
+
# @param [String] quota_user
|
2269
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2270
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2271
|
+
# @param [Google::Apis::RequestOptions] options
|
2272
|
+
# Request-specific options
|
2273
|
+
#
|
2274
|
+
# @yield [result, err] Result & error if block supplied
|
2275
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
2276
|
+
# @yieldparam err [StandardError] error object if request failed
|
2277
|
+
#
|
2278
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
2279
|
+
#
|
2280
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2281
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2282
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2283
|
+
def create_monetization_subscription(package_name, subscription_object = nil, product_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2284
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions', options)
|
2285
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2286
|
+
command.request_object = subscription_object
|
2287
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2288
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2289
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2290
|
+
command.query['productId'] = product_id unless product_id.nil?
|
2291
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
2292
|
+
command.query['fields'] = fields unless fields.nil?
|
2293
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2294
|
+
execute_or_queue_command(command, &block)
|
2295
|
+
end
|
2296
|
+
|
2297
|
+
# Deletes a subscription. A subscription can only be deleted if it has never had
|
2298
|
+
# a base plan published.
|
2299
|
+
# @param [String] package_name
|
2300
|
+
# Required. The parent app (package name) of the app of the subscription to
|
2301
|
+
# delete.
|
2302
|
+
# @param [String] product_id
|
2303
|
+
# Required. The unique product ID of the subscription to delete.
|
2304
|
+
# @param [String] fields
|
2305
|
+
# Selector specifying which fields to include in a partial response.
|
2306
|
+
# @param [String] quota_user
|
2307
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2308
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2309
|
+
# @param [Google::Apis::RequestOptions] options
|
2310
|
+
# Request-specific options
|
2311
|
+
#
|
2312
|
+
# @yield [result, err] Result & error if block supplied
|
2313
|
+
# @yieldparam result [NilClass] No result returned for this method
|
2314
|
+
# @yieldparam err [StandardError] error object if request failed
|
2315
|
+
#
|
2316
|
+
# @return [void]
|
2317
|
+
#
|
2318
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2319
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2320
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2321
|
+
def delete_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
|
2322
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
2323
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2324
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2325
|
+
command.query['fields'] = fields unless fields.nil?
|
2326
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2327
|
+
execute_or_queue_command(command, &block)
|
2328
|
+
end
|
2329
|
+
|
2330
|
+
# Reads a single subscription.
|
2331
|
+
# @param [String] package_name
|
2332
|
+
# Required. The parent app (package name) of the subscription to get.
|
2333
|
+
# @param [String] product_id
|
2334
|
+
# Required. The unique product ID of the subscription to get.
|
2335
|
+
# @param [String] fields
|
2336
|
+
# Selector specifying which fields to include in a partial response.
|
2337
|
+
# @param [String] quota_user
|
2338
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2339
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2340
|
+
# @param [Google::Apis::RequestOptions] options
|
2341
|
+
# Request-specific options
|
2342
|
+
#
|
2343
|
+
# @yield [result, err] Result & error if block supplied
|
2344
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
2345
|
+
# @yieldparam err [StandardError] error object if request failed
|
2346
|
+
#
|
2347
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
2348
|
+
#
|
2349
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2350
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2351
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2352
|
+
def get_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
|
2353
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
2354
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2355
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2356
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2357
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2358
|
+
command.query['fields'] = fields unless fields.nil?
|
2359
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2360
|
+
execute_or_queue_command(command, &block)
|
2361
|
+
end
|
2362
|
+
|
2363
|
+
# Lists all subscriptions under a given app.
|
2364
|
+
# @param [String] package_name
|
2365
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
2366
|
+
# read.
|
2367
|
+
# @param [Fixnum] page_size
|
2368
|
+
# The maximum number of subscriptions to return. The service may return fewer
|
2369
|
+
# than this value. If unspecified, at most 50 subscriptions will be returned.
|
2370
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
2371
|
+
# @param [String] page_token
|
2372
|
+
# A page token, received from a previous `ListSubscriptions` call. Provide this
|
2373
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
2374
|
+
# provided to `ListSubscriptions` must match the call that provided the page
|
2375
|
+
# token.
|
2376
|
+
# @param [Boolean] show_archived
|
2377
|
+
# Whether archived subscriptions should be included in the response. Defaults to
|
2378
|
+
# false.
|
2379
|
+
# @param [String] fields
|
2380
|
+
# Selector specifying which fields to include in a partial response.
|
2381
|
+
# @param [String] quota_user
|
2382
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2383
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2384
|
+
# @param [Google::Apis::RequestOptions] options
|
2385
|
+
# Request-specific options
|
2386
|
+
#
|
2387
|
+
# @yield [result, err] Result & error if block supplied
|
2388
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse] parsed result object
|
2389
|
+
# @yieldparam err [StandardError] error object if request failed
|
2390
|
+
#
|
2391
|
+
# @return [Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse]
|
2392
|
+
#
|
2393
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2394
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2395
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2396
|
+
def list_monetization_subscriptions(package_name, page_size: nil, page_token: nil, show_archived: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2397
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions', options)
|
2398
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse::Representation
|
2399
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse
|
2400
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2401
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2402
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2403
|
+
command.query['showArchived'] = show_archived unless show_archived.nil?
|
2404
|
+
command.query['fields'] = fields unless fields.nil?
|
2405
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2406
|
+
execute_or_queue_command(command, &block)
|
2407
|
+
end
|
2408
|
+
|
2409
|
+
# Updates an existing subscription.
|
2410
|
+
# @param [String] package_name
|
2411
|
+
# Immutable. Package name of the parent app.
|
2412
|
+
# @param [String] product_id
|
2413
|
+
# Immutable. Unique product ID of the product. Unique within the parent app.
|
2414
|
+
# Product IDs must be composed of lower-case letters (a-z), numbers (0-9),
|
2415
|
+
# underscores (_) and dots (.). It must start with a lower-case letter or number,
|
2416
|
+
# and be between 1 and 40 (inclusive) characters in length.
|
2417
|
+
# @param [Google::Apis::AndroidpublisherV3::Subscription] subscription_object
|
2418
|
+
# @param [String] regions_version_version
|
2419
|
+
# Required. The latest version is 2022/02.
|
2420
|
+
# @param [String] update_mask
|
2421
|
+
# Required. The list of fields to be updated.
|
2422
|
+
# @param [String] fields
|
2423
|
+
# Selector specifying which fields to include in a partial response.
|
2424
|
+
# @param [String] quota_user
|
2425
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2426
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2427
|
+
# @param [Google::Apis::RequestOptions] options
|
2428
|
+
# Request-specific options
|
2429
|
+
#
|
2430
|
+
# @yield [result, err] Result & error if block supplied
|
2431
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
2432
|
+
# @yieldparam err [StandardError] error object if request failed
|
2433
|
+
#
|
2434
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
2435
|
+
#
|
2436
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2437
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2438
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2439
|
+
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)
|
2440
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
2441
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2442
|
+
command.request_object = subscription_object
|
2443
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2444
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2445
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2446
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2447
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
2448
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2449
|
+
command.query['fields'] = fields unless fields.nil?
|
2450
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2451
|
+
execute_or_queue_command(command, &block)
|
2452
|
+
end
|
2453
|
+
|
2454
|
+
# Activates a base plan. Once activated, base plans will be available to new
|
2455
|
+
# subscribers.
|
2456
|
+
# @param [String] package_name
|
2457
|
+
# Required. The parent app (package name) of the base plan to activate.
|
2458
|
+
# @param [String] product_id
|
2459
|
+
# Required. The parent subscription (ID) of the base plan to activate.
|
2460
|
+
# @param [String] base_plan_id
|
2461
|
+
# Required. The unique base plan ID of the base plan to activate.
|
2462
|
+
# @param [Google::Apis::AndroidpublisherV3::ActivateBasePlanRequest] activate_base_plan_request_object
|
2463
|
+
# @param [String] fields
|
2464
|
+
# Selector specifying which fields to include in a partial response.
|
2465
|
+
# @param [String] quota_user
|
2466
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2467
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2468
|
+
# @param [Google::Apis::RequestOptions] options
|
2469
|
+
# Request-specific options
|
2470
|
+
#
|
2471
|
+
# @yield [result, err] Result & error if block supplied
|
2472
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
2473
|
+
# @yieldparam err [StandardError] error object if request failed
|
2474
|
+
#
|
2475
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
2476
|
+
#
|
2477
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2478
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2479
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2480
|
+
def activate_base_plan(package_name, product_id, base_plan_id, activate_base_plan_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2481
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate', options)
|
2482
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ActivateBasePlanRequest::Representation
|
2483
|
+
command.request_object = activate_base_plan_request_object
|
2484
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2485
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2486
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2487
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2488
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2489
|
+
command.query['fields'] = fields unless fields.nil?
|
2490
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2491
|
+
execute_or_queue_command(command, &block)
|
2492
|
+
end
|
2493
|
+
|
2494
|
+
# Deactivates a base plan. Once deactivated, the base plan will become
|
2495
|
+
# unavailable to new subscribers, but existing subscribers will maintain their
|
2496
|
+
# subscription
|
2497
|
+
# @param [String] package_name
|
2498
|
+
# Required. The parent app (package name) of the base plan to deactivate.
|
2499
|
+
# @param [String] product_id
|
2500
|
+
# Required. The parent subscription (ID) of the base plan to deactivate.
|
2501
|
+
# @param [String] base_plan_id
|
2502
|
+
# Required. The unique base plan ID of the base plan to deactivate.
|
2503
|
+
# @param [Google::Apis::AndroidpublisherV3::DeactivateBasePlanRequest] deactivate_base_plan_request_object
|
2504
|
+
# @param [String] fields
|
2505
|
+
# Selector specifying which fields to include in a partial response.
|
2506
|
+
# @param [String] quota_user
|
2507
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2508
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2509
|
+
# @param [Google::Apis::RequestOptions] options
|
2510
|
+
# Request-specific options
|
2511
|
+
#
|
2512
|
+
# @yield [result, err] Result & error if block supplied
|
2513
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
2514
|
+
# @yieldparam err [StandardError] error object if request failed
|
2515
|
+
#
|
2516
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
2517
|
+
#
|
2518
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2519
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2520
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2521
|
+
def deactivate_base_plan(package_name, product_id, base_plan_id, deactivate_base_plan_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2522
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate', options)
|
2523
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateBasePlanRequest::Representation
|
2524
|
+
command.request_object = deactivate_base_plan_request_object
|
2525
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
2526
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
2527
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2528
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2529
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2530
|
+
command.query['fields'] = fields unless fields.nil?
|
2531
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2532
|
+
execute_or_queue_command(command, &block)
|
2533
|
+
end
|
2534
|
+
|
2535
|
+
# Deletes a base plan. Can only be done for draft base plans. This action is
|
2536
|
+
# irreversible.
|
2537
|
+
# @param [String] package_name
|
2538
|
+
# Required. The parent app (package name) of the base plan to delete.
|
2539
|
+
# @param [String] product_id
|
2540
|
+
# Required. The parent subscription (ID) of the base plan to delete.
|
2541
|
+
# @param [String] base_plan_id
|
2542
|
+
# Required. The unique offer ID of the base plan to delete.
|
2543
|
+
# @param [String] fields
|
2544
|
+
# Selector specifying which fields to include in a partial response.
|
2545
|
+
# @param [String] quota_user
|
2546
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2547
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2548
|
+
# @param [Google::Apis::RequestOptions] options
|
2549
|
+
# Request-specific options
|
2550
|
+
#
|
2551
|
+
# @yield [result, err] Result & error if block supplied
|
2552
|
+
# @yieldparam result [NilClass] No result returned for this method
|
2553
|
+
# @yieldparam err [StandardError] error object if request failed
|
2554
|
+
#
|
2555
|
+
# @return [void]
|
2556
|
+
#
|
2557
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2558
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2559
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2560
|
+
def delete_monetization_subscription_base_plan(package_name, product_id, base_plan_id, fields: nil, quota_user: nil, options: nil, &block)
|
2561
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}', options)
|
2562
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2563
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2564
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2565
|
+
command.query['fields'] = fields unless fields.nil?
|
2566
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2567
|
+
execute_or_queue_command(command, &block)
|
2568
|
+
end
|
2569
|
+
|
2570
|
+
# Migrates subscribers who are receiving an historical subscription price to the
|
2571
|
+
# currently-offered price for the specified region. Requests will cause price
|
2572
|
+
# change notifications to be sent to users who are currently receiving an
|
2573
|
+
# historical price older than the supplied timestamp. Subscribers who do not
|
2574
|
+
# agree to the new price will have their subscription ended at the next renewal.
|
2575
|
+
# @param [String] package_name
|
2576
|
+
# Required. Package name of the parent app. Must be equal to the package_name
|
2577
|
+
# field on the Subscription resource.
|
2578
|
+
# @param [String] product_id
|
2579
|
+
# Required. The ID of the subscription to update. Must be equal to the
|
2580
|
+
# product_id field on the Subscription resource.
|
2581
|
+
# @param [String] base_plan_id
|
2582
|
+
# Required. The unique base plan ID of the base plan to update prices on.
|
2583
|
+
# @param [Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesRequest] migrate_base_plan_prices_request_object
|
2584
|
+
# @param [String] fields
|
2585
|
+
# Selector specifying which fields to include in a partial response.
|
2586
|
+
# @param [String] quota_user
|
2587
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2588
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2589
|
+
# @param [Google::Apis::RequestOptions] options
|
2590
|
+
# Request-specific options
|
2591
|
+
#
|
2592
|
+
# @yield [result, err] Result & error if block supplied
|
2593
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse] parsed result object
|
2594
|
+
# @yieldparam err [StandardError] error object if request failed
|
2595
|
+
#
|
2596
|
+
# @return [Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse]
|
2597
|
+
#
|
2598
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2599
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2600
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2601
|
+
def migrate_monetization_subscription_base_plan_prices(package_name, product_id, base_plan_id, migrate_base_plan_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2602
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices', options)
|
2603
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesRequest::Representation
|
2604
|
+
command.request_object = migrate_base_plan_prices_request_object
|
2605
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse::Representation
|
2606
|
+
command.response_class = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse
|
2607
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2608
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2609
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2610
|
+
command.query['fields'] = fields unless fields.nil?
|
2611
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2612
|
+
execute_or_queue_command(command, &block)
|
2613
|
+
end
|
2614
|
+
|
2615
|
+
# Activates a subscription offer. Once activated, subscription offers will be
|
2616
|
+
# available to new subscribers.
|
2617
|
+
# @param [String] package_name
|
2618
|
+
# Required. The parent app (package name) of the offer to activate.
|
2619
|
+
# @param [String] product_id
|
2620
|
+
# Required. The parent subscription (ID) of the offer to activate.
|
2621
|
+
# @param [String] base_plan_id
|
2622
|
+
# Required. The parent base plan (ID) of the offer to activate.
|
2623
|
+
# @param [String] offer_id
|
2624
|
+
# Required. The unique offer ID of the offer to activate.
|
2625
|
+
# @param [Google::Apis::AndroidpublisherV3::ActivateSubscriptionOfferRequest] activate_subscription_offer_request_object
|
2626
|
+
# @param [String] fields
|
2627
|
+
# Selector specifying which fields to include in a partial response.
|
2628
|
+
# @param [String] quota_user
|
2629
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2630
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2631
|
+
# @param [Google::Apis::RequestOptions] options
|
2632
|
+
# Request-specific options
|
2633
|
+
#
|
2634
|
+
# @yield [result, err] Result & error if block supplied
|
2635
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
2636
|
+
# @yieldparam err [StandardError] error object if request failed
|
2637
|
+
#
|
2638
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
2639
|
+
#
|
2640
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2641
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2642
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2643
|
+
def activate_subscription_offer(package_name, product_id, base_plan_id, offer_id, activate_subscription_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2644
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate', options)
|
2645
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ActivateSubscriptionOfferRequest::Representation
|
2646
|
+
command.request_object = activate_subscription_offer_request_object
|
2647
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2648
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
2649
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2650
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2651
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2652
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
2653
|
+
command.query['fields'] = fields unless fields.nil?
|
2654
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2655
|
+
execute_or_queue_command(command, &block)
|
2656
|
+
end
|
2657
|
+
|
2658
|
+
# Creates a new subscription offer. Only auto-renewing base plans can have
|
2659
|
+
# subscription offers. The offer state will be DRAFT until it is activated.
|
2660
|
+
# @param [String] package_name
|
2661
|
+
# Required. The parent app (package name) for which the offer should be created.
|
2662
|
+
# Must be equal to the package_name field on the Subscription resource.
|
2663
|
+
# @param [String] product_id
|
2664
|
+
# Required. The parent subscription (ID) for which the offer should be created.
|
2665
|
+
# Must be equal to the product_id field on the SubscriptionOffer resource.
|
2666
|
+
# @param [String] base_plan_id
|
2667
|
+
# Required. The parent base plan (ID) for which the offer should be created.
|
2668
|
+
# Must be equal to the base_plan_id field on the SubscriptionOffer resource.
|
2669
|
+
# @param [Google::Apis::AndroidpublisherV3::SubscriptionOffer] subscription_offer_object
|
2670
|
+
# @param [String] offer_id
|
2671
|
+
# Required. The ID to use for the offer. For the requirements on this format,
|
2672
|
+
# see the documentation of the offer_id field on the SubscriptionOffer resource.
|
2673
|
+
# @param [String] regions_version_version
|
2674
|
+
# Required. The latest version is 2022/02.
|
2675
|
+
# @param [String] fields
|
2676
|
+
# Selector specifying which fields to include in a partial response.
|
2677
|
+
# @param [String] quota_user
|
2678
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2679
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2680
|
+
# @param [Google::Apis::RequestOptions] options
|
2681
|
+
# Request-specific options
|
2682
|
+
#
|
2683
|
+
# @yield [result, err] Result & error if block supplied
|
2684
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
2685
|
+
# @yieldparam err [StandardError] error object if request failed
|
2686
|
+
#
|
2687
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
2688
|
+
#
|
2689
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2690
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2691
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2692
|
+
def create_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, subscription_offer_object = nil, offer_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2693
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers', options)
|
2694
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2695
|
+
command.request_object = subscription_offer_object
|
2696
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2697
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
2698
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2699
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2700
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2701
|
+
command.query['offerId'] = offer_id unless offer_id.nil?
|
2702
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
2703
|
+
command.query['fields'] = fields unless fields.nil?
|
2704
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2705
|
+
execute_or_queue_command(command, &block)
|
2706
|
+
end
|
2707
|
+
|
2708
|
+
# Deactivates a subscription offer. Once deactivated, existing subscribers will
|
2709
|
+
# maintain their subscription, but the offer will become unavailable to new
|
2710
|
+
# subscribers.
|
2711
|
+
# @param [String] package_name
|
2712
|
+
# Required. The parent app (package name) of the offer to deactivate.
|
2713
|
+
# @param [String] product_id
|
2714
|
+
# Required. The parent subscription (ID) of the offer to deactivate.
|
2715
|
+
# @param [String] base_plan_id
|
2716
|
+
# Required. The parent base plan (ID) of the offer to deactivate.
|
2717
|
+
# @param [String] offer_id
|
2718
|
+
# Required. The unique offer ID of the offer to deactivate.
|
2719
|
+
# @param [Google::Apis::AndroidpublisherV3::DeactivateSubscriptionOfferRequest] deactivate_subscription_offer_request_object
|
2720
|
+
# @param [String] fields
|
2721
|
+
# Selector specifying which fields to include in a partial response.
|
2722
|
+
# @param [String] quota_user
|
2723
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2724
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2725
|
+
# @param [Google::Apis::RequestOptions] options
|
2726
|
+
# Request-specific options
|
2727
|
+
#
|
2728
|
+
# @yield [result, err] Result & error if block supplied
|
2729
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
2730
|
+
# @yieldparam err [StandardError] error object if request failed
|
2731
|
+
#
|
2732
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
2733
|
+
#
|
2734
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2735
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2736
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2737
|
+
def deactivate_subscription_offer(package_name, product_id, base_plan_id, offer_id, deactivate_subscription_offer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2738
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate', options)
|
2739
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateSubscriptionOfferRequest::Representation
|
2740
|
+
command.request_object = deactivate_subscription_offer_request_object
|
2741
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2742
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
2743
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2744
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2745
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2746
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
2747
|
+
command.query['fields'] = fields unless fields.nil?
|
2748
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2749
|
+
execute_or_queue_command(command, &block)
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# Deletes a subscription offer. Can only be done for draft offers. This action
|
2753
|
+
# is irreversible.
|
2754
|
+
# @param [String] package_name
|
2755
|
+
# Required. The parent app (package name) of the offer to delete.
|
2756
|
+
# @param [String] product_id
|
2757
|
+
# Required. The parent subscription (ID) of the offer to delete.
|
2758
|
+
# @param [String] base_plan_id
|
2759
|
+
# Required. The parent base plan (ID) of the offer to delete.
|
2760
|
+
# @param [String] offer_id
|
2761
|
+
# Required. The unique offer ID of the offer to delete.
|
2762
|
+
# @param [String] fields
|
2763
|
+
# Selector specifying which fields to include in a partial response.
|
2764
|
+
# @param [String] quota_user
|
2765
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2766
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2767
|
+
# @param [Google::Apis::RequestOptions] options
|
2768
|
+
# Request-specific options
|
2769
|
+
#
|
2770
|
+
# @yield [result, err] Result & error if block supplied
|
2771
|
+
# @yieldparam result [NilClass] No result returned for this method
|
2772
|
+
# @yieldparam err [StandardError] error object if request failed
|
2773
|
+
#
|
2774
|
+
# @return [void]
|
2775
|
+
#
|
2776
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2777
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2778
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2779
|
+
def delete_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil, &block)
|
2780
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
2781
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2782
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2783
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2784
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
2785
|
+
command.query['fields'] = fields unless fields.nil?
|
2786
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2787
|
+
execute_or_queue_command(command, &block)
|
2788
|
+
end
|
2789
|
+
|
2790
|
+
# Reads a single offer
|
2791
|
+
# @param [String] package_name
|
2792
|
+
# Required. The parent app (package name) of the offer to get.
|
2793
|
+
# @param [String] product_id
|
2794
|
+
# Required. The parent subscription (ID) of the offer to get.
|
2795
|
+
# @param [String] base_plan_id
|
2796
|
+
# Required. The parent base plan (ID) of the offer to get.
|
2797
|
+
# @param [String] offer_id
|
2798
|
+
# Required. The unique offer ID of the offer to get.
|
2799
|
+
# @param [String] fields
|
2800
|
+
# Selector specifying which fields to include in a partial response.
|
2801
|
+
# @param [String] quota_user
|
2802
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2803
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2804
|
+
# @param [Google::Apis::RequestOptions] options
|
2805
|
+
# Request-specific options
|
2806
|
+
#
|
2807
|
+
# @yield [result, err] Result & error if block supplied
|
2808
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
2809
|
+
# @yieldparam err [StandardError] error object if request failed
|
2810
|
+
#
|
2811
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
2812
|
+
#
|
2813
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2814
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2815
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2816
|
+
def get_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil, &block)
|
2817
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
2818
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2819
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
2820
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2821
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2822
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2823
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
2824
|
+
command.query['fields'] = fields unless fields.nil?
|
2825
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2826
|
+
execute_or_queue_command(command, &block)
|
2827
|
+
end
|
2828
|
+
|
2829
|
+
# Lists all offers under a given subscription.
|
2830
|
+
# @param [String] package_name
|
2831
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
2832
|
+
# read.
|
2833
|
+
# @param [String] product_id
|
2834
|
+
# Required. The parent subscription (ID) for which the offers should be read.
|
2835
|
+
# May be specified as '-' to read all offers under an app.
|
2836
|
+
# @param [String] base_plan_id
|
2837
|
+
# Required. The parent base plan (ID) for which the offers should be read. May
|
2838
|
+
# be specified as '-' to read all offers under a subscription or an app. Must be
|
2839
|
+
# specified as '-' if product_id is specified as '-'.
|
2840
|
+
# @param [Fixnum] page_size
|
2841
|
+
# The maximum number of subscriptions to return. The service may return fewer
|
2842
|
+
# than this value. If unspecified, at most 50 subscriptions will be returned.
|
2843
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
2844
|
+
# @param [String] page_token
|
2845
|
+
# A page token, received from a previous `ListSubscriptionsOffers` call. Provide
|
2846
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
2847
|
+
# provided to `ListSubscriptionOffers` must match the call that provided the
|
2848
|
+
# page token.
|
2849
|
+
# @param [String] fields
|
2850
|
+
# Selector specifying which fields to include in a partial response.
|
2851
|
+
# @param [String] quota_user
|
2852
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2853
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2854
|
+
# @param [Google::Apis::RequestOptions] options
|
2855
|
+
# Request-specific options
|
2856
|
+
#
|
2857
|
+
# @yield [result, err] Result & error if block supplied
|
2858
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse] parsed result object
|
2859
|
+
# @yieldparam err [StandardError] error object if request failed
|
2860
|
+
#
|
2861
|
+
# @return [Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse]
|
2862
|
+
#
|
2863
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2864
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2865
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2866
|
+
def list_monetization_subscription_base_plan_offers(package_name, product_id, base_plan_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2867
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers', options)
|
2868
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse::Representation
|
2869
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse
|
2870
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2871
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2872
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2873
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2874
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2875
|
+
command.query['fields'] = fields unless fields.nil?
|
2876
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2877
|
+
execute_or_queue_command(command, &block)
|
2878
|
+
end
|
2879
|
+
|
2880
|
+
# Updates an existing subscription offer.
|
2881
|
+
# @param [String] package_name
|
2882
|
+
# Required. Immutable. The package name of the app the parent subscription
|
2883
|
+
# belongs to.
|
2884
|
+
# @param [String] product_id
|
2885
|
+
# Required. Immutable. The ID of the parent subscription this offer belongs to.
|
2886
|
+
# @param [String] base_plan_id
|
2887
|
+
# Required. Immutable. The ID of the base plan to which this offer is an
|
2888
|
+
# extension.
|
2889
|
+
# @param [String] offer_id
|
2890
|
+
# Required. Immutable. Unique ID of this subscription offer. Must be unique
|
2891
|
+
# within the base plan.
|
2892
|
+
# @param [Google::Apis::AndroidpublisherV3::SubscriptionOffer] subscription_offer_object
|
2893
|
+
# @param [String] regions_version_version
|
2894
|
+
# Required. The latest version is 2022/02.
|
2895
|
+
# @param [String] update_mask
|
2896
|
+
# Required. The list of fields to be updated.
|
2897
|
+
# @param [String] fields
|
2898
|
+
# Selector specifying which fields to include in a partial response.
|
2899
|
+
# @param [String] quota_user
|
2900
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2901
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2902
|
+
# @param [Google::Apis::RequestOptions] options
|
2903
|
+
# Request-specific options
|
2904
|
+
#
|
2905
|
+
# @yield [result, err] Result & error if block supplied
|
2906
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
2907
|
+
# @yieldparam err [StandardError] error object if request failed
|
2908
|
+
#
|
2909
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
2910
|
+
#
|
2911
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2912
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2913
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2914
|
+
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)
|
2915
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
2916
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2917
|
+
command.request_object = subscription_offer_object
|
2918
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
2919
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
2920
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
2921
|
+
command.params['productId'] = product_id unless product_id.nil?
|
2922
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
2923
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
2924
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
2925
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2926
|
+
command.query['fields'] = fields unless fields.nil?
|
2927
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2928
|
+
execute_or_queue_command(command, &block)
|
2929
|
+
end
|
2930
|
+
|
2931
|
+
# Refunds a user's subscription or in-app purchase order. Orders older than 1
|
2932
|
+
# year cannot be refunded.
|
2933
|
+
# @param [String] package_name
|
2934
|
+
# The package name of the application for which this subscription or in-app item
|
2935
|
+
# was purchased (for example, 'com.some.thing').
|
2936
|
+
# @param [String] order_id
|
2937
|
+
# The order ID provided to the user when the subscription or in-app order was
|
2938
|
+
# purchased.
|
2939
|
+
# @param [Boolean] revoke
|
1719
2940
|
# Whether to revoke the purchased item. If set to true, access to the
|
1720
2941
|
# subscription or in-app item will be terminated immediately. If the item is a
|
1721
2942
|
# recurring subscription, all future payments will also be terminated. Consumed
|
@@ -1785,6 +3006,41 @@ module Google
|
|
1785
3006
|
execute_or_queue_command(command, &block)
|
1786
3007
|
end
|
1787
3008
|
|
3009
|
+
# Consumes a purchase for an inapp item.
|
3010
|
+
# @param [String] package_name
|
3011
|
+
# The package name of the application the inapp product was sold in (for example,
|
3012
|
+
# 'com.some.thing').
|
3013
|
+
# @param [String] product_id
|
3014
|
+
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
3015
|
+
# @param [String] token
|
3016
|
+
# The token provided to the user's device when the inapp product was purchased.
|
3017
|
+
# @param [String] fields
|
3018
|
+
# Selector specifying which fields to include in a partial response.
|
3019
|
+
# @param [String] quota_user
|
3020
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3021
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3022
|
+
# @param [Google::Apis::RequestOptions] options
|
3023
|
+
# Request-specific options
|
3024
|
+
#
|
3025
|
+
# @yield [result, err] Result & error if block supplied
|
3026
|
+
# @yieldparam result [NilClass] No result returned for this method
|
3027
|
+
# @yieldparam err [StandardError] error object if request failed
|
3028
|
+
#
|
3029
|
+
# @return [void]
|
3030
|
+
#
|
3031
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3032
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3033
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3034
|
+
def consume_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil, &block)
|
3035
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume', options)
|
3036
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3037
|
+
command.params['productId'] = product_id unless product_id.nil?
|
3038
|
+
command.params['token'] = token unless token.nil?
|
3039
|
+
command.query['fields'] = fields unless fields.nil?
|
3040
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3041
|
+
execute_or_queue_command(command, &block)
|
3042
|
+
end
|
3043
|
+
|
1788
3044
|
# Checks the purchase and consumption status of an inapp item.
|
1789
3045
|
# @param [String] package_name
|
1790
3046
|
# The package name of the application the inapp product was sold in (for example,
|
@@ -2046,6 +3302,41 @@ module Google
|
|
2046
3302
|
execute_or_queue_command(command, &block)
|
2047
3303
|
end
|
2048
3304
|
|
3305
|
+
# Get metadata about a subscription
|
3306
|
+
# @param [String] package_name
|
3307
|
+
# The package of the application for which this subscription was purchased (for
|
3308
|
+
# example, 'com.some.thing').
|
3309
|
+
# @param [String] token
|
3310
|
+
# Required. The token provided to the user's device when the subscription was
|
3311
|
+
# purchased.
|
3312
|
+
# @param [String] fields
|
3313
|
+
# Selector specifying which fields to include in a partial response.
|
3314
|
+
# @param [String] quota_user
|
3315
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3316
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3317
|
+
# @param [Google::Apis::RequestOptions] options
|
3318
|
+
# Request-specific options
|
3319
|
+
#
|
3320
|
+
# @yield [result, err] Result & error if block supplied
|
3321
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2] parsed result object
|
3322
|
+
# @yieldparam err [StandardError] error object if request failed
|
3323
|
+
#
|
3324
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2]
|
3325
|
+
#
|
3326
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3327
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3328
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3329
|
+
def get_purchase_subscriptionsv2(package_name, token, fields: nil, quota_user: nil, options: nil, &block)
|
3330
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}', options)
|
3331
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2::Representation
|
3332
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2
|
3333
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
3334
|
+
command.params['token'] = token unless token.nil?
|
3335
|
+
command.query['fields'] = fields unless fields.nil?
|
3336
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3337
|
+
execute_or_queue_command(command, &block)
|
3338
|
+
end
|
3339
|
+
|
2049
3340
|
# Lists the purchases that were canceled, refunded or charged-back.
|
2050
3341
|
# @param [String] package_name
|
2051
3342
|
# The package name of the application for which voided purchases need to be
|
@@ -2377,6 +3668,145 @@ module Google
|
|
2377
3668
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2378
3669
|
execute_or_queue_command(command, &block)
|
2379
3670
|
end
|
3671
|
+
|
3672
|
+
# Grant access for a user to the given developer account.
|
3673
|
+
# @param [String] parent
|
3674
|
+
# Required. The developer account to add the user to. Format: developers/`
|
3675
|
+
# developer`
|
3676
|
+
# @param [Google::Apis::AndroidpublisherV3::User] user_object
|
3677
|
+
# @param [String] fields
|
3678
|
+
# Selector specifying which fields to include in a partial response.
|
3679
|
+
# @param [String] quota_user
|
3680
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3681
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3682
|
+
# @param [Google::Apis::RequestOptions] options
|
3683
|
+
# Request-specific options
|
3684
|
+
#
|
3685
|
+
# @yield [result, err] Result & error if block supplied
|
3686
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::User] parsed result object
|
3687
|
+
# @yieldparam err [StandardError] error object if request failed
|
3688
|
+
#
|
3689
|
+
# @return [Google::Apis::AndroidpublisherV3::User]
|
3690
|
+
#
|
3691
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3692
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3693
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3694
|
+
def create_user(parent, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3695
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/users', options)
|
3696
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
3697
|
+
command.request_object = user_object
|
3698
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
3699
|
+
command.response_class = Google::Apis::AndroidpublisherV3::User
|
3700
|
+
command.params['parent'] = parent unless parent.nil?
|
3701
|
+
command.query['fields'] = fields unless fields.nil?
|
3702
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3703
|
+
execute_or_queue_command(command, &block)
|
3704
|
+
end
|
3705
|
+
|
3706
|
+
# Removes all access for the user to the given developer account.
|
3707
|
+
# @param [String] name
|
3708
|
+
# Required. The name of the user to delete. Format: developers/`developer`/users/
|
3709
|
+
# `email`
|
3710
|
+
# @param [String] fields
|
3711
|
+
# Selector specifying which fields to include in a partial response.
|
3712
|
+
# @param [String] quota_user
|
3713
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3714
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3715
|
+
# @param [Google::Apis::RequestOptions] options
|
3716
|
+
# Request-specific options
|
3717
|
+
#
|
3718
|
+
# @yield [result, err] Result & error if block supplied
|
3719
|
+
# @yieldparam result [NilClass] No result returned for this method
|
3720
|
+
# @yieldparam err [StandardError] error object if request failed
|
3721
|
+
#
|
3722
|
+
# @return [void]
|
3723
|
+
#
|
3724
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3725
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3726
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3727
|
+
def delete_user(name, fields: nil, quota_user: nil, options: nil, &block)
|
3728
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/{+name}', options)
|
3729
|
+
command.params['name'] = name unless name.nil?
|
3730
|
+
command.query['fields'] = fields unless fields.nil?
|
3731
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3732
|
+
execute_or_queue_command(command, &block)
|
3733
|
+
end
|
3734
|
+
|
3735
|
+
# Lists all users with access to a developer account.
|
3736
|
+
# @param [String] parent
|
3737
|
+
# Required. The developer account to fetch users from. Format: developers/`
|
3738
|
+
# developer`
|
3739
|
+
# @param [Fixnum] page_size
|
3740
|
+
# The maximum number of results to return. This must be set to -1 to disable
|
3741
|
+
# pagination.
|
3742
|
+
# @param [String] page_token
|
3743
|
+
# A token received from a previous call to this method, in order to retrieve
|
3744
|
+
# further results.
|
3745
|
+
# @param [String] fields
|
3746
|
+
# Selector specifying which fields to include in a partial response.
|
3747
|
+
# @param [String] quota_user
|
3748
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3749
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3750
|
+
# @param [Google::Apis::RequestOptions] options
|
3751
|
+
# Request-specific options
|
3752
|
+
#
|
3753
|
+
# @yield [result, err] Result & error if block supplied
|
3754
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListUsersResponse] parsed result object
|
3755
|
+
# @yieldparam err [StandardError] error object if request failed
|
3756
|
+
#
|
3757
|
+
# @return [Google::Apis::AndroidpublisherV3::ListUsersResponse]
|
3758
|
+
#
|
3759
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3760
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3761
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3762
|
+
def list_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3763
|
+
command = make_simple_command(:get, 'androidpublisher/v3/{+parent}/users', options)
|
3764
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListUsersResponse::Representation
|
3765
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListUsersResponse
|
3766
|
+
command.params['parent'] = parent unless parent.nil?
|
3767
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3768
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3769
|
+
command.query['fields'] = fields unless fields.nil?
|
3770
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3771
|
+
execute_or_queue_command(command, &block)
|
3772
|
+
end
|
3773
|
+
|
3774
|
+
# Updates access for the user to the developer account.
|
3775
|
+
# @param [String] name
|
3776
|
+
# Required. Resource name for this user, following the pattern "developers/`
|
3777
|
+
# developer`/users/`email`".
|
3778
|
+
# @param [Google::Apis::AndroidpublisherV3::User] user_object
|
3779
|
+
# @param [String] update_mask
|
3780
|
+
# Optional. The list of fields to be updated.
|
3781
|
+
# @param [String] fields
|
3782
|
+
# Selector specifying which fields to include in a partial response.
|
3783
|
+
# @param [String] quota_user
|
3784
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3785
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3786
|
+
# @param [Google::Apis::RequestOptions] options
|
3787
|
+
# Request-specific options
|
3788
|
+
#
|
3789
|
+
# @yield [result, err] Result & error if block supplied
|
3790
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::User] parsed result object
|
3791
|
+
# @yieldparam err [StandardError] error object if request failed
|
3792
|
+
#
|
3793
|
+
# @return [Google::Apis::AndroidpublisherV3::User]
|
3794
|
+
#
|
3795
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3796
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3797
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3798
|
+
def patch_user(name, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3799
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/{+name}', options)
|
3800
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
3801
|
+
command.request_object = user_object
|
3802
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
3803
|
+
command.response_class = Google::Apis::AndroidpublisherV3::User
|
3804
|
+
command.params['name'] = name unless name.nil?
|
3805
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3806
|
+
command.query['fields'] = fields unless fields.nil?
|
3807
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3808
|
+
execute_or_queue_command(command, &block)
|
3809
|
+
end
|
2380
3810
|
|
2381
3811
|
protected
|
2382
3812
|
|