Skip Navigation

PersnlBatchDecision

Represents a batch personalization that delivers personalization decisions (content or recommendations) to a customer segment. Available in API version 64.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field	Details
ActivationTriggerType	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Type of trigger that activates the batch personalization decision. The default value is `None` and possible values are: `Automatic`—Automatically On Job Completion `None`
BatchStatus	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of the batch personalization decision. The default value is `Active` and possible values are: `Active` `Error` `Paused`
DataSpaceId	Type reference Properties Filter, Group, Sort Description The ID of the data space from where batch personalization decision resources originate. Relationship Name DataSpace Refers To DataSpace
Description	Type string Properties Filter, Group, Nillable, Sort Description Text description of the batch personalization decision.
DeveloperName	Type string Properties Filter, Group, Nillable, Sort Description The unique name of the batch personalization decision in the API.
ErrorCode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The issue that’s causing an error. The default value is `None` and possible values are: `ConfigurationMissingError`—A required configuration setting is missing. `DpcJobError`—A problem occurred during processing. `Internal Error`—An internal error occurred during processing. `ModelValidationError`—The model is invalid. `None`
RefreshMode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description How the batch personalization data is refreshed. The default value is `FULL_REFRESH` and possible values are: `FULL_REFRESH`—Generates new decisions for all members in a segment. `INCREMENTAL`—Generates decisions only for the new members added to the segment after the last run.
Name	Type string Properties Filter, Group, idLookup, Sort Description Required. The name of the batch personalization decision.

Usage

PersnlBatchDecision provides details about refresh modes, model versions, and refresh states for specific market segments.