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)

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

DeactivateBasePlanRequest

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

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

string

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

string

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

string

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

enum (ProductUpdateLatencyTolerance)

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