Recommendations クラス

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationAudience createRecommendationAudience(String communityId, ConnectApi.RecommendationAudienceInput recommendationAudience)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationAudience

型: ConnectApi.RecommendationAudienceInput

ConnectApi.RecommendationAudienceInput オブジェクト。

戻り値

型: ConnectApi.​RecommendationAudience

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationAudience createRecommendationAudience(String communityId, String name)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

name

型: String

利用者の名前。

戻り値

型: ConnectApi.​RecommendationAudience

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationDefinition createRecommendationDefinition(String communityId, ConnectApi.RecommendationDefinitionInput recommendationDefinition)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinition

型: ConnectApi.RecommendationDefinitionInput

ConnectApi.RecommendationDefinitionInput オブジェクト。

戻り値

型: ConnectApi.RecommendationDefinition

使用方法

おすすめ定義を使用すると、Experience Cloud サイトに表示されるカスタムおすすめを作成して、ユーザに動画の閲覧やトレーニングの受講などを促すことができます。

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

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

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationDefinition createRecommendationDefinition(String communityId, String name, String title, String actionUrl, String actionUrlName, String explanation)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

name

型: String

カスタムおすすめ定義の名前。この名前が [設定] に表示されます。

title

型: String

カスタムおすすめ定義のタイトル。

actionUrl

型: String

カスタムおすすめに基づいて行動するための URL (グループに参加するための URL など)。

actionUrlName

型: String

ユーザインターフェースのアクション URL のテキストラベル ("Launch" など)。

explanation

型: String

カスタムおすすめの説明 (本文)。

戻り値

型: ConnectApi.RecommendationDefinition

使用方法

おすすめ定義を使用すると、Experience Cloud サイトに表示されるカスタムおすすめを作成して、ユーザに動画の閲覧やトレーニングの受講などを促すことができます。

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

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

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendation createScheduledRecommendation(String communityId, ConnectApi.ScheduledRecommendationInput scheduledRecommendation)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

scheduledRecommendation

型: ConnectApi.ScheduledRecommendationInput

ConnectApi.ScheduledRecommendationInput オブジェクト。

戻り値

型: ConnectApi.ScheduledRecommendation

使用方法

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

API バージョン

36.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendation createScheduledRecommendation(String communityId, String recommendationDefinitionId, Integer rank, Boolean enabled, String recommendationAudienceId, ConnectApi.RecommendationChannel channel)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

rank

型: Integer

スケジュール済みカスタムおすすめの相対的なランク。1 から開始する昇順の整数で示されます。

ランクを設定することと、順序付きリストに挿入することは同じです。スケジュール済みカスタムおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みカスタムおすすめの rank が 1 つずつ下がります。 「スケジュール済みカスタムおすすめにランクを付ける場合の例」を参照してください。

指定された rank がリストのサイズよりも大きい場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。スケジュール済みカスタムおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。

rank が指定されていない場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。

enabled

型: Boolean

スケジュールが有効になっているかどうかを示します。true の場合、カスタムおすすめが有効になり、Experience Cloud サイトに表示されます。false の場合、Salesforce モバイル Web でのフィードのカスタムおすすめは削除されませんが、新しいカスタムおすすめは表示されなくなります。カスタマーサービスと Partner Central のサイトでは、無効にしたカスタムおすすめは表示されません。

recommendationAudienceId

型: String

このスケジュール済みおすすめによってスケジュールされたカスタムおすすめ定義の ID。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

これらのチャネル値を使用します。名前を変更したり、別のチャネルを作成したりすることはできません。

戻り値

型: ConnectApi.ScheduledRecommendation

使用方法

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

スケジュール済みカスタムおすすめにランクを付ける場合の例

次のようなスケジュール済みカスタムおすすめがあるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationB	2
ScheduledRecommendationC	3

Scheduled Custom Recommendation Input に次の情報を含めるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationD	2

結果は次のとおりです。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationD	2
ScheduledRecommendationB	3
ScheduledRecommendationC	4

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteRecommendationAudience(String communityId, String recommendationAudienceId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationAudienceId

型: String

カスタムおすすめ利用者の ID。

戻り値

型: Void

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteRecommendationDefinition(String communityId, String recommendationDefinitionId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

戻り値

型: Void

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

はい

署名

public static Void deleteRecommendationDefinitionPhoto(String communityId, String recommendationDefinitionId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

戻り値

型: Void

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteScheduledRecommendation(String communityId, String scheduledRecommendationId, Boolean deleteDefinitionIfLast)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

scheduledRecommendationId

型: String

スケジュール済みカスタムおすすめの ID。

deleteDefinitionIfLast

型: Boolean

true の場合、カスタムおすすめ定義の最後のスケジュール済みカスタムおすすめのときは、このカスタムおすすめ定義が削除されます。デフォルトは false です。

戻り値

型: Void

使用方法

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

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationAudience getRecommendationAudience(String communityId, String recommendationAudienceId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationAudienceId

型: String

カスタムおすすめ利用者の ID。

戻り値

型: ConnectApi.​RecommendationAudience

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.UserReferencePage getRecommendationAudienceMembership(String communityId, String recommendationAudienceId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationAudienceId

型: String

カスタムおすすめ利用者の ID。

戻り値

型: ConnectApi.​UserReferencePage

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.UserReferencePage getRecommendationAudienceMembership(String communityId, String recommendationAudienceId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationAudienceId

型: String

カスタムおすすめ利用者の ID。

pageParam

型: Integer

返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりのメンバー数を指定します。

戻り値

型: ConnectApi.​UserReferencePage

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationAudiencePage getRecommendationAudiences(String communityId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

戻り値

型: ConnectApi.RecommendationAudiencePage

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationAudiencePage getRecommendationAudiences(String communityId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

pageParam

型: Integer

返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの利用者数を指定します。

戻り値

型: ConnectApi.RecommendationAudiencePage

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationDefinition getRecommendationDefinition(String communityId, String recommendationDefinitionId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

戻り値

型: ConnectApi.RecommendationDefinition

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo getRecommendationDefinitionPhoto(String communityId, String recommendationDefinitionId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

戻り値

型: ConnectApi.Photo

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationDefinitionPage getRecommendationDefinitions(String communityId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

戻り値

型: ConnectApi.RecommendationDefinitionPage

使用方法

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

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectId

型: String

アクションを実行するオブジェクトを指定します。

• action が follow の場合、objectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID になります (バージョン 36.0 以降)。
• action が join の場合、objectId はグループ ID です。
• action が view の場合、objectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、カスタムおすすめ ID (バージョン 34.0 以降)、静的なおすすめの列挙 Today (バージョン 35.0 以降)、または記事 ID (バージョン 37.0 以降) です。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

API バージョン

36.0

ゲストユーザが使用可能

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType contextAction, String contextObjectId, ConnectApi.RecommendationChannel channel, Integer maxResults)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行された���クションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または記事 ID です (バージョン 37.0 以降)。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

36.0

ゲストユーザが使用可能

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendationActionType contextAction, String contextObjectId, ConnectApi.RecommendationChannel channel, Integer maxResults)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または記事 ID です (バージョン 37.0 以降)。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

36.0

ゲストユーザが使用可能

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectCategory, ConnectApi.RecommendationActionType contextAction, String contextObjectId, ConnectApi.RecommendationChannel channel, Integer maxResults)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectCategory

型: String

• action が follow の場合、objectCategory は users、files、topics、または records です。
• action が join の場合、objectCategory は groups になります。
• action が view の場合、objectCategory は users、files、groups、records、custom、apps、または articles になります (バージョン 37.0 以降)。

オブジェクト ID の先頭 3 文字のキープレフィックスを objectCategory として指定することもできます。有効な値は、次のとおりです。

• action が follow の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、0TO (トピック)、または 001 (取引先) です。
• action が join の場合、objectCategory は 0F9 (グループ) です。
• action が view の場合、objectCategory は、005 (ユーザ)、069 (ファイル)、0F9 (グループ)、0RD (カスタムおすすめ)、T (静的なおすすめ)、または 001 (取引先)、kA0 (記事) などです (バージョン 370 以降)。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または記事 ID です (バージョン 37.0 以降)。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendation getScheduledRecommendation(String communityId, String scheduledRecommendationId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

scheduledRecommendationId

型: String

スケジュール済みカスタムおすすめの ID。

戻り値

型: ConnectApi.ScheduledRecommendation

使用方法

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

API バージョン

36.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendationPage getScheduledRecommendations(String communityId, ConnectApi.RecommendationChannel channel)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

戻り値

型: ConnectApi.ScheduledRecommendationPage

使用方法

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

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static rejectRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。サポートされている値は、次のとおりです。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectId

型: String

アクションを実行するオブジェクトを指定します。

• action が follow の場合、objectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID になります (バージョン 36.0 以降)。
• action が join の場合、objectId はグループ ID です。
• action が view の場合、objectId はカスタムおすすめ ID、静的なおすすめの列挙 Today、または記事 ID です (バージョン 37.0 以降)。

戻り値

型: Void

API バージョン

34.0

Chatter が必要かどうか

はい

署名

public static rejectRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendedObjectType objectEnum)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。サポートされている値は、次のとおりです。

• view — 静的なおすすめを表示します。

objectEnum

型: ConnectApi.​RecommendedObjectType

アクションを実行するオブジェクト種別を指定します。

• Today — ID のない静的なおすすめ (Today アプリケーションのおすすめなど)。

戻り値

型: Void

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationAudience updateRecommendationAudience(String communityId, String recommendationAudienceId, ConnectApi.RecommendationAudienceInput recommendationAudience)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationAudienceId

型: String

カスタムおすすめ利用者の ID。

recommendationAudience

型: ConnectApi.RecommendationAudienceInput

ConnectApi.RecommendationAudienceInput オブジェクト。

戻り値

型: ConnectApi.​RecommendationAudience

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationDefinition updateRecommendationDefinition(String communityId, String recommendationDefinitionId, String name, String title, String actionUrl, String actionUrlName, String explanation recommendationDefinition)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

name

型: String

カスタムおすすめ定義の名前。この名前が [設定] に表示されます。

title

型: String

カスタムおすすめ定義のタイトル。

actionUrl

型: String

カスタムおすすめに基づいて行動するための URL (グループに参加するための URL など)。

actionUrlName

型: String

ユーザインターフェースのアクション URL のテキストラベル ("Launch" など)。

explanation

型: String

カスタムおすすめの説明 (本文)。

戻り値

型: ConnectApi.RecommendationDefinition

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RecommendationDefinition updateRecommendationDefinition(String communityId, String recommendationDefinitionId, ConnectApi.RecommendationDefinitionInput recommendationDefinition)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

recommendationDefinition

型: ConnectApi.RecommendationDefinitionInput

更新するプロパティを含む ConnectApi.RecommendationDefinitionInput オブジェクト。

戻り値

型: ConnectApi.RecommendationDefinition

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo updateRecommendationDefinitionPhoto(String communityId, String recommendationDefinitionId, ConnectApi.BinaryInput fileUpload)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

fileUpload

型: ConnectApi.Binary​​Input

写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.Photo

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo updateRecommendationDefinitionPhoto(String communityId, String recommendationDefinitionId, String fileId, Integer versionNumber)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

fileId

型: String

すでにアップロードされたファイルの ID。ファイルは画像であり、2 GB 未満である必要があります。

versionNumber

型: Integer

既存ファイルのバージョン番号。既存のバージョン番号を指定するか、null を指定して最新バージョンを取得します。

戻り値

型: ConnectApi.Photo

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo updateRecommendationDefinitionPhotoWithAttributes(String communityId, String recommendationDefinitionId, ConnectApi.PhotoInput photo)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

photo

型: ConnectApi.PhotoInput

ファイル ID、バージョン番号、およびトリミングパラメータを指定する ConnectApi.PhotoInput オブジェクト。

戻り値

型: ConnectApi.Photo

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo updateRecommendationDefinitionPhotoWithAttributes(String communityId, String recommendationDefinitionId, ConnectApi.PhotoInput photo, ConnectApi.BinaryInput fileUpload)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

photo

型: ConnectApi.PhotoInput

トリミングパラメータを指定する ConnectApi.PhotoInput オブジェクト。

fileUpload

型: ConnectApi.Binary​​Input

写真として使用するファイル。画像として使用できるコンテンツタイプである必要があります。

戻り値

型: ConnectApi.Photo

使用方法

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

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendation updateScheduledRecommendation(String communityId, String scheduledRecommendationId, ConnectApi.ScheduledRecommendationInput scheduledRecommendation)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

scheduledRecommendationId

型: String

スケジュール済みカスタムおすすめの ID。

scheduledRecommendation

型: ConnectApi.ScheduledRecommendationInput

更新するプロパティを含む ConnectApi.ScheduledRecommendationInput オブジェクト。

戻り値

型: ConnectApi.ScheduledRecommendation

使用方法

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

スケジュール済みカスタムおすすめにランクを付ける場合の例

次のようなスケジュール済みカスタムおすすめがあるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationB	2
ScheduledRecommendationC	3

Scheduled Custom Recommendation Input に次の情報を含めるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationD	2

結果は次のとおりです。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationD	2
ScheduledRecommendationB	3
ScheduledRecommendationC	4

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendation updateScheduledRecommendation(String communityId, String scheduledRecommendationId, Integer rank, Boolean enabled, String recommendationAudienceId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

scheduledRecommendationId

型: String

スケジュール済みカスタムおすすめの ID。

rank

型: Integer

スケジュール済みカスタムおすすめの相対的なランク。1 から開始する昇順の整数で示されます。

ランクを設定することと、順序付きリストに挿入することは同じです。スケジュール済みカスタムおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みカスタムおすすめの rank が 1 つずつ下がります。 「スケジュール済みカスタムおすすめにランクを付ける場合の例」を参照してください。

指定された rank がリストのサイズよりも大きい場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。スケジュール済みカスタムおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。

rank が指定されていない場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。

enabled

型: Boolean

スケジュールが有効になっているかどうかを示します。true の場合、カスタムおすすめが有効になり、Experience Cloud サイトに表示されます。false の場合、Salesforce モバイル Web でのフィードのカスタムおすすめは削除されませんが、新しいカスタムおすすめは表示されなくなります。カスタマーサービスと Partner Central のサイトでは、無効にしたカスタムおすすめは表示されません。

recommendationAudienceId

型: String

このスケジュール済みおすすめによってスケジュールされたカスタムおすすめ定義の ID。

戻り値

型: ConnectApi.ScheduledRecommendation

使用方法

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

スケジュール済みカスタムおすすめにランクを付ける場合の例

次のようなスケジュール済みカスタムおすすめがあるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationB	2
ScheduledRecommendationC	3

Scheduled Custom Recommendation Input に次の情報を含めるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationD	2

結果は次のとおりです。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationD	2
ScheduledRecommendationB	3
ScheduledRecommendationC	4

API バージョン

33.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectId, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectId

型: String

アクションを実行するオブジェクトを指定します。

• action が follow の場合、objectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID になります (バージョン 36.0 以降)。
• action が join の場合、objectId はグループ ID です。
• action が view の場合、objectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、カスタムおすすめ ID、静的なおすすめの列挙 Today、または記事 ID (バージョン 37.0 以降) です。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType contextAction, String contextObjectId, ConnectApi.RecommendationChannel channel, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または記事 ID です (バージョン 37.0 以降)。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendationActionType contextAction, String contextObjectId, ConnectApi.RecommendationChannel channel, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または記事 ID です (バージョン 37.0 以降)。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

36.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectCategory, ConnectApi.RecommendationActionType contextAction, String contextObjectId, ConnectApi.RecommendationChannel channel, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectCategory

型: String

• action が follow の場合、objectCategory は users、files、records、または topics です。
• action が join の場合、objectCategory は groups になります。
• action が view の場合、objectCategory は users、files、groups、records、custom、apps、または articles になります (バージョン 37.0 以降)。

オブジェクト ID の先頭 3 文字のキープレフィックスを objectCategory として指定することもできます。有効な値は、次のとおりです。

• action が follow の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、0TO (トピック)、または 001 (取引先) です。
• action が join の場合、objectCategory は 0F9 (グループ) です。
• action が view の場合、objectCategory は、005 (ユーザ)、069 (ファイル)、0F9 (グループ)、0RD (カスタムおすすめ)、T (静的なおすすめ)、または 001 (取引先)、kA0 (記事) などです (バージョン 370 以降)。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、レコード ID、またはトピック ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、レコード ID、または記事 ID です (バージョン 37.0 以降)。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

channel

型: ConnectApi.RecommendationChannel

カスタムおすすめをまとめる方法。たとえば、おすすめを 1 つにまとめ、たとえば UI の特定の場所に表示したり、1 日の時間帯や地理的な場所に基づいて表示したりするなど。値は次のとおりです。

• CustomChannel1 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。たとえば、コミュニティマネージャはエクスペリエンスビルダーを使用して、おすすめを表示する場所を決定できます。
• CustomChannel2 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel3 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel4 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• CustomChannel5 — カスタムのおすすめチャネル。デフォルトでは使用されません。カスタムチャネルはコミュニティマネージャと連携して定義します。
• DefaultChannel — デフォルトのおすすめチャネル。デフォルトでは、おすすめはエクスペリエンスビルダーのカスタマーサービステンプレートと Partner Central テンプレートのホームページと質問の詳細ページに表示されます。また、Salesforce モバイル Web のフィード、およびコミュニティマネージャがエクスペリエンスビルダーを使用しておすすめを追加した場所にも表示されます。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendation createScheduledRecommendation(String communityId, String recommendationDefinitionId, Integer rank, Boolean enabled, String recommendationAudienceId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

recommendationDefinitionId

型: String

カスタムおすすめ定義の ID。

rank

型: Integer

スケジュール済みカスタムおすすめの相対的なランク。1 から開始する昇順の整数で示されます。

ランクを設定することと、順序付きリストに挿入することは同じです。スケジュール済みカスタムおすすめは、rank で指定された位置に挿入されます。それ以降のすべてのスケジュール済みカスタムおすすめの rank が 1 つずつ下がります。 「スケジュール済みカスタムおすすめにランクを付ける場合の例」を参照してください。

指定された rank がリストのサイズよりも大きい場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。スケジュール済みカスタムおすすめの rank には、指定された値の代わりにリストのサイズが指定されます。

rank が指定されていない場合は、スケジュール済みカスタムおすすめがリストの末尾に配置されます。

enabled

型: Boolean

スケジュールが有効になっているかどうかを示します。true の場合、カスタムおすすめが有効になり、Experience Cloud サイトに表示されます。false の場合、Salesforce モバイル Web でのフィードのカスタムおすすめは削除されませんが、新しいカスタムおすすめは表示されなくなります。カスタマーサービスと Partner Central のサイトでは、無効にしたカスタムおすすめは表示されません。

recommendationAudienceId

型: String

このスケジュール済みおすすめによってスケジュールされたカスタムおすすめ定義の ID。

戻り値

型: ConnectApi.ScheduledRecommendation

使用方法

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

スケジュール済みカスタムおすすめにランクを付ける場合の例

次のようなスケジュール済みカスタムおすすめがあるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationB	2
ScheduledRecommendationC	3

Scheduled Custom Recommendation Input に次の情報を含めるとします。

スケジュール済みおすすめ	ランク
ScheduledRecommendationD	2

結果は次のとおりです。

スケジュール済みおすすめ	ランク
ScheduledRecommendationA	1
ScheduledRecommendationD	2
ScheduledRecommendationB	3
ScheduledRecommendationC	4

API バージョン

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

Chatter が必要かどうか

はい

署名

public static ConnectApi.RecommendationCollection getRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectCategory, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectCategory

型: String

• action が follow の場合、objectCategory は users、files、または records になります。
• action が join の場合、objectCategory は groups になります。
• action が view の場合、objectCategory は users、files、groups、records、custom、または apps になります。

オブジェクト ID の先頭 3 文字のキープレフィックスを objectCategory として指定することもできます。有効な値は、次のとおりです。

• action が follow の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、または 001 (取引先) です。
• action が join の場合、objectCategory は 0F9 (グループ) です。
• action が view の場合、objectCategory は、005 (ユーザ)、069 (ファイル)、0F9 (グループ)、0RD (カスタムおすすめ)、T (静的なおすすめ)、または 001 (取引先) などです。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

戻り値

型: ConnectApi.RecommendationCollection

使用方法

実行された最新のアクション (ユーザのフォローなど) に基づいておすすめを取得するには、contextAction と contextObjectId を一緒に使用します。たとえば、直前に Pam をフォローした場合、contextAction に follow、contextObjectId に Pam のユーザ ID を指定します。

この方法により、Pam をフォローするユーザがフォローしているユーザのみが推奨されます。この例では、John が Pam をフォローしており、John は Suzanne もフォローしているため、Suzanne をフォローするためのおすすめが返されます。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ScheduledRecommendationPage getScheduledRecommendations(String communityId)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

戻り値

型: ConnectApi.ScheduledRecommendationPage

使用方法

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

API バージョン

33.0 ～ 35.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

33.0 ～ 35.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void

API バージョン

33.0 ～ 35.0

Chatter が必要かどうか

はい

署名

public static Void setTestGetRecommendationsForUser(String communityId, String userId, ConnectApi.RecommendationActionType action, String objectCategory, ConnectApi.RecommendationActionType contextAction, String contextObjectId, Integer maxResults, ConnectApi.RecommendationCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

userId

型: String

コンテキストユーザの ID またはキーワード me。

action

型: ConnectApi.​RecommendationActionType

おすすめに対して実行するアクションを指定します。

• follow — ファイル、レコード、トピック、またはユーザをフォローします。
• join — グループに参加します。
• view — ファイル、グループ、記事、レコード、ユーザ、カスタム、または静的なおすすめを表示します。

objectCategory

型: String

• action が follow の場合、objectCategory は users、files、または records になります。
• action が join の場合、objectCategory は groups になります。
• action が view の場合、objectCategory は users、files、groups、records、custom、または apps になります。

オブジェクト ID の先頭 3 文字のキープレフィックスを objectCategory として指定することもできます。有効な値は、次のとおりです。

• action が follow の場合、objectCategory は 005 (ユーザ)、069 (ファイル)、または 001 (取引先) です。
• action が join の場合、objectCategory は 0F9 (グループ) です。
• action が view の場合、objectCategory は、005 (ユーザ)、069 (ファイル)、0F9 (グループ)、0RD (カスタムおすすめ)、T (静的なおすすめ)、または 001 (取引先) などです。

contextAction

型: ConnectApi.​RecommendationActionType

コンテキストユーザが直前に実行したアクション。サポートされている値は、次のとおりです。

• follow
• view

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

contextObjectId

型: String

コンテキストユーザが直前に実行したアクションのオブジェクトの ID。

• contextAction が follow の場合、contextObjectId は、ユーザ ID、ファイル ID、またはレコード ID です。
• contextAction が view の場合、contextObjectId は、ユーザ ID、ファイル ID、グループ ID、またはレコード ID です。

直前に実行されたアクションに基づいて新しいおすすめを取得するには、contextAction と contextObjectId を一緒に使用します。最新のアクションに基づくおすすめが不要な場合は、null を指定します。

maxResults

型: Integer

おすすめの結果の最大数。デフォルトは 10 です。値は 1 ～ 99 である必要があります。

result

型: ConnectApi.RecommendationCollection

テストデータを含むオブジェクト。

戻り値

型: Void