アクションリンクテンプレートの設計

アクションリンクテンプレートの概要

[設定] に次のようなアクションリンクグループテンプレートが表示されます。

各アクションリンクグループに、少なくとも 1 つのアクションリンクが必要です。この例のアクションリンクテンプレートには、[アクション URL] 項目に API バージョン番号、[HTTP リクエストボディ] 項目にアイテム番号、[HTTP ヘッダー] 項目に OAuth トークン値の 3 つのバインド変数があります。

テンプレート設計の考慮事項

アクションリンクグループの有効期限の設定

テンプレートからアクションリンクグループを作成するときに、テンプレートに指定された期間に基づいて有効期限を計算することも、アクションリンクグループに有効期限を設定しないことも可能です。

テンプレートに有効期限までの時間を設定するには、アクションリンクグループテンプレートの [有効期限までの時間] 項目に値を入力します。この値は、アクションリンクグループがインスタンス化されてから、関連付けられたフィード要素から削除され実行できなくなるまでの時間数です。最大値は 8760 で、365 日に相当します。

アクションリンクグループをインスタンス化するときに有効期限を設定するには、Action Link Group Definition リクエストボディ (Chatter REST API) または ConnectApi.ActionLinkGroupDefinition 入力クラス (Apex) のいずれかの expirationDate プロパティを設定します。

有効期限のないアクションリンクグループを作成するには、テンプレートの [有効期限までの時間] 項目に値を入力せず、アクションリンクグループをインスタンス化するときに expirationDate プロパティにも値を入力しません。

バインド変数の定義

テンプレートでバインド変数を定義し、アクションリンクグループをインスタンス化するときにその値を設定します。

バインド変数は、アクションリンクテンプレートの [アクション URL]、[HTTP リクエストボディ]、および [HTTP ヘッダー] 項目で定義できます。テンプレートを公開後、これらの項目を編集することや項目間でバインド変数を移動させること、バインド変数を削除することができます。ただし、新しいバインド変数を追加することはできません。

テンプレートでバインド変数のキーを定義します。アクションリンクグループをインスタンス化するときに、キーとその値を指定します。

バインド変数キーは {!Bindings.key} の形式です。

key は、事前に定義された \w 文字クラスの [\p{Alpha}\p{gc=Mn}\p{gc=Me}\p{gc=Mc}\p{Digit}\p{gc=Pc}] で Unicode 文字をサポートします。

アクションリンクを表示できるユーザの設定

[ユーザ表示設定] ドロップダウンリストから値を選択して、アクションリンクがフィード要素に関連付けられた後にそのアクションリンクを表示できるユーザを決定します。

使用可能なオプションに [カスタムユーザのみに表示] と [カスタムユーザ以外の全員に表示] があります。このいずれかの値を選択して、アクションリンクを特定のユーザのみが表示できるようにするか、特定のユーザが表示できないようにします。次に、[カスタムユーザ(別名)] 項目に値を入力します。この値はバインド変数キーです。アクションリンクグループをインスタンス化するコードで、キーを使用して、バインド変数の場合と同じように値を指定します。

次のテンプレートは、[カスタムユーザ(別名)] の値に Invitee を使用します。

テンプレートで [作成者のマネージャのみに表示] を使用する場合にユーザにマネージャがいなければ、テンプレートからアクションリンクグループをインスタンス化するときにエラーが表示されます。この場合のマネージャは、インスタンス化の時点のマネージャです。インスタンス化した後にユーザのマネージャを変更した場合、この変更は反映されません。

コンテキスト変数の使用

コンテキスト変数を使用して、アクションリンクを実行したユーザとアクションリンクが呼び出されたコンテキストに関する情報を、アクションリンクの呼び出しによって実行された HTTP 要求に渡すことができます。コンテキスト変数は、Action Link Definition Input リクエストボディまたは ConnectApi.ActionLinkDefinitionInput オブジェクトの actionUrl、headers、および requestBody プロパティで使用できます。コンテキスト変数はまた、アクションリンクテンプレートの [アクション URL]、[HTTP リクエストボディ]、および [HTTP ヘッダー] 項目でも使用できます。テンプレートの公開後も、これらの項目は編集 (コンテキスト変数の追加と削除を含む) できます。

たとえば、Survey Example という会社に勤務していて、「Survey Example for Salesforce」というアプリケーションを Salesforce AppExchange 用に作成したとします。会社 A には「Survey Example for Salesforce」がインストールされています。会社 A の誰かが surveyexample.com にアクセスしてアンケートを作成します。Survey Example のコードは、Chatter REST API を使用して、会社 A の Salesforce 組織に本文テキスト [調査を実行] と、表示ラベル [OK] のアクションリンクを含むフィード項目を作成します。

この UI アクションリンクをクリックすると、ユーザが Salesforce からアンケートに回答する surveyexample.com の Web ページに移動します。

そのアクションリンクの [HTTP リクエストボディ] または [アクション URL] に {!userId} コンテキスト変数が含まれる場合、ユーザがフィードのアクションリンクをクリックすると、Salesforce はクリックしたユーザの ID を、作成した HTTP 要求に含めてサーバに送信します。

アクションリンクを作成する Survey Example のサーバ側コードに {!actionLinkId} コンテキスト変数が含まれる場合は、Salesforce がアクションリンクの ID を含む HTTP 要求を送信するため、この ID をデータベースに保存できます。

次の例では、アクションリンクテンプレートの [アクション URL] に {!userId} コンテキスト変数が含まれます。