App IntentによるAppショートカットの実装

App IntentによるAppショートカットの実装

ユーザによる設定なしで、みなさんのアプリのショートカットを作成する方法をご確認ください。App Intentでカスタムのショートカットビューを表示する方法や、パラメーター化されたフレーズのサポートを追加して、ユーザの思い通りに素早く意図を表現する方法を紹介します。また、Siri Tipやショートカットリンクを使用して、Appショートカットを見つけやすくする方法も紹介します。このセッションを最大限活かしていただくためには、SwiftUIに関する基本的な知識を習得されていることが推奨されます。

リソース
- App Intents
- - HDビデオ
  - SDビデオ
関連ビデオ

Tech Talks
- エンタープライズデベロッパ向けの最新情報
- カスタムインテントのApp Intentへの移行
WWDC22
- アプリショートカットのデザイン
- Appインテントの詳細
ダウンロード

♪ 落ち着いた雰囲気のヒップホップ音楽 ♪ ♪ こんにちは Michael Sumnerです Siri とApp Intentのソフトウェアエンジニアですこのセッションでは新しいApp Intents フレームワークを使いアプリショートカットを作成する方法を説明します最初にショートカットの概要と App Intentとの関連性を説明します次に Swift を使用してアプリショートカットを作成しパラメータを追加する方法をお見せします最後にユーザーがあなたの努力から利点を得られるようアプリショートカットを発見可能にする方法を説明しますではApp Intents フレームワークとアプリショートカットから始めましょうユーザーはショートカットアプリや Siriから使用可能なみなさんのアプリを利用した複数ステップのワークフローを作成するためにショートカットを使用しますこれまでは Intentを使用可能にするために「Siriに追加」ボタンによる設定かショートカットアプリでの設定が必要がありましたそこでユーザー設定がまったく不要な新しいアプリショートカットを発表しますこれでユーザーがみなさんのショートカットからメリットを得やすくなりますアプリショートカットをサポートすることでアプリで定義されたIntentはアプリがインストールされた直後から利用可能になりますこれによりユーザーはみなさんのアプリの機能を発見・使用しやすくなります何かを設定するためにショートカットアプリや「Siri に追加」ボタンを使用する必要はなくなりますユーザーが構築するショートカットのようにショートカットアプリ Spotlight Siri で実行できますこれでユーザーは複数の方法でシステム内の異なる場所からアプリを発見しやりとりすることができます例えば Spotlightで検索する場合検索結果にアプリショートカットが表示されアクセスしやすくなりますアプリショートカットを実装することでユーザーはみなさんのアプリですばやく軽いやりとりをしてタスクを完了し目的の達成へと向かいやすくなります私のチームは一連の音声によるガイドやサウンドを使いユーザーが瞑想し重要なことに集中するのに役立つ「Mediation」というアプリを作成しています現在瞑想を始めるにはユーザーはアプリを起動しログインして実施する瞑想セッションを検索しますアプリショートカットとサポートすればユーザーは Siri にリクエストするだけでどこからでもアプリにアクセスできるようになりますセッションをすばやく開始することでユーザーは朝の仕事前や長い１日の緊張をほぐすため夕方に瞑想することを日常生活の一部に取り入れることができますでは App Intentを作成しそれをアプリショートカットにするために必要なコードについて説明します以前のショートカットとは異なりアプリショートカットは新しい App Intents フレームワークで構築します App Intentsフレームワークは優れたIntentをすばやく簡単に構築するための一から構築された Swiftオンリーの新しいフレームワークです App Intentではすべてが Swiftのソースコードで定義でき別のメタデータファイルは必要ありませんこれはすべてのコード生成手順を省略できソースエディタとメタデータエディタの間でコンテキストを切り替える必要がなく集中しやすくなりコードのレビューやマージの競合の解決も行いやすくなりますアプリショートカットを構築するには App Intentを本格的なショートカットに変えるのに必要なフレーズや他のメタデータをリストする AppShortcutsProviderを書く必要がありますここで注意が必要なのはアプリショートカットはユーザーインタラクションなしで設定されるためトリガーフレーズにアプリ名を含む必要がある点です Intentは AppIntentプロトコルを実装した Swiftの構造体で定義されます基本のIntentの要件は２つだけショートカットアプリに表示されるタイトルと performと呼ばれるメソッドです performメソッドにて Intentのロジックを実装し結果を戻すようにしますさらにユーザーにプロンプトを出しレスポンスを待つこともできますこのIntentではアプリの MeditationServiceでデフォルトの瞑想セッションを始めます performメソッドは非同期のため非同期コードを実行しセッションを開始できますセッションが開始したらユーザーに表示されるダイアログを戻しますアプリがローカライズされている場合すべての地域でこの文字列をローカライズしますここまでの構築によってショートカットを設定しようとすると StartMeditationIntentがショートカットアプリに現れますやる気のあるユーザーはこのIntentを使用しセッションを開始するためのショートカットを作成できますこのショートカットでは２つ目のIntentを作成し「集中」を有効にしますデフォルトでは Intentはソースコードで指定したタイトルでレンダリングされますアクションのレンダリングをカスタマイズするには App Intentにパラメータサマリを追加しますパラメータサマリでは Intentの見た目をカスタマイズできインラインで値を表示しますこのIntentはショートカットになりますがユーザーがショートカットの設定なしで Intentを実行できるのが理想的ですアプリショートカットを作成すればこの設定手順をユーザーの代わりに行うことができユーザーはアプリをインストールした途端に私のIntentを使用できるようになりますでは Intentを書いたところでアプリショートカットを作成しましょう Intentと同様に App Intentも AppShortcutsProvider プロトコルを実装して Swiftコードで定義しますプロトコルを実装するにはユーザーのために設定したいすべてのショートカットを返す単一のゲッタを作成するだけですみなさんのアプリにおいて最大10件のアプリショートカットを持たせることができますしかしほとんどのアプリは数件必要なだけでしょう StartMeditationIntent 用に単一の AppShortcut を作成します始めにIntentのインスタンスを渡しますイニシャライザにパラメータが必要な場合はここで値を指定します次に Siri からアプリショートカットを起動する一連のフレーズを作成します文字列に直接アプリ名を入力する代わりに特別な.applicationName トークンを使用しますこれにより Siri はアプリのメイン名に加え構成したアプリ名のシノニムを挿入できますユーザーは異なるフレーズを使って瞑想を起動するため代替のフレーズをもう少し追加しますアプリがローカライズされているならこれらのフレーズもローカライズしてください
完了しました　これでユーザーが瞑想を始める時 Siri に「瞑想をスタート」と言えばアプリが起動します Siri は StartMeditationIntentをコールし私が返したダイアログを読み上げますまた誰かが Spotlightで私のアプリを検索すると私がコードに記載した最初のショートカットが表示されますユーザーが結果をタップするとアプリを起動せずにショートカットがすぐに実行されますただしIntentがアプリの起動をトリガーする場合 Spotlightには表示されませんのでご注意くださいこれだけのコードでユーザーが私のアプリで瞑想するのが非常に簡単になりましたしかしこのままでは Intentを実行すると Siri はデフォルトのビューを表示しますこれでも構いませんがユーザーがショートカットを実行した場合に詳細な情報を表示したいとしますそれには Intentを実行した際に Siri がそれを表示するようカスタムビューの実装が必要です App Intentsフレームワークのビューは SwiftUI で構築されウィジェットと同じ技術を使用するためカスタムビューのために別の UI Extension を使用する必要はありません代わりに Intentを実行する際にビューを返すだけですビューにもたらされる特定の制約について意識することが重要ですウィジェット同様にこのカスタマイズされたビューはインタラクティビティやアニメーションを含むことはできません UIをデザインする際にこの事を忘れないでください Intentでは３つのフェーズでカスタム UI を表示できます値の確認フェーズ Intentの確認フェーズ Intent終了後です私のアプリでは Intent実行終了時にカスタムビューを返します他のプロンプトを使用する場合はこれらのフェーズでカスタム UI をサポートする方法も必ず考慮しましょう先述のようにカスタム UI の表示は簡単です Intentからビューを返すだけですではコードに移りましょうカスタムビューの追加は簡単ですダイアログと共にビューを返します App Intentsフレームワークは Siriスニペット内でビューを提示しますこのビューはスニペットのタイトルや確認ボタンなど他の Siriのビューと一緒に表示されることを忘れないでくださいそのためスニペットが Siriの中でホームであるように感じられるデザインをします次はアプリショートカットを拡張しパラメータを含める方法をお見せします前回の実装ではデフォルトの瞑想の開始を選択しましたがアプリにはすばらしいセッションが他にも多くありユーザーは特定のセッションを開始したい場合が考えられますユーザーが私のIntentを実行した場合にセッションを指定できるのが理想的ですこのユースケースに対応するためにはユーザーが実行したいセッションを取得するパラメータを追加して Intentを拡張しますパラメータを追加するにはまずパラメータの型を定義しますセッションの関する情報がある MeditationSession 構造体を作成します名前を含み identifier フィールドを提供しますこれを UUID にすることができますこの構造体をIntentのパラメータとして使うには AppEntityプロトコルを実装する必要もあります AppEntityプロトコルを実装すると App Intentsフレームワークに独自の型を伝えエンティティの表示方法など追加の情報を指定することができますエンティティプロトコルでは型に対する識別子が必要ですがここではすでに提供しています整数や文字列など他の型も使用できますエンティティの表示方法について情報を提供する必要もありますこれはエンティティが表示されるショートカットアプリやその他の場所で使用されます最後にデフォルトクエリをつなげる必要がありますクエリ名は MeditationSessionQuery これを次に実装します App Intentsフレームワークがエンティティと連動するにはエンティティの識別子に基づいて検索できる必要がありますこれを可能にするために EntityQuery プロトコルは次の１つの要件を定義します識別子を使い一致するエンティティを返す関数です SessionManagerでこのセッションを検索しこの関数を実装します StartMeditationIntentを更新してパラメータを追加しますパラメータは簡単です構造体の通常のプロパティですしかしApp Intentにパラメータを伝えるには @Parameter Property Wrapperの追加が必要ですこのProperty Wrapper は App Intentにセッションプロパティが Intentの一部だと伝え表示名など追加のメタデータを @Parameter Property Wrapper で指定できますパラメータプロパティを Intentに追加したらどのセッションを実行するかユーザーに聞く必要があります App Intents フレームワークには Intentのパラメータの値を得るためにユーザーに補足の質問ができる堅牢なサポートがありますこれらの指示はIntentが実行される場所で表示され Siri から実行される場合であれば Siri が質問を読み上げユーザーは答えを言うように指示されます Spotlight とショートカットアプリではユーザーはタッチドリブンなUIで同じプロンプトが出ます App Intentに対応する値を得るプロンプトは３つ曖昧性解消はリストからの選択を指示します曖昧性解消は Intentのパラメータが一定のオプションに限定される場合に最適です値のプロンプトでは制限のない値をユーザーに聞くことができますこれは任意の値を使用できる文字列や整数に最適です最後に確認はユーザーに特定の値の確認を要求しユーザーがIntentを理解していることを再確認するのに最適です値のためのプロンプトは Intentの柔軟性を高めユーザーからより多くの情報を得るのにすばらしい方法ですしかし会話の速度を下げ頻繁に使用するとユーザーが苛立つ場合があります優れたIntentの作成の詳細については Lynnによる『アプリショートカットのデザイン』をご覧くださいではセッションパラメータを StartMeditationIntentに追加したところで performメソッドにロジックを追加してこの値をプロンプトします私のアプリにはユーザーが実行できる一定数のセッションがありますセッションがまだ指定されていない場合 SessionManagerからリストを取得しユーザーに曖昧性解消を示します各セッションにDisplay Representationを使用すると App Intentはセッションをリスト項目にしユーザーに表示しますユーザーが１つ選択すると選択した項目が戻されます選択されたセッションが MeditationServiceに渡されセッションが開始します次にユーザーに Intentが開始したことを知らせるダイアログを返しますユーザーがセッションを渡したのでダイアログにセッション名を表示しリクエストを把握したことを知らせるのがよいでしょう今ユーザーが「瞑想をスタート」と言っていますアプリはユーザーが開始したいセッションに移動しますただし先述のようにユーザーはすばやく明確な Siri とのやりとりを望み理想的には補足的な質問ではなく初期の段階でユーザーが好みのセッションを伝えられることが好ましいですここでいいニュースがありますアプリショートカットは事前定義されたパラメータでトリガーフレーズを拡張することができますパラメータ化されたフレーズの実装によりアプリは「落ち着く瞑想をスタート」や「歩く瞑想をスタート」などの発言に対応することができますパラメータは Siri に事前に指定できる一定数の決まったパラメータ値がある場合に役立ちます私のアプリではセッション名を使用しますパラメータは制限なしの値で使用するものではありません例えば最初の語りかけでユーザーから任意の文字列を収集することはできませんそのためアプリは Xがユーザーの任意の入力となる場合「Xの日記を検索」などの語りかけに対応することはできませんアプリの実行中より前のタイミングでパラメータ値を事前に指定する必要があります。パラメータ化されたフレーズを実装してみましょうアプリでこれを行う場合いくつかの変更を行う必要がありますまず suggestedResults() メソッドを実行しショートカットにエンティティのリストを返すためにSessionEntityのクエリを更新します次にApp Intents フレームワークに SessionEntitiesが変更したことを伝えますこれによりApp Intents フレームワークは Siri で使用される新しいフレーズを作成しますこれを行うにはアプリのモデルレイヤを更新しセッションリストが変更されるたびに App Intentsフレームワークに通知されるよう設定します最後に StartMeditationIntentでセッションパラメータを参照するアプリショートカットに新しいフレーズをいくつか追加しますまず suggestedEntities 関数を実装し MeditationSessionQueryを更新します App Intentsフレームワークは関数から戻されたセッションでパラメータ化されたショートカットを作成しますこのメソッドはオプショナルでしてこのメソッドを実装しない場合パラメータ化されたショートカットは利用できませんまたセッションのリストが変更された場合それを App Intentsフレームワークにそれを知らせるためにアプリのモデルレイヤを更新する必要がありますここではバックグラウンドでサーバから取得した新しいセッションタイプを不定期に公開しています SessionModelを更新して新しいセッションを受信するたびに update AppShortcutParameters()を呼び出しますこれはApp Intents フレームワークが提供し自身で実装する必要はなく App Intentはエンティティのクエリを呼び出しショートカットフレーズのパラメータを収集します最後にアプリショートカットに Intentのセッションキーパスを含む新しいフレーズを追加しますフレームワークはこのフレーズをクエリから返されるすべてのセッションと組み合わせます各値で使用されるテキストは SessionEntityの Display Representationでタイトルプロパティから取得されます先ほどのようにユーザーが私にアプリショートカットに使う異なるフレーズを数件追加したいと思いますこれでユーザーがみなさんが設定したフレーズを思い出せない時でもスムーズな体験を確保しますこれで完全に機能するショートカットができましたユーザーが使用するのが待ち遠しいですしかしそうなるためにはユーザーがショートカットを発見する方法が必要ですまずお伝えしたいのは良いフレーズを選択することこれは短くて覚えやすいフレーズを意味しますユーザーのiPhoneには App ショートカットに対応する多くのアプリがインストールされるはずですそのためユーザーがショートカットのフレーズを思い出せないことが考えられますなので短くて簡単なフレーズにしましょうそれに加えアプリ名が名詞または動詞にできる場合はフレーズでそれらを使用するようにしますこのアプリではフレーズを短く覚えやすくするために瞑想を名詞として使っていますまたアプリ名のシノニムはユーザーにとって便利ですユーザーがアプリを呼ぶ際にアプリの表示名以外で呼ぶ場合があるのでアプリのシノニムを追加することを推奨します iOS 11からアプリ名のシノニムに対応していますまだ作成していないなら今がチャンスです次にお話ししたいのは Siri Tipとショートカットリンクですアプリショートカットはユーザー設定が必要ないのでユーザーがみなさんのアプリショートカットを発見・使用するために見つけやすさは重要ですアプリショートカットではユーザーはショートカットの追加のために「Siriに追加」ボタンが不要ですすでに追加されているためですしかし「Siriに追加」ボタンが提供する見つけやすさを失いたくありませんそれを考慮して新しい Siri Tipビューを作成しましたこのビューは過去に「Siriに追加」ボタンを使用していた場所でうまく機能します TipビューはSwiftUIと UIKitで使用することができさまざまなスタイルが利用可能ですどのアプリでもTipがすばらしい形で見えます Siri Tipは画面のコンテンツに関連性がある場合状況に応じて配置しますユーザーがみなさんのアプリで注文したところなら注文状況を示すショートカットの Tipを表示することを考慮します Siri Tipはユーザーが近い将来アプリショートカットを使うだろうと感じた時にそれを十分に考慮して配置します Siri Tipは消すことにも対応しますビューには消すためのボタンが含まれコードがタップされた時にカスタムのクロージャがトリガーされますレイアウトからビューを削除して関連性があると感じるまで表示しないことを考慮してくださいショートカットのリストを起動するショートカットリンクが追加されましたこの新しい要素はアプリに多数のショートカットがありユーザーにすべて探索してほしい場合に便利ですアプリショートカットのすばらしい点はアプリをインストールしてすぐに利用できることですアプリが最初に起動する前にユーザーはショートカットを Spotlight Siri ショートカットアプリから実行し確認できますアプリショートカットを構築する時はこの事を配慮してください例えばアプリにログインフローが必要な場合ユーザーがIntent実行前にログインしていなければ Intentは失敗しユーザーのログインが必要だと説明するメッセージが表示されます次にアプリショートカットのパラメータ化されたフレーズはアプリが起動するまで利用することはできず App Intents フレームワークに新しいパラメータ値があることを伝えますアプリショートカットにパラメータ化されていないフレーズが含まれているとアプリを起動するまでショートカットは表示されませんこれを避けるためにいくつかのパラメータ化されていないフレーズを追加することをおすすめしますさらに Siri は「ここでなにをしますか」「瞑想で何ができますか」などのフレーズに対応します Siri はショートカットフレーズを自動的に収集推薦しみなさんの代わりに提示しますこの機能が動作するためにアプリが追加で何かをする必要はありません Siri とショートカットアプリの両方でショートカットが表示される順番はソースコードに記載したショートカットの順番で表示されます最も良い便利なアプリショートカットを最初に並べて注意を引くようにしましょう同様にフレーズの配列に最初に載せるフレーズはアプリショートカットのプライマリのフレーズとしてショートカットタイルのラベルとして使用されますまたユーザーが Siri にアプリへのヘルプを依頼した時に表示されます App Intentsフレームワークとショートカットで多くのご案内をしました最後に２つの主要な考えをお伝えしますアプリショートカットはユーザーがシステムのあらゆる場所からアプリを使用できるようになるのでこの軽量なモデルに最適なユースケースを考えましょう次にアプリショートカットを実装したらユーザーにそのことを伝える必要があります見つけやすくするための方法を熟考してください Siri Tipや Webサイトや店舗のサインなどプロダクト外の場所での表示を考慮してください新しいApp Intents フレームワークで作成するショートカットを見るのが楽しみですデザインについての詳細 App Intents フレームワークの詳細は今週の別のトークをご覧くださいありがとうございました WWDCをお楽しみください ♪

// StartMeditationIntent creates a meditation session.

import AppIntents

struct StartMeditationIntent: AppIntent {
    static let title: LocalizedStringResource = "Start Meditation Session"

    func perform() async throws -> some IntentResult & ProvidesDialog {
        await MeditationService.startDefaultSession()
        return .result(dialog: "Okay, starting a meditation session.")
    }
}

5:31 - Create an AppShortcutsProvider

// An AppShortcut turns an Intent into a full fledged shortcut
// AppShortcuts are returned from a struct that implements the AppShortcuts
// protocol

import AppIntents

struct MeditationShortcuts: AppShortcutsProvider {
    static var appShortcuts: [AppShortcut] {
        AppShortcut(
            intent: StartMeditationIntent(),
            phrases: ["Start a \(.applicationName)"]
        )
    }
}

6:35 - Provide multiple phrases

// An AppShortcut turns an Intent into a full fledged shortcut
// AppShortcuts are returned from a struct that implements the AppShortcuts
// protocol

import AppIntents

struct MeditationShortcuts: AppShortcutsProvider {
    static var appShortcuts: [AppShortcut] {
        AppShortcut(
            intent: StartMeditationIntent(),
            phrases: [
                "Start a \(.applicationName)",
                "Begin \(.applicationName)",
                "Meditate with \(.applicationName)",
                "Start a session with \(.applicationName)"
            ]
        )
    }
}

8:54 - Provide a dialog and snippet view

// Custom views give your intent more personality
// and can convey more information

func perform() async throws -> some ProvidesDialog & ShowsSnippetView {
    await MeditationService.startDefaultSession()

    return .result(
        dialog: "Okay, starting a meditation session.",
        view: MeditationSnippetView()
    )
}

10:09 - Implement an AppEntity

// An entity is a type that can be used as a parameter
// for an AppIntent.

import AppIntents

struct MeditationSession: AppEntity {
    let id: UUID
    let name: LocalizedStringResource

    static var typeDisplayName: LocalizedStringResource = "Meditation Session"
    var displayRepresentation: AppIntents.DisplayRepresentation {
        DisplayRepresentation(title: name)
    }

    static var defaultQuery = MeditationSessionQuery()
}

10:55 - Query for entities

// Queries allow the App Intents framework to
// look up your entities by their identifier

struct MeditationSessionQuery: EntityQuery {
    func entities(for identifiers: [UUID]) async throws -> [MeditationSession] {
        return identifiers.compactMap { SessionManager.session(for: $0) }
    }
}

11:16 - Define a parameter

// Adding a parameter to an intent allows you to prompt the user
// to provide a value for the parameter

struct StartMeditationIntent: AppIntent {

    @Parameter(title: "Session Type")
    var sessionType: SessionType?

    // ...

}

13:15 - Prompt for values

// Prompting for values can be done by calling methods
// on the property's wrapper type.

func perform() async throws -> some ProvidesDialog {
    let sessionToRun = self.session ?? try await $session.requestDisambiguation(
           among: SessionManager.allSessions,
           dialog: IntentDialog("What session would you like?")
       )
    }
    await MeditationService.start(session: sessionToRun)
    return .result(
       dialog: "Okay, starting a \(sessionToRun.name) meditation session."
    )
}

16:11 - Implement suggestedEntities()

// Queries can provide suggested values for your Entity
// that serve as parameters for App Shortcuts

struct MeditationSessionQuery: EntityQuery {
    func entities(for identifiers: [UUID]) async throws -> [MeditationSession] {
        return identifiers.compactMap { SessionManager.session(for: $0) }
    }

    func suggestedEntities() async throws -> [MeditationSession] {
        return SessionManager.allSessions
    }
}

16:34 - Update App Shortcut parameters

// Your app must notify App Intents when your values change
// This is typically best done in your app’s model layer

class SessionModel {
    @Published
    var sessions: [MeditationSession] = []
    private var cancellable: AnyCancellable?

    init() {
        self.cancellable = $sessions.sink { _ in
            MeditationShortcuts.updateAppShortcutParameters()
        }
    }

    // ...

}

17:09 - Add parameterized phrases

// Phrases can also contain a single parameter reference

import AppIntents

struct MeditationShortcuts: AppShortcutsProvider {
    static var appShortcuts: [AppShortcut] {
        AppShortcut(
            intent: StartMeditationIntent(),
            phrases: [
                "Start a \(.applicationName)",
                "Begin \(.applicationName)",
                "Meditate with \(.applicationName)",
                "Start a \(\.$session) session with \(.applicationName)",
                "Begin a \(\.$session) session with \(.applicationName)",
                "Meditate on \(\.$session) with \(.applicationName)"
            ]
        )
    }
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

Tech Talks

WWDC22