Dejar de utilizar un campo XDM en la API
En el Modelo de datos de experiencia (XDM), puede dejar de utilizar un campo de un esquema o recurso personalizado mediante API de Registro de esquemas. Si un campo queda obsoleto, se oculta de las interfaces de usuario descendentes, como las Perfiles espacio de trabajo y Customer Journey Analytics, pero por lo demás es un cambio sin saltos y no afecta negativamente a los flujos de datos existentes.
Este documento explica cómo dejar de utilizar los campos para diferentes recursos XDM. Para ver los pasos sobre cómo dejar de utilizar un campo XDM mediante el Editor de esquemas en la interfaz de usuario de Experience Platform, consulte el tutorial sobre dejar de utilizar un campo XDM en la IU.
Primeros pasos
Este tutorial requiere realizar llamadas a la API de Registro de esquemas. Consulte la guía para desarrolladores para obtener información importante que necesita conocer para realizar estas llamadas a la API. Esto incluye su {TENANT_ID}, el concepto de "contenedores" y los encabezados necesarios para realizar solicitudes (con especial atención a la variable Accept y sus posibles valores).
Dejar obsoleto un campo personalizado custom
Para dejar de utilizar un campo de una clase, grupo de campos o tipo de datos personalizado, actualice el recurso personalizado mediante una solicitud de PUT o PATCH y agregue el atributo meta:status: deprecated al campo en cuestión.
La llamada de API de ejemplo siguiente anula la compatibilidad de un campo en un tipo de datos personalizado.
Formato de API
PATCH /tenant/datatypes/{DATA_TYPE_ID}
Solicitud
La siguiente solicitud anula el uso de expansionArea para un tipo de datos que describe una propiedad inmobiliaria.
curl -X PATCH \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/datatypes/_{TENANT_ID}.datatypes.8779fd45d6e4eb074300023a439862bbba359b60d451627a \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'content-type: application/json' \
-d '[
{
"op": "add",
"path": "/properties/expansionArea/meta:status",
"value": "deprecated"
}
]'
Respuesta
Una respuesta correcta devuelve los detalles de actualización del recurso personalizado, con el campo obsoleto que contiene un meta:status valor de deprecated. La respuesta de ejemplo siguiente se ha truncado para el espacio.
{
"$id": "https://ns.adobe.com/{TENANT_ID}/datatypes/8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:altId": "_{TENANT_ID}.datatypes.8779fd45d6e4eb074300023a439862bbba359b60d451627a",
"meta:resourceType": "datatypes",
"version": "1.2",
"title": "Property Details",
"type": "object",
"description": "Details relating to a real-estate property operated by the company.",
"definitions": {
"property": {
"properties": {
"_{TENANT_ID}": {
"type":"object",
"properties": {
"expansionArea": {
"title": "Expansion Area",
"description": "Square footage for renovated additions to the property.",
"type": "integer",
"meta:status": "deprecated",
},
"propertyName": {
"title": "Property Name",
"description": "Name of the property",
"type": "string"
},
"propertyCity": {
"title": "Property City",
"description": "City where the property is located.",
"type": "string"
},
"propertyCountry": {
"title": "Property Country",
"description": "Country where the property is located.",
"type": "string"
},
"phoneNumber": {
"title": "Phone Number",
"description": "Primary phone number for the property.",
"type": "string"
},
"propertyType": {
"type": "string",
"title": "Property Type",
"description": "Type and primary use of property.",
"enum": [
"retail",
"yoga",
"fitness"
],
"meta:enum": {
"retail": "Retail Store",
"yoga": "Yoga Studio",
"fitness": "Fitness Center"
}
},
"propertyConstruction": {
"$ref": "https://ns.adobe.com/{TENANT_ID}/datatypes/24c643f618647344606222c494bd0102"
},
"squareFeet": {
"title": "Expansion Area",
"description": "Square footage for renovated additions to the property.",
"type": "integer",
}
}
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/customFields",
"type": "object",
"meta:xdmType": "object"
}
],
"imsOrg": "{IMS_ORG}",
"meta:extensible": true,
"meta:abstract": true,
"meta:intendedToExtend": [
"https://ns.adobe.com/xdm/context/profile"
],
"meta:xdmType": "object",
"meta:registryMetadata": {
"repo:createdDate": 1594941263588,
"repo:lastModifiedDate": 1594941538433,
"xdm:createdClientId": "{CLIENT_ID}",
"xdm:lastModifiedClientId": "{CLIENT_ID}",
"xdm:createdUserId": "{USER_ID}",
"xdm:lastModifiedUserId": "{USER_ID}",
"eTag": "5e8a5e508eb2ed344c08cb23ed27cfb60c841bec59a2f7513deda0f7af903021",
"meta:globalLibVersion": "1.15.4"
},
"meta:containerId": "tenant",
"meta:tenantNamespace": "_{TENANT_ID}"
}
Dejar obsoleto un campo estándar en un esquema standard
Los campos de clases estándar, grupos de campos y tipos de datos no pueden quedar directamente obsoletos. En su lugar, puede descontinuar su uso en los esquemas individuales que emplean estos recursos estándar mediante un descriptor.
Creación de un descriptor de obsolescencia de campo create-descriptor
Para crear un descriptor para los campos de esquema que desea dejar de utilizar, realice una solicitud de POST a /tenant/descriptors punto final.
Formato de API
POST /tenant/descriptors
Solicitud
curl -X POST \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"@type": "xdm:descriptorDeprecated",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/c65ddf08cf2d4a2fe94bd06113bf4bc4c855e12a936410d5",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/faxPhone"
}'
@typexdm:descriptorDeprecated.xdm:sourceSchema$id del esquema al que está aplicando el descriptor.xdm:sourceVersion1.xdm:sourceProperty["/firstName", "/lastName"]).Respuesta
{
"@id": "d882b1202bac0ac71f1e31fbcd9afbcc37f364270186b4b3",
"@type": "xdm:descriptorDeprecated",
"xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/c65ddf08cf2d4a2fe94bd06113bf4bc4c855e12a936410d5",
"xdm:sourceVersion": 1,
"xdm:sourceProperty": "/faxPhone",
"imsOrg": "{IMS_ORG}",
"version": "1",
"meta:containerId": "tenant",
"meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
"meta:sandboxType": "production"
}
Compruebe el campo obsoleto verify-deprecation
Una vez aplicado el descriptor, puede verificar si el campo ha quedado obsoleto buscando el esquema en cuestión mientras utiliza el adecuado Accept encabezado.
Formato de API
GET /tenant/schemas
Solicitud
Para incluir información sobre campos obsoletos en la respuesta de la API, debe establecer la variable Accept encabezado a application/vnd.adobe.xed-deprecatefield+json; version=1.
curl -X GET \
https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.c65ddf08cf2d4a2fe94bd06113bf4bc4c855e12a936410d5 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Accept: application/vnd.adobe.xed-deprecatefield+json; version=1'
Respuesta
Una respuesta correcta devuelve los detalles del esquema, con el campo obsoleto que contiene un meta:status valor de deprecated. La respuesta de ejemplo siguiente se ha truncado para el espacio.
"faxPhone": {
"title": "Fax phone",
"description": "Fax phone number.",
"type": "object",
"meta:xdmType": "object",
"properties": {},
"meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber",
"meta:xdmField": "xdm:faxPhone",
"meta:status": "deprecated"
}
Pasos siguientes
En este documento se explica cómo dejar de utilizar los campos XDM mediante la API de Registro de esquemas. Para obtener más información sobre la configuración de campos para recursos personalizados, consulte la guía de definición de campos XDM en la API. Para obtener más información sobre la administración de descriptores, consulte la guía de extremo de descriptores.