Method: monetization.subscriptions.basePlans.offers.batchUpdate

  • The batchUpdate method updates a batch of subscription offers.

  • Set latencyTolerance to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT for maximum update throughput.

  • The HTTP request uses a POST method with specific path parameters for packageName, productId, and basePlanId.

  • The request body includes a list of UpdateSubscriptionOfferRequest objects, with a limit of 100 elements.

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

  • The API requires the https://www.googleapis.com/auth/androidpublisher OAuth scope.

  • Each UpdateSubscriptionOfferRequest object requires the subscriptionOffer to update, an updateMask specifying the fields to change, and the regionsVersion.

Updates a batch of subscription offers.

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/{productId}/basePlans/{basePlanId}/offers:batchUpdate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) of the updated subscription offers.

Must be equal to the packageName field on all the updated SubscriptionOffer resources.
productId

string

Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to "-". Must be set.
basePlanId

string

Required. The parent base plan (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple base plans.

Request body

The request body contains data with the following structure:

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

object (UpdateSubscriptionOfferRequest)

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

Response body

Response message for offers.batchUpdate.

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

JSON representation 
{
  "subscriptionOffers": [
    {
      object (SubscriptionOffer)
    }
  ]
}
Fields
subscriptionOffers[]

object (SubscriptionOffer)

The updated subscription offers list.

Authorization scopes

Requires the following OAuth scope:

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

UpdateSubscriptionOfferRequest

Request message for offers.patch.

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

object (SubscriptionOffer)

Required. The subscription offer 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 subscriptionOffer.
allowMissing

boolean

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

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

enum (ProductUpdateLatencyTolerance)

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