For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
メインナビゲーション
Theme
Codex

Codex use case

iOS アプリへの App Intents の追加

Codex を使って、ショートカット、Siri、Spotlight のほか、アシスタントと連携する新しいシステム機能からも、アプリのアクションやコンテンツを利用できるようにします。

Difficulty Advanced
Time horizon 1h

Codex と Build iOS Apps プラグインを使って、App Intents で公開するアクションとエンティティを選び、ショートカットや Spotlight などのシステム機能に組み込みます。これにより、アシスタントを介して実行できるワークフローを段階的に増やすための準備が整います。

Best for

  • 便利なアクションやコンテンツがすでにあるものの、ショートカット、Siri、Spotlight などのシステム機能からは利用できない iOS アプリ
  • まずは利用価値の高いアクションをいくつか公開し、アシスタントから使いやすいワークフローを段階的に整えたいチーム
  • アカウント、リスト、フィルター、移動先、下書き、メディアなど、現在はアプリの UI 内でのみ扱えるオブジェクトをエンティティとして公開できるアプリ

Contents

    ← All use cases

    iOS アプリへの App Intents の追加

    Codex を使って、ショートカット、Siri、Spotlight のほか、アシスタントと連携する新しいシステム機能からも、アプリのアクションやコンテンツを利用できるようにします。

    Codex と Build iOS Apps プラグインを使って、App Intents で公開するアクションとエンティティを選び、ショートカットや Spotlight などのシステム機能に組み込みます。これにより、アシスタントを介して実行できるワークフローを段階的に増やすための準備が整います。

    Advanced
    1h

    Codex と Build iOS Apps プラグインを使って、App Intents で公開するアクションとエンティティを選び、ショートカットや Spotlight などのシステム機能に組み込みます。これにより、アシスタントを介して実行できるワークフローを段階的に増やすための準備が整います。

    Advanced
    1h

    Best for

    • 便利なアクションやコンテンツがすでにあるものの、ショートカット、Siri、Spotlight などのシステム機能からは利用できない iOS アプリ
    • まずは利用価値の高いアクションをいくつか公開し、アシスタントから使いやすいワークフローを段階的に整えたいチーム
    • アカウント、リスト、フィルター、移動先、下書き、メディアなど、現在はアプリの UI 内でのみ扱えるオブジェクトをエンティティとして公開できるアプリ

    Skills & Plugins

    • iOS ビルドと SwiftUI のスキルを使って、App Intents、アプリのエンティティ、App Shortcuts を追加します。その後、アプリが引き続きビルドできることと、インテント経由で呼び出したときに目的の画面や処理に移ることを確認します。
    Skill Why use it
    Build iOS Apps iOS ビルドと SwiftUI のスキルを使って、App Intents、アプリのエンティティ、App Shortcuts を追加します。その後、アプリが引き続きビルドできることと、インテント経由で呼び出したときに目的の画面や処理に移ることを確認します。

    Starter prompt

    Build iOS Apps プラグインを使ってこの iOS アプリを調査し、システムに公開すべきアクションとエンティティに対応する App Intents を追加してください。 制約事項 - まず、ユーザーにとって特に価値の高いアクションと主要なオブジェクトのうち、アプリの外からも利用できるようにすべきものを特定してください。ショートカット、Siri、Spotlight、ウィジェット、コントロールのほか、アシスタントと連携する新しいシステム機能も対象に含めてください。 - 初回の実装は範囲を絞ってください。アプリ本体を開かずに実行でき、ユーザーの役に立つインテントを少数選んでください。アプリを開いて特定の画面やワークフローに直接移る必要がある場合は、そのためのインテントも含めてください。 - アプリのエンティティは、システムが各アクションの内容を把握し、適切な処理に振り分けるために必要なデータだけを対象に定義してください。少数のエンティティで足りる場合は、内部のモデル層全体を再現しないでください。 - アクションが見つけやすくなる場合は App Shortcuts を追加してください。タイトル、呼び出しフレーズ、エンティティの表示形式は、Siri、Spotlight、ショートカットのいずれでもユーザーに伝わるものを選んでください。 - アプリのメイン UI でインテントを処理する必要がある場合は、結果をアプリに適切に引き渡し、それを受けてアプリのシーンがどう動作するかを説明してください。 - 初回の実装後にアプリをビルドして動作を検証し、対応したアクション、エンティティ、システム機能をまとめてください。 成果物 - 初回リリースでの公開を推奨するインテントとエンティティの一覧 - 実装したインテント、エンティティ、App Shortcuts - 実行時にアプリが各インテントをどこに振り分けるか、またはどのように処理するかの説明 - 今回の実装で利用できるようになった Apple のシステム機能と、次の対応候補となる機能
    Build iOS Apps プラグインを使ってこの iOS アプリを調査し、システムに公開すべきアクションとエンティティに対応する App Intents を追加してください。 制約事項 - まず、ユーザーにとって特に価値の高いアクションと主要なオブジェクトのうち、アプリの外からも利用できるようにすべきものを特定してください。ショートカット、Siri、Spotlight、ウィジェット、コントロールのほか、アシスタントと連携する新しいシステム機能も対象に含めてください。 - 初回の実装は範囲を絞ってください。アプリ本体を開かずに実行でき、ユーザーの役に立つインテントを少数選んでください。アプリを開いて特定の画面やワークフローに直接移る必要がある場合は、そのためのインテントも含めてください。 - アプリのエンティティは、システムが各アクションの内容を把握し、適切な処理に振り分けるために必要なデータだけを対象に定義してください。少数のエンティティで足りる場合は、内部のモデル層全体を再現しないでください。 - アクションが見つけやすくなる場合は App Shortcuts を追加してください。タイトル、呼び出しフレーズ、エンティティの表示形式は、Siri、Spotlight、ショートカットのいずれでもユーザーに伝わるものを選んでください。 - アプリのメイン UI でインテントを処理する必要がある場合は、結果をアプリに適切に引き渡し、それを受けてアプリのシーンがどう動作するかを説明してください。 - 初回の実装後にアプリをビルドして動作を検証し、対応したアクション、エンティティ、システム機能をまとめてください。 成果物 - 初回リリースでの公開を推奨するインテントとエンティティの一覧 - 実装したインテント、エンティティ、App Shortcuts - 実行時にアプリが各インテントをどこに振り分けるか、またはどのように処理するかの説明 - 今回の実装で利用できるようになった Apple のシステム機能と、次の対応候補となる機能

    システムに公開するアプリ機能の選び方

    App Intents は、iOS アプリの機能をアプリ自身の UI の外でも使えるようにするためのわかりやすい方法のひとつです。ユーザーがアプリを起動して画面を操作しなくても必要な機能を使えるように、Codex を活用しましょう。ショートカット、Siri、Spotlight、ウィジェット、コントロール、さらにはアシスタントを介した新しいシステム機能から利用できるようにしたいアクションとオブジェクトを公開します。

    こうすると、ユーザーはアプリの機能を見つけやすくなり、操作も自動化できます。今後、アシスタントを介した操作が増えたときの備えにもなります。アプリにすでに作成、表示、絞り込み、適切な画面への誘導、要約といった便利な機能があれば、App Intents を通じて、システムはそれらの機能を構造化された形で呼び出せます。

    各画面より先に検討したいアクションとエンティティ

    App Intents を初めて導入する際は、アプリ全体の機能をそのまま再現しようとするよりも、まずは範囲を絞るのが効果的です。Codex に次の点を洗い出してもらいましょう。

    • ユーザーがアプリの画面をたどらずに実行したいアクションのうち、特に重要なものをいくつか
    • 各アクションを適切な処理につなぐために、システムが把握する必要のあるアプリ内のオブジェクト
    • アプリを特定の状態で開くべきワークフローと、システムの UI 上でそのまま完結させるべきワークフロー

    設計の指針になるのが、Apple の App Intents ガイドです。まずアクションを定義し、次にシステムに公開する必要のあるエンティティとその情報を定めます。そのうえで、システムのさまざまな機能からアクションを見つけて再利用できるようにします。特に参考になるのは、アクションとコンテンツを見つけやすくし、幅広く利用できるようにする、初めてのアプリインテントの作成、そしてシステム機能との連携を示すサンプル App Intents を導入してシステム機能に対応する です。

    ショートカット以外にも広がる利用場面

    App Intents の用途は、ショートカットをひとつ追加するだけにとどまりません。公開する機能を適切に設計すれば、さまざまな場面でアプリを活用できます。

    • ショートカットでは、ユーザーがアクションを直接実行したり、複数のアクションを組み合わせて一連の操作を自動化したりできます。
    • Siri では、単にアプリを起動するだけでなく、具体的な操作を指示したり、ディープリンクで目的の画面を開いたりできます。
    • Spotlight では、アプリのエンティティやアプリショートカットが検索対象になり、システムの検索結果から利用できます。
    • ウィジェット、ライブアクティビティ、コントロールなど、インテントで動作する UI でも利用できます。
    • アシスタントを介した新しい機能では、アプリごとに異なる画面の操作手順に比べ、構造化されたアクションとエンティティのほうが、システムにとってはるかに理解しやすくなります。

    実際のアプリで使える構成例

    多くの場合、次のようにアプリを構成するとうまくいきます。

    • インテントの型を無関係なアプリファイルに分散させず、App Intents 専用のターゲットに集約
    • 投稿の作成や特定のタブを指定したアプリの起動など、ユーザーにとって特に便利な操作を AppShortcutsProvider に登録
    • アカウント、リスト、タイムラインのフィルターなど、システムが識別して扱う必要のある対象を、小さな AppEntity 型として定義
    • 呼び出されたインテントから適切な作成画面を開いたり、目的のタブに切り替えたりできるよう、アプリのメインシーンに処理を引き渡す仕組み

    ほとんどのアプリでは、Codex にもこの構成で実装を依頼するとよいでしょう。まずはシステムから呼び出せるアクションを少数に絞り、エンティティとして公開する範囲も限定します。インテントの実行にアプリのメイン UI が必要な場合に備えて、実行時にどの画面へ処理を引き渡すかをあらかじめ決めておきます。

    最初に公開するインテントの設計を Codex に依頼

    プロンプトでは、アプリの主要なオブジェクトと、ユーザーが行う主な操作を Codex に伝えます。そのうえで、すべてを一律に公開するのではなく、初回の導入で役に立つ最小限のアクションとエンティティを選ぶよう依頼すると効果的です。

    実装のヒント

    ユーザーがアプリの外で実行したい操作

    最初のインテントには、作成、表示、検索、絞り込み、開始、再開、詳細の確認といった操作が適しています。アプリ内で何段階もの準備を済ませて初めて役に立つ操作は、App Intents の初回導入には向かないかもしれません。

    モデル層よりも範囲を絞ったエンティティ

    通常、システムに永続化モデル全体を公開する必要はありません。Siri、ショートカット、Spotlight がアクションを正しく表示し、適切な処理につなぐために必要な情報を見極め、その情報だけを持つアプリのエンティティを定義するよう Codex に依頼しましょう。

    ショートカット機能を超えたアシスタント連携の基盤

    初回リリースでユーザーが変化を実感できるのは、ショートカットや Siri だけかもしれません。それでも、アプリの機能を構造化されたアクションとエンティティで表現できるようになることには、より長期的な利点があります。タップ操作やビュー階層だけで機能を表現するアプリに比べ、将来、システムや AI が提供する新しい入口からもアプリの機能を呼び出しやすくなります。

    Tech stack

    Need

    アクションの公開

    Default options

    App Intents

    Why it's needed

    App Intents は、アプリのアクションをシステムに公開するための共通インターフェースです。ショートカット、Siri、Spotlight、ウィジェット、コントロールのほか、アシスタントと連携する新しいシステム機能でもアクションを利用できます。

    Need

    アプリデータの公開

    Default options

    AppEntity、EntityQuery、エンティティの表示形式

    Why it's needed

    必要なオブジェクトに絞ってエンティティ層を設計すれば、モデル層全体を公開せずに、システムがアプリのオブジェクトを認識できるようになります。

    Need

    アクションの見つけやすさ

    Default options

    わかりやすい呼び出しフレーズ、タイトル、シンボルを設定した AppShortcutsProvider

    Why it's needed

    App Shortcuts を用意しておくと、ユーザーは自分でショートカットを一から作成することなく、最初に公開したアクションを簡単に見つけて実行できます。

    Need

    ビルドと動作検証

    Default options

    xcodebuild、シミュレータでの動作確認、実行時のルーティングに絞った検証

    Why it's needed

    インテント用のターゲットをコンパイルしただけでは、実行時の動作まではわかりません。システムがインテントを呼び出したときに、アプリが想定どおりに開くか、目的の画面や処理に移るかを確認する必要があります。

    Need Default options Why it's needed
    アクションの公開 App Intents App Intents は、アプリのアクションをシステムに公開するための共通インターフェースです。ショートカット、Siri、Spotlight、ウィジェット、コントロールのほか、アシスタントと連携する新しいシステム機能でもアクションを利用できます。
    アプリデータの公開 AppEntity 、 EntityQuery 、エンティティの表示形式 必要なオブジェクトに絞ってエンティティ層を設計すれば、モデル層全体を公開せずに、システムがアプリのオブジェクトを認識できるようになります。
    アクションの見つけやすさ わかりやすい呼び出しフレーズ、タイトル、シンボルを設定した AppShortcutsProvider App Shortcuts を用意しておくと、ユーザーは自分でショートカットを一から作成することなく、最初に公開したアクションを簡単に見つけて実行できます。
    ビルドと動作検証 xcodebuild 、シミュレータでの動作確認、実行時のルーティングに絞った検証 インテント用のターゲットをコンパイルしただけでは、実行時の動作まではわかりません。システムがインテントを呼び出したときに、アプリが想定どおりに開くか、目的の画面や処理に移るかを確認する必要があります。

    Related use cases