XDMフィールドタイプの制約

エクスペリエンスデータモデル(XDM)スキーマでは、フィールドのタイプによって、フィールドに格納できるデータの種類が制限されます。 このドキュメントでは、各コアフィールドタイプの概要を示します。マッピングできるその他のシリアル化形式や、異なる制約を実施するためにAPIで独自のフィールドタイプを定義する方法も示します。

はじめに

このガイドを使用する前に、スキーマ構成の基本を参照し、XDMスキーマ、クラス、スキーマフィールドグループの概要を確認してください。

APIで独自のフィールドの種類を定義する場合は、『スキーマレジストリ開発者ガイド』から始めて、カスタムフィールドを含めるフィールドグループとデータ型の作成方法を学ぶことを強くお勧めします。 Experience PlatformUIを使用してスキーマを作成する場合は、UIでのフィールドの定義のガイドを参照して、カスタムフィールドグループおよびデータ型内で定義するフィールドに制約を実装する方法を確認してください。

基本構造と例

XDMはJSONスキーマに基づいて構築されているので、XDMフィールドは、タイプを定義する際に同様の構文を継承します。 JSONスキーマで異なるフィールドタイプがどのように表されるかを理解すると、各タイプの基本制約を示すのに役立ちます。

メモ

JSONスキーマとPlatform APIのその他の基盤となるテクノロジーについて詳しくは、APIの基本原則ガイドを参照してください。

次の表に、各XDMタイプがJSONスキーマでどのように表されるかと、タイプに準拠する値の例を示します。

XDM タイプ JSON スキーマ
文字列
{"type":"string"}
"Platinum"
Double
{"type":"number"}
12925.49
Long
{
  "type":"integer",
  "maximum":9007199254740991,
  "minimum":-9007199254740991
}
1478108935
整数
{
  "type":"integer",
  "maximum":2147483648,
  "minimum":-2147483648
}
24906290
{
  "type":"integer",
  "maximum":32768,
  "minimum":-32768
}
15781
バイト
{
  "type":"integer",
  "maximum":128,
  "minimum":-128
}
90
日付*
{
  "type":"string",
  "format":"date"
}
"2019-05-15"
DateTime*
{
  "type":"string",
  "format":"date-time"
}
"2019-05-15T20:20:39+00:00"
Boolean
{"type":"string"}
true

*すべての日付形式の文字列は、ISO 8601標準(RFC 3339、セクション5.6)に準拠している必要があります。

他の形式への XDM タイプのマッピング

以下の節では、各XDMタイプを他の一般的なシリアル化形式にマッピングする方法について説明します。

重要

以下の表に示す標準のXDMタイプの中で、Mapタイプも含まれます。 マップは、特定の値にマッピングされるキーとしてデータが表される場合や、キーを静的スキーマに合理的に含めることができず、データ値として扱う必要がある場合に、標準スキーマで使用されます。

マップタイプフィールドは、業界やベンダーのスキーマの使用のために予約されているので、ユーザーが定義したカスタムリソースでは使用できません。 以下の表へのマップタイプの組み込みは、既存のデータが現在以下に示す形式のいずれかで保存されている場合に、そのデータをXDMにマップする方法を判断するのに役立つものです。

Parquet、Spark SQL、Java

XDM タイプ Parquet Spark SQL Java
String 型:BYTE_ARRAY
注釈:UTF8
StringType java.lang.String
Double 型:DOUBLE LongType java.lang.Double
Long 型:INT64 LongType java.lang.Long
整数 型:INT32
注釈:INT_32
IntegerType java.lang.Integer
Short 型:INT32
注釈:INT_16
ShortType java.lang.Short
Byte 型:INT32
注釈:INT_8
ByteType java.lang.Short
日付 型:INT32
注釈:DATE
DateType java.util.Date
DateTime 型:INT64
注釈:TIMESTAMP_MILLIS
TimestampType java.util.Date
ブール型 型:BOOLEAN BooleanType java.lang.Boolean
マップ MAP-annotated group

(<key-type> 必ず STRING)
MapType

(必keyTypeStringType)
java.util.Map

Scala、.NET、CosmosDB

XDM タイプ Scala .NET CosmosDB
文字列 String System.String String
ダブル Double System.Double Number
Long Long System.Int64 Number
整数 Int System.Int32 Number
Short Short System.Int16 Number
バイト Byte System.SByte Number
日付 java.util.Date System.DateTime String
DateTime java.util.Date System.DateTime String
ブール型 Boolean System.Boolean Boolean
マップ Map (なし) object

MongoDB、Aerospike、およびProtobuf 2

XDM タイプ MongoDB Aerospike Protobuf 2
文字列 string String string
ダブル double Double double
Long long Integer int64
整数 int Integer int32
Short int Integer int32
バイト int Integer int32
日付 date Integer
(Unixミリ秒)
int64
(Unixミリ秒)
DateTime timestamp Integer
(Unixミリ秒)
int64
(Unixミリ秒)
ブール型 bool Integer
(0/1バイナリ)
bool
マップ object map map<key_type, value_type>

API での XDM フィールドタイプの定義

すべてのXDMフィールドは、フィールドタイプに適用される標準のJSONスキーマ制約を使用して定義され、Experience Platformによって適用されるフィールド名に対する追加の制約が適用されます。 スキーマレジストリAPIを使用すると、形式とオプションの制約を使用して、追加のフィールドの種類を定義できます。 XDMフィールドタイプは、フィールドレベルの属性meta:xdmTypeで公開されます。

メモ

meta:xdmType はシステムで生成される値なので、APIを使用する際に、フィールドのJSONにこのプロパティを追加する必要はありません。ベストプラクティスは、JSONスキーマタイプ(stringintegerなど)を、以下の表で定義されている適切な最小/最大制約と共に使用することです。

次の表に、オプションのプロパティを含む、様々なフィールドタイプを定義するための適切な書式の概要を示します。 オプションのプロパティとタイプ固有のキーワードに関する詳細については、JSON スキーマのドキュメントを参照してください。

まず、目的のフィールドタイプを見つけ、提供されたサンプルコードを使用して、フィールドグループまたはデータ型を作成するAPIリクエストを作成します。

XDM タイプ オプションのプロパティ
文字列
  • pattern
  • minLength
  • maxLength
"sampleField": {
            "type": "string",
            "pattern": "^[A-Z]{2}$",
            "maxLength": 2
}
URI
"sampleField": {
          "type": "string",
          "format": "uri"
}
Enum
  • default
  • meta:enum
制約付きの列挙値はenum配列の下に提供されますが、各値のオプションの顧客向けラベルはmeta:enumの下に提供できます。
"sampleField": {
          "type": "string",
          "enum": [
              "value1",
              "value2",
              "value3"
          ],
          "meta:enum": {
              "value1": "Value 1",
              "value2": "Value 2",
              "value3": "Value 3"
          },
          "default": "value1"
}
数値
"sampleField": {
          "type": "number"
}
Long
"sampleField": {
          "type": "integer",
          "minimum": -9007199254740992,
          "maximum": 9007199254740992
}
整数
"sampleField": {
          "type": "integer",
          "minimum": -2147483648,
          "maximum": 2147483648
}
"sampleField": {
          "type": "integer",
          "minimum": -32768,
          "maximum": 32768
}
バイト
"sampleField": {
          "type": "integer",
          "minimum": -128,
          "maximum": 128
  }
Boolean
  • default
"sampleField": {
          "type": "boolean",
          "default": false
}
日付
"sampleField": {
          "type": "string",
          "format": "date",
          "examples": ["2004-10-23"]
}
DateTime
"sampleField": {
          "type": "string",
          "format": "date-time",
          "examples": ["2004-10-23T12:00:00-06:00"]
}
配列 基本的なスカラー型の配列(例:文字列):
"sampleField": {
          "type": "array",
          "items": {
            "type": "string"
  }
}
別のスキーマで定義されたオブジェクトの配列:
"sampleField":{
  "type":"array",
  "items":{
    "$ref":"https://ns.adobe.com/xdm/data/paymentitem"
  }
}
オブジェクト propertiesの下に定義された各サブフィールドのtype属性は、任意のスカラ型を使用して定義できます。
"sampleField": {
          "type": "object",
          "properties": {
            "field1": {
              "type": "string"
            },
            "field2": {
              "type": "number"
    }
  }
}
オブジェクトタイプのフィールドは、データ型の$idを参照することで定義できます。
"sampleField":{
  "type":"object",
  "$ref":"https://ns.adobe.com/xdm/common/phoneinteraction"
}
マップ マップでプロパティを定義することはできません。 このは、マップ内に含まれる値のタイプを記述する単一のadditionalPropertiesスキーマを定義する必要があります(各マップには1つのデータタイプのみを含めることができます)。 値には、任意の有効なXDM type属性を指定するか、$ref属性を使用する別のスキーマへの参照を指定します。

文字列タイプの値を持つmapフィールド:
"sampleField": {
          "type": "object",
          "additionalProperties":{
            "type": "string"
  }
}
値の文字列の配列を持つmapフィールド:
"sampleField": {
          "type": "object",
          "additionalProperties":{
            "type": "array",
            "items": {
              "type": "string"
    }
  }
}
別のデータ型を参照するマップフィールド:
"sampleField":{
  "type":"object",
  "additionalProperties":{
    "$ref":"https://ns.adobe.com/xdm/data/paymentitem"
  }
}

このページ