mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 00:02:34 +08:00
202 lines
8.6 KiB
JSON
202 lines
8.6 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "Recommendation - Data API",
|
||
"description": "Represents the recommendations surfaced as offers and actions for Einstein Next Best Action. This object is available in API version 45.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"AcceptanceLabel": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Label that appears as the accept option on the surfaced recommendation. Maximum size is 80 characters."
|
||
},
|
||
"ActionReference": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Flow referenced for this recommendation. Label is Action."
|
||
},
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Text description of the recommendation. Maximum size is 255 characters."
|
||
},
|
||
"ExternalId": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Stores an identifier for the recommendation source, such as product, so Einstein can group all responses for a given recommendation."
|
||
},
|
||
"ImageId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Image referenced by this recommendation. Label is Image. This is a relationship field.",
|
||
"relationship_name": "Image",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "ContentAsset"
|
||
},
|
||
"IsActionActive": {
|
||
"type": "boolean",
|
||
"properties": "Defaulted on create, Filter, Group, Sort",
|
||
"description": "Indicates whether the flow referenced in the Action field is active (true) or not (false). Read only."
|
||
},
|
||
"LastReferencedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The date and time when the recommendation was last referenced."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The date and time when the recommendation was last viewed."
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, idLookup, Sort, Update",
|
||
"description": "The name of the recommendation. Maximum size is 80 characters."
|
||
},
|
||
"NetworkId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "ID of the Experience Cloud site associated with the recommendation (if applicable)."
|
||
},
|
||
"RecommendationKey": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Track responses to a recommendation when it doesn’t have an ID. Maximum size is 255 characters."
|
||
},
|
||
"RejectionLabel": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Label that appears as the reject option on the surfaced recommendation. Maximum size is 80 characters."
|
||
}
|
||
},
|
||
"special_access_rules": "You must have the Modify All Data or Manage Next Best Action Recommendations user permission to create and edit recommendations.",
|
||
"associated_objects": "This object has the following 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- **RecommendationChangeEvent (API version 48.0)**: Change events are available for the object.",
|
||
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<complexType name=\"Recommendation\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AcceptanceLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ActionReference\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ExternalId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Image\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContentAsset\"/>\n <element name=\"ImageId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"IsActionActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RecommendationKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RejectionLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"AcceptanceLabel": {
|
||
"field_label": "Acceptance Label",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"ActionReference": {
|
||
"field_label": "Action",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"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"
|
||
},
|
||
"Description": {
|
||
"field_label": "Description",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"ExternalId": {
|
||
"field_label": "External Id",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"Id": {
|
||
"field_label": "Recommendation ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"ImageId": {
|
||
"field_label": "Asset File ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"IsActionActive": {
|
||
"field_label": "Is Action Active",
|
||
"type": "boolean"
|
||
},
|
||
"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": "Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"NetworkId": {
|
||
"field_label": "Network ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RecommendationKey": {
|
||
"field_label": "RecommendationResponse Identifier",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"RecommendationMode": {
|
||
"field_label": "Recommendation Mode",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"RecommendationScore": {
|
||
"field_label": "Recommendation Score",
|
||
"type": "double",
|
||
"precision": "5",
|
||
"scale": "2"
|
||
},
|
||
"RejectionLabel": {
|
||
"field_label": "Rejection Label",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"precision",
|
||
"scale"
|
||
]
|
||
} |