Personalization クラス

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Audience createAudience(String communityId, ConnectApi.AudienceInput audience)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

audience

型: ConnectApi.AudienceInput

対象読者を定義する ConnectApi.AudienceInput オブジェクト。

戻り値

型: ConnectApi.Audience

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TargetCollection createTargets(String communityId, ConnectApi.TargetCollectionInput target)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

target

型: ConnectApi.TargetCollectionInput

対象を定義する ConnectApi.TargetCollectionInput オブジェクト。

戻り値

型: ConnectApi.TargetCollection

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteAudience(String communityId, String audienceId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

audienceId

型: String

利用者の ID。

戻り値

型: Void

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteTarget(String communityId, String targetId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

targetId

型: String

対象の ID。

戻り値

型: Void

API バージョン

48.0

ゲストユーザーが使用可能

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Audience getAudience(String communityId, String audienceId, Boolean includeAudienceCriteria)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

audienceId

型: String

利用者の ID。

includeAudienceCriteria

型: Boolean

利用者の条件を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。

戻り値

型: ConnectApi.Audience

API バージョン

48.0

ゲストユーザーが使用可能

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.BatchResult[] getAudienceBatch(String communityId, List<String> audienceIds)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

audienceIds

型: List<String>

利用者 ID のカンマ区切りのリスト。

戻り値

型: ConnectApi.BatchResult[]

ConnectApi.BatchResult.getResult() メソッドは、読み込まれなかった利用者の ConnectApi.Audience オブジェクトとエラーを返します。

API バージョン

51.0

ゲストユーザーが使用可能

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.AudienceCollection getAudiences(String communityId, String ipAddress, String domain, String userId, ConnectApi.PublishStatus publishStatus, Boolean includeAudienceCriteria, List<String> targetTypes, String recordId)

パラメ��ター

communityId

型: String

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

ipAddress

型: String

ユーザーの IP アドレス。null の場合、場所条件がある利用者は返されません。

domain

型: String

ユーザーの Salesforce カスタムドメインの名前。null の場合、ドメイン条件がある利用者は返されません。

userId

型: String

ユーザーの ID。null の場合、デフォルトのコンテキストユーザーの ID になります。

publishStatus

型: ConnectApi.PublishStatus

利用者の状況を公開します。値は次のとおりです。

• Draft
• Live

null の場合は、デフォルトの Live になります。

includeAudienceCriteria

型: Boolean

利用者の条件を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。

targetTypes

型: List<String>

結果を絞り込むための対象種別のカンマ区切りリスト。サポートされる値は次のとおりです。

• ExperienceVariation (バージョン 48.0 以降)
• CustomObjectName__c などのカスタムオブジェクトの API 参照名 (バージョン 48.0 以降)
• NavigationLinkSet (バージョン 49.0 以降)
• Topic (バージョン 49.0 以降)
• CollaborationGroup (バージョン 49.0 以降)
• KnowledgeArticle (バージョン 49.0 以降)
• ContentDocument (バージョン 49.0 以降)
• ManagedContent (バージョン 49.0 以降)
• Report (バージョン 49.0 以降)
• Dashboard (バージョン 49.0 以降)

null の場合、すべての対象種別が返されます。

recordId

型: String

項目ベースの条件のレコードの ID。null の場合、項目ベースの条件があるすべての適用可能な利用者が返されます。

戻り値

型: ConnectApi.AudienceCollection

API バージョン

48.0

ゲストユーザーが使用可能

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.AudienceCollection getAudiences(String communityId, String ipAddress, String domain, String userId, ConnectApi.PublishStatus publishStatus, Boolean includeAudienceCriteria, List<String> targetTypes)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

ipAddress

型: String

ユーザーの IP アドレス。null の場合、場所条件がある利用者は返されません。

domain

型: String

ユーザーの Salesforce カスタムドメインの名前。null の場合、ドメイン条件がある利用者は返されません。

userId

型: String

ユーザーの ID。null の場合、デフォルトのコンテキストユーザーの ID になります。

publishStatus

型: ConnectApi.PublishStatus

利用者の状況を公開します。値は次のとおりです。

• Draft
• Live

null の場合は、デフォルトの Live になります。

includeAudienceCriteria

型: Boolean

利用者の条件を含めるか (true)、否か (false) を指定します。指定しない場合は、デフォルトの false になります。

targetTypes

型: List<String>

結果を絞り込むための対象種別のカンマ区切りリスト。サポートされる値は次のとおりです。

• ExperienceVariation (バージョン 48.0 以降)
• CustomObjectName__c などのカスタムオブジェクトの API 参照名 (バージョン 48.0 以降)
• NavigationLinkSet (バージョン 49.0 以降)
• Topic (バージョン 49.0 以降)
• CollaborationGroup (バージョン 49.0 以降)
• KnowledgeArticle (バージョン 49.0 以降)
• ContentDocument (バージョン 49.0 以降)
• ManagedContent (バージョン 49.0 以降)
• Report (バージョン 49.0 以降)
• Dashboard (バージョン 49.0 以降)

null 場合、すべての対象種別が返されます。

戻り値

型: ConnectApi.AudienceCollection

API バージョン

48.0

ゲストユーザーが使用可能

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Target getTarget(String communityId, String targetId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

targetId

型: String

対象の ID。

戻り値

型: ConnectApi.Target

API バージョン

48.0

ゲストユーザーが使用可能

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.BatchResult[] getTargetBatch(String communityId, List<String> targetIds)

パラメーター

communityId

型: String

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

targetIds

型: List<String>

対象 ID のカンマ区切りのリスト。

戻り値

型: ConnectApi.BatchResult

ConnectApi.BatchResult.getResult() メソッドは、読み込まれなかった対象の ConnectApi.Target オブジェクトとエラーを返します。

API バージョン

48.0

ゲストユーザーが使用可能

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TargetCollection getTargets(String communityId, String ipAddress, String domain, String userId, ConnectApi.PublishStatus publishStatus, String recordId, List<String> targetTypes, Boolean includeAudience, Boolean includeAllMatchingTargetsWithinGroup, List<String> groupNames)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

ipAddress

型: String

ユーザーの IP アドレス。null の場合、場所条件がある利用者は返されません。

domain

型: String

ユーザーの Salesforce カスタムドメインの名前。null の場合、ドメイン条件がある利用者は返されません。

userId

型: String

ユーザーの ID。null 場合、デフォルトは、コンテキストユーザーの ID です。

publishStatus

型: ConnectApi.PublishStatus

対象の公開状況。値は次のとおりです。

• Draft
• Live

recordId

型: String

利用者の項目ベースの条件を指定する場合のレコードの ID。

targetTypes

型: List<String>

結果を絞り込むための対象種別のカンマ区切りリスト。サポートされる値は次のとおりです。

• ExperienceVariation (バージョン 48.0 以降)
• CustomObjectName__c などのカスタムオブジェクトの API 参照名 (バージョン 48.0 以降)
• NavigationLinkSet (バージョン 49.0 以降)
• Topic (バージョン 49.0 以降)
• CollaborationGroup (バージョン 49.0 以降)
• KnowledgeArticle (バージョン 49.0 以降)
• ContentDocument (バージョン 49.0 以降)
• ManagedContent (バージョン 49.0 以降)
• Report (バージョン 49.0 以降)
• Dashboard (バージョン 49.0 以降)

null 場合、すべての対象種別が返されます。

includeAudience

型: Boolean

一致する利用者を含めるか (true)、否か (false) を指定します。null の場合、デフォルトは false です。

includeAllMatchingTargetsWithinGroup

型: Boolean

対象グループ内にすべての一致対象を含めるか (true)、否か (false) を指定します。null の場合、デフォルトは false です。false の場合は、グループ内の優先度に基づいて、各グループ内で最初に一致した対象が返されます。

groupNames

型: List<String>

グループ名のカンマ区切りのリスト。グループによって、関連する対象と利用者のペアがまとめられます。

戻り値

型: ConnectApi.TargetCollection

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Audience updateAudience(String communityId, String audienceId, ConnectApi.AudienceInput audience)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

audienceId

型: String

利用者の ID。

audience

型: ConnectApi.AudienceInput

利用者への更新を定義する ConnectApi.AudienceInput オブジェクト。

戻り値

型: ConnectApi.Audience

API バージョン

48.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TargetCollection updateTargets(String communityId, ConnectApi.TargetCollectionUpdateInput target)

パラメーター

communityId

型: String

Experience Cloud サイトの ID。

target

型: ConnectApi.TargetCollectionUpdateInput

対象の更新を定義する ConnectApi.TargetCollectionUpdateInput オブジェクト。

戻り値

型: ConnectApi.TargetCollection