- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- UpdateSubscriptionOfferStateRequest
- ActivateSubscriptionOfferRequest
- DeactivateSubscriptionOfferRequest
- 試してみる
定期購読のオファーの状態をバッチで更新します。
ネストされたリクエストの 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 |
必須。更新された定期購入オファーの親アプリ(パッケージ名)。 更新されたすべての SubscriptionOffer リソースの packageName フィールドと同じにする必要があります。 |
productId |
必須。更新されたオファーがすべて同じ定期購入に属している場合、親定期購入のアイテム ID。このリクエストが複数のサブスクリプションにまたがっている場合は、このフィールドを「-」に設定し、設定する必要があります。 |
basePlanId |
必須。更新対象の特典の親基本プラン(ID)。「-」を指定した場合、複数の基本プランの特典を更新できます。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"requests": [
{
object ( |
フィールド | |
---|---|
requests[] |
必須。最大 100 個の要素を含む更新リクエストのリスト。すべてのリクエストで、異なる特典を更新する必要があります。 |
レスポンスの本文
Offer.batchUpdateStates に対するレスポンス メッセージ。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"subscriptionOffers": [
{
object ( |
フィールド | |
---|---|
subscriptionOffers[] |
更新された購読オファーのリスト。 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/androidpublisher
UpdateSubscriptionOfferStateRequest
定期購読オファーの状態を更新するためのリクエスト メッセージ。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド state_transition_type 。適用する状態遷移のタイプ。1 つだけ設定する必要があります。state_transition_type は次のいずれかになります。 |
|
activateSubscriptionOfferRequest |
特典を有効にします。有効になると、新しい定期購入者が特典を利用できるようになります。 |
deactivateSubscriptionOfferRequest |
特典を無効にします。無効にすると、新しい定期購入者は特典を利用できなくなりますが、既存の定期購入者は引き続き定期購入できます |
ActivateSubscriptionOfferRequest
ActivateSubscriptionOffer に対するリクエスト メッセージ。
JSON 表現 |
---|
{
"packageName": string,
"productId": string,
"basePlanId": string,
"offerId": string,
"latencyTolerance": enum ( |
フィールド | |
---|---|
packageName |
必須。有効化する特典の親アプリ(パッケージ名)。 |
productId |
必須。有効化するオファーの親定期購入(ID)。 |
basePlanId |
必須。有効にする特典の親基本プラン(ID)。 |
offerId |
必須。有効にするオファーの一意のオファー ID。 |
latencyTolerance |
(省略可)このプロダクトの更新の伝播の許容範囲。デフォルトでは、レイテンシの影響を受けやすい値に設定されます。 |
DeactivateSubscriptionOfferRequest
offers.deactivate に対するリクエスト メッセージ。
JSON 表現 |
---|
{
"packageName": string,
"productId": string,
"basePlanId": string,
"offerId": string,
"latencyTolerance": enum ( |
フィールド | |
---|---|
packageName |
必須。無効にする特典の親アプリ(パッケージ名)。 |
productId |
必須。無効にする商品の親定期購入(ID)。 |
basePlanId |
必須。無効にする特典の親基本プラン(ID)。 |
offerId |
必須。無効にするオファーの一意のオファー ID。 |
latencyTolerance |
(省略可)このプロダクトの更新の伝播の許容範囲。デフォルトでは、レイテンシの影響を受けやすい値に設定されます。 |