Method: monetization.subscriptions.basePlans.offers.batchUpdateStates

定期購入特典の状態を一括で更新します。

更新スループットが最大になるように、ネストされたリクエストの latencyTolerance フィールドを PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT に設定します。

HTTP リクエスト

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchUpdateStates

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
packageName

string

必須。更新された定期購入特典の親アプリ（パッケージ名）。

更新されたすべての SubscriptionOffer リソースの packageName フィールドと同じである必要があります。
productId

string

必須。更新されたすべての特典が同じ定期購入に属する場合は、親定期購入のアイテム ID。リクエストが複数の定期購入を対象とする場合は、このフィールドに「-」を設定します。設定は必須です。
basePlanId

string

必須。更新する特典の親基本プラン（ID）。複数の基本プランの特典を更新する場合は「-」を指定できます。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requests": [
    {
      object (UpdateSubscriptionOfferStateRequest)
    }
  ]
}
フィールド
requests[]

object (UpdateSubscriptionOfferStateRequest)

必須。最大 100 の要素を含む更新リクエストのリスト。それぞれのリクエストが更新対象とする特典はすべて異なっている必要があります。

レスポンスの本文

offers.batchUpdateStates のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "subscriptionOffers": [
    {
      object (SubscriptionOffer)
    }
  ]
}
フィールド
subscriptionOffers[]

object (SubscriptionOffer)

更新された定期購入特典のリスト。

認可スコープ

次の OAuth スコープが必要です。

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

UpdateSubscriptionOfferStateRequest

定期購入特典の状態を更新するリクエスト メッセージ。

JSON 表現 
{

  // Union field state_transition_type can be only one of the following:
  "activateSubscriptionOfferRequest": {
    object (ActivateSubscriptionOfferRequest)
  },
  "deactivateSubscriptionOfferRequest": {
    object (DeactivateSubscriptionOfferRequest)
  }
  // End of list of possible types for union field state_transition_type.
}
フィールド
共用体フィールド state_transition_type。適用する状態遷移のタイプ。必ず 1 つ設定する必要があります。state_transition_type は次のいずれかになります。
activateSubscriptionOfferRequest

object (ActivateSubscriptionOfferRequest)

特典を有効にします。有効にすると、新規定期購入者が特典を利用できるようになります。
deactivateSubscriptionOfferRequest

object (DeactivateSubscriptionOfferRequest)

特典を無効にします。無効にすると、新規定期購入者が特典を利用できなくなります。ただし既存の定期購入者の定期購入は維持されます。

ActivateSubscriptionOfferRequest

ActivateSubscriptionOffer のリクエスト メッセージ。

JSON 表現 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
フィールド
packageName

string

必須。有効にする特典の親アプリ（パッケージ名）。
productId

string

必須。有効にする特典の親定期購入（ID）。
basePlanId

string

必須。有効にする特典の親基本プラン（ID）。
offerId

string

必須。有効にする特典の一意の特典 ID。
latencyTolerance

enum (ProductUpdateLatencyTolerance)

省略可。このアイテムの更新の伝播に関する遅延の許容度。デフォルトは latency-sensitive（遅延の影響を受けやすい）です。

DeactivateSubscriptionOfferRequest

offers.deactivate のリクエスト メッセージ。

JSON 表現 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
フィールド
packageName

string

必須。無効にする特典の親アプリ（パッケージ名）。
productId

string

必須。無効にする特典の親定期購入（ID）。
basePlanId

string

必須。無効にする特典の親基本プラン（ID）。
offerId

string

必須。無効にする特典の一意の特典 ID。
latencyTolerance

enum (ProductUpdateLatencyTolerance)

省略可。このアイテムの更新の伝播に関する遅延の許容度。デフォルトは latency-sensitive（遅延の影響を受けやすい）です。