Scheduled Custom Recommendation

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

リソース

1/connect/scheduled-recommendations/scheduledRecommendationId

1/connect/communities/communityId/scheduled-recommendations/scheduledRecommendationId

使用可能なバージョン

33.0

Chatter が必要かどうか

いいえ

HTTP のメソッド

GET、PATCH、DELETE

PATCH のリクエストボディ

ルート XML タグ

<scheduledRecommendation>

スケジュール済みカスタムおすすめを更新する JSON の例

1{   "rank" : "2"}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
channel	String	カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。 CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。 CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。 CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。 CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。 CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。 DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。 これらのチャネル値を使用します。名前を変更したり、別のチャネルを作成したりすることはできません。	スケジュール済みおすすめを作成する場合は省略可能 指定されていない場合、デフォルトの DefaultChannel に設定されます。 スケジュール済みおすすめを更新する場合は使用しないでください。	36.0
enabled	Boolean	スケジュールが有効になっているかどうかを示します。true の場合、カスタムおすすめが有効になり、Experience Cloud サイトに表示されます。false の場合、Salesforce モバイル Web でのフィードのカスタムおすすめは削除されませんが、新しいカスタムおすすめは表示されなくなります。カスタマーサービスと Partner Central のサイトでは、無効にしたカスタムおすすめは表示されません。	省略可能	34.0
rank	Integer	スケジュール済みカスタムおすすめの相対的なランク。1 から開始する昇順の整数で示されます。 ランクを設定することと、順序付きリストに挿入することは同じです。スケジュール済みカスタムおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みカスタムおすすめの rank が 1 つずつ下がります。「スケジュール済みカスタムおすすめにランクを付ける場合の例」を参照してください。 指定された rank がリストのサイズよりも大きい場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。スケジュール済みカスタムおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。 rank が指定されていない場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。	省略可能	33.0
recommendation​AudienceId	String	このスケジュール済みカスタムおすすめの利用者の ID。 スケジュール済みカスタムおすすめを更新する場合、カスタムおすすめ利用者とスケジュール済みカスタムおすすめ間の関連付けを削除するには、ALL を指定します。	省略可能	35.0
recommendation​DefinitionId	String	このスケジュール済みおすすめによってスケジュールされたカスタムおすすめ定義の ID。	スケジュール済みおすすめを作成する場合は必須 スケジュール済みカスタムおすすめを更新する場合は、recommendation​DefinitionId を指定できません。	33.0

PATCH の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
enabled	Boolean	スケジュールが有効になっているかどうかを示します。true の場合、カスタムおすすめが有効になり、Experience Cloud サイトに表示されます。false の場合、Salesforce モバイル Web でのフィードのカスタムおすすめは削除されませんが、新しいカスタムおすすめは表示されなくなります。カスタマーサービスと Partner Central のサイトでは、無効にしたカスタムおすすめは表示されません。	省略可能	34.0
rank	Integer	スケジュール済みカスタムおすすめの相対的なランク。1 から開始する昇順の整数で示されます。 ランクを設定することと、順序付きリストに挿入することは同じです。スケジュール済みカスタムおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みカスタムおすすめの rank が 1 つずつ下がります。「スケジュール済みカスタムおすすめにランクを付ける場合の例」を参照してください。 指定された rank がリストのサイズよりも大きい場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。スケジュール済みカスタムおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。 rank が指定されていない場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。	省略可能	33.0
recommendation​AudienceId	String	このスケジュール済みカスタムおすすめの利用者の ID。 スケジュール済みカスタムおすすめを更新する場合、カスタムおすすめ利用者とスケジュール済みカスタムおすすめ間の関連付けを削除するには、ALL を指定します。	省略可能	35.0

PATCH のレスポンスボディ

Scheduled Custom Recommendation

DELETE の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
deleteDefinition​IfLast	Boolean	true の場合、カスタムおすすめ定義の最後のスケジュール済みカスタムおすすめに対して DELETE 要求を行うと、カスタムおすすめ定義が削除されます。デフォルトは false です。	省略可能	35.0

DELETE のレスポンスボディ

204: Successful Delete

スケジュール済みカスタムおすすめの削除は、順序付きリストでの削除に相当します。スケジュール済みカスタムおすすめを削除すると、削除されたものの後にあるすべてのスケジュール済みカスタムおすすめが自動的に上位に順位付けされます。