Method: monetization.onetimeproducts.purchaseOptions.offers.batchUpdateStates

1 回限りのアイテムの特典の状態を一括で更新します。

HTTP リクエスト

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers:batchUpdateStates

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

パスパラメータ

パラメータ
packageName

string

必須。更新された 1 回限りのアイテム特典の親アプリ（パッケージ名）。
productId

string

必須。更新されたすべての特典が同じ 1 回限りのアイテムに属する場合は、1 回限りの親アイテムのアイテム ID。バッチ更新が複数の 1 回限りのアイテムを対象とする場合は、このフィールドに「-」を設定します。
purchaseOptionId

string

必須。更新されたすべての特典が同じ購入オプションに属する場合は、親購入オプションの購入オプション ID。バッチ更新が複数の購入オプションを対象とする場合は、このフィールドに「-」を設定します。

リクエストの本文

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

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

object (UpdateOneTimeProductOfferStateRequest)

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

レスポンスの本文

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

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

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

object (OneTimeProductOffer)

更新された 1 回限りのアイテム特典のリスト（リクエストと同じ順序）。

認可スコープ

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

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

UpdateOneTimeProductOfferStateRequest

1 回限りのアイテム特典の状態を更新するリクエスト メッセージ。

JSON 表現 
{

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

object (ActivateOneTimeProductOfferRequest)

特典を有効にします。有効化されると、条件にあっている限り、ユーザーは特典を利用できます。
cancelOneTimeProductOfferRequest

object (CancelOneTimeProductOfferRequest)

特典を解約します。解約されると、特典はユーザーに提供されなくなります。この特典に関連付けられた保留中の注文はいずれも解約されます。この状態遷移は予約購入に固有です。
deactivateOneTimeProductOfferRequest

object (DeactivateOneTimeProductOfferRequest)

特典を無効にします。無効化されると、特典はユーザーに提供されなくなります。この状態遷移は割引特典に固有です。

CancelOneTimeProductOfferRequest

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

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

string

必須。キャンセルする特典の親アプリ（パッケージ名）。
productId

string

必須。キャンセルする特典の親 1 回限りのアイテム（ID）。
purchaseOptionId

string

必須。キャンセルする特典の親購入オプション（ID）。
offerId

string

必須。解約する特典の特典 ID。
latencyTolerance

enum (ProductUpdateLatencyTolerance)

省略可。この更新の伝播に関する遅延の影響度。デフォルトは latency-sensitive です。

DeactivateOneTimeProductOfferRequest

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

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

string

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

string

必須。無効にする特典の 1 回限りの親アイテム（ID）。
purchaseOptionId

string

必須。無効にする特典の親購入オプション（ID）。
offerId

string

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

enum (ProductUpdateLatencyTolerance)

省略可。この更新の伝播に関する遅延の影響度。デフォルトは latency-sensitive です。