Developer Changelog / App Bridge・Sidekick

Sidekick Launch API
アプリのボタンから Sidekick の会話を始められる

埋め込みアプリが、あらかじめ用意したプロンプト付きで Sidekick を起動できるようになった。マーチャントはアプリを離れずに、その場の文脈に合ったヘルプを受けられる。

このページの構成
  1. そもそも何が変わるのか（30秒で理解）
  2. 仕組み図解 ： ボタンから会話開始までの流れ
  3. 呼び出し方（コード例）
  4. 従来 vs Sidekick Launch API の比較
  5. 記事に書かれていること／書かれていないこと
  6. 組み込みの流れ（3ステップ）
  7. 技術者が押さえるべき5つのポイント
  8. 業務に活かせる3つのユースケース
  9. 提案で使える1行サマリ

1そもそも何が変わるのか

Shopify 管理画面内の 埋め込みアプリ から、マーチャントの代わりに Sidekick との会話を開始 できるようになった。
アプリが用意したプロンプトが マーチャント本人のメッセージとして送信された状態 で Sidekick が開く。

これまで ： アプリと Sidekick は別々

アプリ画面で疑問が出たら、マーチャントが自分で Sidekick を開き、状況を一から言葉にして質問する必要があった。

これから ： アプリから文脈付きで起動

アプリ側のボタン 1 つで、その画面に合ったプロンプト付きの Sidekick 会話が始まる。マーチャントはアプリを離れない。

2仕組み図解 ： ボタンから会話開始までの流れ

マーチャント ボタンをクリック 埋め込みアプリ 例 ： レポート横の 「Ask Sidekick」ボタン Shopify 管理画面内 shopify.sidekick .launch({ message }) Sidekick Launch API Sidekick が開く アプリのプロンプトが 本人発言として送信 アプリを離れずにヘルプ
ポイントは 「マーチャントの代わりに」会話を始める こと。渡した message は、Sidekick 上では マーチャントが送ったメッセージ として扱われる。

3呼び出し方（コード例）

記事で示されている呼び出しは次の 1 行のみ。

// 例 ： レポートの横に置いた「Ask Sidekick」ボタンのクリック時
shopify.sidekick.launch({ message })
呼び出し元

埋め込みアプリ

Shopify 管理画面の中で動くアプリ（Embedded apps）。

引数

message

事前入力するプロンプト。マーチャントのメッセージとして送信される。その他の引数は記載なし。

結果

Sidekick が開く

プロンプト送信済みの状態で会話が始まる。戻り値・応答の取得方法は記載なし。

4従来 vs Sidekick Launch API の比較

項目従来Sidekick Launch API
Sidekick を開く人 マーチャント 自分で開く アプリ マーチャントの代わりに開始
最初の質問 手入力 状況を一から説明 事前入力 アプリがプロンプトを用意
文脈 マーチャントの説明次第 アプリ画面に合った文脈で質問できる
画面遷移 — アプリ内 アプリを離れずにヘルプ
追加コスト・対象プラン — 記載なし

5記事に書かれていること／書かれていないこと

書かれていること

・対象は埋め込みアプリ
・Shopify 管理画面内から呼べる
・shopify.sidekick.launch({ message }) で起動
・プロンプトはマーチャントのメッセージとして送信
・詳細は Sidekick Launch API ドキュメント参照

書かれていないこと（記載なし）

・必要なスコープ／権限
・対象プラン・対象地域・対応言語
・message の文字数制限
・戻り値や Sidekick の回答をアプリで受け取れるか
・利用料金・レート制限

Changelog 本文は短く、制約や仕様の詳細は記載なし。実装前に Sidekick Launch API のドキュメント を必ず確認すること。

6組み込みの流れ（3ステップ）

1

置き場所を決める

例のように、レポートなど「質問が生まれやすい画面」の横に配置。

2
Ask

「Ask Sidekick」ボタンを置く

クリック時に shopify.sidekick.launch({ message }) を呼ぶ。

3

プロンプトを設計する

message は本人の発言として送られる前提で文面を作る。

記事上の実装は 関数呼び出し 1 つ。既存の埋め込みアプリにボタンを足すだけで、アプリ内ヘルプの入口を作れる。

7技術者が押さえるべき5つのポイント

1. 対象は埋め込みアプリ

Shopify 管理画面内で動く Embedded app からの呼び出しが前提。管理画面外のアプリからの利用は記載なし。

launch()

2. API はグローバルの shopify 経由

shopify.sidekick.launch({ message }) という形で呼ぶ。引数として記事に出てくるのは message のみ。

3. 送信はマーチャント名義

プロンプトは「マーチャントのメッセージ」として送られる。本人が言いそうな自然な文面にし、意図しない依頼を含めない設計が必要。

4. 一方向の起動 API と捉える

記事に書かれているのは「会話を開始する」ことまで。Sidekick の回答をアプリ側で受け取れるかは記載なし。

5. 詳細仕様はドキュメント側にある

権限・制限・エラー時の挙動などは Changelog では記載なし。Sidekick Launch API ドキュメントで確認してから設計に入る のが安全。

8業務に活かせる3つのユースケース

?
USE CASE 1

レポート画面に「Ask Sidekick」を置く

課題
アプリのレポートを見たマーチャントが「この数字をどう読めばいいか」で止まり、別画面で質問し直す手間がかかる。
打ち手
レポートの横に「Ask Sidekick」ボタンを置き、そのレポートに合ったプロンプトで shopify.sidekick.launch({ message }) を呼ぶ。
効果
アプリを離れずに、その場の文脈に合ったヘルプを受けられる。
技術メモ
記事に載っている例そのもの。プロンプトはマーチャントの発言として送られるため、本人目線の文面にする。
USE CASE 2

アプリの設定画面に「困ったら聞く」入口を作る

課題
設定項目が多いアプリで、マーチャントが迷ったときの問い合わせ導線が弱い。
打ち手
設定画面の各ブロック付近にボタンを置き、その画面の状況を表すプロンプトで Sidekick を起動する。
効果
マーチャントが状況を一から説明せずに質問を始められる。
技術メモ
Sidekick が該当アプリの設定内容をどこまで把握して答えるかは記載なし。回答品質は事前に検証が必要。
USE CASE 3

受託開発のアプリ提案に「Sidekick 連携」を標準オプション化

課題
カスタムアプリを納品しても、運用担当者からの「使い方の質問」対応が開発側に集中しがち。
打ち手
主要画面に Sidekick 起動ボタンを組み込む提案を標準メニューに入れる。
効果
関数呼び出し 1 つで、アプリ内に文脈付きヘルプの入口を用意できる。
技術メモ
対象プラン・権限・制限は記載なし。提案前にドキュメントと対象ストアで動作を確認する。

9提案で使える1行サマリ

「埋め込みアプリのボタン 1 つで、その画面に合ったプロンプト付きの Sidekick 会話 を始められる。
shopify.sidekick.launch({ message }) だけで、マーチャントはアプリを離れずにヘルプを受けられる。」