構造体

Message

あなたのアプリで App Store メッセージを受信して表示するためのインスタンス。

iOS 16.0+ iPadOS 16.0+ Mac Catalyst 16.0+ visionOS 1.0+

struct Message

以下で言及

あなたのアプリ内での販売による再獲得提供

サンドボックス環境での再獲得提供のテスト

サブスクリプションの更新とアプリ内購入の失敗をテストする

アプリ内購入用の StoreKit APIの選択
(Choosing a StoreKit API for In-App Purchases)

概観

StoreKit メッセージは、App Store からの重要な情報をあなたのアプリ上に表示するシートです。メッセージには理由があり、その理由は reason 値で示されます。StoreKit はあなたのアプリが起動するたびに App Store からメッセージを取得し、デフォルトで表示します。

注意

StoreKit は、あなたのアプリのビルドに使用した SDK のバージョンに関係なく、App Store からのメッセージを表示します。iOS 16 以降向けにビルドされたアプリでは、メッセージリスナーを実装して、メッセージを遅延または抑制できます。

Message API を使用すると、メッセージを遅延または抑制することで、メッセージの表示を制御できます。あなたのアプリは非同期シーケンス messages でメッセージを注目し、display(in:)、または SwiftUI ビューの場合は DisplayMessageAction を呼び出すことで、特定のタイミングでメッセージを表示できます。例えば、オンボーディングフローの途中など、シートが割り込んでくるとユーザーを混乱させる可能性があるビューや、アプリがリアルタイムの指示を提供している場合など、メッセージを遅延させることができます。

StoreKit は、メッセージがまだ関連性がある場合にのみメッセージシートを表示します。例えば、display(in:) を呼び出す前にユーザーがアプリ外で問題を解決した場合、StoreKit はメッセージを表示しません。アプリがメッセージを複数回表示するように要求した場合でも、StoreKit は各メッセージを 1 回だけ表示します。

メッセージに注目して表示する

App Store メッセージを延期または抑制したい場合は、あなたのアプリの起動時にアプリ内でメッセージリスナーを設定します。

メッセージの表示タイミングを制御するには、あなたのアプリが StoreKit にメッセージを表示させる準備ができたら、display(in:) または DisplayMessageAction を呼び出します。あなたのアプリがメッセージを注目した後にこれらの API のいずれかを呼び出さない場合、メッセージを抑制されます。以下は UIKit を使用するアプリの例です。

// Listen for App Store messages.
for await message in StoreKit.Message.messages {
    // Call display on the message when the app is ready.
}

// Indicate the app is ready to display the message.
guard let windowScene = self.view.window?.windowScene else {
    fatalError("Could not get window scene.")
}
try? message.display(in: windowScene)