これまでは tools を宣言した拡張機能しか Sidekick に拾われなかった。今後は intents だけを宣言した拡張機能も対象になる。ただし extensions_summary が無いと次回の deploy で検証エラーになる。
admin.app.intent.link / admin.app.intent.render の拡張機能が intent しか登録していないと対象外になり、Sidekick はそのアプリを提案しなかった。
すでに宣言している [[extensions.targeting.intents]] ブロックだけで対象になる。設定フォーマット自体は変わっていない。
admin.app.intent.link と admin.app.intent.render の両方。[[extensions.targeting.intents]] ブロックそのもの。新しい書き方は不要。
tools なしで intents を宣言した拡張機能が 1 つ以上ある。ただちに Sidekick の表示対象になる。shopify.app.toml に extensions_summary が無ければ、次回の deploy がその項目名を示す検証エラーで失敗する。
もともと対象で、もともと extensions_summary も必須だった。何も変わらない。
Sidekick 向けの拡張機能を持たないアプリには関係しない。
| 項目 | 変更前 | 変更後 |
|---|---|---|
| Sidekick 対象の条件 | tools 必須 | tools / intents のどちらか |
| intents のみの拡張機能 | スキップされ、提案されない | ただちに提案対象になる |
| 設定フォーマット | [[extensions.targeting.intents]] |
変更なし(同じブロックで足りる) |
| extensions_summary | tools 宣言ありのアプリだけ必須 | intents のみでも必須 無いと deploy 失敗 |
| 適用範囲 | — | 全アプリ・全ストア。API バージョン非依存、オプトイン不要 |
ほとんどのアプリは変更不要。intents のみの拡張機能がある場合だけ、次回 deploy の前に以下を行う。
各 shopify.extension.toml で、intent.link / intent.render に [[extensions.targeting.intents]] があり、tools ファイルが無いものを探す。
該当があれば、shopify.app.toml の [sidekick] に extensions_summary があるか確認。無ければ追加。
開発ストアに対して shopify app deploy を実行する。
登録した intent に合う質問を Sidekick に投げ、自分のアプリが提案されるか確かめる。
記事に掲載されている shopify.app.toml の例:
shopify.extension.toml ではなく、アプリ全体の shopify.app.toml の [sidekick] セクション。文言の書き方の詳細は関連ドキュメント「Add an extensions summary to your app」を参照(本記事には記載なし)。判定ロジックだけが変わり、設定フォーマットは変わっていない。app actions 用に書いた intents の宣言がそのまま Sidekick 対象の根拠になる。
intents のみ+extensions_summary 無しだと、次回の shopify app deploy が欠けている項目名を示す検証エラーで失敗する。CI/CD で自動 deploy しているなら先に直しておく。
API バージョンに紐づかない、feature preview や scope 条件も無い。全ストアに一斉適用なので「影響が出るのはいつか」は「次の deploy」と考えてよい。
intents のみの拡張機能は「ただちに」Sidekick に見えるようになる。提案時に自アプリがどう出るかは、事前に開発ストアで確認しておくと安全。
admin.app.intent.link または admin.app.intent.render の target に [[extensions.targeting.intents]] があり、隣に tools ファイルが無いものが該当。複数の拡張機能を持つアプリは、各 shopify.extension.toml をひとつずつ確認する。
shopify.app.toml に [sidekick] の extensions_summary を追加しておく。admin.app.intent.link / admin.app.intent.render)と extensions_summary だけを用意する。extensions_summary の文言が、Sidekick に何を聞かれたら提案されるかの手がかりになる。提案の精度・順位の仕組みは記載なし。extensions_summary に書いた機能(例:レビューの検索・分析)から作ると漏れにくい。extensions_summary を追加すること。」