Scheduled Recommendation

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

リソース

使用可能なバージョン

33.0

Chatter が必要かどうか

いいえ

HTTP メソッド

GET、HEAD、PATCH、DELETE

PATCH のリクエストボディ

ルート XML タグ

<scheduledRecommendation>

既存のスケジュール済みおすすめを更新する JSON の例

プロパティ

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

PATCH のレスポンスボディ

スケジュール済みおすすめ

DELETE の要求パラメータ

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

DELETE のレスポンスボディ

204: Successful Delete

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