Chatter REST API 開発者ガイド
jUser Profile Feed リソース
フィードで追跡可能なレコードをユーザが変更したときに作成されたフィード要素、親がユーザであるフィード要素、およびユーザにメンションしているフィード要素が含まれます。このフィードは、グループ更新など、より多くのフィード項目を返すニュースフィードとは異なります。User-Profile Feed へのフィード項目の post 送信に使用できます。別のユーザのユーザプロファイルフィードを取得できます。
次のリソースを使用できます。
| リソース | 説明 |
|---|---|
| /chatter/feeds/user-profile/me | ユーザプロファイルフィードのフィード要素への URL を返します。 |
| /chatter/feeds/user-profile/me/feed-elements | フィードで追跡可能なレコードをユーザが変更したときに作成されたフィード要素、親がユーザであるフィード要素、およびユーザにメンションしているフィード要素を返します。このフィードは、グループ更新など、より多くのフィード項目を返すニュースフィードとは異なります。User-Profile Feed へのフィード項目の post 送信に使用できます。別のユーザのユーザプロファイルフィードを取得できます。 |
User Profile Feed Elements
フィードで追跡可能なレコードをユーザが変更したときに作成されたフィード要素、親がユーザであるフィード要素、およびユーザにメンションしているフィード要素を返します。このフィードは、グループ更新など、より多くのフィード項目を返すニュースフィードとは異なります。User-Profile Feed へのフィード項目の post 送信に使用できます。別のユーザのユーザプロファイルフィードを取得できます。
- リソース
-
- 適用開始バージョン
- 31.0
- Chatter が必要かどうか
- はい
- HTTP メソッド
- GET、HEAD
- GET の要求パラメータ
-
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン density String フィードの密度。次のいずれかの値にします。 - AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。
- FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。
デフォルト値は、AllUpdates です。
省略可能 31.0 elementsPerBundle Integer バンドルに含める最大フィード要素数。値は 0 ～ 10 の整数である必要があります。デフォルト値は 3 です。 省略可能 31.0 filter String 値は、CommunityScoped のみです。コミュニティを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。 省略可能 34.0 page String 生成されたトークン。フィード内のフィード要素のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。 省略可能 31.0 pageSize Integer ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。デフォルト値は 25 です。 省略可能 31.0 q String このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。 検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
省略可能 31.0 recentCommentCount Integer フィード要素ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。 省略可能 31.0 sort String 並び替えによって返される順序を指定します。 - CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は、カスタマーサービス (Napili) テンプレートを使用したコミュニティのナビゲーション階層内にある、トピックが指定された質問にのみ使用できます。
省略可能 31.0 - GET のレスポンスボディ
- Feed Element Page
User Profile Feed Items
フィードで追跡可能なすべてのレコードに対するすべてのアクションのフィード項目を返します。このリソースは、新しいフィード項目の post 送信にも使用できます。
フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。
API バージョン 23.0 および 24.0 では、User Profile Feed Items リソースへの投稿でユーザ状況更新が作成されますが、フィード項目は作成されません。このため、これらの API バージョンでは、User Profile Feed Items リソースの文字制限は引き続き 1000 文字になります。- リソース
-
または
- 使用可能なバージョン
- 23.0 ～ 31.0
- Chatter が必要かどうか
- はい
- HTTP メソッド
- GET、POST、または HEAD
- POST のリクエストボディ
-
- ルート XML タグ
- <feedItem>
- JSON
- 次の例では、フィード項目にアンケートを添付します。
- プロパティ
-
名前 型 説明 必須項目/省略可能 使用可能なバージョン attachment 種別によって異なる。 attachment パラメータには、次のいずれか 1 つの値のみを指定できます。値は次のとおりです。 - Attachment Input: Canvas App (v29.0 ～ 31.0)
- Attachment Input: Existing Content (v23.0 ～ 31.0)
- Attachment Input: Feed Poll (v26.0 ～ 31.0)
- Attachment Input: Link (v23.0 ～ 31.0)
- Attachment Input: New File Upload (v23.0 ～ 31.0)
省略可能 body Message Body Input メッセージ本文の説明。フィード項目とコメントの本文には、最大 10,000 文字まで含めることができます。この制限は変更可能なため、クライアントが FeedItem または FeedComment オブジェクトで describeSObjects() コールを実行することをお勧めします。最大許容文字数を判断するには、Body または CommentBody 項目の長さを見ます。本文には 25 文字まで使用できます。 フィード項目を共有するための originalFeedElementId を指定する場合、body プロパティを使用して最初のコメントをフィード項目に追加します。
フィード項目のこのプロパティを編集するには、/chatter/feed-elements/feedElementId に対して PATCH 要求を実行します。フィード投稿の編集は、バージョン 34.0 以降でサポートされています。
フィード項目にコンテンツ機能またはリンク機能がある場合を除き、必須 23.0 capabilities Feed Element Capabilities Input このフィード要素の動作を定義する機能。 省略可能 31.0 isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 24.0 ～ 31.0 feedElementType String この入力が表すフィード要素の種別。 有効な値は FeedItem のみです。
必須項目 31.0 originalFeedElementId String フィード要素を共有するには、18 文字の ID を指定します。 省略可能 31.0 originalFeedItemId String フィード項目を共有するには、18 文字の ID を指定します。 省略可能 24.0 ～ 31.0 subjectId String このフィード要素が投稿された親の ID。この値は、ユーザ、グループ、レコードの ID、またはコンテキストユーザを示す文字列 me になります。 必須項目 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 26.0
- POST の要求パラメータ
- 次のいずれかのパラメータセットを使用します。たとえば、リンクの post 送信とファイルの添付を同じ要求で行うことはできません。
-
既存のファイルを添付するためのパラメータ
-
新規のファイルを添付するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン attachmentType String 添付ファイルの種別。値 NewFile を含める必要があります。 必須項目 27.0 ～ 31.0 desc String post 送信するファイルの説明。 省略可能 23.0 ～ 26.0 description String post 送信するファイルの説明。 省略可能 27.0 ～ 31.0 fileName String post 送信するファイルのファイル名。 必須項目 23.0 ～ 24.0 isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0 text String フィード項目のテキスト。 省略可能 23.0 ～ 31.0 title String アップロードまたは post 送信するファイルのファイル名。 必須項目 24.0 ～ 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 26.0 ～ 31.0 -
リンクを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン attachmentType String 添付ファイルの種別。値 Link を含める必要があります。 必須項目 27.0 ～ 31.0 isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0 text String フィード項目のテキスト。 省略可能 23.0 ～ 31.0 url String リンクの URL。 必須項目 23.0 ～ 31.0 urlName String URL の名前。 省略可能 23.0 ～ 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 26.0 ～ 31.0 -
アンケートを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン attachmentType String 添付ファイルの種別。値 Poll を含める必要があります。 必須項目 27.0 ～ 31.0 isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0 pollChoice1 ～ pollChoice10 String この選択肢を使用して、アンケートを含むフィード項目を作成します。アンケートには 2 個から 10 個のアンケート選択肢を指定します。 必須項目 26.0 ～ 31.0 text String フィード項目のテキスト。 必須項目 23.0 ～ 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 26.0 ～ 31.0 -
投稿を共有するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0 originalFeedItemId String 共有するフィード項目の 18 文字の ID。 必須項目 24.0 ～ 31.0 text String 共有されるフィード項目に対するコメント。 省略可能 28.0 ～ 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 26.0 ～ 31.0 -
テキストのみを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0 text String フィード項目のテキスト。最大文字数は 1000 文字です。 必須項目 23.0 ～ 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 26.0 ～ 31.0 -
キャンバスアプリケーションを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン attachmentType String 添付ファイルの種別。値 Canvas を含める必要があります。 必須項目 29.0 ～ 31.0 description String キャンバスアプリケーションの説明 省略可能 29.0 ～ 31.0 developerName String キャンバスアプリケーションの開発者名 (API 名) 必須項目 29.0 ～ 31.0 height String キャンバスアプリケーションの高さ (ピクセル単位)。デフォルトの高さは 200 ピクセルです。 省略可能 29.0 ～ 31.0 isBookmarkedByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 29.0 ～ 31.0 namespacePrefix String キャンバスアプリケーションが作成された Developer Edition 組織の名前空間プレフィックス。 省略可能 29.0 ～ 31.0 parameters String キャンバスアプリケーションに渡される JSON 形式のパラメータ。JSON は URL でエンコードされている必要があります。 省略可能 29.0 ～ 31.0 text String フィード項目のテキスト 省略可能 29.0 ～ 31.0 thumbnailUrl String キャンバスアプリケーションのサムネイル画像の URL。最大サイズは 120x120 ピクセルです。 省略可能 29.0 ～ 31.0 title String キャンバスアプリケーションへのリンクのタイトル 省略可能 29.0 ～ 31.0 visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。 - InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
- AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。- 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
- 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
省略可能 29.0 ～ 31.0 - GET または HEAD の要求パラメータ
-
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン density String フィードの密度。次のいずれかの値にします。 - AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。
- FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。
デフォルト値は、AllUpdates です。
省略可能 29.0 ～ 31.0 page String 生成されたトークン。フィード内のフィード項目のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。たとえば、次のようになります。 省略可能 23.0 ～ 31.0 pageSize Integer ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。 省略可能 23.0 ～ 31.0 q String このフィード内のフィード項目の本文とコメントに含まれる 1 つ以上の検索キーワード。 検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
省略可能 28.0 ～ 31.0 recentCommentCount Integer フィード項目ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。 省略可能 29.0 ～ 31.0 sort String 並び替えによって返される順序を指定します。 - CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は、カスタマーサービス (Napili) テンプレートを使用したコミュニティのナビゲーション階層内にある、トピックが指定された質問にのみ使用できます。
省略可能 23.0 ～ 31.0 - GET のレスポンスボディ
- Feed Item Page
- POST のレスポンスボディ
- Feed Item
User-Profile Feed Items Flat
このリソースは、バージョン 26.0 で廃止されました。
フラットフィードを返します。つまり、フィード項目とコメントの間に階層がなく、フィード項目とコメントはすべて同じレベルに配置されます。すべての項目は、時系列に返されます。
- リソース
-
または
- 適用開始バージョン
- 25.0 ～ 26.0
- Chatter が必要かどうか
- はい
- HTTP メソッド
- GET または HEAD
- 要求パラメータ
-
パラメータ名 型 説明 numFeedItems Integer 返されるフィード項目数を指定します。有効な値は 0 ～ 100 です。デフォルト値は 25 です。フィード項目にはコメントが含まれる場合があるため、25 個のフラットフィード項目を指定しても、実際に返される数がそれより多くなることがあります。たとえば、各フィード項目に 1 つのコメントがあり、recentCommentCount が 1 よりも大きい場合、50 個のフラットフィード項目が返されます。 page String 生成されたトークン。フィード内のフィード項目のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。 recentCommentCount Integer 返される最近のコメントの数を指定します。有効な値は 0 ～ 25 です。デフォルト値は 3 です。 sort String。次のいずれかになります。 - CreatedDateDesc
- LastModifiedDateDesc
返されたフィードを、作成日の昇順、または最終更新日の昇順で並び替えます。デフォルトは LastModifiedDateDesc です。 - レスポンスボディ
- Flat Feed