Connect REST API Developer Guide (Connect REST API 開発者ガイド)
jExperience Cloud サイト
Salesforce Experience Cloud により、従業員、顧客、パートナーのためのブランド空間を作成できます。ビジネスニーズに合わせてコミュニティ、サイト、またはポータルなどのエクスペリエンスをカスタマイズしながら作成することができ、その後も相互間をシームレスに移行できます。
特定の Experience Cloud サイトでは、ほとんどの Connect REST API リソースを要求できます。たとえば、特定のサイト内で、Feeds、Files、Groups、Topics、Users リソースに対して要求を実行できます。サイトでリソースを使用できる場合、そのドキュメントには /connect/communities/communityId で始まるリソースが含まれます。
一部の Connect REST API リソースは、サイト内でのみ使用できます。これには、コンテンツのフラグ設定とモデレート、管理トピックの使用、ユーザの評価に関する情報の取得を行うためのリソースが含まれます。
サイトで使用できるリソースは、ログインなしでのアクセスを許可するかどうかに関係なく使用できます。ただし、サイトでログインなしでのアクセスが許可されている場合、ゲストユーザはどの Connect REST API リソースにもアクセスできません。
次の表に、サイト内でのみ使用できるリソースを示します。
| リソース | HTTP のメソッド | ToDo | |
|---|---|---|---|
| /connect/communities | GET、POST | コンテキストユーザが使用できるすべての Experience Cloud サイトのリストを取得します。Experience Cloud サイトを作成します。 | |
| /connect/communities/communityId | GET | Experience Cloud サイトに関する情報を取得します。 | |
| /connect/communities/communityId/publish | POST | Experience Cloud サイトを公開します。 | |
| /connect/communities/communityId/chatter/comments/commentId/moderation-flags | GET、POST、DELETE | コンテキストユーザがモデレータの場合、メンバーが 1 つのコメントにフラグを設定した回数を取得します。また、コメントにモデレーションのフラグを設定したり、コメントのすべてのフラグを削除したりします。 コンテキストユーザがモデレータでない場合は、ユーザがコメントにフラグを設定したかどうかを返します。また、コメントにモデレーションのフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。 |
|
| /connect/communities/communityId/chatter/feed-elements/feedElementId/capabilities/moderation | GET、POST、DELETE | フィード要素のモデレーション機能に関する情報の取得、フィード要素へのモデレーションフラグの追加、またはフィード要素のすべてのモデレーションフラグの削除を行います。 | |
| /connect/communities/communityId/files/moderation | GET |
コンテキストユーザがモデレータの場合、メンバーがフラグを設定したファイルを取得します。 |
|
| /connect/communities/communityId/files/fileId/moderation-flags | GET、POST、DELETE | コンテキストユーザがモデレータの場合、メンバーが 1 つのファイルにフラグを設定した回数を取得します。また、ファイルにモデレーションのフラグを設定したり、ファイルのすべてのフラグを削除したりします。 コンテキストユーザがモデレータでない場合は、ユーザがファイルにフラグを設定したかどうかを取得します。また、ファイルにモデレーションのフラグを設定したり、ユーザが以前に追加したフラグを削除したりします。 |
|
| /connect/communities/communityId/chatter/feeds/moderation/feed-elements | GET | コンテキストユーザが「エクスペリエンスフィードのモデレート」権限を持っている場合、このリソースは Experience Cloud サイトのメンバーによってフラグが設定された、サイト内のすべてのフィード要素とコメントのリストを返します。 | |
| /connect/communities/communityId/chatter/feeds/home/feed-elements | GET | Experience Cloud サイトのホームからのフィード要素とコメントを含むフィード。 | |
| /connect/communities/communityId/managed-content/delivery | GET | Experience Cloud サイトの公開された管理コンテンツバージョンを取得します。 | |
| /connect/communities/communityId/managed-topics | GET、POST、PATCH | Experience Cloud サイトのすべての管理トピックを取得します。管理トピックの作成、管理トピック階層の作成、管理トピックの並び替えを行います。 | |
| /connect/communities/communityId/managed-topics/managedTopicId | GET、DELETE | Experience Cloud サイトの管理トピックの情報取得または削除を行います。 | |
| /connect/communities/communityId/missions/users/userId | PATCH | ユーザの活動目的アクティビティ数を更新します。 | |
| /connect/communities/communityId/missions/users/userId/activities/export-job | GET | ユーザの活動目的アクティビティをエクスポートします。 | |
| /connect/communities/communityId/missions/users/userId/activities/purge-job | POST | ユーザの活動目的アクティビティを消去するジョブを開始します。 | |
| /connect/communities/communityId/missions/activities/purge-job | POST | すべてのユーザの活動目的アクティビティを消去するジョブを開始します。 | |
| /connect/communities/communityId/navigation-menu/navigation-menu-items | GET | Experience Cloud サイトのナビゲーションメニュー項目を取得します。 | |
| /connect/communities/communityId/personalization/audiences | GET、POST | ユーザコンテキストに一致する割り当て済み利用者のリストを取得します。利用者を作成します。 | |
| /connect/communities/communityId/personalization/audiences/audienceId | GET、PATCH、DELETE | 利用者を取得、更新、削除します。 | |
| /connect/communities/communityId/personalization/targets | GET、POST、PATCH | ユーザを含む割り当て済み利用者に基づいて、そのユーザのコンテキストに一致する対象のリストを取得します。対象を作成、更新します。 | |
| /connect/communities/communityId/personalization/targets/batch/targetIds | GET | 対象 ID のカンマ区切りのリストの対象情報を取得します。 | |
| /connect/communities/communityId/personalization/targets/targetId | GET、DELETE | 対象を取得または削除します。 | |
| /connect/communities/communityId/question-and-answers/top-unanswered (パイロット) | GET | Experience Cloud サイトのコンテキストユーザの上位の未回答の質問を取得します。 | |
| /connect/communities/communityId/topics/topicId/trending-articles | GET | Experience Cloud サイトのトピックのトレンド記事を取得します。 | |
| /connect/communities/communityId/trending-articles | GET | Experience Cloud サイトのトレンド記事を取得します。 | |
| /connect/communities/communityId/chatter/users/userId/audit-actions/counts | GET | Experience Cloud サイトのユーザの監査統計を取得します。 | |
| /connect/communities/communityId/chatter/users/userId/reputation | GET | Experience Cloud サイトのユーザの評価を取得します。 |