google-apis-androidpublisher_v3 0.54.0 → 0.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,6 +34,8 @@ module Google
34
34
  #
35
35
  # @see https://developers.google.com/android-publisher
36
36
  class AndroidPublisherService < Google::Apis::Core::BaseService
37
+ DEFAULT_ENDPOINT_TEMPLATE = "https://androidpublisher.$UNIVERSE_DOMAIN$/"
38
+
37
39
  # @return [String]
38
40
  # API key. Your API key identifies your project and provides you with API access,
39
41
  # quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -45,12 +47,45 @@ module Google
45
47
  attr_accessor :quota_user
46
48
 
47
49
  def initialize
48
- super('https://androidpublisher.googleapis.com/', '',
50
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
49
51
  client_name: 'google-apis-androidpublisher_v3',
50
52
  client_version: Google::Apis::AndroidpublisherV3::GEM_VERSION)
51
53
  @batch_path = 'batch'
52
54
  end
53
55
 
56
+ # Writes the Safety Labels declaration of an app.
57
+ # @param [String] package_name
58
+ # Required. Package name of the app.
59
+ # @param [Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateRequest] safety_labels_update_request_object
60
+ # @param [String] fields
61
+ # Selector specifying which fields to include in a partial response.
62
+ # @param [String] quota_user
63
+ # Available to use for quota purposes for server-side applications. Can be any
64
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
65
+ # @param [Google::Apis::RequestOptions] options
66
+ # Request-specific options
67
+ #
68
+ # @yield [result, err] Result & error if block supplied
69
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse] parsed result object
70
+ # @yieldparam err [StandardError] error object if request failed
71
+ #
72
+ # @return [Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse]
73
+ #
74
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
75
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
76
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
77
+ def data_application_safety(package_name, safety_labels_update_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
78
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/dataSafety', options)
79
+ command.request_representation = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateRequest::Representation
80
+ command.request_object = safety_labels_update_request_object
81
+ command.response_representation = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse::Representation
82
+ command.response_class = Google::Apis::AndroidpublisherV3::SafetyLabelsUpdateResponse
83
+ command.params['packageName'] = package_name unless package_name.nil?
84
+ command.query['fields'] = fields unless fields.nil?
85
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
86
+ execute_or_queue_command(command, &block)
87
+ end
88
+
54
89
  # Creates a new device tier config for an app.
55
90
  # @param [String] package_name
56
91
  # Package name of the app.
@@ -162,6 +197,188 @@ module Google
162
197
  execute_or_queue_command(command, &block)
163
198
  end
164
199
 
200
+ # Incrementally update targeting for a recovery action. Note that only the
201
+ # criteria selected during the creation of recovery action can be expanded.
202
+ # @param [String] package_name
203
+ # Required. Package name of the app for which recovery action is to be updated.
204
+ # @param [Fixnum] app_recovery_id
205
+ # Required. ID corresponding to the app recovery action.
206
+ # @param [Google::Apis::AndroidpublisherV3::AddTargetingRequest] add_targeting_request_object
207
+ # @param [String] fields
208
+ # Selector specifying which fields to include in a partial response.
209
+ # @param [String] quota_user
210
+ # Available to use for quota purposes for server-side applications. Can be any
211
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
212
+ # @param [Google::Apis::RequestOptions] options
213
+ # Request-specific options
214
+ #
215
+ # @yield [result, err] Result & error if block supplied
216
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::AddTargetingResponse] parsed result object
217
+ # @yieldparam err [StandardError] error object if request failed
218
+ #
219
+ # @return [Google::Apis::AndroidpublisherV3::AddTargetingResponse]
220
+ #
221
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
222
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
223
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
224
+ def add_apprecovery_targeting(package_name, app_recovery_id, add_targeting_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
225
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:addTargeting', options)
226
+ command.request_representation = Google::Apis::AndroidpublisherV3::AddTargetingRequest::Representation
227
+ command.request_object = add_targeting_request_object
228
+ command.response_representation = Google::Apis::AndroidpublisherV3::AddTargetingResponse::Representation
229
+ command.response_class = Google::Apis::AndroidpublisherV3::AddTargetingResponse
230
+ command.params['packageName'] = package_name unless package_name.nil?
231
+ command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
232
+ command.query['fields'] = fields unless fields.nil?
233
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
234
+ execute_or_queue_command(command, &block)
235
+ end
236
+
237
+ # List all app recovery action resources associated with a particular package
238
+ # name and app version.
239
+ # @param [String] package_name
240
+ # Required. Package name of the app for which list of recovery actions is
241
+ # requested.
242
+ # @param [Fixnum] version_code
243
+ # Required. Version code targeted by the list of recovery actions.
244
+ # @param [String] fields
245
+ # Selector specifying which fields to include in a partial response.
246
+ # @param [String] quota_user
247
+ # Available to use for quota purposes for server-side applications. Can be any
248
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
249
+ # @param [Google::Apis::RequestOptions] options
250
+ # Request-specific options
251
+ #
252
+ # @yield [result, err] Result & error if block supplied
253
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse] parsed result object
254
+ # @yieldparam err [StandardError] error object if request failed
255
+ #
256
+ # @return [Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse]
257
+ #
258
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
259
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
260
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
261
+ def app_apprecovery_recoveries(package_name, version_code: nil, fields: nil, quota_user: nil, options: nil, &block)
262
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries', options)
263
+ command.response_representation = Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse::Representation
264
+ command.response_class = Google::Apis::AndroidpublisherV3::ListAppRecoveriesResponse
265
+ command.params['packageName'] = package_name unless package_name.nil?
266
+ command.query['versionCode'] = version_code unless version_code.nil?
267
+ command.query['fields'] = fields unless fields.nil?
268
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
269
+ execute_or_queue_command(command, &block)
270
+ end
271
+
272
+ # Cancel an already executing app recovery action. Note that this action changes
273
+ # status of the recovery action to CANCELED.
274
+ # @param [String] package_name
275
+ # Required. Package name of the app for which recovery action cancellation is
276
+ # requested.
277
+ # @param [Fixnum] app_recovery_id
278
+ # Required. ID corresponding to the app recovery action.
279
+ # @param [Google::Apis::AndroidpublisherV3::CancelAppRecoveryRequest] cancel_app_recovery_request_object
280
+ # @param [String] fields
281
+ # Selector specifying which fields to include in a partial response.
282
+ # @param [String] quota_user
283
+ # Available to use for quota purposes for server-side applications. Can be any
284
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
285
+ # @param [Google::Apis::RequestOptions] options
286
+ # Request-specific options
287
+ #
288
+ # @yield [result, err] Result & error if block supplied
289
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse] parsed result object
290
+ # @yieldparam err [StandardError] error object if request failed
291
+ #
292
+ # @return [Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse]
293
+ #
294
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
295
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
296
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
297
+ def cancel_apprecovery_app_recovery(package_name, app_recovery_id, cancel_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
298
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel', options)
299
+ command.request_representation = Google::Apis::AndroidpublisherV3::CancelAppRecoveryRequest::Representation
300
+ command.request_object = cancel_app_recovery_request_object
301
+ command.response_representation = Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse::Representation
302
+ command.response_class = Google::Apis::AndroidpublisherV3::CancelAppRecoveryResponse
303
+ command.params['packageName'] = package_name unless package_name.nil?
304
+ command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
305
+ command.query['fields'] = fields unless fields.nil?
306
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
307
+ execute_or_queue_command(command, &block)
308
+ end
309
+
310
+ # Create an app recovery action with recovery status as DRAFT. Note that this
311
+ # action does not execute the recovery action.
312
+ # @param [String] package_name
313
+ # Required. Package name of the app on which recovery action is performed.
314
+ # @param [Google::Apis::AndroidpublisherV3::CreateDraftAppRecoveryRequest] create_draft_app_recovery_request_object
315
+ # @param [String] fields
316
+ # Selector specifying which fields to include in a partial response.
317
+ # @param [String] quota_user
318
+ # Available to use for quota purposes for server-side applications. Can be any
319
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
320
+ # @param [Google::Apis::RequestOptions] options
321
+ # Request-specific options
322
+ #
323
+ # @yield [result, err] Result & error if block supplied
324
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::AppRecoveryAction] parsed result object
325
+ # @yieldparam err [StandardError] error object if request failed
326
+ #
327
+ # @return [Google::Apis::AndroidpublisherV3::AppRecoveryAction]
328
+ #
329
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
330
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
331
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
332
+ def create_apprecovery_draft_app_recovery(package_name, create_draft_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
333
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries', options)
334
+ command.request_representation = Google::Apis::AndroidpublisherV3::CreateDraftAppRecoveryRequest::Representation
335
+ command.request_object = create_draft_app_recovery_request_object
336
+ command.response_representation = Google::Apis::AndroidpublisherV3::AppRecoveryAction::Representation
337
+ command.response_class = Google::Apis::AndroidpublisherV3::AppRecoveryAction
338
+ command.params['packageName'] = package_name unless package_name.nil?
339
+ command.query['fields'] = fields unless fields.nil?
340
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
341
+ execute_or_queue_command(command, &block)
342
+ end
343
+
344
+ # Deploy an already created app recovery action with recovery status DRAFT. Note
345
+ # that this action activates the recovery action for all targeted users and
346
+ # changes its status to ACTIVE.
347
+ # @param [String] package_name
348
+ # Required. Package name of the app for which recovery action is deployed.
349
+ # @param [Fixnum] app_recovery_id
350
+ # Required. ID corresponding to the app recovery action to deploy.
351
+ # @param [Google::Apis::AndroidpublisherV3::DeployAppRecoveryRequest] deploy_app_recovery_request_object
352
+ # @param [String] fields
353
+ # Selector specifying which fields to include in a partial response.
354
+ # @param [String] quota_user
355
+ # Available to use for quota purposes for server-side applications. Can be any
356
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
357
+ # @param [Google::Apis::RequestOptions] options
358
+ # Request-specific options
359
+ #
360
+ # @yield [result, err] Result & error if block supplied
361
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse] parsed result object
362
+ # @yieldparam err [StandardError] error object if request failed
363
+ #
364
+ # @return [Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse]
365
+ #
366
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
367
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
368
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
369
+ def deploy_apprecovery_app_recovery(package_name, app_recovery_id, deploy_app_recovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
370
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:deploy', options)
371
+ command.request_representation = Google::Apis::AndroidpublisherV3::DeployAppRecoveryRequest::Representation
372
+ command.request_object = deploy_app_recovery_request_object
373
+ command.response_representation = Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse::Representation
374
+ command.response_class = Google::Apis::AndroidpublisherV3::DeployAppRecoveryResponse
375
+ command.params['packageName'] = package_name unless package_name.nil?
376
+ command.params['appRecoveryId'] = app_recovery_id unless app_recovery_id.nil?
377
+ command.query['fields'] = fields unless fields.nil?
378
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
379
+ execute_or_queue_command(command, &block)
380
+ end
381
+
165
382
  # Commits an app edit.
166
383
  # @param [String] package_name
167
384
  # Package name of the app.
@@ -3832,6 +4049,44 @@ module Google
3832
4049
  execute_or_queue_command(command, &block)
3833
4050
  end
3834
4051
 
4052
+ # Revoke a subscription purchase for the user.
4053
+ # @param [String] package_name
4054
+ # Required. The package of the application for which this subscription was
4055
+ # purchased (for example, 'com.some.thing').
4056
+ # @param [String] token
4057
+ # Required. The token provided to the user's device when the subscription was
4058
+ # purchased.
4059
+ # @param [Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseRequest] revoke_subscription_purchase_request_object
4060
+ # @param [String] fields
4061
+ # Selector specifying which fields to include in a partial response.
4062
+ # @param [String] quota_user
4063
+ # Available to use for quota purposes for server-side applications. Can be any
4064
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4065
+ # @param [Google::Apis::RequestOptions] options
4066
+ # Request-specific options
4067
+ #
4068
+ # @yield [result, err] Result & error if block supplied
4069
+ # @yieldparam result [Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse] parsed result object
4070
+ # @yieldparam err [StandardError] error object if request failed
4071
+ #
4072
+ # @return [Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse]
4073
+ #
4074
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4075
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4076
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4077
+ def revoke_subscriptionsv2_subscription_purchase(package_name, token, revoke_subscription_purchase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4078
+ command = make_simple_command(:post, 'androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:revoke', options)
4079
+ command.request_representation = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseRequest::Representation
4080
+ command.request_object = revoke_subscription_purchase_request_object
4081
+ command.response_representation = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse::Representation
4082
+ command.response_class = Google::Apis::AndroidpublisherV3::RevokeSubscriptionPurchaseResponse
4083
+ command.params['packageName'] = package_name unless package_name.nil?
4084
+ command.params['token'] = token unless token.nil?
4085
+ command.query['fields'] = fields unless fields.nil?
4086
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4087
+ execute_or_queue_command(command, &block)
4088
+ end
4089
+
3835
4090
  # Lists the purchases that were canceled, refunded or charged-back.
3836
4091
  # @param [String] package_name
3837
4092
  # The package name of the application for which voided purchases need to be
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-androidpublisher_v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.54.0
4
+ version: 0.56.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-12-17 00:00:00.000000000 Z
11
+ date: 2024-02-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.11.0
19
+ version: 0.12.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.11.0
29
+ version: 0.12.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-androidpublisher_v3/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-androidpublisher_v3/v0.54.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-androidpublisher_v3/v0.56.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-androidpublisher_v3
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.4.19
78
+ rubygems_version: 3.5.3
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Google Play Android Developer API V3