google-apis-androidpublisher_v3 0.1.0 → 0.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +156 -0
- data/OVERVIEW.md +3 -3
- data/lib/google/apis/androidpublisher_v3/classes.rb +2460 -86
- data/lib/google/apis/androidpublisher_v3/gem_version.rb +3 -3
- data/lib/google/apis/androidpublisher_v3/representations.rb +1403 -230
- data/lib/google/apis/androidpublisher_v3/service.rb +1362 -53
- 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,6 +1558,183 @@ module Google
|
|
|
1397
1558
|
execute_or_queue_command(command, &block)
|
|
1398
1559
|
end
|
|
1399
1560
|
|
|
1561
|
+
# Downloads a single signed APK generated from an app bundle.
|
|
1562
|
+
# @param [String] package_name
|
|
1563
|
+
# Package name of the app.
|
|
1564
|
+
# @param [Fixnum] version_code
|
|
1565
|
+
# Version code of the app bundle.
|
|
1566
|
+
# @param [String] download_id
|
|
1567
|
+
# Download ID, which uniquely identifies the APK to download. Can be obtained
|
|
1568
|
+
# from the response of `generatedapks.list` method.
|
|
1569
|
+
# @param [String] fields
|
|
1570
|
+
# Selector specifying which fields to include in a partial response.
|
|
1571
|
+
# @param [String] quota_user
|
|
1572
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1573
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1574
|
+
# @param [IO, String] download_dest
|
|
1575
|
+
# IO stream or filename to receive content download
|
|
1576
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1577
|
+
# Request-specific options
|
|
1578
|
+
#
|
|
1579
|
+
# @yield [result, err] Result & error if block supplied
|
|
1580
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
1581
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1582
|
+
#
|
|
1583
|
+
# @return [void]
|
|
1584
|
+
#
|
|
1585
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1586
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1587
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1588
|
+
def download_generatedapk(package_name, version_code, download_id, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
|
|
1589
|
+
if download_dest.nil?
|
|
1590
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download', options)
|
|
1591
|
+
else
|
|
1592
|
+
command = make_download_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}/downloads/{downloadId}:download', options)
|
|
1593
|
+
command.download_dest = download_dest
|
|
1594
|
+
end
|
|
1595
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
1596
|
+
command.params['versionCode'] = version_code unless version_code.nil?
|
|
1597
|
+
command.params['downloadId'] = download_id unless download_id.nil?
|
|
1598
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1599
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1600
|
+
execute_or_queue_command(command, &block)
|
|
1601
|
+
end
|
|
1602
|
+
|
|
1603
|
+
# Returns download metadata for all APKs that were generated from a given app
|
|
1604
|
+
# bundle.
|
|
1605
|
+
# @param [String] package_name
|
|
1606
|
+
# Package name of the app.
|
|
1607
|
+
# @param [Fixnum] version_code
|
|
1608
|
+
# Version code of the app bundle.
|
|
1609
|
+
# @param [String] fields
|
|
1610
|
+
# Selector specifying which fields to include in a partial response.
|
|
1611
|
+
# @param [String] quota_user
|
|
1612
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1613
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1614
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1615
|
+
# Request-specific options
|
|
1616
|
+
#
|
|
1617
|
+
# @yield [result, err] Result & error if block supplied
|
|
1618
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::GeneratedApksListResponse] parsed result object
|
|
1619
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1620
|
+
#
|
|
1621
|
+
# @return [Google::Apis::AndroidpublisherV3::GeneratedApksListResponse]
|
|
1622
|
+
#
|
|
1623
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1624
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1625
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1626
|
+
def list_generatedapks(package_name, version_code, fields: nil, quota_user: nil, options: nil, &block)
|
|
1627
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/generatedApks/{versionCode}', options)
|
|
1628
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::GeneratedApksListResponse::Representation
|
|
1629
|
+
command.response_class = Google::Apis::AndroidpublisherV3::GeneratedApksListResponse
|
|
1630
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
1631
|
+
command.params['versionCode'] = version_code unless version_code.nil?
|
|
1632
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1633
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1634
|
+
execute_or_queue_command(command, &block)
|
|
1635
|
+
end
|
|
1636
|
+
|
|
1637
|
+
# Grant access for a user to the given package.
|
|
1638
|
+
# @param [String] parent
|
|
1639
|
+
# Required. The user which needs permission. Format: developers/`developer`/
|
|
1640
|
+
# users/`user`
|
|
1641
|
+
# @param [Google::Apis::AndroidpublisherV3::Grant] grant_object
|
|
1642
|
+
# @param [String] fields
|
|
1643
|
+
# Selector specifying which fields to include in a partial response.
|
|
1644
|
+
# @param [String] quota_user
|
|
1645
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1646
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1647
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1648
|
+
# Request-specific options
|
|
1649
|
+
#
|
|
1650
|
+
# @yield [result, err] Result & error if block supplied
|
|
1651
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Grant] parsed result object
|
|
1652
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1653
|
+
#
|
|
1654
|
+
# @return [Google::Apis::AndroidpublisherV3::Grant]
|
|
1655
|
+
#
|
|
1656
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1657
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1658
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1659
|
+
def create_grant(parent, grant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1660
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/grants', options)
|
|
1661
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
|
1662
|
+
command.request_object = grant_object
|
|
1663
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
|
1664
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Grant
|
|
1665
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1666
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1667
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1668
|
+
execute_or_queue_command(command, &block)
|
|
1669
|
+
end
|
|
1670
|
+
|
|
1671
|
+
# Removes all access for the user to the given package or developer account.
|
|
1672
|
+
# @param [String] name
|
|
1673
|
+
# Required. The name of the grant to delete. Format: developers/`developer`/
|
|
1674
|
+
# users/`email`/grants/`package_name`
|
|
1675
|
+
# @param [String] fields
|
|
1676
|
+
# Selector specifying which fields to include in a partial response.
|
|
1677
|
+
# @param [String] quota_user
|
|
1678
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1679
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1680
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1681
|
+
# Request-specific options
|
|
1682
|
+
#
|
|
1683
|
+
# @yield [result, err] Result & error if block supplied
|
|
1684
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
1685
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1686
|
+
#
|
|
1687
|
+
# @return [void]
|
|
1688
|
+
#
|
|
1689
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1690
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1691
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1692
|
+
def delete_grant(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1693
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/{+name}', options)
|
|
1694
|
+
command.params['name'] = name unless name.nil?
|
|
1695
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1696
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1697
|
+
execute_or_queue_command(command, &block)
|
|
1698
|
+
end
|
|
1699
|
+
|
|
1700
|
+
# Updates access for the user to the given package.
|
|
1701
|
+
# @param [String] name
|
|
1702
|
+
# Required. Resource name for this grant, following the pattern "developers/`
|
|
1703
|
+
# developer`/users/`email`/grants/`package_name`". If this grant is for a draft
|
|
1704
|
+
# app, the app ID will be used in this resource name instead of the package name.
|
|
1705
|
+
# @param [Google::Apis::AndroidpublisherV3::Grant] grant_object
|
|
1706
|
+
# @param [String] update_mask
|
|
1707
|
+
# Optional. The list of fields to be updated.
|
|
1708
|
+
# @param [String] fields
|
|
1709
|
+
# Selector specifying which fields to include in a partial response.
|
|
1710
|
+
# @param [String] quota_user
|
|
1711
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1712
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1713
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1714
|
+
# Request-specific options
|
|
1715
|
+
#
|
|
1716
|
+
# @yield [result, err] Result & error if block supplied
|
|
1717
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Grant] parsed result object
|
|
1718
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1719
|
+
#
|
|
1720
|
+
# @return [Google::Apis::AndroidpublisherV3::Grant]
|
|
1721
|
+
#
|
|
1722
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1723
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1724
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1725
|
+
def patch_grant(name, grant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1726
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/{+name}', options)
|
|
1727
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
|
1728
|
+
command.request_object = grant_object
|
|
1729
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Grant::Representation
|
|
1730
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Grant
|
|
1731
|
+
command.params['name'] = name unless name.nil?
|
|
1732
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1733
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1734
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1735
|
+
execute_or_queue_command(command, &block)
|
|
1736
|
+
end
|
|
1737
|
+
|
|
1400
1738
|
# Deletes an in-app product (i.e. a managed product or a subscriptions).
|
|
1401
1739
|
# @param [String] package_name
|
|
1402
1740
|
# Package name of the app.
|
|
@@ -1499,13 +1837,17 @@ module Google
|
|
|
1499
1837
|
execute_or_queue_command(command, &block)
|
|
1500
1838
|
end
|
|
1501
1839
|
|
|
1502
|
-
# Lists all in-app products - both managed products and subscriptions.
|
|
1840
|
+
# Lists all in-app products - both managed products and subscriptions. If an app
|
|
1841
|
+
# has a large number of in-app products, the response may be paginated. In this
|
|
1842
|
+
# case the response field `tokenPagination.nextPageToken` will be set and the
|
|
1843
|
+
# caller should provide its value as a `token` request parameter to retrieve the
|
|
1844
|
+
# next page.
|
|
1503
1845
|
# @param [String] package_name
|
|
1504
1846
|
# Package name of the app.
|
|
1505
1847
|
# @param [Fixnum] max_results
|
|
1506
|
-
#
|
|
1848
|
+
# Deprecated and ignored. The page size is determined by the server.
|
|
1507
1849
|
# @param [Fixnum] start_index
|
|
1508
|
-
#
|
|
1850
|
+
# Deprecated and ignored. Set the `token` parameter to rertieve the next page.
|
|
1509
1851
|
# @param [String] token
|
|
1510
1852
|
# Pagination token. If empty, list starts at the first product.
|
|
1511
1853
|
# @param [String] fields
|
|
@@ -1585,6 +1927,9 @@ module Google
|
|
|
1585
1927
|
# @param [String] sku
|
|
1586
1928
|
# Unique identifier for the in-app product.
|
|
1587
1929
|
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
|
1930
|
+
# @param [Boolean] allow_missing
|
|
1931
|
+
# If set to true, and the in-app product with the given package_name and sku
|
|
1932
|
+
# doesn't exist, the in-app product will be created.
|
|
1588
1933
|
# @param [Boolean] auto_convert_missing_prices
|
|
1589
1934
|
# If true the prices for all regions targeted by the parent app that don't have
|
|
1590
1935
|
# a price specified for this in-app product will be auto converted to the target
|
|
@@ -1606,7 +1951,7 @@ module Google
|
|
|
1606
1951
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1607
1952
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1608
1953
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1609
|
-
def update_inappproduct(package_name, sku, in_app_product_object = nil, auto_convert_missing_prices: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1954
|
+
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)
|
|
1610
1955
|
command = make_simple_command(:put, 'androidpublisher/v3/applications/{packageName}/inappproducts/{sku}', options)
|
|
1611
1956
|
command.request_representation = Google::Apis::AndroidpublisherV3::InAppProduct::Representation
|
|
1612
1957
|
command.request_object = in_app_product_object
|
|
@@ -1614,6 +1959,7 @@ module Google
|
|
|
1614
1959
|
command.response_class = Google::Apis::AndroidpublisherV3::InAppProduct
|
|
1615
1960
|
command.params['packageName'] = package_name unless package_name.nil?
|
|
1616
1961
|
command.params['sku'] = sku unless sku.nil?
|
|
1962
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
1617
1963
|
command.query['autoConvertMissingPrices'] = auto_convert_missing_prices unless auto_convert_missing_prices.nil?
|
|
1618
1964
|
command.query['fields'] = fields unless fields.nil?
|
|
1619
1965
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
@@ -1708,18 +2054,11 @@ module Google
|
|
|
1708
2054
|
execute_or_queue_command(command, &block)
|
|
1709
2055
|
end
|
|
1710
2056
|
|
|
1711
|
-
#
|
|
2057
|
+
# Calculates the region prices, using today's exchange rate and country-specific
|
|
2058
|
+
# pricing patterns, based on the price in the request for a set of regions.
|
|
1712
2059
|
# @param [String] package_name
|
|
1713
|
-
# The package name
|
|
1714
|
-
#
|
|
1715
|
-
# @param [String] order_id
|
|
1716
|
-
# The order ID provided to the user when the subscription or in-app order was
|
|
1717
|
-
# purchased.
|
|
1718
|
-
# @param [Boolean] revoke
|
|
1719
|
-
# Whether to revoke the purchased item. If set to true, access to the
|
|
1720
|
-
# subscription or in-app item will be terminated immediately. If the item is a
|
|
1721
|
-
# recurring subscription, all future payments will also be terminated. Consumed
|
|
1722
|
-
# in-app items need to be handled by developer's app. (optional).
|
|
2060
|
+
# Required. The app package name.
|
|
2061
|
+
# @param [Google::Apis::AndroidpublisherV3::ConvertRegionPricesRequest] convert_region_prices_request_object
|
|
1723
2062
|
# @param [String] fields
|
|
1724
2063
|
# Selector specifying which fields to include in a partial response.
|
|
1725
2064
|
# @param [String] quota_user
|
|
@@ -1729,33 +2068,36 @@ module Google
|
|
|
1729
2068
|
# Request-specific options
|
|
1730
2069
|
#
|
|
1731
2070
|
# @yield [result, err] Result & error if block supplied
|
|
1732
|
-
# @yieldparam result [
|
|
2071
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse] parsed result object
|
|
1733
2072
|
# @yieldparam err [StandardError] error object if request failed
|
|
1734
2073
|
#
|
|
1735
|
-
# @return [
|
|
2074
|
+
# @return [Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse]
|
|
1736
2075
|
#
|
|
1737
2076
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1738
2077
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1739
2078
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1740
|
-
def
|
|
1741
|
-
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/
|
|
2079
|
+
def convert_monetization_region_prices(package_name, convert_region_prices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2080
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/pricing:convertRegionPrices', options)
|
|
2081
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ConvertRegionPricesRequest::Representation
|
|
2082
|
+
command.request_object = convert_region_prices_request_object
|
|
2083
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse::Representation
|
|
2084
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ConvertRegionPricesResponse
|
|
1742
2085
|
command.params['packageName'] = package_name unless package_name.nil?
|
|
1743
|
-
command.params['orderId'] = order_id unless order_id.nil?
|
|
1744
|
-
command.query['revoke'] = revoke unless revoke.nil?
|
|
1745
2086
|
command.query['fields'] = fields unless fields.nil?
|
|
1746
2087
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1747
2088
|
execute_or_queue_command(command, &block)
|
|
1748
2089
|
end
|
|
1749
2090
|
|
|
1750
|
-
#
|
|
2091
|
+
# Archives a subscription. Can only be done if at least one base plan was active
|
|
2092
|
+
# in the past, and no base plan is available for new or existing subscribers
|
|
2093
|
+
# currently. This action is irreversible, and the subscription ID will remain
|
|
2094
|
+
# reserved.
|
|
1751
2095
|
# @param [String] package_name
|
|
1752
|
-
# The package name of the
|
|
1753
|
-
#
|
|
2096
|
+
# Required. The parent app (package name) of the app of the subscription to
|
|
2097
|
+
# delete.
|
|
1754
2098
|
# @param [String] product_id
|
|
1755
|
-
# The
|
|
1756
|
-
# @param [
|
|
1757
|
-
# The token provided to the user's device when the inapp product was purchased.
|
|
1758
|
-
# @param [Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest] product_purchases_acknowledge_request_object
|
|
2099
|
+
# Required. The unique product ID of the subscription to delete.
|
|
2100
|
+
# @param [Google::Apis::AndroidpublisherV3::ArchiveSubscriptionRequest] archive_subscription_request_object
|
|
1759
2101
|
# @param [String] fields
|
|
1760
2102
|
# Selector specifying which fields to include in a partial response.
|
|
1761
2103
|
# @param [String] quota_user
|
|
@@ -1765,34 +2107,827 @@ module Google
|
|
|
1765
2107
|
# Request-specific options
|
|
1766
2108
|
#
|
|
1767
2109
|
# @yield [result, err] Result & error if block supplied
|
|
1768
|
-
# @yieldparam result [
|
|
2110
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
|
1769
2111
|
# @yieldparam err [StandardError] error object if request failed
|
|
1770
2112
|
#
|
|
1771
|
-
# @return [
|
|
2113
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
|
1772
2114
|
#
|
|
1773
2115
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1774
2116
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1775
2117
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1776
|
-
def
|
|
1777
|
-
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/
|
|
1778
|
-
command.request_representation = Google::Apis::AndroidpublisherV3::
|
|
1779
|
-
command.request_object =
|
|
2118
|
+
def archive_subscription(package_name, product_id, archive_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2119
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive', options)
|
|
2120
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ArchiveSubscriptionRequest::Representation
|
|
2121
|
+
command.request_object = archive_subscription_request_object
|
|
2122
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2123
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
|
1780
2124
|
command.params['packageName'] = package_name unless package_name.nil?
|
|
1781
2125
|
command.params['productId'] = product_id unless product_id.nil?
|
|
1782
|
-
command.params['token'] = token unless token.nil?
|
|
1783
2126
|
command.query['fields'] = fields unless fields.nil?
|
|
1784
2127
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1785
2128
|
execute_or_queue_command(command, &block)
|
|
1786
2129
|
end
|
|
1787
2130
|
|
|
1788
|
-
#
|
|
2131
|
+
# Creates a new subscription. Newly added base plans will remain in draft state
|
|
2132
|
+
# until activated.
|
|
1789
2133
|
# @param [String] package_name
|
|
1790
|
-
# The package name
|
|
1791
|
-
#
|
|
2134
|
+
# Required. The parent app (package name) for which the subscription should be
|
|
2135
|
+
# created. Must be equal to the package_name field on the Subscription resource.
|
|
2136
|
+
# @param [Google::Apis::AndroidpublisherV3::Subscription] subscription_object
|
|
1792
2137
|
# @param [String] product_id
|
|
1793
|
-
# The
|
|
1794
|
-
#
|
|
1795
|
-
#
|
|
2138
|
+
# Required. The ID to use for the subscription. For the requirements on this
|
|
2139
|
+
# format, see the documentation of the product_id field on the Subscription
|
|
2140
|
+
# resource.
|
|
2141
|
+
# @param [String] regions_version_version
|
|
2142
|
+
# Required. A string representing version of the available regions being used
|
|
2143
|
+
# for the specified resource. The current version is 2022/02.
|
|
2144
|
+
# @param [String] fields
|
|
2145
|
+
# Selector specifying which fields to include in a partial response.
|
|
2146
|
+
# @param [String] quota_user
|
|
2147
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2148
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2149
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2150
|
+
# Request-specific options
|
|
2151
|
+
#
|
|
2152
|
+
# @yield [result, err] Result & error if block supplied
|
|
2153
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
|
2154
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2155
|
+
#
|
|
2156
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
|
2157
|
+
#
|
|
2158
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2159
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2160
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2161
|
+
def create_monetization_subscription(package_name, subscription_object = nil, product_id: nil, regions_version_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2162
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions', options)
|
|
2163
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2164
|
+
command.request_object = subscription_object
|
|
2165
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2166
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
|
2167
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2168
|
+
command.query['productId'] = product_id unless product_id.nil?
|
|
2169
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
|
2170
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2171
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2172
|
+
execute_or_queue_command(command, &block)
|
|
2173
|
+
end
|
|
2174
|
+
|
|
2175
|
+
# Deletes a subscription. A subscription can only be deleted if it has never had
|
|
2176
|
+
# a base plan published.
|
|
2177
|
+
# @param [String] package_name
|
|
2178
|
+
# Required. The parent app (package name) of the app of the subscription to
|
|
2179
|
+
# delete.
|
|
2180
|
+
# @param [String] product_id
|
|
2181
|
+
# Required. The unique product ID of the subscription to delete.
|
|
2182
|
+
# @param [String] fields
|
|
2183
|
+
# Selector specifying which fields to include in a partial response.
|
|
2184
|
+
# @param [String] quota_user
|
|
2185
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2186
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2187
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2188
|
+
# Request-specific options
|
|
2189
|
+
#
|
|
2190
|
+
# @yield [result, err] Result & error if block supplied
|
|
2191
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
2192
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2193
|
+
#
|
|
2194
|
+
# @return [void]
|
|
2195
|
+
#
|
|
2196
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2197
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2198
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2199
|
+
def delete_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2200
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
|
2201
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2202
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2203
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2204
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2205
|
+
execute_or_queue_command(command, &block)
|
|
2206
|
+
end
|
|
2207
|
+
|
|
2208
|
+
# Reads a single subscription.
|
|
2209
|
+
# @param [String] package_name
|
|
2210
|
+
# Required. The parent app (package name) of the subscription to get.
|
|
2211
|
+
# @param [String] product_id
|
|
2212
|
+
# Required. The unique product ID of the subscription to get.
|
|
2213
|
+
# @param [String] fields
|
|
2214
|
+
# Selector specifying which fields to include in a partial response.
|
|
2215
|
+
# @param [String] quota_user
|
|
2216
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2217
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2218
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2219
|
+
# Request-specific options
|
|
2220
|
+
#
|
|
2221
|
+
# @yield [result, err] Result & error if block supplied
|
|
2222
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
|
2223
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2224
|
+
#
|
|
2225
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
|
2226
|
+
#
|
|
2227
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2228
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2229
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2230
|
+
def get_monetization_subscription(package_name, product_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2231
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
|
2232
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2233
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
|
2234
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2235
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2236
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2237
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2238
|
+
execute_or_queue_command(command, &block)
|
|
2239
|
+
end
|
|
2240
|
+
|
|
2241
|
+
# Lists all subscriptions under a given app.
|
|
2242
|
+
# @param [String] package_name
|
|
2243
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
|
2244
|
+
# read.
|
|
2245
|
+
# @param [Fixnum] page_size
|
|
2246
|
+
# The maximum number of subscriptions to return. The service may return fewer
|
|
2247
|
+
# than this value. If unspecified, at most 50 subscriptions will be returned.
|
|
2248
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
2249
|
+
# @param [String] page_token
|
|
2250
|
+
# A page token, received from a previous `ListSubscriptions` call. Provide this
|
|
2251
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
|
2252
|
+
# provided to `ListSubscriptions` must match the call that provided the page
|
|
2253
|
+
# token.
|
|
2254
|
+
# @param [Boolean] show_archived
|
|
2255
|
+
# Whether archived subscriptions should be included in the response. Defaults to
|
|
2256
|
+
# false.
|
|
2257
|
+
# @param [String] fields
|
|
2258
|
+
# Selector specifying which fields to include in a partial response.
|
|
2259
|
+
# @param [String] quota_user
|
|
2260
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2261
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2262
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2263
|
+
# Request-specific options
|
|
2264
|
+
#
|
|
2265
|
+
# @yield [result, err] Result & error if block supplied
|
|
2266
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse] parsed result object
|
|
2267
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2268
|
+
#
|
|
2269
|
+
# @return [Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse]
|
|
2270
|
+
#
|
|
2271
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2272
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2273
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2274
|
+
def list_monetization_subscriptions(package_name, page_size: nil, page_token: nil, show_archived: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2275
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions', options)
|
|
2276
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse::Representation
|
|
2277
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListSubscriptionsResponse
|
|
2278
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2279
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2280
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2281
|
+
command.query['showArchived'] = show_archived unless show_archived.nil?
|
|
2282
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2283
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2284
|
+
execute_or_queue_command(command, &block)
|
|
2285
|
+
end
|
|
2286
|
+
|
|
2287
|
+
# Updates an existing subscription.
|
|
2288
|
+
# @param [String] package_name
|
|
2289
|
+
# Immutable. Package name of the parent app.
|
|
2290
|
+
# @param [String] product_id
|
|
2291
|
+
# Immutable. Unique product ID of the product. Unique within the parent app.
|
|
2292
|
+
# Product IDs must be composed of lower-case letters (a-z), numbers (0-9),
|
|
2293
|
+
# underscores (_) and dots (.). It must start with a lower-case letter or number,
|
|
2294
|
+
# and be between 1 and 40 (inclusive) characters in length.
|
|
2295
|
+
# @param [Google::Apis::AndroidpublisherV3::Subscription] subscription_object
|
|
2296
|
+
# @param [String] regions_version_version
|
|
2297
|
+
# Required. A string representing version of the available regions being used
|
|
2298
|
+
# for the specified resource. The current version is 2022/02.
|
|
2299
|
+
# @param [String] update_mask
|
|
2300
|
+
# Required. The list of fields to be updated.
|
|
2301
|
+
# @param [String] fields
|
|
2302
|
+
# Selector specifying which fields to include in a partial response.
|
|
2303
|
+
# @param [String] quota_user
|
|
2304
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2305
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2306
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2307
|
+
# Request-specific options
|
|
2308
|
+
#
|
|
2309
|
+
# @yield [result, err] Result & error if block supplied
|
|
2310
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
|
2311
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2312
|
+
#
|
|
2313
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
|
2314
|
+
#
|
|
2315
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2316
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2317
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2318
|
+
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)
|
|
2319
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}', options)
|
|
2320
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2321
|
+
command.request_object = subscription_object
|
|
2322
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2323
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
|
2324
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2325
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2326
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
|
2327
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
2328
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2329
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2330
|
+
execute_or_queue_command(command, &block)
|
|
2331
|
+
end
|
|
2332
|
+
|
|
2333
|
+
# Activates a base plan. Once activated, base plans will be available to new
|
|
2334
|
+
# subscribers.
|
|
2335
|
+
# @param [String] package_name
|
|
2336
|
+
# Required. The parent app (package name) of the base plan to activate.
|
|
2337
|
+
# @param [String] product_id
|
|
2338
|
+
# Required. The parent subscription (ID) of the base plan to activate.
|
|
2339
|
+
# @param [String] base_plan_id
|
|
2340
|
+
# Required. The unique base plan ID of the base plan to activate.
|
|
2341
|
+
# @param [Google::Apis::AndroidpublisherV3::ActivateBasePlanRequest] activate_base_plan_request_object
|
|
2342
|
+
# @param [String] fields
|
|
2343
|
+
# Selector specifying which fields to include in a partial response.
|
|
2344
|
+
# @param [String] quota_user
|
|
2345
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2346
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2347
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2348
|
+
# Request-specific options
|
|
2349
|
+
#
|
|
2350
|
+
# @yield [result, err] Result & error if block supplied
|
|
2351
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
|
2352
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2353
|
+
#
|
|
2354
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
|
2355
|
+
#
|
|
2356
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2357
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2358
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2359
|
+
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)
|
|
2360
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:activate', options)
|
|
2361
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ActivateBasePlanRequest::Representation
|
|
2362
|
+
command.request_object = activate_base_plan_request_object
|
|
2363
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2364
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
|
2365
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2366
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2367
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2368
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2369
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2370
|
+
execute_or_queue_command(command, &block)
|
|
2371
|
+
end
|
|
2372
|
+
|
|
2373
|
+
# Deactivates a base plan. Once deactivated, the base plan will become
|
|
2374
|
+
# unavailable to new subscribers, but existing subscribers will maintain their
|
|
2375
|
+
# subscription
|
|
2376
|
+
# @param [String] package_name
|
|
2377
|
+
# Required. The parent app (package name) of the base plan to deactivate.
|
|
2378
|
+
# @param [String] product_id
|
|
2379
|
+
# Required. The parent subscription (ID) of the base plan to deactivate.
|
|
2380
|
+
# @param [String] base_plan_id
|
|
2381
|
+
# Required. The unique base plan ID of the base plan to deactivate.
|
|
2382
|
+
# @param [Google::Apis::AndroidpublisherV3::DeactivateBasePlanRequest] deactivate_base_plan_request_object
|
|
2383
|
+
# @param [String] fields
|
|
2384
|
+
# Selector specifying which fields to include in a partial response.
|
|
2385
|
+
# @param [String] quota_user
|
|
2386
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2387
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2388
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2389
|
+
# Request-specific options
|
|
2390
|
+
#
|
|
2391
|
+
# @yield [result, err] Result & error if block supplied
|
|
2392
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::Subscription] parsed result object
|
|
2393
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2394
|
+
#
|
|
2395
|
+
# @return [Google::Apis::AndroidpublisherV3::Subscription]
|
|
2396
|
+
#
|
|
2397
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2398
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2399
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2400
|
+
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)
|
|
2401
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:deactivate', options)
|
|
2402
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateBasePlanRequest::Representation
|
|
2403
|
+
command.request_object = deactivate_base_plan_request_object
|
|
2404
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::Subscription::Representation
|
|
2405
|
+
command.response_class = Google::Apis::AndroidpublisherV3::Subscription
|
|
2406
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2407
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2408
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2409
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2410
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2411
|
+
execute_or_queue_command(command, &block)
|
|
2412
|
+
end
|
|
2413
|
+
|
|
2414
|
+
# Deletes a base plan. Can only be done for draft base plans. This action is
|
|
2415
|
+
# irreversible.
|
|
2416
|
+
# @param [String] package_name
|
|
2417
|
+
# Required. The parent app (package name) of the base plan to delete.
|
|
2418
|
+
# @param [String] product_id
|
|
2419
|
+
# Required. The parent subscription (ID) of the base plan to delete.
|
|
2420
|
+
# @param [String] base_plan_id
|
|
2421
|
+
# Required. The unique offer ID of the base plan to delete.
|
|
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 [NilClass] No result returned for this method
|
|
2432
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2433
|
+
#
|
|
2434
|
+
# @return [void]
|
|
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 delete_monetization_subscription_base_plan(package_name, product_id, base_plan_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2440
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}', options)
|
|
2441
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2442
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2443
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2444
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2445
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2446
|
+
execute_or_queue_command(command, &block)
|
|
2447
|
+
end
|
|
2448
|
+
|
|
2449
|
+
# Migrates subscribers who are receiving an historical subscription price to the
|
|
2450
|
+
# currently-offered price for the specified region. Requests will cause price
|
|
2451
|
+
# change notifications to be sent to users who are currently receiving an
|
|
2452
|
+
# historical price older than the supplied timestamp. Subscribers who do not
|
|
2453
|
+
# agree to the new price will have their subscription ended at the next renewal.
|
|
2454
|
+
# @param [String] package_name
|
|
2455
|
+
# Required. Package name of the parent app. Must be equal to the package_name
|
|
2456
|
+
# field on the Subscription resource.
|
|
2457
|
+
# @param [String] product_id
|
|
2458
|
+
# Required. The ID of the subscription to update. Must be equal to the
|
|
2459
|
+
# product_id field on the Subscription resource.
|
|
2460
|
+
# @param [String] base_plan_id
|
|
2461
|
+
# Required. The unique base plan ID of the base plan to update prices on.
|
|
2462
|
+
# @param [Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesRequest] migrate_base_plan_prices_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::MigrateBasePlanPricesResponse] parsed result object
|
|
2473
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2474
|
+
#
|
|
2475
|
+
# @return [Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse]
|
|
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 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)
|
|
2481
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices', options)
|
|
2482
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesRequest::Representation
|
|
2483
|
+
command.request_object = migrate_base_plan_prices_request_object
|
|
2484
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse::Representation
|
|
2485
|
+
command.response_class = Google::Apis::AndroidpublisherV3::MigrateBasePlanPricesResponse
|
|
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
|
+
# Activates a subscription offer. Once activated, subscription offers will be
|
|
2495
|
+
# available to new subscribers.
|
|
2496
|
+
# @param [String] package_name
|
|
2497
|
+
# Required. The parent app (package name) of the offer to activate.
|
|
2498
|
+
# @param [String] product_id
|
|
2499
|
+
# Required. The parent subscription (ID) of the offer to activate.
|
|
2500
|
+
# @param [String] base_plan_id
|
|
2501
|
+
# Required. The parent base plan (ID) of the offer to activate.
|
|
2502
|
+
# @param [String] offer_id
|
|
2503
|
+
# Required. The unique offer ID of the offer to activate.
|
|
2504
|
+
# @param [Google::Apis::AndroidpublisherV3::ActivateSubscriptionOfferRequest] activate_subscription_offer_request_object
|
|
2505
|
+
# @param [String] fields
|
|
2506
|
+
# Selector specifying which fields to include in a partial response.
|
|
2507
|
+
# @param [String] quota_user
|
|
2508
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2509
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2510
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2511
|
+
# Request-specific options
|
|
2512
|
+
#
|
|
2513
|
+
# @yield [result, err] Result & error if block supplied
|
|
2514
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
|
2515
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2516
|
+
#
|
|
2517
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
|
2518
|
+
#
|
|
2519
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2520
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2521
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2522
|
+
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)
|
|
2523
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:activate', options)
|
|
2524
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ActivateSubscriptionOfferRequest::Representation
|
|
2525
|
+
command.request_object = activate_subscription_offer_request_object
|
|
2526
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2527
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
|
2528
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2529
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2530
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2531
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
|
2532
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2533
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2534
|
+
execute_or_queue_command(command, &block)
|
|
2535
|
+
end
|
|
2536
|
+
|
|
2537
|
+
# Creates a new subscription offer. Only auto-renewing base plans can have
|
|
2538
|
+
# subscription offers. The offer state will be DRAFT until it is activated.
|
|
2539
|
+
# @param [String] package_name
|
|
2540
|
+
# Required. The parent app (package name) for which the offer should be created.
|
|
2541
|
+
# Must be equal to the package_name field on the Subscription resource.
|
|
2542
|
+
# @param [String] product_id
|
|
2543
|
+
# Required. The parent subscription (ID) for which the offer should be created.
|
|
2544
|
+
# Must be equal to the product_id field on the SubscriptionOffer resource.
|
|
2545
|
+
# @param [String] base_plan_id
|
|
2546
|
+
# Required. The parent base plan (ID) for which the offer should be created.
|
|
2547
|
+
# Must be equal to the base_plan_id field on the SubscriptionOffer resource.
|
|
2548
|
+
# @param [Google::Apis::AndroidpublisherV3::SubscriptionOffer] subscription_offer_object
|
|
2549
|
+
# @param [String] offer_id
|
|
2550
|
+
# Required. The ID to use for the offer. For the requirements on this format,
|
|
2551
|
+
# see the documentation of the offer_id field on the SubscriptionOffer resource.
|
|
2552
|
+
# @param [String] regions_version_version
|
|
2553
|
+
# Required. A string representing version of the available regions being used
|
|
2554
|
+
# for the specified resource. The current version is 2022/02.
|
|
2555
|
+
# @param [String] fields
|
|
2556
|
+
# Selector specifying which fields to include in a partial response.
|
|
2557
|
+
# @param [String] quota_user
|
|
2558
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2559
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2560
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2561
|
+
# Request-specific options
|
|
2562
|
+
#
|
|
2563
|
+
# @yield [result, err] Result & error if block supplied
|
|
2564
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
|
2565
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2566
|
+
#
|
|
2567
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
|
2568
|
+
#
|
|
2569
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2570
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2571
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2572
|
+
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)
|
|
2573
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers', options)
|
|
2574
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2575
|
+
command.request_object = subscription_offer_object
|
|
2576
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2577
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
|
2578
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2579
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2580
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2581
|
+
command.query['offerId'] = offer_id unless offer_id.nil?
|
|
2582
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
|
2583
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2584
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2585
|
+
execute_or_queue_command(command, &block)
|
|
2586
|
+
end
|
|
2587
|
+
|
|
2588
|
+
# Deactivates a subscription offer. Once deactivated, existing subscribers will
|
|
2589
|
+
# maintain their subscription, but the offer will become unavailable to new
|
|
2590
|
+
# subscribers.
|
|
2591
|
+
# @param [String] package_name
|
|
2592
|
+
# Required. The parent app (package name) of the offer to deactivate.
|
|
2593
|
+
# @param [String] product_id
|
|
2594
|
+
# Required. The parent subscription (ID) of the offer to deactivate.
|
|
2595
|
+
# @param [String] base_plan_id
|
|
2596
|
+
# Required. The parent base plan (ID) of the offer to deactivate.
|
|
2597
|
+
# @param [String] offer_id
|
|
2598
|
+
# Required. The unique offer ID of the offer to deactivate.
|
|
2599
|
+
# @param [Google::Apis::AndroidpublisherV3::DeactivateSubscriptionOfferRequest] deactivate_subscription_offer_request_object
|
|
2600
|
+
# @param [String] fields
|
|
2601
|
+
# Selector specifying which fields to include in a partial response.
|
|
2602
|
+
# @param [String] quota_user
|
|
2603
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2604
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2605
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2606
|
+
# Request-specific options
|
|
2607
|
+
#
|
|
2608
|
+
# @yield [result, err] Result & error if block supplied
|
|
2609
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
|
2610
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2611
|
+
#
|
|
2612
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
|
2613
|
+
#
|
|
2614
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2615
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2616
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2617
|
+
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)
|
|
2618
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}:deactivate', options)
|
|
2619
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::DeactivateSubscriptionOfferRequest::Representation
|
|
2620
|
+
command.request_object = deactivate_subscription_offer_request_object
|
|
2621
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2622
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
|
2623
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2624
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2625
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2626
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
|
2627
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2628
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2629
|
+
execute_or_queue_command(command, &block)
|
|
2630
|
+
end
|
|
2631
|
+
|
|
2632
|
+
# Deletes a subscription offer. Can only be done for draft offers. This action
|
|
2633
|
+
# is irreversible.
|
|
2634
|
+
# @param [String] package_name
|
|
2635
|
+
# Required. The parent app (package name) of the offer to delete.
|
|
2636
|
+
# @param [String] product_id
|
|
2637
|
+
# Required. The parent subscription (ID) of the offer to delete.
|
|
2638
|
+
# @param [String] base_plan_id
|
|
2639
|
+
# Required. The parent base plan (ID) of the offer to delete.
|
|
2640
|
+
# @param [String] offer_id
|
|
2641
|
+
# Required. The unique offer ID of the offer to delete.
|
|
2642
|
+
# @param [String] fields
|
|
2643
|
+
# Selector specifying which fields to include in a partial response.
|
|
2644
|
+
# @param [String] quota_user
|
|
2645
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2646
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2647
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2648
|
+
# Request-specific options
|
|
2649
|
+
#
|
|
2650
|
+
# @yield [result, err] Result & error if block supplied
|
|
2651
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
2652
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2653
|
+
#
|
|
2654
|
+
# @return [void]
|
|
2655
|
+
#
|
|
2656
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2657
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2658
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2659
|
+
def delete_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2660
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
|
2661
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2662
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2663
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2664
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
|
2665
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2666
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2667
|
+
execute_or_queue_command(command, &block)
|
|
2668
|
+
end
|
|
2669
|
+
|
|
2670
|
+
# Reads a single offer
|
|
2671
|
+
# @param [String] package_name
|
|
2672
|
+
# Required. The parent app (package name) of the offer to get.
|
|
2673
|
+
# @param [String] product_id
|
|
2674
|
+
# Required. The parent subscription (ID) of the offer to get.
|
|
2675
|
+
# @param [String] base_plan_id
|
|
2676
|
+
# Required. The parent base plan (ID) of the offer to get.
|
|
2677
|
+
# @param [String] offer_id
|
|
2678
|
+
# Required. The unique offer ID of the offer to get.
|
|
2679
|
+
# @param [String] fields
|
|
2680
|
+
# Selector specifying which fields to include in a partial response.
|
|
2681
|
+
# @param [String] quota_user
|
|
2682
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2683
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2684
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2685
|
+
# Request-specific options
|
|
2686
|
+
#
|
|
2687
|
+
# @yield [result, err] Result & error if block supplied
|
|
2688
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
|
2689
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2690
|
+
#
|
|
2691
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
|
2692
|
+
#
|
|
2693
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2694
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2695
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2696
|
+
def get_monetization_subscription_base_plan_offer(package_name, product_id, base_plan_id, offer_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
2697
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
|
2698
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2699
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
|
2700
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2701
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2702
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2703
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
|
2704
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2705
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2706
|
+
execute_or_queue_command(command, &block)
|
|
2707
|
+
end
|
|
2708
|
+
|
|
2709
|
+
# Lists all offers under a given subscription.
|
|
2710
|
+
# @param [String] package_name
|
|
2711
|
+
# Required. The parent app (package name) for which the subscriptions should be
|
|
2712
|
+
# read.
|
|
2713
|
+
# @param [String] product_id
|
|
2714
|
+
# Required. The parent subscription (ID) for which the offers should be read.
|
|
2715
|
+
# @param [String] base_plan_id
|
|
2716
|
+
# Required. The parent base plan (ID) for which the offers should be read. May
|
|
2717
|
+
# be specified as '-' to read all offers under a subscription.
|
|
2718
|
+
# @param [Fixnum] page_size
|
|
2719
|
+
# The maximum number of subscriptions to return. The service may return fewer
|
|
2720
|
+
# than this value. If unspecified, at most 50 subscriptions will be returned.
|
|
2721
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
2722
|
+
# @param [String] page_token
|
|
2723
|
+
# A page token, received from a previous `ListSubscriptionsOffers` call. Provide
|
|
2724
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
2725
|
+
# provided to `ListSubscriptionOffers` must match the call that provided the
|
|
2726
|
+
# page token.
|
|
2727
|
+
# @param [String] fields
|
|
2728
|
+
# Selector specifying which fields to include in a partial response.
|
|
2729
|
+
# @param [String] quota_user
|
|
2730
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2731
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2732
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2733
|
+
# Request-specific options
|
|
2734
|
+
#
|
|
2735
|
+
# @yield [result, err] Result & error if block supplied
|
|
2736
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse] parsed result object
|
|
2737
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2738
|
+
#
|
|
2739
|
+
# @return [Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse]
|
|
2740
|
+
#
|
|
2741
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2742
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2743
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2744
|
+
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)
|
|
2745
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers', options)
|
|
2746
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse::Representation
|
|
2747
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListSubscriptionOffersResponse
|
|
2748
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2749
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2750
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2751
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
2752
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
2753
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2754
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2755
|
+
execute_or_queue_command(command, &block)
|
|
2756
|
+
end
|
|
2757
|
+
|
|
2758
|
+
# Updates an existing subscription offer.
|
|
2759
|
+
# @param [String] package_name
|
|
2760
|
+
# Required. Immutable. The package name of the app the parent subscription
|
|
2761
|
+
# belongs to.
|
|
2762
|
+
# @param [String] product_id
|
|
2763
|
+
# Required. Immutable. The ID of the parent subscription this offer belongs to.
|
|
2764
|
+
# @param [String] base_plan_id
|
|
2765
|
+
# Required. Immutable. The ID of the base plan to which this offer is an
|
|
2766
|
+
# extension.
|
|
2767
|
+
# @param [String] offer_id
|
|
2768
|
+
# Required. Immutable. Unique ID of this subscription offer. Must be unique
|
|
2769
|
+
# within the base plan.
|
|
2770
|
+
# @param [Google::Apis::AndroidpublisherV3::SubscriptionOffer] subscription_offer_object
|
|
2771
|
+
# @param [String] regions_version_version
|
|
2772
|
+
# Required. A string representing version of the available regions being used
|
|
2773
|
+
# for the specified resource. The current version is 2022/02.
|
|
2774
|
+
# @param [String] update_mask
|
|
2775
|
+
# Required. The list of fields to be updated.
|
|
2776
|
+
# @param [String] fields
|
|
2777
|
+
# Selector specifying which fields to include in a partial response.
|
|
2778
|
+
# @param [String] quota_user
|
|
2779
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2780
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2781
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2782
|
+
# Request-specific options
|
|
2783
|
+
#
|
|
2784
|
+
# @yield [result, err] Result & error if block supplied
|
|
2785
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionOffer] parsed result object
|
|
2786
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2787
|
+
#
|
|
2788
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionOffer]
|
|
2789
|
+
#
|
|
2790
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2791
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2792
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2793
|
+
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)
|
|
2794
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers/{offerId}', options)
|
|
2795
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2796
|
+
command.request_object = subscription_offer_object
|
|
2797
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionOffer::Representation
|
|
2798
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionOffer
|
|
2799
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2800
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2801
|
+
command.params['basePlanId'] = base_plan_id unless base_plan_id.nil?
|
|
2802
|
+
command.params['offerId'] = offer_id unless offer_id.nil?
|
|
2803
|
+
command.query['regionsVersion.version'] = regions_version_version unless regions_version_version.nil?
|
|
2804
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
2805
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2806
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2807
|
+
execute_or_queue_command(command, &block)
|
|
2808
|
+
end
|
|
2809
|
+
|
|
2810
|
+
# Refunds a user's subscription or in-app purchase order. Orders older than 1
|
|
2811
|
+
# year cannot be refunded.
|
|
2812
|
+
# @param [String] package_name
|
|
2813
|
+
# The package name of the application for which this subscription or in-app item
|
|
2814
|
+
# was purchased (for example, 'com.some.thing').
|
|
2815
|
+
# @param [String] order_id
|
|
2816
|
+
# The order ID provided to the user when the subscription or in-app order was
|
|
2817
|
+
# purchased.
|
|
2818
|
+
# @param [Boolean] revoke
|
|
2819
|
+
# Whether to revoke the purchased item. If set to true, access to the
|
|
2820
|
+
# subscription or in-app item will be terminated immediately. If the item is a
|
|
2821
|
+
# recurring subscription, all future payments will also be terminated. Consumed
|
|
2822
|
+
# in-app items need to be handled by developer's app. (optional).
|
|
2823
|
+
# @param [String] fields
|
|
2824
|
+
# Selector specifying which fields to include in a partial response.
|
|
2825
|
+
# @param [String] quota_user
|
|
2826
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2827
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2828
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2829
|
+
# Request-specific options
|
|
2830
|
+
#
|
|
2831
|
+
# @yield [result, err] Result & error if block supplied
|
|
2832
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
2833
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2834
|
+
#
|
|
2835
|
+
# @return [void]
|
|
2836
|
+
#
|
|
2837
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2838
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2839
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2840
|
+
def refund_order(package_name, order_id, revoke: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2841
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund', options)
|
|
2842
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2843
|
+
command.params['orderId'] = order_id unless order_id.nil?
|
|
2844
|
+
command.query['revoke'] = revoke unless revoke.nil?
|
|
2845
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2846
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2847
|
+
execute_or_queue_command(command, &block)
|
|
2848
|
+
end
|
|
2849
|
+
|
|
2850
|
+
# Acknowledges a purchase of an inapp item.
|
|
2851
|
+
# @param [String] package_name
|
|
2852
|
+
# The package name of the application the inapp product was sold in (for example,
|
|
2853
|
+
# 'com.some.thing').
|
|
2854
|
+
# @param [String] product_id
|
|
2855
|
+
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
|
2856
|
+
# @param [String] token
|
|
2857
|
+
# The token provided to the user's device when the inapp product was purchased.
|
|
2858
|
+
# @param [Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest] product_purchases_acknowledge_request_object
|
|
2859
|
+
# @param [String] fields
|
|
2860
|
+
# Selector specifying which fields to include in a partial response.
|
|
2861
|
+
# @param [String] quota_user
|
|
2862
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2863
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2864
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2865
|
+
# Request-specific options
|
|
2866
|
+
#
|
|
2867
|
+
# @yield [result, err] Result & error if block supplied
|
|
2868
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
2869
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2870
|
+
#
|
|
2871
|
+
# @return [void]
|
|
2872
|
+
#
|
|
2873
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2874
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2875
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2876
|
+
def acknowledge_purchase_product(package_name, product_id, token, product_purchases_acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2877
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge', options)
|
|
2878
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest::Representation
|
|
2879
|
+
command.request_object = product_purchases_acknowledge_request_object
|
|
2880
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2881
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2882
|
+
command.params['token'] = token unless token.nil?
|
|
2883
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2884
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2885
|
+
execute_or_queue_command(command, &block)
|
|
2886
|
+
end
|
|
2887
|
+
|
|
2888
|
+
# Consumes a purchase for an inapp item.
|
|
2889
|
+
# @param [String] package_name
|
|
2890
|
+
# The package name of the application the inapp product was sold in (for example,
|
|
2891
|
+
# 'com.some.thing').
|
|
2892
|
+
# @param [String] product_id
|
|
2893
|
+
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
|
2894
|
+
# @param [String] token
|
|
2895
|
+
# The token provided to the user's device when the inapp product was purchased.
|
|
2896
|
+
# @param [String] fields
|
|
2897
|
+
# Selector specifying which fields to include in a partial response.
|
|
2898
|
+
# @param [String] quota_user
|
|
2899
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
2900
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
2901
|
+
# @param [Google::Apis::RequestOptions] options
|
|
2902
|
+
# Request-specific options
|
|
2903
|
+
#
|
|
2904
|
+
# @yield [result, err] Result & error if block supplied
|
|
2905
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
2906
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
2907
|
+
#
|
|
2908
|
+
# @return [void]
|
|
2909
|
+
#
|
|
2910
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2911
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2912
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2913
|
+
def consume_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, options: nil, &block)
|
|
2914
|
+
command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:consume', options)
|
|
2915
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
2916
|
+
command.params['productId'] = product_id unless product_id.nil?
|
|
2917
|
+
command.params['token'] = token unless token.nil?
|
|
2918
|
+
command.query['fields'] = fields unless fields.nil?
|
|
2919
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2920
|
+
execute_or_queue_command(command, &block)
|
|
2921
|
+
end
|
|
2922
|
+
|
|
2923
|
+
# Checks the purchase and consumption status of an inapp item.
|
|
2924
|
+
# @param [String] package_name
|
|
2925
|
+
# The package name of the application the inapp product was sold in (for example,
|
|
2926
|
+
# 'com.some.thing').
|
|
2927
|
+
# @param [String] product_id
|
|
2928
|
+
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
|
2929
|
+
# @param [String] token
|
|
2930
|
+
# The token provided to the user's device when the inapp product was purchased.
|
|
1796
2931
|
# @param [String] fields
|
|
1797
2932
|
# Selector specifying which fields to include in a partial response.
|
|
1798
2933
|
# @param [String] quota_user
|
|
@@ -2046,6 +3181,41 @@ module Google
|
|
|
2046
3181
|
execute_or_queue_command(command, &block)
|
|
2047
3182
|
end
|
|
2048
3183
|
|
|
3184
|
+
# Get metadata about a subscription
|
|
3185
|
+
# @param [String] package_name
|
|
3186
|
+
# The package of the application for which this subscription was purchased (for
|
|
3187
|
+
# example, 'com.some.thing').
|
|
3188
|
+
# @param [String] token
|
|
3189
|
+
# Required. The token provided to the user's device when the subscription was
|
|
3190
|
+
# purchased.
|
|
3191
|
+
# @param [String] fields
|
|
3192
|
+
# Selector specifying which fields to include in a partial response.
|
|
3193
|
+
# @param [String] quota_user
|
|
3194
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3195
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3196
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3197
|
+
# Request-specific options
|
|
3198
|
+
#
|
|
3199
|
+
# @yield [result, err] Result & error if block supplied
|
|
3200
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2] parsed result object
|
|
3201
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3202
|
+
#
|
|
3203
|
+
# @return [Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2]
|
|
3204
|
+
#
|
|
3205
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3206
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3207
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3208
|
+
def get_purchase_subscriptionsv2(package_name, token, fields: nil, quota_user: nil, options: nil, &block)
|
|
3209
|
+
command = make_simple_command(:get, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}', options)
|
|
3210
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2::Representation
|
|
3211
|
+
command.response_class = Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2
|
|
3212
|
+
command.params['packageName'] = package_name unless package_name.nil?
|
|
3213
|
+
command.params['token'] = token unless token.nil?
|
|
3214
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3215
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3216
|
+
execute_or_queue_command(command, &block)
|
|
3217
|
+
end
|
|
3218
|
+
|
|
2049
3219
|
# Lists the purchases that were canceled, refunded or charged-back.
|
|
2050
3220
|
# @param [String] package_name
|
|
2051
3221
|
# The package name of the application for which voided purchases need to be
|
|
@@ -2377,6 +3547,145 @@ module Google
|
|
|
2377
3547
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2378
3548
|
execute_or_queue_command(command, &block)
|
|
2379
3549
|
end
|
|
3550
|
+
|
|
3551
|
+
# Grant access for a user to the given developer account.
|
|
3552
|
+
# @param [String] parent
|
|
3553
|
+
# Required. The developer account to add the user to. Format: developers/`
|
|
3554
|
+
# developer`
|
|
3555
|
+
# @param [Google::Apis::AndroidpublisherV3::User] user_object
|
|
3556
|
+
# @param [String] fields
|
|
3557
|
+
# Selector specifying which fields to include in a partial response.
|
|
3558
|
+
# @param [String] quota_user
|
|
3559
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3560
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3561
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3562
|
+
# Request-specific options
|
|
3563
|
+
#
|
|
3564
|
+
# @yield [result, err] Result & error if block supplied
|
|
3565
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::User] parsed result object
|
|
3566
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3567
|
+
#
|
|
3568
|
+
# @return [Google::Apis::AndroidpublisherV3::User]
|
|
3569
|
+
#
|
|
3570
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3571
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3572
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3573
|
+
def create_user(parent, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3574
|
+
command = make_simple_command(:post, 'androidpublisher/v3/{+parent}/users', options)
|
|
3575
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
|
3576
|
+
command.request_object = user_object
|
|
3577
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
|
3578
|
+
command.response_class = Google::Apis::AndroidpublisherV3::User
|
|
3579
|
+
command.params['parent'] = parent unless parent.nil?
|
|
3580
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3581
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3582
|
+
execute_or_queue_command(command, &block)
|
|
3583
|
+
end
|
|
3584
|
+
|
|
3585
|
+
# Removes all access for the user to the given developer account.
|
|
3586
|
+
# @param [String] name
|
|
3587
|
+
# Required. The name of the user to delete. Format: developers/`developer`/users/
|
|
3588
|
+
# `email`
|
|
3589
|
+
# @param [String] fields
|
|
3590
|
+
# Selector specifying which fields to include in a partial response.
|
|
3591
|
+
# @param [String] quota_user
|
|
3592
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3593
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3594
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3595
|
+
# Request-specific options
|
|
3596
|
+
#
|
|
3597
|
+
# @yield [result, err] Result & error if block supplied
|
|
3598
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
3599
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3600
|
+
#
|
|
3601
|
+
# @return [void]
|
|
3602
|
+
#
|
|
3603
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3604
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3605
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3606
|
+
def delete_user(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
3607
|
+
command = make_simple_command(:delete, 'androidpublisher/v3/{+name}', options)
|
|
3608
|
+
command.params['name'] = name unless name.nil?
|
|
3609
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3610
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3611
|
+
execute_or_queue_command(command, &block)
|
|
3612
|
+
end
|
|
3613
|
+
|
|
3614
|
+
# Lists all users with access to a developer account.
|
|
3615
|
+
# @param [String] parent
|
|
3616
|
+
# Required. The developer account to fetch users from. Format: developers/`
|
|
3617
|
+
# developer`
|
|
3618
|
+
# @param [Fixnum] page_size
|
|
3619
|
+
# The maximum number of results to return. This must be set to -1 to disable
|
|
3620
|
+
# pagination.
|
|
3621
|
+
# @param [String] page_token
|
|
3622
|
+
# A token received from a previous call to this method, in order to retrieve
|
|
3623
|
+
# further results.
|
|
3624
|
+
# @param [String] fields
|
|
3625
|
+
# Selector specifying which fields to include in a partial response.
|
|
3626
|
+
# @param [String] quota_user
|
|
3627
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3628
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3629
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3630
|
+
# Request-specific options
|
|
3631
|
+
#
|
|
3632
|
+
# @yield [result, err] Result & error if block supplied
|
|
3633
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::ListUsersResponse] parsed result object
|
|
3634
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3635
|
+
#
|
|
3636
|
+
# @return [Google::Apis::AndroidpublisherV3::ListUsersResponse]
|
|
3637
|
+
#
|
|
3638
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3639
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3640
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3641
|
+
def list_users(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3642
|
+
command = make_simple_command(:get, 'androidpublisher/v3/{+parent}/users', options)
|
|
3643
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::ListUsersResponse::Representation
|
|
3644
|
+
command.response_class = Google::Apis::AndroidpublisherV3::ListUsersResponse
|
|
3645
|
+
command.params['parent'] = parent unless parent.nil?
|
|
3646
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3647
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3648
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3649
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3650
|
+
execute_or_queue_command(command, &block)
|
|
3651
|
+
end
|
|
3652
|
+
|
|
3653
|
+
# Updates access for the user to the developer account.
|
|
3654
|
+
# @param [String] name
|
|
3655
|
+
# Required. Resource name for this user, following the pattern "developers/`
|
|
3656
|
+
# developer`/users/`email`".
|
|
3657
|
+
# @param [Google::Apis::AndroidpublisherV3::User] user_object
|
|
3658
|
+
# @param [String] update_mask
|
|
3659
|
+
# Optional. The list of fields to be updated.
|
|
3660
|
+
# @param [String] fields
|
|
3661
|
+
# Selector specifying which fields to include in a partial response.
|
|
3662
|
+
# @param [String] quota_user
|
|
3663
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3664
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3665
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3666
|
+
# Request-specific options
|
|
3667
|
+
#
|
|
3668
|
+
# @yield [result, err] Result & error if block supplied
|
|
3669
|
+
# @yieldparam result [Google::Apis::AndroidpublisherV3::User] parsed result object
|
|
3670
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3671
|
+
#
|
|
3672
|
+
# @return [Google::Apis::AndroidpublisherV3::User]
|
|
3673
|
+
#
|
|
3674
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3675
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3676
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3677
|
+
def patch_user(name, user_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3678
|
+
command = make_simple_command(:patch, 'androidpublisher/v3/{+name}', options)
|
|
3679
|
+
command.request_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
|
3680
|
+
command.request_object = user_object
|
|
3681
|
+
command.response_representation = Google::Apis::AndroidpublisherV3::User::Representation
|
|
3682
|
+
command.response_class = Google::Apis::AndroidpublisherV3::User
|
|
3683
|
+
command.params['name'] = name unless name.nil?
|
|
3684
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
3685
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3686
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3687
|
+
execute_or_queue_command(command, &block)
|
|
3688
|
+
end
|
|
2380
3689
|
|
|
2381
3690
|
protected
|
|
2382
3691
|
|