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 個の要素を含む更新リクエストのリスト。すべてのリクエストでは、異なるオファーを更新する必要があります。

レスポンスの本文

offer.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)

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

DeactivateSubscriptionOfferRequest

offer.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)

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