型

notificationType

App Store がバージョン 2 通知を送信するアプリ内購入または外部購入イベントを記述する型。

App Store Server Notifications 2.0+

string notificationType

可能な値

CONSUMPTION_REQUEST

消耗品アプリ内購入または自動更新サブスクリプションの払い戻し要求を顧客が開始し、App Store が消費データをあなたが提供する事を要求していることを示す通知型です。詳しくは、消費情報を送信をご覧ください。

DID_CHANGE_RENEWAL_PREF

顧客がサブスクリプションプランを変更したことを示す通知型とその subtype。subtype が UPGRADE の場合、ユーザはサブスクリプションをアップグレードしました。アップグレードは直ちに有効になり、新しい課金期間が開始され、ユーザは以前の期間の未使用分について日割り計算された払い戻しを受け取ります。subtype が DOWNGRADE の場合、顧客はサブスクリプションをダウングレードしました。ダウングレードは次回の更新日に有効になり、現在有効なプランには影響しません。

subtype が空の場合、ユーザは更新設定を現在のサブスクリプションに戻しました。これは、ダウングレードがキャンセルされたことを意味します。

サブスクリプションレベルの詳細については、グループ内でのサブスクリプションのランク付けを参照してください。

DID_CHANGE_RENEWAL_STATUS

顧客がサブスクリプションの更新ステータスを変更したことを示す通知型とその subtype。subtype が AUTO_RENEW_ENABLED の場合、顧客はサブスクリプションの自動更新を再度有効にしました。subtype が AUTO_RENEW_DISABLED の場合、顧客がサブスクリプションの自動更新を無効にしたか、顧客が払い戻しを要求した後に App Store がサブスクリプションの自動更新を無効にしました。

DID_FAIL_TO_RENEW

課金の問題によりサブスクリプションの更新に失敗したことを示す通知型と subtype です。サブスクリプションは課金の再試行期間に入ります。subtype が GRACE_PERIOD の場合、猶予期間中もサービスの提供を継続します。subtype が空の場合、サブスクリプションは猶予期間中ではないため、サブスクリプションサービスの提供をあなたは停止できます。

顧客に、課金情報に問題がある可能性があることをお伝えください。App Store は、顧客が課金の問題を解決するか、サブスクリプションをキャンセルするまで、または 60 日間（いずれか早い方）請求を再試行します。詳しくは、不本意なサブスクライバーの解約の削減 (Reducing Involuntary Subscriber Churn) をご覧ください。

DID_RENEW

サブスクリプションが正常に更新されたことを示す通知型とその subtype。subtype が BILLING_RECOVERY の場合、以前更新に失敗した期限切れのサブスクリプションが正常に更新されたことを示します。subtype が空の場合、アクティブなサブスクリプションが新しい取引期間に自動更新されたことを示します。顧客にサブスクリプションのコンテンツまたはサービスへのアクセスを提供します。

EXPIRED

サブスクリプションの有効期限が切れたことを示す通知型とその subtype。subtype が VOLUNTARY の場合、ユーザがサブスクリプションの更新を無効にした後にサブスクリプションが期限切れになったことを示します。subtype が BILLING_RETRY の場合、課金取引が成功せずに課金再試行期間が終了したため、サブスクリプションが期限切れになったことを示します。subtype が PRICE_INCREASE の場合、顧客の同意が必要な価格引き上げに顧客が同意しなかったため、サブスクリプションが期限切れになったことを示します。subtype が PRODUCT_NOT_FOR_SALE の場合、サブスクリプションの更新を試みたときに製品が購入できなかったため、サブスクリプションが期限切れになったことを示します。

subtype のない通知は、他の何らかの理由でサブスクリプションが期限切れになったことを示します。

EXTERNAL_PURCHASE_TOKEN

subtype UNREPORTED と共に、Apple があなたのアプリの外部購入トークンを作成したが、レポートを受け取っていないことを示す通知タイプです。トークンのレポートの詳細については、externalPurchaseToken を参照してください。

この通知は、外部での購入 (External Purchase) を使用して代替支払いオプションを提供するアプリにのみ適用されます。

GRACE_PERIOD_EXPIRED

サブスクリプションが更新されずに課金猶予期間が終了したことを湿す通知型です。これにより、サービスまたはコンテンツへのアクセスを停止できます。顧客に、課金情報に問題がある可能性があることをお知らせします。App Store は、60日間、または顧客が課金の問題を解決するかサブスクリプションをキャンセルするまで（いずれか早い方）課金を再試行し続けます。詳しくは、不本意なサブスクライバーの解約の削減 (Reducing Involuntary Subscriber Churn) をご覧ください。

METADATA_UPDATE

サブスクリプションメタデータ変更 (Change Subscription Metadata) エンドポイントを使用してサブスクリプションのメタデータを変更したことを示す通知型です。この通知は、Advanced Commerce API を使用するアプリにのみ適用されます。

MIGRATION

サブスクリプションを Advanced Commerce API に移行 (Migrate a Subscription to Advanced Commerce API) エンドポイントをあなたが使用したことを示す通知型です。この通知は、Advanced Commerce API を使用するアプリにのみ適用されます。

OFFER_REDEEMED

アクティブなサブスクリプションを持つ顧客がサブスクリプションオファーを利用したことを示す通知型とその subtype。

subtype が UPGRADE の場合、顧客はアクティブなサブスクリプションをアップグレードするオファーを利用しました。このオファーは即時に有効になります。サブタイプが DOWNGRADE の場合、顧客はアクティブなサブスクリプションをダウングレードするオファーを利用しました。このオファーは次回の更新日に有効になります。顧客がアクティブなサブスクリプションのオファーを利用した場合は、subtype のない OFFER_REDEEMED 通知型をあなたは受信します。

サブスクリプションオファーコードの詳細については、あなたのアプリでサブスクリプション提供コードをサポート (Supporting subscription offer codes in your app) をご覧ください。販売促進オファーの詳細については、あなたのアプリに販売促進オファーを実装する (Implementing promotional offers in your app) をご覧ください。

ONE_TIME_CHARGE

ONE_TIME_CHARGE 通知は現在、サンドボックス環境でのみ利用可能です。

顧客が消耗品、非消耗品、または非更新サブスクリプションを購入したことを示す通知型です。App Store は、顧客が家族間共有を通じて非消耗品製品へのアクセスを受けた場合にも、この通知を送信します。

自動更新サブスクリプションの購入に関する通知については、SUBSCRIBED 通知型をご覧ください。

PRICE_CHANGE

サブスクリプション価格変更 (Change Subscription Price) エンドポイントをあなたが呼び出したことを示す通知型です。この通知は、Advanced Commerce API を使用するアプリにのみ適用されます。

PRICE_INCREASE

自動更新サブスクリプションの価格引き上げについてシステムが顧客に通知したことを示す通知型とその subtype。

価格引き上げに顧客の同意が必要な場合、顧客が価格引き上げに応答していない場合は subtype は PENDING で、顧客が価格引き上げに同意している場合は ACCEPTED になります。

価格引き上げに顧客の同意が不要な場合、subtype は ACCEPTED になります。

顧客の同意が必要なサブスクリプション価格の引き上げについて、システムが価格同意シートを表示する前にあなたのアプリを呼び出す方法については、paymentQueueShouldShowPriceConsent(_:) を参照してください。サブスクリプション価格の管理については、自動更新サブスクリプションの価格上昇の管理
(Managing Price Increases for Auto-Renewable Subscriptions) および価格の管理を参照してください。

REFUND

App Store が消耗品アプリ内購入、非消耗品アプリ内購入、自動更新サブスクリプション、または非更新サブスクリプションの取引の払い戻しを正常に処理したことを示す通知型です。 revocationDate には、払い戻しされた取引のタイムスタンプが含まれます。originalTransactionId と productId は、元の取引と製品を識別します。revocationReason には、理由が含まれます。

顧客の払い戻し済み取引の一覧を要求するには、App Store Server API の 払い戻し履歴の取得 (Get Refund History) を参照してください。

REFUND_DECLINED

App Store が払い戻し要求を拒否したことを示す通知型。

REFUND_REVERSED

顧客からの異議申し立てにより、App Store が以前に承認した払い戻しを取り消したことを示す通知型です。関連する払い戻しの結果としてあなたのアプリがコンテンツまたはサービスを取り消した場合は、それらを元に戻す必要があります。

この通知型は、消耗品、非消耗品、非更新サブスクリプション、自動更新サブスクリプションなど、あらゆるアプリ内購入型に適用できます。自動更新サブスクリプションの場合、App Store が払い戻しを取り消しても更新日は変更されません。

RENEWAL_EXTENDED

App Store が特定のサブスクリプションの更新日を延長したことを示す通知型です。サブスクリプション更新日の延長を要求するには、App Store Server API のサブスクリプション更新日を延長またはすべてのアクティブな加入者のサブスクリプション更新日を延長を呼び出して下さい。

RENEWAL_EXTENSION

App Store がすべてのアクティブな加入者のサブスクリプション更新日を延長するを呼び出して、要求されたサブスクリプション更新日を延長しようとしていることを示す通知型とそのサブタイプ。

サブタイプが SUMMARY の場合、App Store はすべての対象サブスクライバーの更新日延長を完了しています。詳細は responseBodyV2DecodedPayload の summary をご覧ください。サブタイプが FAILURE の場合、特定のサブスクリプションの更新日延長は成功しませんでした。詳細は responseBodyV2DecodedPayload のデータをご覧ください。

REVOKE

家族間共有を通じて顧客が利用できた App 内課金が、共有できなくなったことを示す通知型です。購入者が購入時に家族間共有を無効にした場合、購入者（または家族のメンバー）が家族のグループから脱退した場合、または購入者が払い戻しを受けた場合、App Store はこの通知を送信します。また、AppはpaymentQueue(_:didRevokeEntitlementsForProductIdentifiers:) 呼び出しも受け取ります。家族間共有は、非消耗品 App 内課金と自動更新サブスクリプションに適用されます。家族間共有の詳細については、あなたの App で家族間共有をサポートするを参照してください。

SUBSCRIBED

顧客が自動更新サブスクリプションに加入したことを示す通知型とそのサブタイプ。サブタイプが INITIAL_BUY の場合、顧客は初めてサブスクリプションを購入したか、家族間共有を通じてアクセスを取得したことになります。サブタイプが RESUBSCRIBE の場合、ユーザは同じサブスクリプションまたは同じサブスクリプショングループ内の別のサブスクリプションに再加入したか、家族間共有を通じてアクセスを取得したことになります。

他の製品型の購入に関する通知については、ONE_TIME_CHARGE 通知型を参照してください。

TEST

テスト通知の要求エンドポイントを呼び出してあなたが要求すると、App Store サーバから送信される通知型です。このエンドポイントを呼び出して、あなたのサーバが通知を受信しているかどうかをテストしてください。この通知は要求に応じてのみ受信されます。トラブルシューティング情報については、テスト通知状況の取得エンドポイントをご覧ください。

以下で言及

App Store サーバー通知の変更履歴

App Store サーバー通知の有効化

議論

notificationType は通知ペイロード responseBodyV2DecodedPayload に出現します。これは通知のきっかけとなったイベントを表します。一部の通知には、イベントの詳細を表す subtype も存在します。data、summary、または externalPurchaseToken オブジェクト内の通知の詳細については、responseBodyV2DecodedPayload を参照してください。

アプリ内購入ライフサイクルイベントの使用ケースを処理

顧客のアプリ内購入およびサブスクリプションのライフサイクルに影響を与えるイベントが発生すると、App Store サーバから通知があなたに送信されます。以下の表は、ライフサイクルイベントごとの通知の一覧です。

消耗品、非消耗品、または非更新型サブスクリプションのアプリ内購入のサービスを有効にするイベントが発生すると、以下の通知が送信されます。これらの通知は現在、サンドボックス環境でのみ利用可能です。

イベント	通知型	通知サブタイプ
顧客は消耗品、非消耗品、または更新されないサブスクリプションを購入します。	ONE_TIME _CHARGE
顧客は、家族間共有を通じて非消耗品のアプリ内購入にアクセスできるようになります。	ONE_TIME _CHARGE

初回のサブスクリプション、再度のサブスクリプション、自動更新の成功など、サブスクリプションのサービスを有効にするイベントが発生すると、以下の通知が生成されます。

イベント	通知型	通知サブタイプ
顧客がサブスクリプショングループ内のいずれかのサブスクリプションに初めて登録します。	SUBSCRIBED	INITIAL_BUY
顧客は、期限切れのサブスクリプションと同じサブスクリプショングループ内の任意のサブスクリプションに再サブスクライブします。	SUBSCRIBED	RESUBSCRIBE
サブスクリプションはうまく自動更新されました。	DID_RENEW
家族のメンバーは、初めてサブスクリプションを購入した後、家族間共有を通じてサブスクリプションにアクセスできるようになります。	SUBSCRIBED	INITIAL_BUY
購入者が再加入すると、家族のメンバーは家族間共有を通じてサブスクリプションにアクセスできるようになります。	SUBSCRIBED	RESUBSCRIBE

アップグレード、ダウングレード、キャンセルなど、サブスクリプションのオプションを変更する顧客に対して、以下の通知が送信されます。

イベント	通知型	通知サブタイプ
顧客は同じサブスクリプショングループ内のサブスクリプションをダウングレードします。	DID_CHANGE _RENEWAL_PREF	DOWNGRADE
顧客は以前のサブスクリプションに戻り、ダウングレードを事実上キャンセルします。	DID_CHANGE _RENEWAL_PREF
顧客は同じサブスクリプショングループ内のサブスクリプションをアップグレードします。	DID_CHANGE _RENEWAL_PREF	UPGRADE
顧客は、App Store のサブスクリプション設定ページからサブスクリプションをキャンセルします。	DID_CHANGE _RENEWAL_STATUS	AUTO_RENEW _DISABLED
顧客はサブスクリプションをキャンセルした後に再度サブスクリプションを申し込むと、自動更新が再度有効になります。	DID_CHANGE _RENEWAL_STATUS	AUTO_RENEW _ENABLED
顧客が払い戻し要求 API を使用してあなたのアプリを通じて払い戻しを開始したため、システムによって自動更新が無効になりました。	DID_CHANGE _RENEWAL_STATUS	AUTO_RENEW _DISABLED

販売促進オファー、オファーコード、再獲得提供オファーなどのサブスクリプションオファーを利用する顧客には、以下の通知が送信されます。

イベント	通知型	通知サブタイプ
顧客は販売促進オファーまたはオファーコードを利用して、アクティブなサブスクリプションを取得します。	OFFER _REDEEMED
顧客はオファーコードを利用して初めてサブスクライブします。	SUBSCRIBED	INITIAL_BUY
顧客は、サブスクリプションの有効期限が切れた後に、販売促進オファー、オファーコード、または再獲得提供オファーを利用します。	SUBSCRIBED	RESUBSCRIBE
顧客は販売促進オファーまたはオファーコードを利用して、サブスクリプションをアップグレードします。	OFFER _REDEEMED	UPGRADE
顧客は販売促進オファーを利用して、サブスクリプションをダウングレードします。	OFFER _REDEEMED	DOWNGRADE

課金の再試行、課金猶予期間の開始と終了、サブスクリプションの有効期限などの課金イベントが発生すると、以下の通知が送信されます。

イベント	通知型	通知サブタイプ
顧客がキャンセルを選択したため、サブスクリプションは期限切れになります。	EXPIRED	VOLUNTARY
開発者がサブスクリプションの販売を削除し、更新に失敗したため、サブスクリプションの有効期限が切れます。	EXPIRED	PRODUCT_NOT_FOR _SALE
サブスクリプションが回復されずに課金再試行期間が終了したため、サブスクリプションは期限切れになります。	EXPIRED	BILLING_RETRY
サブスクリプションの更新に失敗し、課金の再試行期間に入ります。	DID_FAIL_TO _RENEW
サブスクリプションの更新に失敗し、課金猶予期間が有効になっている課金再試行期間に入ります。	DID_FAIL_TO _RENEW	GRACE_PERIOD
課金の再試行により、サブスクリプションが正常に回復しました。	DID_RENEW	BILLING _RECOVERY
サブスクリプションの課金猶予期間が終了します (課金の再試行が継続します)。	GRACE_PERIOD _EXPIRED

自動更新サブスクリプションの価格を上げるときに発生するイベントまたは通知は以下のとおりです。

イベント	通知型	通知サブタイプ
システムは、顧客の同意が必要となる自動更新サブスクリプションの価格引き上げについて顧客に通知しますが、顧客は応答しません。	PRICE_INCREASE	PENDING
同意が必要な価格の値上げに顧客が同意しなかったため、自動更新サブスクリプションの有効期限が切れます。	EXPIRED	PRICE _INCREASE
顧客は、同意が必要となる自動更新サブスクリプションの価格引き上げに同意します。	PRICE_INCREASE	ACCEPTED
システムは、顧客の同意を必要としない自動更新サブスクリプションの価格上昇を顧客に通知します。	PRICE_INCREASE	ACCEPTED
顧客は、価格値上げの通知または価格値上げへの同意要求を受け取った後にサブスクリプションをキャンセルしました。	DID_CHANGE _RENEWAL_STATUS

払い戻しを要求したり、家族間共有をキャンセルしたりする顧客には、以下の通知が届きます。

イベント	通知型	通知サブタイプ
Apple は、消耗品または非消耗品のアプリ内購入、非更新型サブスクリプション、または自動更新型サブスクリプションの取引を払い戻します。	REFUND
Apple は、顧客が提起した異議により、以前に承認した払い戻しを取り消します。	REFUND _REVERSED
Apple は、払い戻し要求 API を使用して顧客がアプリ内で開始した払い戻しを拒否します。	REFUND _DECLINED
Apple は、顧客が開始した払い戻し要求の消費情報を要求します。	CONSUMPTION _REQUEST
家族間共有を通じて、家族メンバーがサブスクリプションにアクセスできなくなります。	REVOKE

開発者がサブスクリプション更新日の延長を要求すると、以下の通知が送信されます。

イベント	通知型	通知サブタイプ
App Store は、特定のサブスクリプションの更新日を正常に延長しました。	RENEWAL _EXTENDED
App Store は、対象となるすべての加入者に対してサブスクリプションの更新日を延長することを正常に完了しました。	RENEWAL _EXTENSION	SUMMARY
App Store は、特定の加入者のサブスクリプション更新日を延長できませんでした。	RENEWAL _EXTENSION	FAILURE