このページについて
このページではiPhone/iPad/Macで使う事ができるショートカットアプリのX-CallbackとURLエンコードの解説をしています。
更新履歴など
2022/9/24:iOS16の内容をベースに書き直しました。URLエンコードをこのページに統合しました。
2023/8/14:iOS17の内容を元に書き直しました。
X-CallbackのURLを開く
| OS | 使用 |
|---|---|
| iPhone | ○ |
| iPad | ○ |
| Mac | ○ |
| Apple Watch | × |
このアクションはXコールバックをショートカットで実現するための機能を持っています。
まずXコールバックの説明から行います。これはAppleが独自に定めているコールバックの形式です。そしてコールバックは「Aの処理の途中で別のアプリを呼び出して処理をしてもらい、処理結果をAで受け取る」みたいなやりとりのことを言います。
X-Callback URLのところにコールバック先のURLを入力します。基本的にはスキームの形式なので、アプリ名://パラメータのように書きます。
カスタムコールバックはx-callbackの形式に準拠せず、x-success、x-error、x-cancel以外のキーが使用されるコールバックURLを使用する際に使います。
x-callbackの形式に準拠しているURLを使用する際はこれらの設定は不要です。成功(success)の場合はURLにresultが付与されます。キャンセルキーはユーザーによって処理がキャンセルされた場合に使用されます。エラーキーはその名の通り、エラーが発生した際に使用されます。
カスタムX-Success URLは呼び出すアプリで出力を渡すためにx-cuccessURLのプレースホルダが使用される場合に便利と書かれています。
この例だとshortchts://callbackが設定されていますが、これはよく分かりませんでした。素直にショートカットで受け取っておきましょう。
使い方の例
とても簡単にですが、X-Callbackを体験できる超簡単な紹介をします。MacでもiPhoneでもBearというメモアプリが存在します。そしてこのメモアプリの公式ドキュメントではX-Callbackで使用可能なスキームを公開しているページがあります。(X-Callback-url Scheme documentation)
今回はここからcreateとtagsを使ったものを紹介します。まずはX-callback URLは以下になります。
bear://x-callback-url/create?title=test&tags=shortcutこれはcreateでtitleをtest、tagsでshortcutというタグを作成という書き方になります。初見だと意味不明だと思います。これをX-Callback URLに設定して実行します。
するとBearが表示されるのと同時に、処理が終わったら再びショートカット側で何かが表示されるはずです。X-Callbackは結果が辞書形式で表示されます。そして成功すると、Bear側にtestというメモと、shortcutというタグが実装されているはずです。
こんな感じでスキームが公開されているアプリもあれば、公開されていないアプリもあります。その辺りは探してみるしかありません。
URLエンコード
| OS | 使用 |
|---|---|
| iPhone | ○ |
| iPad | ○ |
| Mac | ○ |
| Apple Watch | × |
このアクションは受け取ったテキストをパーセントエンコーディングする機能を持っています。
テキストの部分に変換したいテキストを指定します。これは【入力を要求】やショートカットの入力を受けつける事で簡単かつ便利に利用できたりします。逆にパーセントエンコーディング済みのテキストを受け取ることもできます。
エンコードの部分を選択するとエンコードとデコードの選択肢が出てきます。エンコードは変換を意味し、デコードは復元(元の形に戻す)を意味します。そのためテキストをパーセントエンコーディングしたい場合はエンコードを、パーセントエンコーディング済みのテキストを元の形式に戻したい場合はデコードを選択します。
ここでパーセントエンコーディングについて簡単に解説します。これはURLエンコードとも呼ばれていて、これはURI(統一資源識別子)にて使用できない文字を%と16進数を使用した変換をする事で使用可能とするエンコード方法です。日常生活において特に出番があるとかではないです。
まとめ
URL関係はX-Callbaclとエンコードの2種ですが、片方は使い方が若干難しい上級者向け、もう片方は簡単に使えるけどあまり出番がないというアクションになっています。
X-Callbackは使うにしてもアプリ側の対応状況から調べないといけないため、手間といえば手間です。とはいえ一度実装に成功してしまえばショートカットから指定のメモを作成したり色々とできることは広がります。
エンコードの方はエンコードしてどこで使うんだって感じがしますし、デコードするにもパーセントエンコーディングでテキストを受け取る人はそうそういないでしょう。こういうのがあるっていうだけでも知っておいてあげてください。
ショートカット関連リンク
- ショートカットの基礎
- ショートカットの仕組み・作り方などの基礎を解説しています。
- ショートカットのカテゴリトップ
- ショートカットのカテゴリトップページへ移動します。
- オートメーションの使い方
- オートメーションの使い方などを解説しています。
- 使用端末による違い
- ショートカットを使用できる4端末による違いをまとめています。
- サンプルレシピ
- 中の人作のサンプルレシピ集です。役に立つものはありません。
- ウィジェットの解説
- ショートカットをウィジェットに表示する方法を解説しています。
- アクション一覧
- ショートカットで使用可能なアクションを全て掲載しています。(サードパーティアプリは除く)