{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "SearchCustomization - Metadata API",
"description": "Represents the configuration of search settings created in Search Manager. The configuration includes the search channel, searchable objects and fields, and rules to filter search results.",
"file_information": ".searchCustomization",
"directory_location": "searchCustomizations",
"fields_columns": [
"type",
"required",
"description"
],
"fields": {
"channel": {
"type": "string",
"required": true,
"description": "The search channel that the configuration applies to."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The name of the configuration."
},
"objectOverride": {
"type": "SearchCustomizationObjectOverride[]",
"description": "A list of object configurations."
},
"objectToAlwaysSearch": {
"type": "string[]",
"description": "A list of the objects that are always searched for the user profile if the search channel is Einstein Global Search Bar."
},
"profile": {
"type": "string",
"description": "Specifies user profile if the search channel is Einstein Global Search Bar."
},
"selectedObject": {
"type": "string[]",
"description": "A list of the objects that are selected in the configuration if the search channel is LWR Experience Sites."
},
"selectedProfile": {
"type": "string[]",
"description": "Specifies all user profiles that are associated with a Search configuration if the search channel is Einstein Global Search Bar. This field is available in API version 62.0 and later."
}
},
"sub_types": {
"SearchCustomizationObjectOverride": {
"fieldOverride": {
"type": "SearchCustomizationFieldOverride[]",
"description": "A list of field configurations."
},
"objectApiName": {
"type": "string",
"required": true,
"description": "The API name of the object that the configuration is applied to."
},
"rule": {
"type": "SearchCustomizationRule[]",
"description": "A list of rules applied to filter search results."
},
"searchable": {
"type": "boolean",
"description": "Indicates whether the object is searchable (true) or not (false)."
}
},
"SearchCustomizationFieldOverride": {
"fieldApiName": {
"type": "string",
"required": true,
"description": "The API name of the field that the configuration is applied to."
},
"searchable": {
"type": "boolean",
"required": true,
"description": "Indicates whether the field is searchable (true) or not (false)."
}
},
"SearchCustomizationRule": {
"fieldApiName": {
"type": "string",
"required": true,
"description": "The field that the rule applies to."
},
"operator": {
"type": "string",
"required": true,
"description": "The operator for the rule."
},
"ruleValue": {
"type": "SearchCustomizationRuleValue[]",
"description": "A list of rule values."
}
},
"SearchCustomizationRuleValue": {
"targetObjectApiName": {
"type": "string",
"description": "The API name of the target object, in case the rule applies to a lookup field."
},
"value": {
"type": "string",
"required": true,
"description": "The value of the rule."
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a SearchCustomization component.",
"code": "\n\n GlobalSearch\n My_Standard_User_Configuration\n \n \n Description\n false\n \n \n Rating\n true\n \n Account\n \n My_Custom_Field__c\n ne\n \n Other\n \n \n \n Rating\n in\n \n Hot\n \n \n Warm\n \n \n \n \n Asset\n false\n \n \n Contact\n \n AccountId\n ne\n \n Account\n A Company\n \n \n \n DoNotCall\n eq\n \n false\n \n \n \n Account\n Contact\n My_Custom_Object__c\n Product2\n standard\n"
}
]
}