Apéndice

Este documento proporciona información adicional relacionada con el trabajo con la API Schema Registry.

Uso de parámetros de consulta

El Schema Registry admite el uso de parámetros de consulta para filtrar los resultados de la página al enumerar los recursos.

NOTA

Cuando se combinan varios parámetros de consulta, deben separarse con ampersands (&).

Paginación

Los parámetros de consulta más comunes para la paginación incluyen:

Parámetro Descripción
start Especifique dónde deben comenzar los resultados enumerados. Este valor puede obtenerse del atributo _page.next de una respuesta de lista y utilizarse para acceder a la siguiente página de resultados. Si el valor _page.next es nulo, no hay ninguna página adicional disponible.
limit Limite el número de recursos devueltos. Ejemplo: limit=5 devolverá una lista de cinco recursos.
orderby Ordene los resultados por una propiedad específica. Ejemplo: orderby=title clasificará los resultados por título en orden ascendente (A-Z). Añadir un - antes del valor del parámetro (orderby=-title) ordenará los elementos por título en orden descendente (Z-A).

Filtro

Puede filtrar los resultados utilizando el parámetro property, que se utiliza para aplicar un operador específico a una propiedad JSON determinada dentro de los recursos recuperados. Los operadores admitidos son:

Operador Descripción Ejemplo
== Filtros si la propiedad es igual al valor proporcionado. property=title==test
!= Filtros por si la propiedad no es igual al valor proporcionado. property=title!=test
< Filtros si la propiedad es menor que el valor proporcionado. property=version<5
> Filtros según si la propiedad es buena que el valor proporcionado. property=version>5
<= Filtros por si la propiedad es menor o igual que el valor proporcionado. property=version<=5
>= Filtros por si la propiedad es buena o igual al valor proporcionado. property=version>=5
~ Filtros según si la propiedad coincide con una expresión regular proporcionada. property=title~test$
(Ninguna) Si se establece únicamente el nombre de la propiedad, solo se devuelven las entradas donde existe la propiedad. property=title
CONSEJO

Puede utilizar el parámetro property para filtrar las mezclas por su clase compatible. Por ejemplo, property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile sólo devuelve mezclas compatibles con la clase XDM Individual Profile.

Modo de compatibilidad

Experience Data Model (XDM) es una especificación públicamente documentada, impulsada por el Adobe de mejorar la interoperabilidad, la expresividad y el poder de las experiencias digitales. Adobe mantiene el código fuente y las definiciones XDM formales en un proyecto de código abierto en GitHub. Estas definiciones se escriben en notación estándar XDM, utilizando JSON-LD (JavaScript Object Notation for Linked Data) y Esquema JSON como gramática para definir esquemas XDM.

Al consultar las definiciones XDM formales en el repositorio público, puede ver que el XDM estándar difiere de lo que ve en Adobe Experience Platform. Lo que está viendo en Experience Platform se llama Modo de compatibilidad y proporciona una asignación simple entre el XDM estándar y la manera en que se utiliza dentro de Platform.

Funcionamiento del modo de compatibilidad

El modo de compatibilidad permite que el modelo JSON-LD de XDM funcione con la infraestructura de datos existente alterando los valores dentro del XDM estándar manteniendo la semántica igual. Utiliza una estructura JSON anidada, que muestra esquemas en un formato de árbol.

La principal diferencia que notará entre el modo XDM estándar y el modo de compatibilidad es la eliminación del prefijo "xdm:" para los nombres de campo.

A continuación se muestra una comparación paralela que muestra los campos relacionados con el cumpleaños (con los atributos "description" eliminados) tanto en el modo XDM estándar como en el modo de compatibilidad. Observe que los campos Modo de compatibilidad incluyen una referencia al campo XDM y su tipo de datos en los atributos "meta:xdmField" y "meta:xdmType".

XDM estándar Modo de compatibilidad
        {
          "xdm:bornDate": {
              "title": "Fecha de nacimiento",
              "type": "string",
              "format": "date",
          },
          "xdm:bornDayAndMonth": {
              "title": "Fecha de nacimiento",
              "type": "string",
              "pattern": "[0-1][0-9]-[0-9][0-9]",
          },
          "xdm:bornYear": {
              "title": "Año de nacimiento",
              "type": "integer",
              "mínimo": 1,
              "máximo": 32767
        }
  
        {
          "bornDate": {
              "title": "Fecha de nacimiento",
              "type": "string",
              "format": "date",
              "meta:xdmField": "xdm:bornDate",
              "meta:xdmType": "date"
          },
          "bornDayAndMonth": {
              "title": "Fecha de nacimiento",
              "type": "string",
              "pattern": "[0-1][0-9]-[0-9][0-9]",
              "meta:xdmField": "xdm:bornDayAndMonth",
              "meta:xdmType": "string"
          },
          "bornYear": {
              "title": "Año de nacimiento",
              "type": "integer",
              "mínimo": 1,
              "máximo": 32767,
              "meta:xdmField": "xdm:bornYear",
              "meta:xdmType": "short"
        }
      

¿Por qué es necesario el modo de compatibilidad?

Adobe Experience Platform está diseñado para trabajar con múltiples soluciones y servicios, cada uno con sus propios desafíos y limitaciones técnicos (por ejemplo, cómo ciertas tecnologías manejan caracteres especiales). Para superar estas limitaciones, se desarrolló el Modo de compatibilidad.

La mayoría de los Experience Platform servicios, incluidos Catalog, Data Lake y Real-time Customer Profile, utilizan Compatibility Mode en lugar de XDM estándar. La API Schema Registry también utiliza Compatibility Mode y los ejemplos de este documento se muestran usando Compatibility Mode.

Vale la pena saber que se produce una asignación entre el XDM estándar y la manera en que se hace operativo en Experience Platform, pero no debería afectar al uso de Platform servicios.

El proyecto de código abierto está disponible para usted, pero cuando se trata de interactuar con los recursos a través de Schema Registry, los ejemplos de API de este documento proporcionan las optimizaciones que debe conocer y seguir.

En esta página