google-apis-androidpublisher_v3 0.1.0 → 0.33.0

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