フィードとフィード要素

Salesforce ヘルプでは、フィード項目を投稿、バンドルをバンドル投稿と呼んでいます。

メモ

機能

フィードを多様化する取り組みの一環として、フィード要素の持つさまざまな機能性を個々の機能に分割しました。機能では、一貫した方法でフィードを操作できます。フィード要素で使用できる機能を判別するためにフィード要素種別を調べないでください。使用可能な機能を明示的に示す機能を調べてください。機能が存在するかどうかを確認することで、フィード要素に対してクライアントが実行できる操作を判別します。

すべてのフィード要素に capabilities プロパティがあり、このプロパティに Feed Element Capabilities レスポンスボディが保持されています。Feed Element Capabilities レスポンスボディには 1 つ以上のプロパティがあり、それぞれのプロパティにフィード要素の機能が保持されています。

機能には、ある操作が可能であることを示す情報と、その操作に関連付けられたデータが含まれます。フィード要素に機能が存在する場合、機能に関連付けられたデータがまだなくてもその機能を使用できます。たとえば、chatterLikes 機能プロパティがフィード要素に存在している場合、コンテキストユーザはそのフィード要素にいいね! と言うことができます。その機能プロパティがフィード要素に存在しない場合、そのフィード要素にいいね! と言うことはできません。

Salesforce UI でのフィード項目の表示

クライアントは capabilities プロパティを使用して、フィード要素で可能な操作やフィード要素を表示する方法を判別できます。フィード項目以外のすべてのフィード要素では、クライアントは、フィード要素の種別を知る必要はありません。代わりに、機能を確認することができます。フィード項目には機能がありますが、actor などのプロパティもいくつかあり、これらは機能として公開されていません。このため、フィード項目はフィード要素とは異なる方法で処理する必要があります。

Salesforce UI では、1 つのレイアウトを使用して、すべてのフィード項目が表示されます。このレイアウトにより、一貫したフィード項目のビューが顧客に提供され、容易に UI を作成する手段が開発者に提供されます。このレイアウトには常に同じ要素が含まれ、この要素は常に同じ位置にあります。変更されるのは、レイアウト要素の内容のみです。

次のフィード項目レイアウト要素があります。

アクター (Feed Item レスポンスボディの actor プロパティ) — フィード項目の作成者の写真またはアイコン。
ヘッダー (Feed Item レスポンスボディの header プロパティ) — フィード項目のコンテキスト。同じフィード項目に、誰がどこに投稿したかに応じて異なるヘッダーを設定できます。この例では、Ted がフィード項目をグループに投稿しています。
タイムスタンプ (Feed Item レスポンスボディの relativeCreatedDate プロパティ) — フィード項目が投稿された日時。フィード項目の作成後 2 日を経過していない場合、日時は相対的なローカライズされた文字列として書式設定されます (「17 分前」など)。それ以外の場合は、日時は絶対的なローカライズされた文字列として書式設定されます。
内容 (Feed Item レスポンスボディの body プロパティ) — すべてのフィード項目には内容があります。ユーザがフィード項目のテキストを指定しない場合は、内容が null になることがあります。内容は null になる可能性があるため、テキスト表示のデフォルトケースとして使用できません。代わりに、常に値が含まれる、フィード項目のヘッダーの text プロパティを使用します。
補助内容 (Feed Item レスポンスボディの capabilities プロパティ) — フィード項目の機能の視覚化。「機能」を参照してください。

Salesforce UI でのバンドルの表示

バンドル投稿には、フィード追跡変更が含まれます。また、バンドル投稿はレコードフィード内にのみ存在します。

メモ

クライアントは capabilities プロパティを使用して、フィード要素で可能な操作やフィード要素を表示する方法を判別できます。このセクションでは、フィード要素の表示方法の一例としてバンドルを使用しますが、これらのプロパティはどのフィード要素でも使用できます。

きれいに整理されたフィードをユーザに提供するために、フィード変更追跡のフィード項目はバンドルに集約できます。個々のフィード項目を表示するには、バンドルをクリックします。

フィード追跡変更のバンドル。

バンドルは、バンドル機能を備えた汎用フィード要素です。次のバンドルレイアウト要素があります。

ヘッダー (Generic Feed Element レスポンスボディの header プロパティ) — フィード追跡変更バンドルの場合、このテキストは「User Name がこのレコードを更新しました。」です。
タイムスタンプ (Generic Feed Element レスポンスボディの relativeCreatedDate プロパティ) — フィード追跡変更が行われた日時。変更を行って 2 日を経過していない場合、日時は相対的なローカライズされた文字列として書式設定されます (「17 分前」など)。それ以外の場合は、日時は絶対的なローカライズされた文字列として書式設定されます。
補助内容 (Generic Feed Element レスポンスボディの capabilities.bundle.changes プロパティ) — バンドルは、バンドル内の最初の 2 つのフィード変更追跡について fieldName、oldValue、および newValue プロパティを表示します。フィード変更追跡が 3 つ以上ある場合は、バンドルが [すべての更新を表示] リンクを表示します。

フィード要素の表示

ユーザに表示されるフィード要素は、システム管理者によるフィード追跡、共有ルール、および項目レベルセキュリティの設定に応じて異なります。たとえば、ユーザにレコードへのアクセス権がない場合、そのレコードの更新は表示されません。フィード要素の親を表示できるユーザは、そのフィード要素を表示できます。通常、ユーザには次のフィード更新が表示されます。

ユーザに @メンションしているフィード要素 (ユーザがそのフィード要素の親にアクセスできる場合)
ユーザがメンバーであるグループに @メンションしているフィード要素
ユーザが親レコードを表示できるレコードに対するレコード項目の変更 (User、Group、および File レコードを含む)
ユーザに投稿されたフィード要素
ユーザが所有するか、ユーザがメンバーであるグループに投稿されたフィード要素
標準およびカスタムレコードのフィード要素 (ToDo、行動、リード、取引先、ファイルなど)

フィードの種別

フィードには多くの種別があります。各フィード種別は、フィード要素のコレクションを定義します。

フィード要素のコレクションはリリースが変わると変更される可能性があります。

重要

フィード種別は次のリソースで公開されます。

1/chatter/feeds/feedType
2/chatter/feeds/feedType/subjectId
3/connect/communities/communityId/chatter/feeds/feedType

たとえば、会社 (company)、トピック (topics)、およびホーム (home) のリソースを次に示します。

1/chatter/feeds/company
2/chatter/feeds/topics/subjectId
3/connect/communities/communityId/chatter/feeds/home

フィード種別とその説明は、次のとおりです。

Bookmarks — コンテキストユーザがブックマークとして保存したすべてのフィード項目が含まれます。
Company — 種別 TrackedChange のフィード項目を除くすべてのフィード項目が含まれます。ユーザがフィード項目を表示するには、親への共有アクセス権が必要です。
DirectMessageModeration — モデレーション用にフラグが設定されたすべてのダイレクトメッセージが含まれる。このダイレクトメッセージモデレーションフィードは、「エクスペリエンス Chatter メッセージのモデレート」権限を持つユーザのみが使用できます。
DirectMessages — コンテキストユーザのダイレクトメッセージのすべてのフィード項目が含まれます。
Draft — コンテキストユーザがドラフトを作成したすべてのフィード項目が含まれます。
Files — コンテキストユーザがフォローしている人またはグループによって投稿されたファイルを含むすべてのフィード項目が含まれます。
Filter — 指定したオブジェクト種別の親を持つフィード項目を含むように絞り込まれたニュースフィードが含まれます。
Groups — コンテキストユーザが所有するか、メンバーであるすべてのグループのすべてのフィード項目が含まれます。
Home — Experience Cloud サイトの管理トピックに関連付けられたすべてのフィード項目が含まれます。
Landing — フィードが要求されたとき、ユーザエンゲージメントを最適に促進する、すべてのフィード項目が含まれる。カスタマイズされたフィード項目が多くないとき、クライアントは空のフィードを避けることができます。
Moderation — ダイレクトメッセージを除き、モデレーション用にフラグが設定されたすべてのフィード項目が含まれます。このモデレーションフィードは、「エクスペリエンスフィードのモデレート」権限を持つユーザのみが使用できます。
Mute — コンテキストユーザがミュートしたすべてのフィード項目が含まれます。
News — コンテキストユーザがフォローする人、ユーザがメンバーとなっているグループ、およびユーザがフォローするファイルとレコードからのすべての更新が含まれます。親がコンテキストユーザであるレコードのすべての更新が含まれます。
PendingReview — 確認待機中のすべてのフィード項目とコメントが含まれます。
People — コンテキストユーザがフォローしているすべての人によって投稿されたすべてのフィード項目が含まれます。
Record — 親が指定されたレコードであるすべてのフィード項目が含まれます。レコードは、グループ、ユーザ、オブジェクト、ファイル、その他の標準またはカスタムオブジェクトの場合があります。レコードがグループの場合、フィードにはそのグループにメンションしているフィード項目も含まれます。レコードがユーザの場合、フィードにはそのユーザに対するフィード項目のみが含まれます。別のユーザのレコードフィードは取得できません。
Streams — コンテキストユーザがストリームで登録している最大 25 個のフィード対応エンティティの組み合わせのすべてのフィード項目が含まれます。フィード対応エンティティの例としては、ユーザ、グループ、レコードなどがあります。
To — コンテキストユーザのメンションを含むすべてのフィード項目が含まれます。コンテキストユーザがコメントしたフィード項目、コンテキストユーザが作成し、コメントされたフィード項目が含まれます。
Topics — 指定したトピックを含むすべてのフィード項目が含まれます。
UserProfile — フィードで追跡可能なレコードをユーザが変更したときに作成されたフィード項目が含まれます。親がそのユーザであるフィード項目とそのユーザに @メンションしているフィード項目が含まれます。このフィードは、グループ更新など、より多くのフィード項目を返すニュースフィードとは異なります。別のユーザのユーザプロファイルフィードを取得できます。

Favorites — コンテキストユーザが保存したお気に入りが含まれます。お気に入りには、フィード検索、リストビュー、およびトピックがあります。

/chatter/feed-elements を使用したフィード項目の投稿

/chatter/feed-elements リソースを使用すると、フィード種別を渡す必要がないため、非常に簡単に効率よくフィード項目を投稿できます。投稿できるフィード要素種別はフィード項目のみです。

ヒント

フィード項目を投稿するには、次のリソースを使用します。

1POST /chatter/feed-elements

フィード項目を投稿するときには、標準オブジェクトまたはカスタムオブジェクトの子を作成します。subjectId 要求パラメータ、または Feed Item Input リクエストボディの subjectId プロパティに、親オブジェクトを指定します。

投稿されたフィード項目の parent プロパティには、親オブジェクトに関する情報が含まれます。

ユーザプロファイルへの投稿

次の例では、要求パラメータを使用して、テキスト投稿をコンテキストユーザのユーザプロファイルに投稿します。

1POST /chatter/feed-elements?feedElementType=FeedItem&subjectId=me&text=Test

subjectId に、別名 me を指定します。コンテキストユーザのユーザ ID を指定することもできます。

新しく投稿されたフィード項目の parent プロパティには、コンテキストユーザの User Summary レスポンスボディが含まれます。

別のユーザへの投稿

次の例では、リクエストボディを使用して、別のユーザに投稿します。subjectId プロパティでは、ユーザの ID を指定します。

1POST /chatter/feed-elements
2
3{ 
4   "feedElementType":"FeedItem",
5   "subjectId":"005RR000000DmOg",
6   "body" : {
7      "messageSegments" : [
8      {
9         "type" : "Text",
10         "text" : "When should we meet for release planning?"
11      }
12      ]
13   }
14}

新しく投稿されたフィード項目の parent プロパティには、対象ユーザの User Summary レスポンスボディが含まれます。

グループへの投稿

次の例では、リクエストボディを使用して、グループに投稿します。subjectId プロパティでは、グループ ID を指定します。

1POST /chatter/feed-elements
2
3{ 
4   "feedElementType":"FeedItem",
5   "subjectId":"0F9RR0000004CPw",
6   "body" : {
7      "messageSegments" : [
8      {
9         "type" : "Text",
10         "text" : "When should we meet for release planning?"
11      }
12      ]
13   }
14}

新しく投稿されたフィード項目の parent プロパティには、指定されたグループの Group レスポンスボディが含まれます。

レコード (ファイルや取引先など) への投稿

次の例では、リクエストボディを使用して、レコードフィードでユーザにメンションします。subjectId プロパティでは、レコード ID を指定します。

1POST /chatter/feed-elements
2
3{ 
4   "feedElementType" : "FeedItem",
5   "subjectId" : "001RR000002G4Y0",
6   "body" : {
7      "messageSegments" : [
8      {
9         "type" : "Mention",
10         "id" : "005RR000000DmOg"
11      },
12      {
13         "type" : "Text",
14         "text" : " Have you checked on this account recently?"
15      }
16      ]
17   }
18}

新しいフィード項目の parent プロパティは、指定されたレコードタイプに応じて異なります。レコードタイプが File の場合、親は File Summary レスポンスボディです。レコードタイプが Group の場合、親は Group レスポンスボディです。レコードタイプが User の場合、親は User Summary レスポンスボディです。その他すべてのレコードタイプの場合、親は Record Summary レスポンスボディです。

フィードからのフィード要素の取得

フィード要素を含むフィードを返すには、次のリソースを使用します。フィード要素種別には、フィード項目、バンドル、およびおすすめが含まれます。

ヒント

フィードからフィード要素を取得する方法は、どのフィード種別でも似ていますが同一ではありません。

このテーブルのフィード種別からフィード要素を取得するときは、件名 ID を指定しないでください。別のフィードを指定するには、feedType を置き換えます。

フィード種別	リソース
会社、ダイレクトメッセージ、ドラフト、ランディング、確認待機中	`/chatter/feeds/feedType/feed-elements` 例: `/chatter/feeds/company/feed-elements`
ダイレクトメッセージモデレーション、ホーム、モデレーション	`/connect/communities/communityId/chatter/feeds/feedType/feed-elements` 例: `/connect/communities/communityId/chatter/feeds/home/feed-elements`

その他すべてのフィード種別からフィード要素を取得するには、件名 ID を指定します。別のフィードを指定するには、feedType を置き換えます。このテーブルの大部分のフィード種別の場合、subjectId は、コンテキストユーザの ID または別名 me である必要があります。レコードフィードの場合、subjectId はレコード ID です。ストリームフィードの場合、subjectId はストリーム ID です。トピックフィードの場合、subjectId はトピック ID です。ユーザプロファイルフィードの場合、subjectId はユーザ ID または別名 me です。

レコードフィードの場合、recordId は、フィードをサポートする任意のタイプのレコードにすることができます (グループを含む)。Salesforce UI のグループページ上のフィードは、レコードフィードです。

ヒント

フィード種別	リソース
Bookmarks、Files、Groups、Mute、News、People、Record、Streams、To、Topics、User Profile	`/chatter/feeds/feedType/subjectId/feed-elements` 例: `/chatter/feeds/news/me/feed-elements`

お気に入りフィードおよびフィルタフィードからフィード要素を取得するには、favoriteId または keyPrefix を指定します。keyPrefix はオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。次のフィードの場合、subjectId は、コンテキストユーザの ID または別名 me である必要があります。

フィード種別	リソース
Favorites	`/chatter/feeds/favorites/subjectId/favoriteId/feed-elements`
Filter	`/chatter/feeds/filter/subjectId/keyPrefix/feed-elements`

Connect REST API 開発者ガイド

機能