Method: monetization.subscriptions.batchUpdate

  • The batchUpdate method updates a batch of subscriptions for a given package name.

  • The request body requires a list of UpdateSubscriptionRequest objects, each specifying the subscription to update and the fields to modify.

  • The response body contains a list of the updated Subscription objects.

  • The update operation requires authorization using the https://www.googleapis.com/auth/androidpublisher OAuth scope.

  • Setting latencyTolerance to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT on nested requests can maximize update throughput.

Updates a batch of subscriptions.

Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.

HTTP request

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions:batchUpdate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the packageName field on all the Subscription resources.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (UpdateSubscriptionRequest)
    }
  ]
}
Fields
requests[]

object (UpdateSubscriptionRequest)

Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.

Response body

Response message for BatchUpdateSubscription.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ]
}
Fields
subscriptions[]

object (Subscription)

The updated subscriptions list.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidpublisher

UpdateSubscriptionRequest

Request message for subscriptions.patch.

JSON representation 
{
  "subscription": {
    object (Subscription)
  },
  "updateMask": string,
  "regionsVersion": {
    object (RegionsVersion)
  },
  "allowMissing": boolean,
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
Fields
subscription

object (Subscription)

Required. The subscription to update.
updateMask

string (FieldMask format)

Required. The list of fields to be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
regionsVersion

object (RegionsVersion)

Required. The version of the available regions being used for the subscription.
allowMissing

boolean

Optional. If set to true, and the subscription with the given packageName and productId doesn't exist, the subscription will be created.

If a new subscription is created, updateMask is ignored.
latencyTolerance

enum (ProductUpdateLatencyTolerance)

Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.