カスタムのおすすめを作成し、利用者を使用してスケジュールする | Connect REST API 開発者ガイド

コミュニティマネージャは、カスタムのおすすめの利用者、定義、およびスケジュールへのアクセスと、それらの作成および削除を行うことができます。(コミュニティマネージャとは、「エクスペリエンスの作成および設定」または「環境を管理」権限を持つユーザです。)「すべてのデータの編集」権限を持つユーザも、カスタムおすすめ利用者、カスタムおすすめ定義、およびスケジュール済みカスタムおすすめに対するアクセス、作成、削除を行うことができます。

デフォルトでは、これらのおすすめは、カスタマーサービステンプレートにのみ表示されます。ホームページと質問の詳細ページ、および Salesforce モバイル Web のフィードに表示されます。また、コミュニティマネージャがエクスペリエンスビルダーを使用してカスタマーサービステンプレートにおすすめを追加した場所にも表示されます。

ユーザに常に同じおすすめが表示されないように、Salesforce では、受け入れられたり却下されたりしていないカスタムおすすめを定期的に削除したり、復活させたりしています。

ステップ 1: カスタムのおすすめを定義する

リソース

/connect/communities/communityId/recommendation-definitions

HTTP メソッド

POST

リクエストボディ

Custom Recommendation Definition Input

リクエストボディの例

1{
2   "name":"Corporate Training Project",
3   "title":"Want to learn more about the Corporate Training Project?",
4   "explanation":"Click this link to learn more!",
5   "actionUrl":"https://www.example.com",
6   "actionUrlName":"Launch"
7}

レスポンスボディ

Custom Recommendation Definition

ステップ 2: 画像をカスタムのおすすめに追加する

この例では、Salesforce にアップロードされている画像ファイルを追加します。新しい画像ファイルをアップロードするには、「バイナリファイルのアップロード」を参照してください。

リソース

/connect/recommendation-definitions/recommendationDefinitionId/photo

ステップ 1 の Recommendation Definition レスポンスボディで返された recommendationDefinitionId を使用します。

HTTP メソッド

PUT

リクエストボディ

Photo Input

リクエストボディの例

1{
2   "cropSize" : "120",
3   "cropX" : "0",
4   "cropY" : "0",
5   "fileId" : "069D00000001IOh"
6}

レスポンスボディ

Photo

ステップ 3: おすすめ利用者を作成する

リソース

/connect/communities/communityId/recommendation-audiences

HTTP メソッド

POST

リクエストボディ

Custom Recommendation Audience Input

リクエストボディの例

1{
2   "name" : "Custom App Users"
3}

レスポンスボディ

Custom Recommendation Audience

ステップ 4: メンバーをおすすめ利用者に追加する

リソース

/connect/communities/communityId/recommendation-audiences/recommendationAudienceId

ステップ 3 の Recommendation Audience レスポンスボディで返された recommendationAudienceId を使用します。

HTTP メソッド

PATCH

リクエストボディ

Custom Recommendation Audience Input

この例では、この Recommendation Audience Input リクエストボディには criteria プロパティがあり、これは Custom List Audience Criteria Input リクエストボディです。Custom List Audience Criteria Input リクエストボディには members プロパティがあり、これは User ID Collection Input リクエストボディです。

リクエストボディの例

1{ 
2   "criteria" : {
3      "memberOperationType" : "Add",
4      "members" : {
5         "userIds" : [
6            "005B0000000Ge16",
7            "005D0000001GpHp"
8            ]
9         },
10      "type" : "CustomList"
11   }
12}

レスポンスボディ

Custom Recommendation Audience

ステップ 5: 利用者を使用して、カスタムのおすすめをスケジュールする

リソース

/connect/communities/communityId/scheduled-recommendations

HTTP メソッド

POST

リクエストボディ

Scheduled Custom Recommendation Input

リクエストボディの例

1{
2   "recommendationDefinitionId" : "0RDD00000004CEhOAM",
3   "recommendationAudienceId":"02JD00000008SfdMAE"
4}

レスポンスボディ

Scheduled Custom Recommendation