この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Chatter REST API 開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

アクションリンクの使用

アクションリンクを使用して、Salesforce とサードパーティシステムを Chatter フィードに統合します。アクションリンクは、API、Web ページ、またはファイルを指し示すフィード要素上のインジケータで、Salesforce Chatter フィード UI ではボタンで表されます。フィー���内でユーザが作業できるようにすることは、ユーザによる Chatter の採用とエンゲージメントを確保するための最も強力な方法です。

アクションリンクは現在、パイロットプログラムを通じて一部のお客様が使用できます。このパイロットプログラムに参加する方法については、salesforce.com にお問い合わせください。パイロットプログラムへの参加には、追加の契約条件が適用される場合があります。パイロットプログラムは変更される可能性があるため、このパイロットプログラムへの参加や、特定の期間にこの機能を有効化することは保証できません。このドキュメント、プレスリリース、または公式声明で参照されている未リリースのサービスまたは機能は、現在利用できず、提供が遅れたり中止されたりする可能性があります。サービスのご購入をご検討中のお客様は、現在利用可能な機能に基づいて購入をご決定ください。

メモ

アクションリンクは、プラットフォームアクションの種別の 1 つです。プラットフォームアクションには次の種別があります。
  • ActionLink — API、Web ページ、またはファイルを指す、フィード要素上のインジケータで、Salesforce Chatter フィード UI のボタンによって表されます。
  • AnchorAction — Salesforce1 レコードアクションバーのアクション。
  • CustomButton — クリックすると、ウィンドウ内で URL または Visualforce ページが開くか、JavaScript が実行されます。
  • QuickAction — ホームページ、Chatter タブ、Chatter グループ、レコード詳細ページの Chatter パブリッシャー上のアクション。クイックアクションは、Salesforce1 のアクショントレイにも表示されます。クイックアクションは、Salesforce ヘルプではパブリッシャーアクションと呼ばれます。
  • StandardButton — あらかじめ用意されている Salesforce ボタン ([新規]、[編集]、[削除] など)。
フィード要素に関連付けられたプラットフォームアクション (アクションリンクを含む) を取得し、次のリソースを使用してアクションリンクを管理します。
リソース HTTP メソッド ToDo
/chatter/feed-elements/feedElementId​/capabilities/associated-actions GET フィード要素に関連付けられたすべてのプラットフォームアクションを取得します。
/connect/action-link-group-definitions POST アクションリンクグループ定義を作成します。
/connect/action-link-group-definitions​/actionLinkGroupId GET、DELETE アクションリンクグループ定義を作成した接続アプリケーションを使用して、アクションリンクグループ定義の情報取得や削除を行います。アクションリンクグループ定義を削除すると、その定義へのすべての参照がフィード要素から削除されます。
/connect/action-link-groups​/actionLinkGroupId GET コンテキストユーザの状態を含む、アクションリンクグループに関する情報を取得します。
/connect/action-links/actionLinkId GET、PATCH アクションリンクの状況の情報取得や更新を行います。
/chatter/feed-elements POST アクションリンクグループが関連付けられたフィード項目を投稿します。この POST 要求で渡すリクエストボディのフィード項目には最大 10 個のアクションリンクグループを関連付けられます。
/connect/action-links/actionLinkId​/diagnostic-info GET アクションリンクが実行されたときに REST エンドポイントから返された診断情報を取得します。診断情報は、アクションリンクにアクセスできるユーザに対してのみ提供されます。

Chatter フィードとの統合のために、さまざまな方法でアクションリンクを使用できます。次にいくつかの例を示します。

この使用事例では、サードパーティアプリケーションによって投稿されたフィード項目にアクションリンクが含まれており、ユーザはこれらを利用して出張許可願いを承認、却下、コピー、参照することができます。[承認] および [却下] アクションリンクドロップダウンメニューのアクションリンク

複数のアクションリンクをグループ化して定義します。1 つのグループ内に同じアクションリンクを含めることはできません。1 つの投稿に最大 10 個のアクションリンクグループを関連付けられます。この例では、[承認] と [却下] が 1 つのグループであり、[コピー] と [参照] は別のグループに含まれています。アクションリンクグループごとに、投稿内に表示するか、投稿のドロップダウンメニューに表示するかを指定します。[承認] と [却下] は投稿内に表示され、[コピー] と [参照] はドロップダウンメニューに表示されます。

アクションリンクはユーザに固有で、非公開または公開に設定できます。この例では、Pam が Deanna のフィードに投稿し、手順をダウンロードして、注文を実行するように依頼しています。Deanna のフィード内の投稿には [注文] および [ダウンロード] アクションリンクが表示されます。フィード項目の [注文] および [ダウンロード] アクションリンク

この投稿は Pam にも表��されますが、彼女には注文を実行する権限がないので、[ダウンロード] アクションリンクのみが表示されます。[ダウンロード] アクションリンク

認証およびセキュリティ

アクションリンクは、HTTPS のみを使用します。

API の詳細は、暗号化して保存され、クライアントには隠匿されます。

アクションリンクを定義するときは、URL (actionUrl) と、その URL に対して要求を行うために必要な HTTP ヘッダー (headers) を指定します。URL に認証が必要な場合は、HTTP ヘッダーに OAuth 情報を含めます。このサンプルでは、Action Link Group Definition Input リクエストボディに 1 つのアクションリンクが含まれ、actionLinks プロパティに OAuth 情報が指定されています。
1POST /connect/action-link-group-definitions
2
3{
4    "actionLinks": [
5    {
6       "actionType" : "Api",
7       "actionUrl" : "https://www.example.com/api/v1/cofirm",
8       "groupDefault" : "true",
9       "headers" : [
10       {
11          "name" : "Authorization",
12          "value" : "OAuth 00DRR0000000N0g!ARoAQMZyQtsP1Gs27EZ8hl7vdpYXH5O5rv1
13                        VNprqTeD12xYnvygD3JgPnNR._nmE6thZakAbBVJUsjUInMUaKMlkNKaWXdHO"
14       },
15       {
16          "name" : "Content-Type",
17          "value" : "application/json"
18       }],
19       "labelKey" : "Confirm",
20       "method" : "Post",
21       "requiresConfirmation" : "true"
22    }],
23    "executionsAllowed" : "OncePerUser",
24    "category" : "Primary",
25    "expirationDate" :  "2014-09-09T18:45:39.000Z"
26}

アクションリンクグループを定義するときは、有効期限 (expirationDate) を指定する必要があります。この期限後は、グループのアクションリンクを実行できなくなります。アクションリンクグループの有効期限を OAuth トークンの有効期限と同じ値に設定することをお勧めします。そうすれば、ユーザがアクションリンクを実行しようとしたときに、OAuth エラーを受信することがありません。

この例には含まれていませんが、アクションリンクの保護に使用可能なプロパティが他に 2 つあります。excludeUserId プロパティは、アクションの実行から単一ユーザを除外する場合に使用します。userId プロパティは、アクションを実行できるユーザのみの ID を指定する場合に使用します。userId プロパティを指定しない場合、または null を渡す場合は、すべてのユーザがアクションを実行できます。アクションリンクに excludeUserId と userId 両方を指定することはできません。

バージョン設定

API のアップグレードや機能の変更による問題を避けるため、アクションリンクを定義するときにはバージョン設定を使用することをお勧めします。たとえば、Action Link Definition Input のactionUrl プロパティは https://www.example.com/api/v1/exampleResource のようになります。API がバージョン管理されていない場合、Action Link Group Definition Input の expirationDate プロパティを使用して API のアップグレードや機能変更による問題を避けることができます。

エラー

アクションリンクの診断情報リソース (/connect/action-links/actionLinkId/diagnostic-info) を使用して、Api アクションリンクおよび AsyncApi アクションリンクを実行後の状況コードおよびエラーを返します。診断情報は、アクションリンクにアクセスできるユーザに対してのみ提供されます。

ローカライズされた表示ラベル

アクションリンクは、Action Link Definition Input リクエストボディの labelKey プロパティに指定された、定義済みのローカライズされた表示ラベルセットを使用します (認証およびセキュリティで例を確認できます)。

表示ラベルのリストについては、アクションリンクの表示ラベルを参照してください。

アクションリンクの種別

アクションリンクには次の 4 つの種別があります。
  • Api — アクションリンクは同期 API をコールします。
  • ApiAsync — アクションリンクは非同期 API をコールします。
  • Download — アクションリンクはファイルをダウンロードします。
  • Ui — アクションリンクはユーザインターフェースをユーザに表示します。

アクションリンクの種別は、actionType プロパティで指定します。認証およびセキュリティで例を確認できます。

さまざまな種別のアクションリンクのさまざまなワークフローで status が設定されます。詳細は、/connect/action-links/actionLinkIdを参照してください。