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

Chatter REST API 開発者ガイド

Chatter REST API の概要
Chatter REST API クイックスタート
Chatter REST API の機能
Chatter REST API の例
Chatter REST API リソース
Action Links リソース
Announcements リソース
Async Query リソース
Batch リソース
Chatter リソース
Comments リソース
Communities リソース
Communities Moderation リソース
Connect リソース
Dashboard Component Snapshot リソース
Datacloud リソース
Feed Elements リソース
Feed Items リソース
Feed リソース
Bookmarks Feed リソース
Communities Home Feed リソース
Communities Moderation Feed リソース
Company Feed リソース
Favorites Feed リソース
Feeds リソース
Files Feed リソース
Filter Feed リソース
Groups Feed リソース
Mute Feed リソース
News Feed リソース
People Feed リソース
Record Feed リソース
To Feed リソース
Topics Feed リソース
User Profile Feed リソース
Files Connect Repository リソース
Files リソース
Folders リソース
Groups リソース
Influence リソース
Likes リソース
Managed Topics リソース
Mentions リソース
Motifs リソース
Push Notifications リソース
Question and Answers Suggestions リソース
Recommendation Audience Resources
おすすめ定義リソース
Records リソース
スケジュール済みおすすめリソース
Subscriptions リソース
Topics リソース
User Profiles リソース
Users リソース
Zones リソース
Chatter REST API リクエストボディ
Chatter REST API レスポンスボディ
Chatter REST API の付録
PDF

News Feed リソース

コンテキストユーザが関心を示しているフィード要素を含むフィード。ニュースフィードへのフィード項目の post 送信に使用できます。

このフィードの構成は、Chatter Web UI に表示されているフィードと一致させるために、リリースによって異なる場合があります。

メモ

次のリソースを使用できます。

リソース 説明
/chatter/feeds/news/me コンテキストユーザの全フィードのフィード要素への URL を返します。
/chatter/feeds/news/me/feed-elements コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィード要素と、コンテキストユーザがフォローしている全ファイル、レコード、お���びユーザからの全フィード要素。このリソースは、フィード要素に関する情報を取得し、フィード要素を投稿するために使用します。

News Feed URL

コンテキストユーザの全フィードのフィード要素への URL を返します。

リソース
1/chatter/feeds/news/userId
1/connect/communities/communityId/chatter/feeds/news/userId

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

メモ

適用開始バージョン
23.0
Chatter が必要かどうか
はい
HTTP メソッド
GET または HEAD
要求パラメータ
パラメータ名 型 説明
sort String 作成日や最終更新日などで並び替えて返される順序を指定します。
  • CreatedDateDesc — 作成日の新しい順に並び替えます。
  • LastModifiedDateDesc — 活動の新しい順に並び替えられます。
デフォルト値は、CreatedDescDate です。
レスポンスボディ
Feed
レスポンスボディの例
1{ 
2   "feedElementPostUrl": "/services/data/v35.0/chatter/feed-elements",
3   "feedElementsUrl": "/services/data/v35.0/chatter/feeds/news/005xx000001Sv1mAAB/feed-elements"
4}

News Feed Elements

コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィード要素と、コンテキストユーザがフォローしている全ファイル、レコード、およびユーザからの全フィード要素。このリソースは、フィード要素に関する情報を取得し、フィード要素を投稿するために使用します。

フィード要素の投稿についての詳細は、「Feed Elements, Post and Search」を参照してください。

バイナリファイルのアップロードとフィード要素への添付についての詳細は、「バイナリファイルのアップロード」を参照してください。

リソース
1/chatter/feeds/news/userId/feed-elements
1/connect/communities/communityId/chatter/feeds/news/userId/feed-elements

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

メモ

適用開始バージョン
31.0
Chatter が必要かどうか
はい
HTTP メソッド
GET、HEAD
GET の要求パラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
density String フィードの密度。次のいずれかの値にします。
  • AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。
  • FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。

デフォルト値は、AllUpdates です。

 省略可能 31.0
elementsPerBundle Integer バンドルに含める最大フィード要素数。値は 0 ～ 10 の整数である必要があります。デフォルト値は 3 です。

バンドル投稿にはフィード追跡変更が含まれます。Salesforce1 ダウンロード可能アプリケーションでは、バンドル投稿がレコードフィードのみにあります。

メモ

 省略可能 31.0
filter String フィードの検索条件値を示します。
  • AllQuestions — 質問であるフィード要素のみ。
  • CommunityScoped — コミュニティを範囲とするフィード要素のみ。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。すべてのコミュニティで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
  • SolvedQuestions — 質問で最良の回答があるフィード要素のみ。
  • UnansweredQuestions — 質問で回答がないフィード要素のみ。
  • UnsolvedQuestions — 質問で最良の回答がないフィード要素のみ。
 省略可能 32.0
page String 生成されたトークン。フィード内のフィード要素のビューを示します。
ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。 
1"nextPageUrl": 
2"/services/data/v35.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-elements
6?page=2011-03-30T17:34:50Z,
70D5D0000000DSv4KAG"
 省略可能 31.0
pageSize Integer ページあたりの要素数を指定します。有効な値は 1 ～ 100 です。サイズを指定しない場合、デフォルトは 25 です。 省略可能 31.0
q String このフィード内のフィード要素の本文とコメントに含まれる 1 つ以上の検索キーワード。

検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

 省略可能 31.0
recentComment​Count Integer フィード要素ごとに含めるコメントの最大数。デフォルト値は 3 です。最大値は、25 です。 省略可能 31.0
sort String 作成日や最終更新日などで並び替えて返される順序を指定します。
  • CreatedDateDesc — 作成日の新しい順に並び替えます。
  • LastModifiedDateDesc — 活動の新しい順に並び替えられます。
デフォルト値は、CreatedDescDate です。		 省略可能 31.0
updatedSince String フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。

このトークンは作成しません。Feed Element Page レスポンスボディの updatesToken プロパティから、このトークンを取得します。

 省略可能 31.0
GET のレスポンスボディ
Feed Element Page

News Feed Items

コンテキストユーザが所有するグループかメンバーであるグループすべてからの全フィード要素と、コンテキストユーザがフォローしている全ファイル、レコード、およびユーザからの全フィード項目。このリソースは、フィード項目に関する情報の取得と、フィード項目の投稿 (ファイルを添付する、リンク、アンケート、質問を投稿する、投稿を共有するなど) に使用します。

フィード項目の post 送信についての詳細は、「入力での POST、PATCH、または PUT の使用」を参照してください。

バイナリファイルのアップロードとフィード項目への添付についての詳細は、「バイナリファイルのアップロード」を参照してください。

フィード項目とコメントの本文には、最大 10,000 文字まで含めることができます。

リソース
1/chatter/feeds/news/userId/feed-items

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

メモ

使用可能なバージョン
23.0 ～ 31.0

バージョン 32.0 以降では、News Feed Elements を使用します。

重要

Chatter が必要かどうか
はい
HTTP メソッド
GET、POST、HEAD
GET の要求パラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
density String フィードの密度。次のいずれかの値にします。
  • AllUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されます。
  • FewerUpdates — ユーザがフォローする人とレコード、およびユーザがメンバーとなっているグループからのすべての更新が表示されますが、レコードからのシステム生成された更新は非表示になります。

デフォルト値は、AllUpdates です。

 省略可能 29.0 ～ 31.0
page String 生成されたトークン。フィード内のフィード項目のビューを示します。ページトークンは、レスポンスボディの一部として、nextPageURL など、いずれかの URL パラメータで返されます。 
1"nextPageUrl": 
2"/services/data/v35.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-items
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 作成日や最終更新日などで並び替えて返される順序を指定します。
  • CreatedDateDesc — 作成日の新しい順に並び替えます。
  • LastModifiedDateDesc — 活動の新しい順に並び替えられます。
デフォルト値は、CreatedDescDate です。		 省略可能 23.0 ～ 31.0
updatedSince String フィードの変更タイムスタンプと並び替え順を定義する不透明トークン。

このトークンは作成しません。Feed Item Page レスポンスボディの updatesToken プロパティから、このトークンを取得します。

 省略可能 30.0 ～ 31.0
POST のリクエストボディ
ルート XML タグ
<feedItem>
JSON
次の例では、フィード項目にアンケートを添付します。
1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"When should we meet for release planning?"
7         }
8      ]
9   },
10   "capabilities":{
11      "poll":{
12         "choices":[
13            "Monday",
14            "Tuesday"
15         ]
16      }
17   },
18   "feedElementType":"FeedItem",
19   "subjectId":"me"
20}
フィード項目は複数の機能をサポートします。次の例では、ファイルをフィード項目に添付し、ブックマークします。
1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"Check out the latest marketing collateral."
7         }
8      ]
9   },
10   "capabilities":{
11      "bookmarks":{
12         "isBookmarkedByCurrentUser": true
13      },
14      "content":{
15         "contentDocumentId": "069D00000001uQO"
16      }
17   },
18   "feedElementType":"FeedItem",
19   "subjectId":"me"
20}
プロパティ
名前 型 説明 必須項目/省略可能 使用可能なバージョン
attachment 種別によって異なる。 attachment パラメータには、次のいずれか 1 つの値のみを指定できます。値は次のとおりです。

API バージョン 32.0 以降では、capabilities プロパティを使用します。

重要

 省略可能
body Message Body Input メッセージ本文の説明。本文には 25 文字まで使用できます。

フィード項目を共有するための originalFeedElementId を指定する場合、body プロパティを使用して最初のコメントをフィード項目に追加します。

フィード項目のこのプロパティを編集するには、/chatter/feed-elements​/feedElementId に対して PATCH 要求を実行します。フィード投稿の編集は、バージョン 34.0 以降でサポートされています。

 フィード項目にコンテンツ機能またはリンク機能がある場合を除き、必須 23.0
capabilities Feed Element Capabilities Input このフィード要素の動作を定義する機能。 省略可能 31.0
isBookmarked​ByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。

API バージョン 32.0 以降では、capabilities.bookmarks.​isBookmarkedByCurrentUser プロパティを使用します。

重要

 省略可能 24.0 ～ 31.0
feedElementType String この入力が表すフィード要素の種別。

有効な値は FeedItem のみです。

 必須項目 31.0
originalFeedElementId String フィード要素を共有するには、18 文字の ID を指定します。

投稿の共有とファイルのアップロードを同じリクエストボディで行うことはできません。

メモ

 省略可能 31.0
originalFeedItemId String フィード項目を共有するには、18 文字の ID を指定します。

API バージョン 32.0 以降は、originalFeedElementId プロパティを使用します。

重要

 省略可能 24.0 ～ 31.0
subjectId String このフィード要素が投稿された親の ID。この値は、ユーザ、グループ、レコードの ID、またはコンテキストユーザを示す文字列 me になります。 必須項目 31.0
visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。
  • InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
  • AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。
  • 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
  • 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 26.0
POST の要求パラメータ
次のいずれかのパラメータセットを使用します。たとえば、リンクの post 送信とファイルの添付を同じ要求で行うことはできません。

既存のファイルを添付するためのパラメータ

パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
attachmentType String 添付ファイルの種別。値 ExistingContent を含める必要があります。 必須項目 27.0 ～ 31.0
contentDocumentId String 既存のファイルの 18 文字の ID。 必須項目 23.0 ～ 31.0
isBookmarked​​ByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0
text String フィード項目のテキスト。 省略可能 23.0 ～ 31.0
visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。
  • InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
  • AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。
  • 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
  • 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 26.0 ～ 31.0

新規のファイルを添付するためのパラメータ

パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
attachmentType String 添付ファイルの種別。値 NewFile を含める必要があります。 必須項目 27.0 ～ 31.0
desc String post 送信するファイルの説明。

このパラメータは、バージョン 27.0 以降では使用しないでください。代わりに description を使用します。

注意

 省略可能 23.0 ～ 26.0
description String post 送信するファイルの説明。 省略可能 27.0 ～ 31.0
fileName String post 送信するファイルのファイル名。

このパラメータは、バージョン 24.0 以降では使用しないでください。代わりに title を使用します。

注意

 必須項目 23.0 ～ 24.0
isBookmarked​​ByCurrentUser 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 を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 26.0 ～ 31.0
リンクを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
attachmentType String 添付ファイルの種別。値 Link を含める必要があります。 必須項目 27.0 ～ 31.0
isBookmarked​​ByCurrentUser 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 を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 26.0 ～ 31.0
アンケートを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
attachmentType String 添付ファイルの種別。値 Poll を含める必要があります。 必須項目 27.0 ～ 31.0
isBookmarked​​ByCurrentUser 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 を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 26.0 ～ 31.0
投稿を共有するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
isBookmarked​ByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0
originalFeedItemId String 共有するフィード項目の 18 文字の ID。

投稿の共有は、ファイルのアップロードよりも優先されます。1 つの POST 内では、投稿の共有とファイルのアップロードの両方は行わないでください。

メモ

 必須項目 24.0 ～ 31.0
text String 共有されるフィード項目に対するコメント。 省略可能 28.0 ～ 31.0
visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。
  • InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
  • AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。
  • 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
  • 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 26.0 ～ 31.0
テキストのみを post 送信するためのパラメータ
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン
isBookmarked​​ByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 26.0 ～ 31.0
text String フィード項目のテキスト。最大文字数は 1000 文字です。 必須項目 23.0 ～ 31.0
visibility String 投稿を表示できるユーザ。有効な値は、次のとおりです。
  • InternalUsers — コミュニティが有効な場合は、デフォルトの内部コミュニティのメンバーに対してのみフィード項目を表示できます。
  • AllUsers — コミュニティが有効な場合は、コミュニティのすべてのメンバーに対してフィード項目を表示できます。
デフォルト値は、次のとおりです。
  • 外部ユーザの場合、デフォルト値は AllUsers です。外部ユーザが投稿を表示するには、この値を使用する必要があります。
  • 内部ユーザの場合、デフォルト値は InternalUsers です。内部ユーザは、この値を受け入れるか、値 AllUsers を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は 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
isBookmarked​​ByCurrentUser Boolean 新しいフィード項目をユーザのためにブックマークするか (true)、否か (false) を指定します。デフォルト値は、false です。 省略可能 29.0 ～ 31.0
namespacePrefix String キャンバスアプリケーションが作成された Developer Edition 組織の名前空間プレフィックス。 省略可能 29.0 ～ 31.0
parameters String キャンバスアプリケーションに渡される JSON 形式のパラメータ。JSON は URL でエンコードされている必要があります。
1parameters={'isUpdated'='true';}"
 省略可能 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 を使用して外部ユーザに投稿の表示を許可します。
フィード項目の親が User または Group の場合、フィード項目の visibility は AllUsers である必要があります。
 省略可能 29.0 ～ 31.0
GET のレスポンスボディ
Feed Item Page
POST のレスポンスボディ
Feed Item
ファイルポストの例
この例では、新しい添付ファイルがある投稿でニュースフィードを更新します。
1curl https://instance_name/services/data/v31.0/chatter/feeds/news/me/feed-items 
2     --form "feedItemFileUpload=@Desktop/textFile.txt" 
3     --form "title=Sample" 
4     --form "description=Just a Text File" 
5     --form "text=Please review" 
6     --form "attachmentType=NewFile" 
7     --header 'Authorization: Bearer 00DD0000000Jhd2!AQIAQBgn42jbvCW2SX8JaRO2_JjX1fNKXWBrjYQPXODtDyaT6gT4DJVs4Ki7s6GoxvO8a.Z7gTHKkfqjW6S1.ujlD413PYpF'
これは、ファイルポストでニュースフィードを更新する Java の例です。
1import java.io.File;
2
3import org.apache.commons.httpclient.*;
4import org.apache.commons.httpclient.methods.PostMethod;
5import org.apache.commons.httpclient.methods.multipart.*;
6
7...
8
9String oauthToken = "00Dx0000000X42V!AQgAQClp6UqGWNJUf4d3LQkVCysBIS6a";
10String url = "https://instance_name/services/data/v31.0/chatter/" +
11              "feeds/user-profile/me/feed-items";
12String text = "I love posting files to Chatter!";
13File contentFile = getFile();
14String description = "This is a test file that I'm posting.";
15String title = "contentFile";
16Part[] parts = {
17        new StringPart("description", description),
18        new StringPart("title", fileName),
19        new StringPart("text", text),
20        new FilePart("feedItemFileUpload", contentFile),
21};
22
23final PostMethod postMethod = new PostMethod(url);
24                
25try {
26    postMethod.setRequestEntity(new MultipartRequestEntity(parts, 
27                                postMethod.getParams()));
28    postMethod.setRequestHeader("Authorization", "Bearer " + oauthToken);
29    postMethod.setRequestHeader("Content-type", "multipart/form-data")
30    postMethod.addRequestHeader("X-PrettyPrint", "1");
31    
32    HttpClient httpClient = new HttpClient();
33    httpClient.getParams().setSoTimeout(60000);
34    
35    int returnCode = httpClient.executeMethod(postMethod);
36    
37    System.out.println(postMethod.getResponseBodyAsString());
38    
39    assertTrue("Expected return code of: " + HttpStatus.SC_CREATED, 
40                returnCode == HttpStatus.SC_CREATED);
41} finally {
42    postMethod.releaseConnection();
43}
リンクポストの例
この要求では、要求パラメータを使用してリンクポストを作成します。
1/chatter/feeds/news/me/feed-items?text=Did+you+see+this?&url=http://www.chatter.com
次のリクエストボディは、フィード項目投稿内にリンクを作成します。
1{ "body" : { 
2     "messageSegments" : [ 
3        { 
4           "type": "Link", 
5           "url" : "http://www.chatter.com" 
6        },
7        { 
8           "type": "Text", 
9           "text" : "Is everyone following this?" 
10        }
11      ]
12  }
13}
次のリクエストボディには、フィード項目投稿への添付ファイルとしてリンクが含まれます。
1{ "body" : { 
2      "messageSegments" : [ 
3         { 
4            "type": "Text", 
5            "text" : "Is everyone following this?" 
6         }
7      ]
8   },
9  "attachment" :{ 
10     "url" : "http://www.chatter.com",
11     "urlName" : "The Future of Social Enterprise"
12  }
13}

News Feed Items Flat

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

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

リソース
1/chatter/feeds/news/me/feed-items/flat
または
1/chatter/feeds/news/userId/feed-items/flat

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

メモ

適用開始バージョン
25.0 ～ 26.0

API バージョン 32.0 以降は、/chatter/feeds/news/userId/feed-elements を使用します。

重要

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