Restrições do tipo de campo XDM

Nos esquemas do Experience Data Model (XDM), o tipo de campo restringe o tipo de dados que o campo pode conter. Este documento fornece uma visão geral de cada tipo de campo principal, incluindo os outros formatos de serialização para os quais podem ser mapeados e como definir seus próprios tipos de campo na API para impor restrições diferentes.

Introdução

Antes de usar este guia, revise as noções básicas da composição do schema para obter uma introdução a esquemas, classes e mixins do XDM.

Se você planeja definir seus próprios tipos de campo na API, é altamente recomendável começar com o Guia do desenvolvedor do Registro de Schema para saber como criar mixins e tipos de dados para incluir seus campos personalizados. Se você estiver usando a interface do usuário do Experience Platform para criar seus esquemas, consulte o guia sobre definição de campos na interface do usuário para saber como implementar restrições em campos definidos em mixins e tipos de dados personalizados.

Estrutura básica e exemplos

O XDM é criado sobre o Esquema JSON e, portanto, os campos XDM herdam uma sintaxe semelhante ao definir seu tipo. Entender como diferentes tipos de campo são representados no Esquema JSON pode ajudar a indicar as restrições básicas de cada tipo.

A tabela a seguir descreve como cada tipo de XDM é representado no Esquema JSON, juntamente com um exemplo de valor que está em conformidade com o tipo :

{"type": "string"}

{"type": "número"}

{
  "type": "integer",
  "máximo": 9007199254740991,
  "mínimo": -9007199254740991
}

{
  "type": "integer",
  "máximo": 2147483648,
  "mínimo": -2147483648
}

{
  "type": "integer",
  "máximo": 32768
  "mínimo": -32768
}

{
  "type": "integer",
  "máximo": 128,
  "mínimo": -128
}

{
  "type": "string",
  "format": "date"
}

{
  "type": "string",
  "format": "date-time"
}

{"type": "string"}

*Todas as cadeias de caracteres formatadas por data devem estar em conformidade com o padrão ISO 8601 (RFC 3339, seção 5.6).

Mapeamento de tipos XDM para outros formatos

As seções abaixo descrevem como cada tipo XDM mapeia para outros formatos de serialização comuns:

• Parquet, Spark SQL e Java
• Scala, .NET e CosmosDB
• MongoDB, Aerospike e Protobuf 2

Parquet, Spark SQL e Java

Scala, .NET e CosmosDB

MongoDB, Aerospike e Protobuf 2

Definição de tipos de campo XDM na API

Todos os campos XDM são definidos usando as restrições padrão JSON Schema que se aplicam ao tipo de campo, com restrições adicionais para nomes de campo que são impostas por Experience Platform. A API de Registro de Esquema permite definir tipos de campo adicionais por meio do uso de formatos e restrições opcionais. Os tipos de campo XDM são expostos pelo atributo de nível de campo, meta:xdmType.

A tabela a seguir descreve a formatação apropriada para definir tipos de campos diferentes, incluindo aqueles com propriedades opcionais. Mais informações sobre propriedades opcionais e palavras-chave específicas do tipo estão disponíveis na documentação do Esquema JSON.

Para começar, encontre o tipo de campo desejado e use o código de amostra fornecido para criar sua solicitação de API para criar um mixin ou criar um tipo de dados.

"sampleField": {
    "type": "string",
    "padrão": "^[A-Z]{2}$",
    "maxLength": 2
}

"sampleField": {
  "type": "string",
  "format": "uri"
}

"sampleField": {
  "type": "string",
  "enum": [
      "value1",
      "value2",
      "value3"
  ],
  "meta:enum": {
      "value1": "Valor 1",
      "value2": "Valor 2",
      "value3": "Valor 3"
  },
  "default": "value1"
}

"sampleField": {
  "type": "número"
}

"sampleField": {
  "type": "integer",
  "mínimo": -9007199254740992,
  "máximo": 9007199254740992
}

"sampleField": {
  "type": "integer",
  "mínimo": -2147483648,
  "máximo": 2147483648
}

"sampleField": {
  "type": "integer",
  "mínimo": -32768
  "máximo": 32768
}

"sampleField": {
  "type": "integer",
  "mínimo": -128,
  "máximo": 128
  }

"sampleField": {
  "type": "booleano",
  "default": false
}

"sampleField": {
  "type": "string",
  "format": "date",
  "exemplos": ["2004-10-23"]
}

"sampleField": {
  "type": "string",
  "format": "date-time",
  "exemplos": ["2004-10-23T12:00:00-06:00"]
}

"sampleField": {
  "type": "array",
  "itens": {
    "type": "string"
  }
}

"sampleField": {
  "type": "array",
  "itens": {
    "$ref": "https://ns.adobe.com/xdm/data/paymentitem"
  }
}

"sampleField": {
  "type": "object",
  "properties": {
    "field1": {
      "type": "string"
    },
    "field2": {
      "type": "número"
    }
  }
}

"sampleField": {
  "type": "object",
  "$ref": "https://ns.adobe.com/xdm/common/phoneinteraction"
}

"sampleField": {
  "type": "object",
  "additionalProperties":{
    "type": "string"
  }
}

"sampleField": {
  "type": "object",
  "additionalProperties":{
    "type": "array",
    "itens": {
      "type": "string"
    }
  }
}

"sampleField": {
  "type": "object",
  "additionalProperties":{
    "$ref": "https://ns.adobe.com/xdm/data/paymentitem"
  }
}