Apêndice do guia da API do registro de esquema

Este documento fornece informações adicionais relacionadas ao trabalho com a API Schema Registry.

Uso de parâmetros de consulta query

O Schema Registry dá suporte ao uso de parâmetros de consulta para página e filtrar resultados ao listar recursos.

Paginação paging

Os parâmetros de consulta mais comuns para paginação incluem:

Filtragem filtering

Você pode filtrar os resultados usando o parâmetro property, que é usado para aplicar um operador específico em uma determinada propriedade JSON nos recursos recuperados. Os operadores compatíveis incluem:

Modo de compatibilidade compatibility

O Experience Data Model (XDM) é uma especificação documentada publicamente, orientada pela Adobe para melhorar a interoperabilidade, a expressividade e o potencial das experiências digitais. O Adobe mantém o código-fonte e as definições formais do XDM em um projeto de código aberto no GitHub. Essas definições são escritas em Notação padrão XDM, usando JSON-LD (Notação de objeto JavaScript para dados vinculados) e Esquema JSON como a gramática para definir esquemas XDM.

Ao observar as definições formais de XDM no repositório público, é possível observar que o XDM padrão é diferente do que você vê no Adobe Experience Platform. O que você está vendo no Experience Platform é chamado de Modo de Compatibilidade e fornece um mapeamento simples entre o XDM padrão e a maneira como é usado no Experience Platform.

Como o modo de compatibilidade funciona

O modo de compatibilidade permite que o modelo XDM JSON-LD funcione com a infraestrutura de dados existente, alterando os valores no XDM padrão e mantendo a semântica igual. Ele usa uma estrutura JSON aninhada, exibindo esquemas em um formato em árvore.

A principal diferença observada entre o XDM padrão e o Modo de compatibilidade é a remoção do prefixo "xdm:" para nomes de campo.

Veja a seguir uma comparação lado a lado que mostra campos relacionados ao aniversário (com atributos de "descrição" removidos) no XDM padrão e no Modo de compatibilidade. Observe que os campos Modo de compatibilidade incluem uma referência ao campo XDM e seu tipo de dados nos atributos "meta:xdmField" e "meta:xdmType".

{
  "xdm:birthDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date"
  },
  "xdm:birthDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    "padrão": "[0-1][0-9]-[0-9][0-9]"
  },
  "xdm:birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767
  }
}

{
  "birthDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date",
    "meta:xdmField": "xdm:birthDate",
    "meta:xdmType": "date"
  },
  "birthDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    "padrão": "[0-1][0-9]-[0-9][0-9]",
    "meta:xdmField": "xdm:birthDayAndMonth",
    "meta:xdmType": "string"
  },
  "birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767,
    "meta:xdmField": "xdm:birthYear",
    "meta:xdmType": "short"
  }
}

Por que o modo de compatibilidade é necessário?

A Adobe Experience Platform foi projetada para trabalhar com várias soluções e serviços, cada um com seus próprios desafios e limitações técnicas (por exemplo, como determinadas tecnologias lidam com caracteres especiais). Para superar essas limitações, o Modo de compatibilidade foi desenvolvido.

A maioria dos serviços do Experience Platform, incluindo Catalog, Data Lake e Real-Time Customer Profile, usa Compatibility Mode no lugar do XDM padrão. A API Schema Registry também usa Compatibility Mode, e os exemplos neste documento são todos mostrados usando Compatibility Mode.

Vale a pena saber que um mapeamento ocorre entre o XDM padrão e a forma como ele é operacionalizado no Experience Platform, mas não deve afetar o uso dos serviços do Experience Platform.

O projeto de código aberto está disponível para você, mas quando se trata de interagir com recursos por meio do Schema Registry, os exemplos de API neste documento fornecem as práticas recomendadas que você deve conhecer e seguir.