ショートカット入口(グループプラグイン)とは
ユーザーがグループ内でプラグイン入口をクリックすると、グループに関するパラメーターが付加されます。これにより、開発者は「誰が」「どのグループで」「いつ」「どの具体的なプラグインを」クリックしたかを特定できます。これを活用することで、ソリューションプロバイダーは高度にインテリジェントかつ目的の明確な業務サービスを実現できます。- DingTalk 開発者バックエンド にログインします。
- 開発者バックエンド ページで、シーングループ を選択し、グループプラグイン の作成をクリックします。
-
グループプラグイン を新規作成し、新規作成 をクリックして、審査の完了を待ちます。
説明
- 審査時間は、営業日 12 時間以内に承認が完了します。
ショートカット入口リンクの構築
ショートカット入口(グループプラグイン)は業務機能を備えた DingTalk リンクです。開発者は、自身のマイクロアプリの実際のシナリオと、グループ内でユーザーが利用する際の具体的なニーズに基づいて、ショートカット入口リンクを組み立てる必要があります。 ショートカット入口の名称は最大 4 文字まで対応しています。ショートカット入口リンクには非常に多くの機能がありますが、開発者がリンクパラメーターを通じて組み立てる必要があります。たとえば、モバイル端末でのページの開き方(ページのプッシュ、ポップアップなど)から、PC 端末でのページ遷移ロジック(新しいコンテナで開く、ページを左へスライドさせるなど)まで、すべてリンクパラメーターの設定によって実現します。-
H5 ページへリダイレクト
link(サイドバー / コンテナのスライド表示)
例:
パラメーター説明:
-
マイクロアプリへリダイレクト
openapp(ワークベンチ、ブラウザ、左スライドパネルなど)
例:
パラメーター説明:
-
ミニプログラムへリダイレクト
-
共通パラメーター(open_micro_app と open_mini_app の両方に対応)
-
共通パラメーター(open_micro_app と open_mini_app の両方に対応)
ddMode=float(フローティングウィンドウ)の場合に使用可能なパラメーター
ddMode=pop(ポップアップ)の場合に使用可能なパラメーター
-
マイクロアプリを開く scheme(企業ミニプログラム専用 scheme)
scheme:
dingtalk://dingtalkclient/action/open_micro_app基本パラメーターは共通パラメーターリストと同じです。グレーリリース制御ロジックは、この scheme の handler 内に配置する必要があります。 PC 端末テストケース:-
slide panel で URL を開く(title なし)
-
slide panel で URL を開く(title なし)
-
browser で URL を開く
-
slide panel で URL を開く(title あり)
-
browser で URL を開く
-
slide panel で URL を開く(title なし)
-
ミニプログラムを開く schema(個人ミニプログラム専用 scheme)
scheme:
dingtalk://dingtalkclient/action/open_mini_app基本パラメーターは共通パラメーターリストと同じです。 -
ミニプログラムデバッグ scheme
scheme:
dingtalk://dingtalkclient/action/dev_mini_app主にミニプログラムのデバッグ、および appx フレームワーク開発に使用します。この方式で開いたミニプログラムは、直接 URL からメインドキュメントを起動します。パッケージ管理フローには入らず、保活ロジックもトリガーされません。miniAppId はインターフェース検証などの用途のみに使用されます。
重要
パラメーターはすべて encode 済みです。デコードに注意してください。リンクから追加元グループ情報を取得する方法
-
特殊な開き方の指定
ショートカット入口(グループプラグイン)は業務機能を備えた dingtalk リンクです。開発者は、自身のマイクロアプリの実際のシナリオと、グループ内でユーザーが利用する際の具体的なニーズに基づいて、グループプラグインリンクを組み立てる必要があります。プラグインの名称は最大 4 文字まで対応しています。プラグインリンクには非常に多くの機能がありますが、開発者がリンクパラメーターを通じて組み立てる必要があります。たとえば、モバイル端末でのページの開き方(ページのプッシュ、ポップアップなど)から、PC 端末でのページ遷移ロジック(新しいコンテナで開く、ページを左へスライドさせるなど)まで、すべてリンクパラメーターの設定によって実現します。
以下では、プロジェクトグループのショートカット入口を例に、ショートカット入口リンクをどのように組み立てるか詳しく説明します。
<dingtalk://dingtalkclient/page/link?url=https%3a%2f%2fding-doc.dingtalk.io%2fdoc%23%2fpqkq0u%2feluagw%2f$CORPID$%2f$DOUBLE_ENCCID$>-
開発者のターゲットページアドレス:https%3a%2f%2fding-doc.dingtalk.io%2fdoc%23%2fpqkq0u%2feluagw
- DingTalk 統一リダイレクトプロトコルを使用する場合、この部分は「DingTalk 統一リダイレクトプロトコル」アドレスの入力パラメーターとなるため、urlEncode が必要です。
- DingTalk 統一リダイレクトプロトコルを使用しない場合、元の URL をそのままショートカット入口のアドレスとして使用できます。urlEncode は不要です。
-
DingTalk 統一リダイレクトプロトコル(任意) dingtalk://dingtalkclient/page/link?url=
- この部分は、指定したページをどのような方法で開くかを決定します。現在、「ブラウザで開く」「サイドバーで開く」などに対応しており、それぞれの方式に対応する統一リダイレクトプロトコルの path が異なります。
- 一部の統一リダイレクトプロトコル path は、特定のプラットフォームクライアントでのみ使用可能です。たとえば、サイドバーで開くのは PC および Mac 端末でのみ利用可能です。
-
ショートカット入口の アドレス動的パラメーター(任意)
-
この動的パラメーターを設定すると、ユーザーがショートカット入口をクリックして開発者のアドレスにアクセスした際に、URL 内のこの部分の動的パラメーターを、corpid や openConversationId などのグループのコンテキスト情報に置換できます。
現在対応している動的パラメーターは以下のとおりです:
で URL の暗号化・復号化を 2 回行う理由は次のとおりです。DingTalk では「dingtalk://」という内部プロトコルが 1 層あり、このプロトコルを解析する際に 1 回暗号化が必要です。また、URL パラメーターの後ろの業務 https プロトコルを下流のコンテナに透過して使用する際にも、1 回の暗号化・復号化が必要です。消費側で 2 回の解析が必要なため、URL を生成する際にも 2 回の暗号化が必要となります。 URL 生成例:urlencode(DingTalk url?xxx=xxx & url = urlencode(業務 url)) URL 解析例:a、urldecode(DingTalk url)-> 業務 url を取得;b、urldecode(業務 url)-> 使用可能なパラメーター
-
この動的パラメーターを設定すると、ユーザーがショートカット入口をクリックして開発者のアドレスにアクセスした際に、URL 内のこの部分の動的パラメーターを、corpid や openConversationId などのグループのコンテキスト情報に置換できます。
現在対応している動的パラメーターは以下のとおりです:
-
開発者のターゲットページアドレス:https%3a%2f%2fding-doc.dingtalk.io%2fdoc%23%2fpqkq0u%2feluagw