Method: monetization.subscriptions.basePlans.batchUpdateStates

1 つまたは複数の定期購入で基本プランを有効または無効にします。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
packageName

string

必須。更新された基本プランの親アプリ（パッケージ名）。
productId

string

必須。親定期購入のプロダクト ID（更新された基本プランがすべて同じ定期購入に属している場合）。複数の定期購入にまたがる一括更新の場合は、このフィールドを「-」に設定します。設定する必要があります。

リクエスト本文

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

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

object (UpdateBasePlanStateRequest)

必須。最大 100 個の要素を含む更新リクエストのリスト。すべてのリクエストで異なる基本プランを更新する必要があります。

レスポンスの本文

basePlans.batchUpdateStates に対するレスポンス メッセージ。

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

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

object (Subscription)

更新されたサブスクリプションのリスト。このリストは、同じ順序で 1 対 1 のリクエストに対応します。

認可スコープ

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

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

UpdateBasePlanStateRequest

定期購入の基本プランの状態を更新するためのリクエスト メッセージ。

JSON 表現 
{

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

object (ActivateBasePlanRequest)

基本プランを有効にします。有効になると、新規の定期購入者は基本プランを利用できるようになります。
deactivateBasePlanRequest

object (DeactivateBasePlanRequest)

基本プランを無効にします。無効にすると、新規の定期購入者は基本プランを利用できなくなりますが、既存の定期購入者は定期購入を継続できます

ActivateBasePlanRequest

ActivateBasePlan に対するリクエスト メッセージ。

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

string

必須。有効にする基本プランの親アプリ（パッケージ名）。
productId

string

必須。有効にする基本プランの親定期購入（ID）。
basePlanId

string

必須。有効にする基本プランの一意の基本プラン ID。
latencyTolerance

enum (ProductUpdateLatencyTolerance)

省略可。このプロダクトの更新の伝播に対するレイテンシの許容度。デフォルトでは、レイテンシの影響を受けやすい設定になります。

DeactivateBasePlanRequest

basePlans.deactivate に対するリクエスト メッセージ。

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

string

必須。無効にする基本プランの親アプリ（パッケージ名）。
productId

string

必須。無効にする基本プランの親定期購入（ID）。
basePlanId

string

必須。無効にする基本プランの一意の基本プラン ID。
latencyTolerance

enum (ProductUpdateLatencyTolerance)

省略可。このプロダクトの更新の伝播に対するレイテンシの許容度。デフォルトでは、レイテンシの影響を受けやすい設定になります。