Definieren von XDM-Feldern in der Schema Registry-API

Alle Felder des Experience-Datenmodells (XDM) werden mit dem Standard JSON-Schema Einschränkungen, die für ihren Feldtyp gelten, mit zusätzlichen Einschränkungen für Feldnamen, die von Adobe Experience Platform erzwungen werden. Mit der Schema Registry-API können Sie benutzerdefinierte Felder in Ihren Schemas definieren, indem Sie Formate und optionale Einschränkungen verwenden. XDM-Feldtypen werden durch das Attribut auf Feldebene verfügbar gemacht, meta:xdmType.

In diesem Handbuch wird die geeignete Formatierung zum Definieren verschiedener Feldtypen beschrieben, einschließlich derjenigen mit optionalen Eigenschaften. Weitere Informationen zu optionalen Eigenschaften und typspezifischen Suchbegriffen finden Sie in der Dokumentation zum JSON-Schema.

Suchen Sie zunächst den gewünschten Feldtyp und verwenden Sie den Beispielcode, der zum Erstellen Ihrer API-Anfrage für bereitgestellt wird. Erstellen einer Feldergruppe oder Erstellen eines Datentyps.

String string

Zeichenfolge -Felder werden durch type: string.

"sampleField": {
  "title": "Sample String Field",
  "description": "An example string field.",
  "type": "string"
}

Sie können optional mithilfe der folgenden zusätzlichen Eigenschaften einschränken, welche Arten von Werten für die Zeichenfolge eingegeben werden können:

"sampleField": {
  "title": "Sample String Field",
  "description": "An example string field with added constraints.",
  "type": "string",
  "pattern": "^[A-Z]{2}$",
  "maxLength": 2
}

URI uri

URI -Felder werden durch type: string mit format Eigenschaft auf uri. Es werden keine anderen Eigenschaften akzeptiert.

"sampleField": {
  "title": "Sample URI Field",
  "description": "An example URI field.",
  "type": "string",
  "format": "uri"
}

Enum enum

Enum -Felder müssen type: string, wobei die Enum-Werte selbst unter einer enum array:

"sampleField": {
  "title": "Sample Enum Field",
  "description": "An example enum field.",
  "type": "string",
  "enum": [
      "value1",
      "value2",
      "value3"
  ]
}

Sie können optional für jeden Wert unter einer meta:enum -Eigenschaft, wobei jede Bezeichnung einem entsprechenden Wert unter enum.

"sampleField": {
  "title": "Sample Enum Field",
  "description": "An example enum field with customer-facing labels.",
  "type": "string",
  "enum": [
      "value1",
      "value2",
      "value3"
  ],
  "meta:enum": {
      "value1": "Value 1",
      "value2": "Value 2",
      "value3": "Value 3"
  }
}

Sie können optional eine default -Eigenschaft zum Angeben der Standardeinstellung enum -Wert, den das Feld verwendet, wenn kein Wert angegeben ist.

"sampleField": {
  "title": "Sample Enum Field",
  "description": "An example enum field with customer-facing labels and a default value.",
  "type": "string",
  "enum": [
      "value1",
      "value2",
      "value3"
  ],
  "meta:enum": {
      "value1": "Value 1",
      "value2": "Value 2",
      "value3": "Value 3"
  },
  "default": "value1"
}

Zahl number

Zahlenfelder werden durch type: number und keine anderen erforderlichen Eigenschaften aufweisen.

"sampleField": {
  "title": "Sample Number Field",
  "description": "An example number field.",
  "type": "number"
}

Ganzzahl integer

Ganzzahl -Felder werden durch type: integer und haben keine weiteren erforderlichen Felder.

"sampleField": {
  "title": "Sample Integer Field",
  "description": "An example integer field.",
  "type": "integer"
}

Sie können den Bereich der Ganzzahl optional einschränken, indem Sie minimum und maximum -Eigenschaften der Definition. Mehrere andere numerische Typen, die von der Schema Builder-Benutzeroberfläche unterstützt werden, sind integer Typen mit bestimmten minimum und maximum Einschränkungen wie Lang, Shortund Byte.

"sampleField": {
  "title": "Sample Integer Field",
  "description": "An example integer field with added constraints.",
  "type": "integer",
  "minimum": 1,
  "maximum": 100
}

Lang long

Das Äquivalent eines Lang -Feld, das über die Schema Builder-Benutzeroberfläche erstellt wurde, ist ein integer Typfeld mit spezifischen minimum und maximum -Werte (-9007199254740992 und 9007199254740992, bzw. ).

"sampleField": {
  "title": "Sample Long Field",
  "description": "An example long field.",
  "type": "integer",
  "minimum": -9007199254740992,
  "maximum": 9007199254740992
}

Kurz short

Das Äquivalent eines Short -Feld, das über die Schema Builder-Benutzeroberfläche erstellt wurde, ist ein integer Typfeld mit spezifischen minimum und maximum -Werte (-32768 und 32768, bzw. ).

"sampleField": {
  "title": "Sample Short Field",
  "description": "An example short field.",
  "type": "integer",
  "minimum": -32768,
  "maximum": 32768
}

Byte byte

Das Äquivalent eines Byte -Feld, das über die Schema Builder-Benutzeroberfläche erstellt wurde, ist ein integer Typfeld mit spezifischen minimum und maximum -Werte (-128 und 128, bzw. ).

"sampleField": {
  "title": "Sample Byte Field",
  "description": "An example byte field.",
  "type": "integer",
  "minimum": -128,
  "maximum": 128
}

Boolesch boolean

Boolesch -Felder werden durch type: boolean.

"sampleField": {
  "title": "Sample Boolean Field",
  "description": "An example boolean field.",
  "type": "boolean"
}

Sie können optional eine default -Wert, den das Feld verwendet, wenn während der Erfassung kein expliziter Wert angegeben wird.

"sampleField": {
  "title": "Sample Boolean Field",
  "description": "An example boolean field with a default value.",
  "type": "boolean",
  "default": false
}

Datum date

Datum -Felder werden durch type: string und format: date. Sie können optional auch ein Array von examples , um zu nutzen, wenn Sie eine Beispieldatumszeichenfolge für die manuelle Eingabe der Daten durch Benutzer anzeigen möchten.

"sampleField": {
  "title": "Sample Date Field",
  "description": "An example date field with an example array item.",
  "type": "string",
  "format": "date",
  "examples": ["2004-10-23"]
}

DateTime date-time

DateTime -Felder werden durch type: string und format: date-time. Sie können optional auch ein Array von examples , um zu nutzen, wenn Sie eine Beispiel-Datums-Uhrzeit-Zeichenfolge für Benutzer anzeigen möchten, die die Daten manuell eingeben.

"sampleField": {
  "title": "Sample Datetime Field",
  "description": "An example datetime field with an example array item.",
  "type": "string",
  "format": "date-time",
  "examples": ["2004-10-23T12:00:00-06:00"]
}

Array array

Array -Felder werden durch type: array und items -Objekt, das das Schema der Elemente definiert, die das Array akzeptiert.

Sie können Array-Elemente mithilfe von Primitive-Typen definieren, z. B. ein Array von Zeichenfolgen:

"sampleField": {
  "title": "Sample Array Field",
  "description": "An example array field using a primitive type.",
  "type": "array",
  "items": {
    "type": "string"
  }
}

Sie können die Array-Elemente auch basierend auf einem vorhandenen Datentyp definieren, indem Sie auf die $id des Datentyps durch $ref -Eigenschaft. Im Folgenden finden Sie ein Array von Zahlungselement Objekte:

"sampleField": {
  "title": "Sample Array Field",
  "description": "An example array field using a data type reference.",
  "type": "array",
  "items": {
    "$ref": "https://ns.adobe.com/xdm/data/paymentitem"
  }
}

Objekt object

Objekt -Felder werden durch type: object und properties -Objekt, das Untereigenschaften für das Schemafeld definiert.

Die einzelnen Unterfelder, die unter properties kann mit einem beliebigen Primitive definiert werden type oder durch Referenzierung eines vorhandenen Datentyps über eine $ref -Eigenschaft, die auf die $id des betreffenden Datentyps:

"sampleField": {
  "title": "Sample Object Field",
  "description": "An example object field.",
  "type": "object",
  "properties": {
    "field1": {
      "type": "string"
    },
    "field2": {
      "$ref": "https://ns.adobe.com/xdm/common/measure"
    }
  }
}

Sie können auch das gesamte Objekt definieren, indem Sie auf einen Datentyp verweisen, vorausgesetzt der betreffende Datentyp ist selbst definiert als type: object:

"sampleField": {
  "title": "Sample Object Field",
  "description": "An example object field using a data type reference.",
  "$ref": "https://ns.adobe.com/xdm/common/phoneinteraction"
}

Landkarte map

Ein Zuordnungsfeld ist im Wesentlichen ein object-Typ-Feld mit einem unbeschränkten Satz von Schlüsseln. Wie Objekte haben Karten eine type Wert von object, aber ihre meta:xdmType explizit auf map.

Karte darf nicht definieren beliebige Eigenschaften. Es must eine einzelne additionalProperties schema zur Beschreibung des Werttyps, der in der Zuordnung enthalten ist (jede Zuordnung kann nur einen einzigen Datentyp enthalten). Die type Wert muss entweder string oder integer.

Ein Zuordnungsfeld mit Zeichenfolgenwerten würde beispielsweise wie folgt definiert:

"sampleField": {
  "title": "Sample Map Field",
  "description": "An example map field.",
  "type": "object",
  "meta:xdmType": "map",
  "additionalProperties": {
    "type": "string"
  }
}

Weitere Informationen zum Erstellen von benutzerdefinierten Zuordnungsfeldern finden Sie im folgenden Abschnitt.

Erstellen benutzerdefinierter Zuordnungstypen custom-maps

Um "map-ähnliche"Daten in XDM effizient zu unterstützen, können Objekte mit einer meta:xdmType auf map , um deutlich zu machen, dass ein Objekt so verwaltet werden sollte, als wäre der Schlüsselsatz nicht eingeschränkt. Daten, die in Zuordnungsfelder aufgenommen werden, müssen Zeichenfolgenschlüssel und nur Zeichenfolgen- oder Ganzzahlwerte verwenden (wie durch additionalProperties.type).

XDM legt die folgenden Einschränkungen für die Verwendung dieses Speicherhinweises fest:

Stellen Sie sicher, dass Sie nur Felder vom Typ Zuordnung verwenden, wenn dies unbedingt erforderlich ist, da sie die folgenden Leistungsbeeinträchtigungen aufweisen:

Die Benutzeroberfläche von Platform weist außerdem Einschränkungen hinsichtlich der Art und Weise auf, wie die Schlüssel von Feldern vom Typ Zuordnung extrahiert werden können. Während Objekttypen erweitert werden können, werden Zuordnungen stattdessen als ein einzelnes Feld angezeigt.

Nächste Schritte

In diesem Handbuch wurde die Definition verschiedener Feldtypen in der API beschrieben. Weitere Informationen zur Formatierung von XDM-Feldtypen finden Sie im Handbuch unter XDM-Feldtypbegrenzungen.