afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/PersonalizationSchema.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "associated_objects",
    "field_reference"
  ],
  "title": "PersonalizationSchema - Data API",
  "description": "Represents a personalization response template that’s used when you build a personalization decision. Available in API version 62.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "refers_to"
  ],
  "fields": {
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
      "description": "Three letter ISO currency codes for supported currencies. The default value is USD. This is an optional field."
    },
    "DataSpaceId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "Unique identifier that refers to the data space where a response template's resources originate. This is a required field.",
      "relationship_name": "DataSpace",
      "refers_to": "DataSpace"
    },
    "Description": {
      "type": "String",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Text description of the response template. This is an optional field."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "System or user-generated API name for the personalization response template. This is a required field."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "Timestamp that indicates the last time the personalized response template was referenced by another resource."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "Timestamp that indicates the last time a user viewed the response template."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "The text label that identifies the personalization response template."
    },
    "PersonalizationType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the kind of personalization content to present. The default value is Recommendations, and the accepted values are ManualContent and Recommendations."
    }
  },
  "usage": "A response template outlines the attributes that marketers use to configure the personalization response. It defines an expected format and shape for all decision response data.",
  "associated_objects": "This object has these associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **PersonalizationSchemaChangeEvent**: Change events are available for the object.\n- **PersonalizationSchemaFeed**: Feed tracking is available for the object.\n- **PersonalizationSchemaHistory**: History is available for tracked fields of the object.\n- **PersonalizationSchemaOwnerSharingRule**: Sharing rules are available for the object.\n- **PersonalizationSchemaShare**: Sharing is available for the object.",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "DataSpaceId": {
      "field_label": "Data Space ID",
      "type": "reference",
      "length": "18"
    },
    "Description": {
      "field_label": "Description",
      "type": "string",
      "length": "40"
    },
    "DeveloperName": {
      "field_label": "Response Template API Name",
      "type": "string",
      "length": "40"
    },
    "Id": {
      "field_label": "Response Template ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Response Template Name",
      "type": "string",
      "length": "255"
    },
    "PersonalizationType": {
      "field_label": "Personalization Type",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}