Filter Feed リソース

コンテキストユーザが使用できるフィルタフィードに関する情報が含まれる、フィードディレクトリオブジェクトのコレクション。各オブジェクトには、フィルタフィードの URL、フィルタフィード内のフィード項目またはフィード要素の URL、およびフィードの絞り込みに使用されるオブジェクトを説明する表示ラベルが含まれます。各 URL には、キープレフィックスと呼ばれるフィルタオブジェクトの最初の 3 文字が含まれます。これによりオブジェクト種別が示されます。このリソースを使用して、コンテキストユーザが独自のニュースフィードに適用できるキープレフィックスフィルタフィードのリストを返します。「Filter Feed Items」および「Filter Feed Elements」を参照してください。

リソース

1/chatter/feeds/filter/userId

1/connect/communities/communityId/chatter/feeds/filter/userId

userId は、コンテキストユーザの ID または別名 me である必要があります。

適用開始バージョン

23.0

Chatter が必要かどうか

はい

HTTP メソッド

GET または HEAD

レスポンスボディ

Feed Directory

レスポンスボディが空である場合、ユーザはどのレコードもフォローしていないということです。

コンテキストユーザが使用できる特定のフィルタフィードに関する情報が含まれる、フィードオブジェクト。リソース URL 内の keyPrefix はオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。

リソース

1/chatter/feeds/filter/userId/keyPrefix

1/connect/communities/communityId/chatter/feeds/filter/userId/keyPrefix

userId は、コンテキストユーザの ID または別名 me である必要があります。

適用開始バージョン

23.0

Chatter が必要かどうか

はい

HTTP メソッド

GET または HEAD

要求のパラメータ

パラメータ名	型	説明
sort	String	フィード内のフィード項目の順序。 CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、Moderation、および PendingReview フィードでのみ使用できます。 CreatedDateDesc — 作成日の新しい順に並び替えます。 LastModifiedDateDesc — 活動の新しい順に並び替えられます。 MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。 Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。 デフォルト値は、CreatedDateDesc です。

レスポンスボディ

Feed

レスポンスボディの例

この要求では、User オブジェクト (キープレフィックス 005) で絞り込まれたフィルタフィード項目リソースの URL が返されます。

1GET /chatter/feeds/filter/me/005

コンテキストユーザがメンバーであるすべてのグループからのフィード項目など、指定されたキープレフィックスが含まれる親を持つコンテキストユーザのニュースフィードからのフィード項目。キープレフィックスはオブジェクト ID の最初の 3 文字であり、オブジェクト種別を示します。

User 親オブジェクトを持つフィード項目で絞り込むには、キープレフィックス 005 を使用します。

Group 親オブジェクトを持つフィード項目で絞り込むには、キープレフィックス 0F9 を使用します。

コンテキストユーザがフォローしている親オブジェクト (取引先など) を持つフィード項目で絞り込むには、List of Filter Feed URLs リソースを使用して親オブジェクトを返します。

1/chatter/feeds/filter/me/0F9/feed-items

1/chatter/feeds/record/0F9XXXXXXXXX/feed-items

フィルタフィードは、コン��キストユーザに表示されるフィード項目のみを返します。最初の例では、リソースはコンテキストユーザがメンバーであるグループのフィード項目を返しません。2 番目の例では、このグループが公開グループであれば、コンテキストユーザがメンバーではなくても、グループのすべてのフィード項目が返されます。

リソース

1/chatter/feeds/filter/me/keyPrefix/feed-items

または

1/chatter/feeds/filter/userId/keyPrefix/feed-items

userId は、コンテキストユーザの ID または別名 me である必要があります。

使用可能なバージョン

23.0 ～ 31.0

バージョン 32.0 以降では、Filter Feed Elements を使用してください。

重要

Chatter が必要かどうか

はい

HTTP メソッド

GET または HEAD

要求のパラメータ

パラメータ名	型	説明	必須項目/省略可能	使用可能なバージョン
density	String	フィードの密度。次のいずれかの値にします。 AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。 FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。 デフォルト値は、AllUpdates です。	省略可能	29.0 ～ 31.0
page	String	生成されたトークン。フィード内のフィード要素のビューを示します。 ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。たとえば、次のようになります。 1"nextPageUrl": 2"/services/data/v42.0/ 3chatter/feeds/news/ 4005D0000001GLowIAN 5/feed-elements 6?page=2011-03-30T17:34:50Z, 70D5D0000000DSv4KAG"	省略可能	23.0 ～ 31.0
pageSize	Integer	ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。	省略可能	23.0 ～ 31.0
q	String	このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。 検索文字列にはワイルドカード文字を含め��ことができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。	省略可能	28.0 ～ 31.0
recentComment​Count	Integer	フィード項目ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。	省略可能	29.0 ～ 31.0
sort	String	フィード内のフィード項目の順序。 CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、Moderation、および PendingReview フィードでのみ使用できます。 CreatedDateDesc — 作成日の新しい順に並び替えます。 LastModifiedDateDesc — 活動の新しい順に並び替えられます。 MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。 Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。 デフォルト値は、CreatedDateDesc です。	省略可能	23.0 ～ 31.0
updatedSince	String	フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。 このトークンは作成しません。Feed Element Page レスポンスボディの updatesToken プロパティから、このトークンを取得します。	省略可能	30.0 ～ 31.0

レスポンスボディ

Feed Item Page

例

この要求では、User オブジェクトである親を持ち、コンテキストユーザに表示されるすべてのフィード項目が取得されます。

1GET https://instance_name/services/data/v42.0/chatter/feeds/filter/me/005/feed-items

このリソースは、バージョン 26.0 で廃止されました。

フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。

リソース

1/chatter/feeds/filter/me/feed-items/flat

または

1/chatter/feeds/filter/userId/feed-items/flat

userId は、コンテキストユーザの ID または別名 me である必要があります。

メモ

適用開始バージョン

25.0 ～ 26.0

Chatter が必要かどうか

はい

HTTP メソッド

GET または HEAD

要求のパラメータ

パラメータ名	型	説明
numFeedItems	Integer	返されるフィード項目数を指定します。有効な値は 0 ～ 100 です。デフォルト値は 25 です。フィード項目にはコメントが含まれる場合があるため、25 個のフラットフィード項目を指定しても、実際に返される数がそれより多くなることがあります。たとえば、各フィード項目に 1 つのコメントがあり、recentCommentCount が 1 よりも大きい場合、50 個のフラットフィード項目が返されます。
page	String	生成されたトークン。フィード内のフィード項目のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。
recentComment​Count	Integer	返される最近のコメントの数を指定します。有効な値は 0 ～ 25 です。デフォルト値は 3 です。
sort	String。次のいずれかになります。 CreatedDateDesc LastModifiedDateDesc	返されたフィードを、作成日の昇順、または最終更新日の昇順で並び替えます。デフォルトは LastModifiedDateDesc です。

レスポンスボディ

Flat Feed