使用建立方案 Schema Registry API

Last update: Thu May 25 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
Schemas

建立對象：

Developer

此 Schema Registry 用於存取 Schema Library 在Adobe Experience Platform中。此 Schema Library 包含可依Adobe提供給您的資源， Experience Platform 您使用之應用程式的合作夥伴與廠商。登入提供可存取所有可用程式庫資源的使用者介面和RESTful API。

本教學課程使用 Schema Registry 此API可引導您完成使用標準類別撰寫結構描述的步驟。如果您偏好在中使用使用者介面 Experience Platform，則結構描述編輯器教學課程提供在架構編輯器中執行類似動作的逐步指示。

NOTE

如果您正在將CSV資料擷取至Platform，您可以將該資料對應到AI產生的建議所建立的XDM結構描述（目前為測試版），不需自行手動建立結構描述。

快速入門

本指南需要您實際瞭解下列Adobe Experience Platform元件：

Experience Data Model (XDM) System：作為依據的標準化架構 Experience Platform 組織客戶體驗資料。
- 結構描述組合基本概念：瞭解XDM結構描述的基本建置組塊，包括結構描述組合中的關鍵原則和最佳實務。
Real-Time Customer Profile：根據來自多個來源的彙總資料，提供統一的即時消費者設定檔。
Sandboxes： Experience Platform 提供分割單一區域的虛擬沙箱 Platform 將執行個體整合至個別的虛擬環境中，以協助開發及改進數位體驗應用程式。

在開始本教學課程之前，請檢閱開發人員指南如需您成功對 Schema Registry API。這包括您的 {TENANT_ID}、「容器」的概念，以及提出請求所需的標頭(請特別注意 Accept 標頭及其可能的值)。

本教學課程將逐步解說構成忠誠度會員綱要的步驟，該綱要說明與零售忠誠度計畫會員相關的資料。開始之前，您可以預覽完整熟客會員結構在附錄中。

使用標準類別撰寫結構描述

結構描述可視為您要擷取至的資料的藍圖 Experience Platform. 每個結構描述都由一個類別和零個或多個結構描述欄位群組組成。換言之，您不必為了定義結構描述而新增欄位群組，但在大多數情況下至少使用一個欄位群組。

指派類別

結構描述構成程式從選取類別開始。類別會定義資料的主要行為方面（記錄與時間序列），以及描述將擷取之資料所需的最少欄位。

您在本教學課程中建立的結構描述會使用 XDM Individual Profile 類別。 XDM Individual Profile 是Adobe提供的標準類別，用於定義記錄行為。有關行為的更多資訊可在以下網址找到：結構描述組合基本概念.

若要指派類別，會進行API呼叫，以在租使用者容器中建立(POST)新結構描述。此呼叫包含結構描述將實作的類別。每個結構描述只能實作一個類別。

API格式

POST /tenant/schemas

要求

請求必須包含 allOf 參照 $id 類別的。此屬性會定義結構描述將實作的「基底類別」。在此範例中，基底類別是 XDM Individual Profile 類別。此 $id 的 XDM Individual Profile 類別當作 $ref 中的欄位 allOf 下方陣列。

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
        "type": "object",
        "title": "Loyalty Members",
        "description": "Information for all members of the loyalty program",
        "allOf": [
            {
              "$ref": "https://ns.adobe.com/xdm/context/profile"
            }
        ]
      }'

回應

成功的要求會傳回HTTP回應狀態201 （已建立），其回應本文包含新建立之綱要的詳細資訊，包括 $id， meta:altIt、和 version. 這些值是唯讀的，並由 Schema Registry.

{
  "$id": "https://ns.adobe.com/tenantId/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:altId": "_tenantId.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "Loyalty Members",
  "type": "object",
  "description": "Information for all members of the loyalty program",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/common/auditable",
    "https://ns.adobe.com/xdm/data/record",
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673310304048,
    "repo:lastModifiedDate": 1673310304048,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "6d2ed8acd9c3b768a44de29e069fc6f71329d2550f708381d22fa8bf8c192366",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_tenantId"
}

查詢結構描述

GET若要檢視您新建立的結構描述，請使用 meta:altId 或編碼的URL $id 結構描述的URI。

API格式

GET /tenant/schemas/{SCHEMA_ID}

參數

說明

{SCHEMA_ID}

此 meta:altId 或URL編碼 $id 要查閱的結構描述中。

要求

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/https%3A%2F%2Fns.adobe.com%2F{TENANT_ID}%2Fschemas%2F533ca5da28087c44344810891b0f03d9\
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed+json; version=1'

回應

回應格式取決於 Accept 標頭已隨請求傳送。嘗試使用不同的方式進行實驗 Accept 標頭，檢視哪一個最符合您的需求。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "Loyalty Members",
  "type": "object",
  "description": "Information for all members of the loyalty program",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/common/auditable",
    "https://ns.adobe.com/xdm/data/record",
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673310304048,
    "repo:lastModifiedDate": 1673310304048,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "6d2ed8acd9c3b768a44de29e069fc6f71329d2550f708381d22fa8bf8c192366",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}",
  "meta:allFieldAccess": true
}

新增欄位群組 add-a-field-group

現在忠誠會員方案已建立並確認，您可以新增欄位群組。

根據所選的結構描述類別，有不同的標準欄位群組可供使用。每個欄位群組都包含 intendedToExtend 定義與該欄位群組相容之類別的欄位。

欄位群組會定義概念（例如「名稱」或「地址」），這些概念可在需要擷取相同資訊的任何結構描述中重複使用。

API格式

PATCH /tenant/schemas/{SCHEMA_ID}

參數

說明

{SCHEMA_ID}

此 meta:altId 或URL編碼 $id 欄位群組新增至的結構描述中。

要求

此請求會更新熟客會員結構以包含人口統計細節欄位群組 (profile-person-details)。

藉由新增 profile-person-details 欄位群組，「忠誠會員」結構描述現在會擷取忠誠會員方案會員的人口統計資訊，例如他們的名字、姓氏和生日。

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.533ca5da28087c44344810891b0f03d9 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/allOf/-", "value":  {"$ref": "https://ns.adobe.com/xdm/context/profile-person-details"}}
      ]'

回應

回應中會顯示新新增的欄位群組 meta:extends 陣列並包含 $ref 至中的欄位群組 allOf 屬性。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:resourceType": "schemas",
  "version": "1.1",
  "title": "Loyalty Members",
  "type": "object",
  "description": "Information for all members of the loyalty program",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile-person-details",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/common/auditable",
    "https://ns.adobe.com/xdm/data/record",
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673310304048,
    "repo:lastModifiedDate": 1673310912096,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "b480f28a35f356b237fc129e796074a3f33a7a67df273f6a8beaee1ec6465540",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}",
  "meta:descriptorStatus": {
    "result": []
  }
}

新增更多欄位群組

「忠誠會員」結構需要兩個更標準的欄位群組，您可以使用其他欄位群組重複步驟來新增這些欄位群組。

TIP

請務必檢閱所有可用的欄位群組，以熟悉每個群組中所包含的欄位。您可以透過對每個「全域」和「租使用者」容器執行請求，僅傳回「meta：intendedToExtend」欄位符合您使用之類別的那些欄位群組，列出(GET)所有可用於特定類別的欄位群組。在此案例中，它是 XDM Individual Profile 類別，因此 XDM Individual Profile $id 已使用：

code language-http
`GET /global/fieldgroups?property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile GET /tenant/fieldgroups?property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile`

API格式

PATCH /tenant/schemas/{SCHEMA_ID}

參數

說明

{SCHEMA_ID}

此 meta:altId 或URL編碼 $id 您正在更新的結構描述。

要求

此請求會更新熟客會員結構，以納入以下標準欄位群組中的欄位：

個人聯絡詳細資訊 (profile-personal-details)：新增聯絡資訊，例如住家地址、電子郵件地址和家庭電話。
熟客方案細節 (profile-loyalty-details)：新增聯絡資訊，例如住家地址、電子郵件地址和家庭電話。

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.533ca5da28087c44344810891b0f03d9 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/allOf/-", "value":  {"$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"}},
        { "op": "add", "path": "/allOf/-", "value":  {"$ref": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details"}}
      ]'

回應

回應中會顯示新新增的欄位群組 meta:extends 陣列並包含 $ref 至中的欄位群組 allOf 屬性。

熟客會員結構描述現在應包含四個 $ref 中的值 allOf 陣列： profile， profile-person-details， profile-personal-details、和 profile-loyalty-details 如下所示。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:resourceType": "schemas",
  "version": "1.2",
  "title": "Loyalty Members",
  "type": "object",
  "description": "Information for all members of the loyalty program",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile-person-details",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
    "https://ns.adobe.com/xdm/context/profile-personal-details",
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
    "https://ns.adobe.com/xdm/context/profile-personal-details",
    "https://ns.adobe.com/xdm/common/auditable",
    "https://ns.adobe.com/xdm/data/record",
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673310304048,
    "repo:lastModifiedDate": 1673311559934,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "1de5ed1a07e3478719952f0a8c94d5e5390d5a9a998761adb4cf1989137fd6ea",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}",
  "meta:descriptorStatus": {
    "result": []
  }
}

定義新的欄位群組

而標準熟客方案細節欄位群組為結構描述提供有用的熟客相關欄位，其他熟客欄位未包含在任何標準欄位群組中。

若要新增這些欄位，您可以在 tenant 容器。這些欄位群組是您組織所獨有的，並且您的組織以外的任何人都看不到或無法編輯。

若要建立(POST)新欄位群組，您的請求必須包含 meta:intendedToExtend 包含 $id 與欄位群組相容的基底類別，以及欄位群組將包含的屬性。

任何自訂屬性都必須巢狀內嵌在 TENANT_ID 以避免與其他欄位群組或欄位衝突。

API格式

POST /tenant/fieldgroups

要求

此請求會建立具有 loyaltyTier 包含公司特定忠誠度方案特定四個欄位的物件： id， effectiveDate， currentThreshold、和 nextThreshold.

curl -X POST\
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups\
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'content-type: application/json' \
  -d '{
        "type": "object",
        "title": "Loyalty Tier",
        "meta:intendedToExtend": [
          "https://ns.adobe.com/xdm/context/profile"
        ],
        "description": "Captures info about the current loyalty tier of a customer.",
        "definitions": {
          "loyaltyTier": {
            "properties": {
              "_{TENANT_ID}": {
                "type": "object",
                "properties": {
                  "loyaltyTier": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "title": "Loyalty Tier Identifier",
                        "type": "string",
                        "description": "Loyalty Tier Identifier."
                      },
                      "effectiveDate": {
                        "title": "Effective Date",
                        "type": "string",
                        "format": "date-time",
                        "description": "Date the member joined their current loyalty tier."
                      },
                      "currentThreshold": {
                        "title": "Current Point Threshold",
                        "type": "integer",
                        "description": "The minimum number of loyalty points the member must maintain to remain in the current tier."
                      },
                      "nextThreshold": {
                        "title": "Next Point Threshold",
                        "type": "integer",
                        "description": "The number of loyalty points the member must accrue to graduate to the next tier."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "allOf": [
          {
            "$ref": "#/definitions/loyaltyTier"
          }
        ]
      }'

回應

成功的要求會傳回HTTP回應狀態201 （已建立），其回應本文包含新建立欄位群組的詳細資訊，包括 $id， meta:altIt、和 version. 這些值是唯讀的，並由 Schema Registry.

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
  "meta:altId": "_{TENANT_ID}.mixins.9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
  "meta:resourceType": "mixins",
  "version": "1.0",
  "title": "Loyalty Tier",
  "type": "object",
  "description": "Captures info about the current loyalty tier of a customer.",
  "definitions": {
    "loyaltyTier": {
      "properties": {
        "_{TENANT_ID}": {
          "type": "object",
          "properties": {
            "loyaltyTier": {
              "type": "object",
              "properties": {
                "id": {
                  "title": "Loyalty Tier Identifier",
                  "type": "string",
                  "description": "Loyalty Tier Identifier.",
                  "meta:xdmType": "string"
                },
                "effectiveDate": {
                  "title": "Effective Date",
                  "type": "string",
                  "format": "date-time",
                  "description": "Date the member joined their current loyalty tier.",
                  "meta:xdmType": "date-time"
                },
                "currentThreshold": {
                  "title": "Current Point Threshold",
                  "type": "integer",
                  "description": "The minimum number of loyalty points the member must maintain to remain in the current tier.",
                  "meta:xdmType": "int"
                },
                "nextThreshold": {
                  "title": "Next Point Threshold",
                  "type": "integer",
                  "description": "The number of loyalty points the member must accrue to graduate to the next tier.",
                  "meta:xdmType": "int"
                }
              },
              "meta:xdmType": "object"
            }
          },
          "meta:xdmType": "object"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/loyaltyTier",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": true,
  "meta:abstract": true,
  "meta:intendedToExtend": [
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673313004645,
    "repo:lastModifiedDate": 1673313004645,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "98e5d48808f5a4d9655493777389568a2581cfce013351ab9e1595d82f698dd6",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}"
}

將自訂欄位群組新增到結構描述

您現在可以執行以下的相同步驟：新增標準欄位群組以將此新建立的欄位群組新增至您的結構描述。

API格式

PATCH /tenant/schemas/{SCHEMA_ID}

參數

說明

{SCHEMA_ID}

此 meta:altId 或URL編碼 $id 結構描述的。

要求

此請求會更新(PATCH)忠誠會員結構，以包含新「忠誠度等級」欄位群組中的欄位。

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.533ca5da28087c44344810891b0f03d9 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/allOf/-", "value":  {"$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691"}}
      ]'

回應

您可以看到欄位群組已成功新增，因為回應現在會在中顯示新新增的欄位群組 meta:extends 陣列並包含 $ref 至中的欄位群組 allOf 屬性。

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
    "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
    "meta:resourceType": "schemas",
    "version": "1.3",
    "title": "Loyalty Members",
    "type": "object",
    "description": "Information for all members of the loyalty program",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-person-details",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "refs": [
        "https://ns.adobe.com/xdm/context/profile-person-details",
        "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
        "https://ns.adobe.com/xdm/context/profile-personal-details",
        "https://ns.adobe.com/xdm/context/profile",
        "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691"
    ],
    "imsOrg": "{ORG_ID}",
    "meta:extensible": false,
    "meta:abstract": false,
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/profile-person-details",
        "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
        "https://ns.adobe.com/xdm/context/profile-personal-details",
        "https://ns.adobe.com/xdm/common/auditable",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/xdm/context/profile",
        "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691"
    ],
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1673310304048,
        "repo:lastModifiedDate": 1673313118938,
        "xdm:createdClientId": "{CLIENT_ID}",
        "xdm:lastModifiedClientId": "{CLIENT_ID}",
        "xdm:createdUserId": "{USER_ID}",
        "xdm:lastModifiedUserId": "{USER_ID}",
        "eTag": "6559b197a04bb3fda5bc80bf383a260cfbe32539d528f0139c5750711eebfba2",
        "meta:globalLibVersion": "1.38.2"
    },
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:containerId": "tenant",
    "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
    "meta:sandboxType": "production",
    "meta:tenantNamespace": "_{TENANT_ID}",
    "meta:descriptorStatus": {
        "result": []
    }
}

檢視目前的結構描述

您現在可以執行GET要求來檢視目前的結構描述，並檢視新增的欄位群組對結構描述整體結構的貢獻。

API格式

GET /tenant/schemas/{SCHEMA_ID}

參數

說明

{SCHEMA_ID}

此 meta:altId 或URL編碼 $id 結構描述的。

要求

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed-full+json; version=1'

回應

藉由使用 application/vnd.adobe.xed-full+json; version=1 Accept 標題中，您可以看到完整結構描述顯示所有屬性。這些屬性是用來構成結構描述的類別和欄位群組所貢獻的欄位。在下列範例回應中，只會顯示最近新增的欄位以取得空格。您可以在「」中檢視完整結構描述，包括所有屬性及其屬性。附錄（位於本檔案結尾）。

下 "properties"，您會看到 _{TENANT_ID} 新增自訂欄位群組時所建立的名稱空間。該名稱空間內是 loyaltyTier 物件和建立欄位群組時定義的欄位。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
  "meta:altId": "_{TENANT_ID}.mixins.9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
  "meta:resourceType": "mixins",
  "version": "1.0",
  "title": "Loyalty Tier",
  "type": "object",
  "description": "Captures info about the current loyalty tier of a customer.",
  "definitions": {
    "loyaltyTier": {
      "properties": {
        "_{TENANT_ID}": {
          "type": "object",
          "properties": {
            "loyaltyTier": {
              "type": "object",
              "properties": {
                "id": {
                  "title": "Loyalty Tier Identifier",
                  "type": "string",
                  "description": "Loyalty Tier Identifier.",
                  "meta:xdmType": "string"
                },
                "effectiveDate": {
                  "title": "Effective Date",
                  "type": "string",
                  "format": "date-time",
                  "description": "Date the member joined their current loyalty tier.",
                  "meta:xdmType": "date-time"
                },
                "currentThreshold": {
                  "title": "Current Point Threshold",
                  "type": "integer",
                  "description": "The minimum number of loyalty points the member must maintain to remain in the current tier.",
                  "meta:xdmType": "int"
                },
                "nextThreshold": {
                  "title": "Next Point Threshold",
                  "type": "integer",
                  "description": "The number of loyalty points the member must accrue to graduate to the next tier.",
                  "meta:xdmType": "int"
                }
              },
              "meta:xdmType": "object"
            }
          },
          "meta:xdmType": "object"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/loyaltyTier",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": true,
  "meta:abstract": true,
  "meta:intendedToExtend": [
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673313004645,
    "repo:lastModifiedDate": 1673313004645,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "98e5d48808f5a4d9655493777389568a2581cfce013351ab9e1595d82f698dd6",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}"
}

建立資料型別

您建立的「熟客層」欄位群組包含可能在其他結構描述中有用的特定屬性。例如，資料可能會當作體驗事件的一部分擷取，或供實作不同類別的結構描述使用。在此情況下，將物件階層儲存為資料型別是有意義的，這樣可以更輕鬆地在其他地方重複使用定義。

資料型別可讓您定義物件階層一次，並在欄位中參照它，就像任何其他純量型別一樣。

換言之，資料型別允許一致地使用多欄位結構，比欄位群組有更多彈性，因為它們可以新增為欄位的「型別」，以包含在結構描述中的任何位置。

API格式

POST /tenant/datatypes

要求

定義資料型別不需要 meta:extends 或 meta:intendedToExtend 欄位和欄位不需要巢狀內嵌在租使用者ID底下，即可避免衝突。

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/datatypes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "title": "Loyalty Tier",
        "type": "object",
        "description": "Loyalty Tier data type",
        "definitions": {
          "loyaltyTier": {
            "type": "object",
            "properties": {
              "id": {
                "title": "Loyalty Tier Identifier",
                "type": "string",
                "description": "Loyalty Tier Identifier."
              },
              "effectiveDate": {
                "title": "Effective Date",
                "type": "string",
                "format": "date-time",
                "description": "Date the member joined their current loyalty tier."
              },
              "currentThreshold": {
                "title": "Current Point Threshold",
                "type": "integer",
                "description": "The minimum number of loyalty points the member must maintain to remain in the       current tier."
              },
              "nextThreshold": {
                "title": "Next Point Threshold",
                "type": "integer",
                "description": "The number of loyalty points the member must accrue to graduate to the next tier."
              }
            }
          }
        },
        "allOf": [
          {
            "$ref": "#/definitions/loyaltyTier"
          }
        ]
      }'

回應

成功的要求會傳回HTTP回應狀態201 （已建立），其回應本文包含新建立資料型別的詳細資訊，包括 $id， meta:altIt、和 version. 這些值是唯讀的，並由 Schema Registry.

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb",
  "meta:altId": "_{TENANT_ID}.datatypes.c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb",
  "meta:resourceType": "datatypes",
  "version": "1.0",
  "title": "Loyalty Tier",
  "type": "object",
  "description": "Loyalty Tier data type",
  "definitions": {
    "loyaltyTier": {
      "type": "object",
      "properties": {
        "id": {
          "title": "Loyalty Tier Identifier",
          "type": "string",
          "description": "Loyalty Tier Identifier.",
          "meta:xdmType": "string"
        },
        "effectiveDate": {
          "title": "Effective Date",
          "type": "string",
          "format": "date-time",
          "description": "Date the member joined their current loyalty tier.",
          "meta:xdmType": "date-time"
        },
        "currentThreshold": {
          "title": "Current Point Threshold",
          "type": "integer",
          "description": "The minimum number of loyalty points the member must maintain to remain in the current tier.",
          "meta:xdmType": "int"
        },
        "nextThreshold": {
          "title": "Next Point Threshold",
          "type": "integer",
          "description": "The number of loyalty points the member must accrue to graduate to the next tier.",
          "meta:xdmType": "int"
        }
      },
      "meta:xdmType": "object"
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/loyaltyTier",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": true,
  "meta:abstract": true,
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673378256699,
    "repo:lastModifiedDate": 1673378256699,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "8afba84c0c9a68126a7a1389f8523a1112bdf4405badc6dcddbbb4a0e18f5cdb",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}"
}

您可以使用編碼的URL執行查詢(GET)請求 $id URI直接檢視新的資料型別。請務必包含 version 在您的 Accept 查詢請求的標頭。

在結構描述中使用資料型別

現在忠誠度層級資料型別已建立，您可以更新(PATCH) loyaltyTier 欄位群組中的欄位，用來參照資料型別，以取代先前存在的欄位。

API格式

PATCH /tenant/fieldgroups/{FIELD_GROUP_ID}

參數

說明

{FIELD_GROUP_ID}

此 meta:altId 或URL編碼 $id 要更新的欄位群組的。

要求

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/fieldgroups/_{TENANT_ID}.mixins.9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        {
          "op": "replace",
          "path": "/definitions/loyaltyTier/properties/_{TENANT_ID}/properties",
          "value": {
            "loyaltyTier": {
              "title": "Loyalty Tier",
              "$ref": "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb",
              "description": "Loyalty tier info"
            }
          }
        }
      ]'

回應

回應現在包含參考($ref)至中的資料型別 loyaltyTier 物件，而非先前定義的欄位。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
  "meta:altId": "_{TENANT_ID}.mixins.9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
  "meta:resourceType": "mixins",
  "version": "1.1",
  "title": "Loyalty Tier",
  "type": "object",
  "description": "Captures info about the current loyalty tier of a customer.",
  "definitions": {
    "loyaltyTier": {
      "properties": {
        "_{TENANT_ID}": {
          "type": "object",
          "properties": {
            "loyaltyTier": {
              "title": "Loyalty Tier",
              "$ref": "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb",
              "description": "Loyalty tier info",
              "type": "object",
              "meta:xdmType": "object"
            }
          },
          "meta:xdmType": "object"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/loyaltyTier",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [
    "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb"
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": true,
  "meta:abstract": true,
  "meta:intendedToExtend": [
    "https://ns.adobe.com/xdm/context/profile"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673313004645,
    "repo:lastModifiedDate": 1673378970276,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "4df8fa56d00991590364606bb2e219e1ea8f5717a51c0e6ae57ca956830b6a27",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}",
  "meta:descriptorStatus": {
    "result": []
  }
}

如果您現在執行GET要求來查閱結構描述， loyaltyTier 屬性會顯示下資料型別的參考 meta:referencedFrom：

"_{TENANT_ID}": {
  "type": "object",
  "meta:xdmType": "object",
  "properties": {
    "loyaltyTier": {
      "title": "Loyalty Tier",
      "description": "Loyalty tier info",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "id": {
          "title": "Loyalty Tier Identifier",
          "type": "string",
          "description": "Loyalty Tier Identifier.",
          "meta:xdmType": "string"
        },
        "effectiveDate": {
          "title": "Effective Date",
          "type": "string",
          "format": "date-time",
          "description": "Date the member joined their current loyalty tier.",
          "meta:xdmType": "date-time"
        },
        "currentThreshold": {
          "title": "Current Point Threshold",
          "type": "integer",
          "description": "The minimum number of loyalty points the member must maintain to remain in the current tier.",
          "meta:xdmType": "int"
        },
        "nextThreshold": {
          "title": "Next Point Threshold",
          "type": "integer",
          "description": "The number of loyalty points the member must accrue to graduate to the next tier.",
          "meta:xdmType": "int"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb"
    }
  }
}

定義身分描述項

結構描述用於將資料擷取到 Experience Platform. 此資料最終會跨多個服務使用，以建立個人的單一、統一檢視。為協助執行此程式，可將關鍵欄位標示為「身分」，並在資料擷取後，將這些欄位中的資料插入該個人的「身分圖表」。之後可透過以下方式存取圖表資料： Real-Time Customer Profile 和其他 Experience Platform 服務，提供各個客戶的拼接檢視表。

通常標籤為「身分」的欄位包括：電子郵件地址、電話號碼、 Experience Cloud ID (ECID)、CRM ID或其他唯一ID欄位。請考量貴組織特有的任何唯一識別碼，因為這些識別碼可能是良好的身分識別欄位。

身分描述項會指出 sourceProperty 的 sourceSchema 是應視為身分的唯一識別碼。

如需使用描述元的詳細資訊，請參閱 Schema Registry開發人員指南.

API格式

POST /tenant/descriptors

要求

以下請求在上定義身分描述項 personalEmail.address 「熟客會員」結構描述的欄位。這說明 Experience Platform 將熟客會員的電子郵件地址當作識別碼，以協助彙整個人的相關資訊。此呼叫也會透過設定將此欄位設定為結構描述的主要身分 xdm:isPrimary 至 true，這是啟用結構以用於Real-Time Customer Profile.

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "@type": "xdm:descriptorIdentity",
        "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/533ca5da28087c44344810891b0f03d9",
        "xdm:sourceVersion": 1,
        "xdm:sourceProperty": "/_{TENANT_ID}/loyalty/loyaltyId",
        "xdm:namespace": "Email",
        "xdm:property": "xdm:code",
        "xdm:isPrimary": false
      }'

NOTE

您可以列出可用的「xdm：namespace」值，或使用 Identity Service API. 「xdm：property」的值可以是「xdm：code」或「xdm：id」，具體取決於使用的「xdm：namespace」。

回應

成功的回應會傳回HTTP狀態201 （已建立），其回應內文包含新建立之描述項的詳細資訊，包括其 @id. 此 @id 是由指派的唯讀欄位 Schema Registry 和用於參考API中的描述項。

{
  "@id": "719a4391897c097786efbaa6d4262bb928a1cd88540344c6",
  "@type": "xdm:descriptorIdentity",
  "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": "/personalEmail/address",
  "imsOrg": "{ORG_ID}",
  "version": "1",
  "xdm:namespace": "Email",
  "xdm:property": "xdm:code",
  "xdm:isPrimary": true,
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production"
}

啟用結構描述以用於 Real-Time Customer Profile profile

一旦結構描述套用了主要身分描述項後，您就可以啟用忠誠會員結構描述以供使用 Real-Time Customer Profile 藉由新增 union 標籤到 meta:immutableTags 屬性。

NOTE

如需使用聯合檢視的詳細資訊，請參閱以下章節：聯合在 Schema Registry 開發人員指南。

新增 `union` 標籤

為了使結構描述包含在合併的聯合檢視中， union 標籤必須新增至 meta:immutableTags 結構描述的屬性。這是透過PATCH請求完成的，以更新結構並新增 meta:immutableTags 陣列，值為 union.

API格式

PATCH /tenant/schemas/{SCHEMA_ID}

參數

說明

{SCHEMA_ID}

此 meta:altId 或URL編碼 $id 設定檔啟用的結構描述。

要求

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.533ca5da28087c44344810891b0f03d9 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/meta:immutableTags", "value": ["union"]}
      ]'

回應

回應會顯示已成功執行作業，而且結構描述現在包含最上層屬性。 meta:immutableTags，此陣列包含值「union」。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:resourceType": "schemas",
  "version": "1.4",
  "title": "Loyalty Members",
  "type": "object",
  "description": "Information for all members of the loyalty program",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile-person-details",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
      "type": "object",
      "meta:xdmType": "object"
    },
    {
      "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691",
      "type": "object",
      "meta:xdmType": "object"
    }
  ],
  "refs": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
    "https://ns.adobe.com/xdm/context/profile-personal-details",
    "https://ns.adobe.com/xdm/context/profile",
    "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691"
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
    "https://ns.adobe.com/xdm/context/profile-personal-details",
    "https://ns.adobe.com/xdm/common/auditable",
    "https://ns.adobe.com/xdm/data/record",
    "https://ns.adobe.com/xdm/context/profile",
    "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673310304048,
    "repo:lastModifiedDate": 1673380280074,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "c590ccc7a293040d85c2b7d93276480ef4b4aa9a4fcd6991f50fbb47f58bced2",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}",
  "meta:immutableTags": [
    "union"
  ],
  "meta:descriptorStatus": {
    "result": []
  }
}

聯合中的清單結構描述

您現在已成功將結構描述新增至 XDM Individual Profile 聯合。若要檢視屬於相同聯合的所有結構描述清單，您可以使用查詢引數來執行GET請求以篩選回應。

使用 property 查詢引數時，您可以指定僅包含 meta:immutableTags 欄位有 meta:class 等於 $id 的 XDM Individual Profile 類別會傳回。

API格式

GET /tenant/schemas?property=meta:immutableTags==union&property=meta:class=={CLASS_ID}

要求

以下範例要求傳回屬於 XDM Individual Profile 聯合。

curl -X GET \
  'https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile' \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

回應是經過篩選的結構描述清單，僅包含同時滿足這兩個要求的結構描述。請記住，使用多個查詢引數時，會假設為AND關係。清單回應的格式取決於 Accept 標頭已在請求中傳送。

{
  "results": [
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d29a200b5deb6cfb55d3b865ef627f33",
      "meta:altId": "_{TENANT_ID}.schemas.d29a200b5deb6cfb55d3b865ef627f33",
      "version": "1.2",
      "title": "Profile Schema"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/5d70026f5522fc60b3c81f6523b83c86",
      "meta:altId": "_{TENANT_ID}.schemas.5d70026f5522fc60b3c81f6523b83c86",
      "version": "1.3",
      "title": "CRM Onboarding"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/653e53eb04341d09453c9b6a5fb43d1b4ca9526ec274856d",
      "meta:altId": "_{TENANT_ID}.schemas.653e53eb04341d09453c9b6a5fb43d1b4ca9526ec274856d",
      "version": "1.1",
      "title": "Profile consents"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
      "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
      "version": "1.4",
      "title": "Loyalty Members"
    }
  ],
  "_page": {
    "orderby": "updated",
    "next": null,
    "count": 4
  },
  "_links": {
    "next": null,
    "global_schemas": {
      "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile"
    }
  }
}

後續步驟

依照本教學課程，您已使用標準欄位群組和您定義的欄位群組，成功撰寫結構描述。您現在可以使用此結構描述來建立資料集，並將記錄資料擷取到Adobe Experience Platform。

在本教學課程中建立的完整熟客會員結構描述可在下列附錄中取得。當您檢視結構描述時，您可以看到欄位群組對整體結構的貢獻，以及哪些欄位可用於資料擷取。

建立多個結構描述後，您可以透過使用關係描述元來定義它們之間的關係。請參閱教學課程，瞭解定義兩個結構描述之間的關係以取得詳細資訊。如需如何在登入中執行所有作業(GET、POST、PUT、PATCH和DELETE)的詳細範例，請參閱 Schema Registry開發人員指南使用API時。

附錄 appendix

下列資訊可補充API教學課程。

完整的熟客會員結構 complete-schema

在本教學課程中，會撰寫結構描述來說明零售忠誠度計畫的會員。

結構描述會實作 XDM Individual Profile 類別並結合多個欄位群組。它會使用標準來擷取關於忠誠會員的資訊 Demographic Details，個人聯絡詳細資訊、和熟客方案細節欄位群組，以及透過教學課程中定義的自訂忠誠度層級欄位群組。

以下顯示JSON格式中完成的熟客會員結構：

檢視完整結構描述

code language-json

code language-json
{ "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3", "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3", "meta:resourceType": "schemas", "version": "1.4", "title": "Loyalty Members", "type": "object", "description": "Information for all members of the loyalty program", "properties": { "_{TENANT_ID}": { "type": "object", "properties": { "loyaltyTier": { "title": "Loyalty Tier", "description": "Loyalty tier info", "type": "object", "meta:xdmType": "object", "properties": { "id": { "title": "Loyalty Tier Identifier", "type": "string", "description": "Loyalty Tier Identifier.", "meta:xdmType": "string" }, "effectiveDate": { "title": "Effective Date", "type": "string", "format": "date-time", "description": "Date the member joined their current loyalty tier.", "meta:xdmType": "date-time" }, "currentThreshold": { "title": "Current Point Threshold", "type": "integer", "description": "The minimum number of loyalty points the member must maintain to remain in the current tier.", "meta:xdmType": "int" }, "nextThreshold": { "title": "Next Point Threshold", "type": "integer", "description": "The number of loyalty points the member must accrue to graduate to the next tier.", "meta:xdmType": "int" } }, "meta:referencedFrom": "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb" } }, "meta:xdmType": "object" }, "_id": { "title": "Identifier", "type": "string", "format": "uri-reference", "description": "A unique identifier for the record.", "meta:xdmType": "string", "meta:xdmField": "@id" }, "_repo": { "properties": { "createDate": { "type": "string", "format": "date-time", "meta:immutable": true, "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:createDate" }, "modifyDate": { "type": "string", "format": "date-time", "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:modifyDate" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "billingAddress": { "title": "Billing Address", "description": "Billing postal address.", "type": "object", "meta:xdmType": "object", "properties": { "_id": { "title": "Coordinates ID", "type": "string", "format": "uri-reference", "description": "The unique identifier of the coordinates.", "meta:xdmType": "string", "meta:xdmField": "@id" }, "_repo": { "properties": { "createDate": { "type": "string", "format": "date-time", "meta:immutable": true, "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:createDate" }, "modifyDate": { "type": "string", "format": "date-time", "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:modifyDate" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "_schema": { "properties": { "description": { "title": "Description", "type": "string", "description": "A description of what the coordinates identify.", "meta:xdmType": "string", "meta:xdmField": "schema:description" }, "elevation": { "title": "Elevation", "type": "number", "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.", "meta:xdmType": "number", "meta:xdmField": "schema:elevation" }, "latitude": { "title": "Latitude", "type": "number", "minimum": -90, "maximum": 90, "description": "The signed vertical coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:latitude" }, "longitude": { "title": "Longitude", "type": "number", "minimum": -180, "maximum": 180, "description": "The signed horizontal coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:longitude" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "city": { "title": "City", "type": "string", "description": "The name of the city.", "meta:xdmType": "string", "meta:xdmField": "xdm:city" }, "country": { "title": "Country", "type": "string", "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.", "meta:xdmType": "string", "meta:xdmField": "xdm:country" }, "countryCode": { "title": "Country code", "type": "string", "pattern": "^[A-Z]{2}$", "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "createdByBatchID": { "title": "Created by batch identifier", "type": "string", "format": "uri-reference", "description": "The dataset files in Catalog which has been originating the creation of the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:createdByBatchID" }, "dmaID": { "title": "Designated market area", "type": "integer", "description": "The Nielsen media research designated market area.", "meta:xdmType": "int", "meta:xdmField": "xdm:dmaID" }, "label": { "title": "Label", "type": "string", "description": "Free form name of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:label" }, "lastVerifiedDate": { "title": "Last verified date", "type": "string", "format": "date", "description": "The date that the address was last verified as still associated to the person.", "meta:xdmType": "date", "meta:xdmField": "xdm:lastVerifiedDate" }, "modifiedByBatchID": { "title": "Modified by batch identifier", "type": "string", "format": "uri-reference", "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.", "meta:xdmType": "string", "meta:xdmField": "xdm:modifiedByBatchID" }, "msaID": { "title": "Metropolitan statistical area", "type": "integer", "description": "The metropolitan statistical area in the United States where the observation occurred.", "meta:xdmType": "int", "meta:xdmField": "xdm:msaID" }, "postOfficeBox": { "title": "Post office box", "type": "string", "description": "Post office box of the address.", "maxLength": 20, "meta:xdmType": "string", "meta:xdmField": "xdm:postOfficeBox" }, "postalCode": { "title": "Postal code", "type": "string", "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.", "meta:xdmType": "string", "meta:xdmField": "xdm:postalCode" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "region": { "title": "Region", "type": "string", "description": "The region, county, or district portion of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:region" }, "repositoryCreatedBy": { "title": "Created by user identifier", "type": "string", "description": "User ID of who created the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryCreatedBy" }, "repositoryLastModifiedBy": { "title": "Modified by user identifier", "type": "string", "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryLastModifiedBy" }, "state": { "title": "State", "type": "string", "description": "The name of the State. This is a free-form field.", "meta:xdmType": "string", "meta:xdmField": "xdm:state" }, "stateProvince": { "title": "State or province", "type": "string", "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", "examples": [ "US-CA", "DE-BB", "JP-13" ], "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}\|)", "meta:xdmType": "string", "meta:xdmField": "xdm:stateProvince" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the address.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "pending_verification": "Pending verification", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "street1": { "title": "Street 1", "type": "string", "description": "Primary street level information, apartment number, street number, and street name.", "meta:xdmType": "string", "meta:xdmField": "xdm:street1" }, "street2": { "title": "Street 2", "type": "string", "description": "Optional street information second line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street2" }, "street3": { "title": "Street 3", "type": "string", "description": "Optional street information third line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street3" }, "street4": { "title": "Street 4", "type": "string", "description": "Optional street information fourth line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street4" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address", "meta:xdmField": "xdm:billingAddress" }, "createdByBatchID": { "title": "Created by batch identifier", "type": "string", "format": "uri-reference", "description": "The dataset files in Catalog which has been originating the creation of the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:createdByBatchID" }, "faxPhone": { "title": "Fax Phone", "description": "Fax phone number.", "type": "object", "meta:xdmType": "object", "properties": { "countryCode": { "title": "Country Calling Code", "type": "string", "description": "Country calling code (CC) as defined by E.164.", "minLength": 1, "maxLength": 3, "pattern": "^[0-9]{1,3}?$", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "extension": { "title": "Extension", "type": "string", "description": "The internal dialing number used to call from a private exchange, operator, or switchboard.", "meta:xdmType": "string", "meta:xdmField": "xdm:extension" }, "number": { "title": "Number", "type": "string", "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234.", "meta:xdmType": "string", "meta:xdmField": "xdm:number" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the phone number.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "validity": { "title": "Validity", "type": "string", "description": "A level of technical correctness of the phone number.", "meta:enum": { "consistent": "Consistent", "inconsistent": "Inconsistent", "incomplete": "Incomplete", "successfullyUsed": "Successfully used" }, "meta:xdmType": "string", "meta:xdmField": "xdm:validity" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber", "meta:xdmField": "xdm:faxPhone" }, "homeAddress": { "title": "Home Address", "description": "A home postal address.", "type": "object", "meta:xdmType": "object", "properties": { "_id": { "title": "Coordinates ID", "type": "string", "format": "uri-reference", "description": "The unique identifier of the coordinates.", "meta:xdmType": "string", "meta:xdmField": "@id" }, "_repo": { "properties": { "createDate": { "type": "string", "format": "date-time", "meta:immutable": true, "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:createDate" }, "modifyDate": { "type": "string", "format": "date-time", "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:modifyDate" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "_schema": { "properties": { "description": { "title": "Description", "type": "string", "description": "A description of what the coordinates identify.", "meta:xdmType": "string", "meta:xdmField": "schema:description" }, "elevation": { "title": "Elevation", "type": "number", "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.", "meta:xdmType": "number", "meta:xdmField": "schema:elevation" }, "latitude": { "title": "Latitude", "type": "number", "minimum": -90, "maximum": 90, "description": "The signed vertical coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:latitude" }, "longitude": { "title": "Longitude", "type": "number", "minimum": -180, "maximum": 180, "description": "The signed horizontal coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:longitude" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "city": { "title": "City", "type": "string", "description": "The name of the city.", "meta:xdmType": "string", "meta:xdmField": "xdm:city" }, "country": { "title": "Country", "type": "string", "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.", "meta:xdmType": "string", "meta:xdmField": "xdm:country" }, "countryCode": { "title": "Country code", "type": "string", "pattern": "^[A-Z]{2}$", "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "createdByBatchID": { "title": "Created by batch identifier", "type": "string", "format": "uri-reference", "description": "The dataset files in Catalog which has been originating the creation of the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:createdByBatchID" }, "dmaID": { "title": "Designated market area", "type": "integer", "description": "The Nielsen media research designated market area.", "meta:xdmType": "int", "meta:xdmField": "xdm:dmaID" }, "label": { "title": "Label", "type": "string", "description": "Free form name of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:label" }, "lastVerifiedDate": { "title": "Last verified date", "type": "string", "format": "date", "description": "The date that the address was last verified as still associated to the person.", "meta:xdmType": "date", "meta:xdmField": "xdm:lastVerifiedDate" }, "modifiedByBatchID": { "title": "Modified by batch identifier", "type": "string", "format": "uri-reference", "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.", "meta:xdmType": "string", "meta:xdmField": "xdm:modifiedByBatchID" }, "msaID": { "title": "Metropolitan statistical area", "type": "integer", "description": "The metropolitan statistical area in the United States where the observation occurred.", "meta:xdmType": "int", "meta:xdmField": "xdm:msaID" }, "postOfficeBox": { "title": "Post office box", "type": "string", "description": "Post office box of the address.", "maxLength": 20, "meta:xdmType": "string", "meta:xdmField": "xdm:postOfficeBox" }, "postalCode": { "title": "Postal code", "type": "string", "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.", "meta:xdmType": "string", "meta:xdmField": "xdm:postalCode" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "region": { "title": "Region", "type": "string", "description": "The region, county, or district portion of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:region" }, "repositoryCreatedBy": { "title": "Created by user identifier", "type": "string", "description": "User ID of who created the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryCreatedBy" }, "repositoryLastModifiedBy": { "title": "Modified by user identifier", "type": "string", "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryLastModifiedBy" }, "state": { "title": "State", "type": "string", "description": "The name of the State. This is a free-form field.", "meta:xdmType": "string", "meta:xdmField": "xdm:state" }, "stateProvince": { "title": "State or province", "type": "string", "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", "examples": [ "US-CA", "DE-BB", "JP-13" ], "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}\|)", "meta:xdmType": "string", "meta:xdmField": "xdm:stateProvince" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the address.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "pending_verification": "Pending verification", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "street1": { "title": "Street 1", "type": "string", "description": "Primary street level information, apartment number, street number, and street name.", "meta:xdmType": "string", "meta:xdmField": "xdm:street1" }, "street2": { "title": "Street 2", "type": "string", "description": "Optional street information second line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street2" }, "street3": { "title": "Street 3", "type": "string", "description": "Optional street information third line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street3" }, "street4": { "title": "Street 4", "type": "string", "description": "Optional street information fourth line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street4" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address", "meta:xdmField": "xdm:homeAddress" }, "homePhone": { "title": "Home Phone", "description": "Home phone number.", "type": "object", "meta:xdmType": "object", "properties": { "countryCode": { "title": "Country Calling Code", "type": "string", "description": "Country calling code (CC) as defined by E.164.", "minLength": 1, "maxLength": 3, "pattern": "^[0-9]{1,3}?$", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "extension": { "title": "Extension", "type": "string", "description": "The internal dialing number used to call from a private exchange, operator, or switchboard.", "meta:xdmType": "string", "meta:xdmField": "xdm:extension" }, "number": { "title": "Number", "type": "string", "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234.", "meta:xdmType": "string", "meta:xdmField": "xdm:number" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the phone number.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "validity": { "title": "Validity", "type": "string", "description": "A level of technical correctness of the phone number.", "meta:enum": { "consistent": "Consistent", "inconsistent": "Inconsistent", "incomplete": "Incomplete", "successfullyUsed": "Successfully used" }, "meta:xdmType": "string", "meta:xdmField": "xdm:validity" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber", "meta:xdmField": "xdm:homePhone" }, "loyalty": { "type": "object", "description": "Captures details related to the customer's loyalty rewards.", "properties": { "joinDate": { "title": "Program Join Date", "type": "string", "format": "date-time", "description": "Date which the visitor registered for the loyalty program.", "meta:xdmType": "date-time", "meta:xdmField": "xdm:joinDate" }, "loyaltyID": { "title": "Program ID", "type": "array", "items": { "type": "string", "meta:xdmType": "string" }, "description": "The loyalty program ID(s) associated with a specific user, if they are enrolled in the client's loyalty program.", "meta:xdmType": "array", "meta:xdmField": "xdm:loyaltyID" }, "points": { "title": "Program Points Balance", "type": "number", "description": "Current balance of the loyalty points/awards in a visitor's loyalty account.", "meta:xdmType": "number", "meta:xdmField": "xdm:points" }, "pointsExpiration": { "title": "Points Expiration", "type": "array", "items": { "type": "object", "properties": { "pointsExpirationDate": { "type": "string", "format": "date-time", "description": "Date on which the given portion of the loyalty points expire.", "meta:xdmType": "date-time", "meta:xdmField": "xdm:pointsExpirationDate" }, "pointsExpiring": { "title": "Points Expiring", "type": "number", "description": "Point balance expiring as of the associated expiration date.", "meta:xdmType": "number", "meta:xdmField": "xdm:pointsExpiring" } }, "meta:xdmType": "object" }, "meta:xdmType": "array", "meta:xdmField": "xdm:pointsExpiration" }, "pointsRedeemed": { "title": "Points Redeemed", "type": "number", "description": "Amount of points applied toward a purchase or otherwise redeemed.", "meta:xdmType": "number", "meta:xdmField": "xdm:pointsRedeemed" }, "program": { "title": "Program Name", "type": "string", "description": "This should define the loyalty progam in which a visitor is enrolled.", "meta:xdmType": "string", "meta:xdmField": "xdm:program" }, "status": { "title": "Status", "type": "string", "description": "Captures the visitor's loyalty progam status, such as active, disabled, or suspended.", "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "tier": { "title": "Tier", "type": "string", "description": "Captures the loyalty progam tier in which a visitor is enrolled.", "meta:xdmType": "string", "meta:xdmField": "xdm:tier" }, "upgradeDate": { "title": "Program Name", "type": "string", "description": "Date which the customer was upgraded to the next tier level.", "meta:xdmType": "string", "meta:xdmField": "xdm:upgradeDate" } }, "meta:xdmType": "object", "meta:xdmField": "xdm:loyalty" }, "mailingAddress": { "title": "Mailing Address", "description": "Mailing postal address.", "type": "object", "meta:xdmType": "object", "properties": { "_id": { "title": "Coordinates ID", "type": "string", "format": "uri-reference", "description": "The unique identifier of the coordinates.", "meta:xdmType": "string", "meta:xdmField": "@id" }, "_repo": { "properties": { "createDate": { "type": "string", "format": "date-time", "meta:immutable": true, "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:createDate" }, "modifyDate": { "type": "string", "format": "date-time", "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:modifyDate" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "_schema": { "properties": { "description": { "title": "Description", "type": "string", "description": "A description of what the coordinates identify.", "meta:xdmType": "string", "meta:xdmField": "schema:description" }, "elevation": { "title": "Elevation", "type": "number", "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.", "meta:xdmType": "number", "meta:xdmField": "schema:elevation" }, "latitude": { "title": "Latitude", "type": "number", "minimum": -90, "maximum": 90, "description": "The signed vertical coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:latitude" }, "longitude": { "title": "Longitude", "type": "number", "minimum": -180, "maximum": 180, "description": "The signed horizontal coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:longitude" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "city": { "title": "City", "type": "string", "description": "The name of the city.", "meta:xdmType": "string", "meta:xdmField": "xdm:city" }, "country": { "title": "Country", "type": "string", "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.", "meta:xdmType": "string", "meta:xdmField": "xdm:country" }, "countryCode": { "title": "Country code", "type": "string", "pattern": "^[A-Z]{2}$", "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "createdByBatchID": { "title": "Created by batch identifier", "type": "string", "format": "uri-reference", "description": "The dataset files in Catalog which has been originating the creation of the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:createdByBatchID" }, "dmaID": { "title": "Designated market area", "type": "integer", "description": "The Nielsen media research designated market area.", "meta:xdmType": "int", "meta:xdmField": "xdm:dmaID" }, "label": { "title": "Label", "type": "string", "description": "Free form name of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:label" }, "lastVerifiedDate": { "title": "Last verified date", "type": "string", "format": "date", "description": "The date that the address was last verified as still associated to the person.", "meta:xdmType": "date", "meta:xdmField": "xdm:lastVerifiedDate" }, "modifiedByBatchID": { "title": "Modified by batch identifier", "type": "string", "format": "uri-reference", "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.", "meta:xdmType": "string", "meta:xdmField": "xdm:modifiedByBatchID" }, "msaID": { "title": "Metropolitan statistical area", "type": "integer", "description": "The metropolitan statistical area in the United States where the observation occurred.", "meta:xdmType": "int", "meta:xdmField": "xdm:msaID" }, "postOfficeBox": { "title": "Post office box", "type": "string", "description": "Post office box of the address.", "maxLength": 20, "meta:xdmType": "string", "meta:xdmField": "xdm:postOfficeBox" }, "postalCode": { "title": "Postal code", "type": "string", "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.", "meta:xdmType": "string", "meta:xdmField": "xdm:postalCode" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "region": { "title": "Region", "type": "string", "description": "The region, county, or district portion of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:region" }, "repositoryCreatedBy": { "title": "Created by user identifier", "type": "string", "description": "User ID of who created the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryCreatedBy" }, "repositoryLastModifiedBy": { "title": "Modified by user identifier", "type": "string", "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryLastModifiedBy" }, "state": { "title": "State", "type": "string", "description": "The name of the State. This is a free-form field.", "meta:xdmType": "string", "meta:xdmField": "xdm:state" }, "stateProvince": { "title": "State or province", "type": "string", "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", "examples": [ "US-CA", "DE-BB", "JP-13" ], "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}\|)", "meta:xdmType": "string", "meta:xdmField": "xdm:stateProvince" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the address.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "pending_verification": "Pending verification", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "street1": { "title": "Street 1", "type": "string", "description": "Primary street level information, apartment number, street number, and street name.", "meta:xdmType": "string", "meta:xdmField": "xdm:street1" }, "street2": { "title": "Street 2", "type": "string", "description": "Optional street information second line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street2" }, "street3": { "title": "Street 3", "type": "string", "description": "Optional street information third line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street3" }, "street4": { "title": "Street 4", "type": "string", "description": "Optional street information fourth line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street4" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address", "meta:xdmField": "xdm:mailingAddress" }, "mobilePhone": { "title": "Mobile Phone", "description": "Mobile phone number.", "type": "object", "meta:xdmType": "object", "properties": { "countryCode": { "title": "Country Calling Code", "type": "string", "description": "Country calling code (CC) as defined by E.164.", "minLength": 1, "maxLength": 3, "pattern": "^[0-9]{1,3}?$", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "extension": { "title": "Extension", "type": "string", "description": "The internal dialing number used to call from a private exchange, operator, or switchboard.", "meta:xdmType": "string", "meta:xdmField": "xdm:extension" }, "number": { "title": "Number", "type": "string", "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234.", "meta:xdmType": "string", "meta:xdmField": "xdm:number" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the phone number.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "validity": { "title": "Validity", "type": "string", "description": "A level of technical correctness of the phone number.", "meta:enum": { "consistent": "Consistent", "inconsistent": "Inconsistent", "incomplete": "Incomplete", "successfullyUsed": "Successfully used" }, "meta:xdmType": "string", "meta:xdmField": "xdm:validity" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber", "meta:xdmField": "xdm:mobilePhone" }, "modifiedByBatchID": { "title": "Modified by batch identifier", "type": "string", "format": "uri-reference", "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.", "meta:xdmType": "string", "meta:xdmField": "xdm:modifiedByBatchID" }, "person": { "title": "Person", "description": "An individual actor, contact, or owner.", "type": "object", "meta:xdmType": "object", "properties": { "birthDate": { "title": "Birth date(YYYY-MM-DD)", "type": "string", "format": "date", "description": "The full date a person was born.", "meta:xdmType": "date", "meta:xdmField": "xdm:birthDate" }, "birthDayAndMonth": { "title": "Birth date (MM-DD)", "type": "string", "pattern": "[0-1][0-9]-[0-9][0-9]", "description": "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year.", "meta:xdmType": "string", "meta:xdmField": "xdm:birthDayAndMonth" }, "birthYear": { "title": "Birth year", "type": "integer", "description": "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.", "minimum": 1, "maximum": 32767, "meta:xdmType": "short", "meta:xdmField": "xdm:birthYear" }, "gender": { "title": "Gender", "type": "string", "enum": [ "male", "female", "not_specified", "non_specific" ], "meta:enum": { "male": "Male", "female": "Female", "not_specified": "Not Specified", "non_specific": "Non-specific" }, "description": "Gender identity of the person.\n", "default": "not_specified", "meta:xdmType": "string", "meta:xdmField": "xdm:gender" }, "maritalStatus": { "title": "Marital Status", "type": "string", "enum": [ "married", "single", "divorced", "widowed", "not_specified" ], "meta:enum": { "married": "Married", "single": "Single", "divorced": "Divorced", "widowed": "Widowed", "not_specified": "Not Specified" }, "description": "Describes a person's relationship with a significant other.", "default": "not_specified", "meta:xdmType": "string", "meta:xdmField": "xdm:maritalStatus" }, "name": { "title": "Full name", "description": "The person's full name.", "type": "object", "meta:xdmType": "object", "properties": { "courtesyTitle": { "title": "Courtesy title", "type": "string", "description": "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr.", "meta:xdmType": "string", "meta:xdmField": "xdm:courtesyTitle" }, "firstName": { "title": "First name", "type": "string", "description": "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable.", "meta:xdmType": "string", "meta:xdmField": "xdm:firstName" }, "fullName": { "title": "Full name", "type": "string", "description": "The full name of the person, in writing order most commonly accepted in the language of the name.", "meta:xdmType": "string", "meta:xdmField": "xdm:fullName" }, "lastName": { "title": "Last name", "type": "string", "description": "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable.", "meta:xdmType": "string", "meta:xdmField": "xdm:lastName" }, "middleName": { "title": "Middle name", "type": "string", "description": "Middle, alternative, or additional names supplied between the first name and last name.", "meta:xdmType": "string", "meta:xdmField": "xdm:middleName" }, "suffix": { "title": "Suffix", "type": "string", "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc.", "meta:xdmType": "string", "meta:xdmField": "xdm:suffix" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person-name", "meta:xdmField": "xdm:name" }, "nationality": { "title": "Nationality", "type": "string", "pattern": "^[A-Z]{2}$", "description": "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code.", "meta:xdmType": "string", "meta:xdmField": "xdm:nationality" }, "taxId": { "title": "Tax ID", "type": "string", "description": "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain.", "meta:status": "deprecated", "meta:xdmType": "string", "meta:xdmField": "xdm:taxId" }, "type": { "title": "Type", "type": "string", "description": "The type of individual in different business contexts like B2C.", "meta:xdmType": "string", "meta:xdmField": "xdm:type" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person", "meta:xdmField": "xdm:person" }, "personID": { "title": "Person ID", "description": "Unique identifier of Person/Profile fragment.", "type": "string", "meta:xdmType": "string", "meta:xdmField": "xdm:personID" }, "personalEmail": { "title": "Personal Email", "description": "A personal email address.", "type": "object", "meta:xdmType": "object", "properties": { "address": { "title": "Address", "type": "string", "format": "email", "description": "The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards.", "meta:xdmType": "string", "meta:xdmField": "xdm:address", "minLength": 1 }, "label": { "title": "Label", "type": "string", "description": "Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label.", "meta:xdmType": "string", "meta:xdmField": "xdm:label" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary email indicator. A profile can have only one `primary` email address at a given point of time.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the email address.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "pending_verification": "Pending verification", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "type": { "title": "Type", "type": "string", "description": "The way the account relates to the person for example 'work' or 'personal'.", "meta:enum": { "unknown": "Unknown", "personal": "Personal", "work": "Work", "education": "Education" }, "meta:xdmType": "string", "meta:xdmField": "xdm:type" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/context/emailaddress", "meta:xdmField": "xdm:personalEmail", "required": [ "address" ] }, "repositoryCreatedBy": { "title": "Created by user identifier", "type": "string", "description": "User ID of who created the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryCreatedBy" }, "repositoryLastModifiedBy": { "title": "Modified by user identifier", "type": "string", "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryLastModifiedBy" }, "shippingAddress": { "title": "Shipping Address", "description": "Shipping postal address.", "type": "object", "meta:xdmType": "object", "properties": { "_id": { "title": "Coordinates ID", "type": "string", "format": "uri-reference", "description": "The unique identifier of the coordinates.", "meta:xdmType": "string", "meta:xdmField": "@id" }, "_repo": { "properties": { "createDate": { "type": "string", "format": "date-time", "meta:immutable": true, "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:createDate" }, "modifyDate": { "type": "string", "format": "date-time", "meta:usereditable": false, "examples": [ "2004-10-23T12:00:00-06:00" ], "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", "meta:xdmType": "date-time", "meta:xdmField": "repo:modifyDate" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "_schema": { "properties": { "description": { "title": "Description", "type": "string", "description": "A description of what the coordinates identify.", "meta:xdmType": "string", "meta:xdmField": "schema:description" }, "elevation": { "title": "Elevation", "type": "number", "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.", "meta:xdmType": "number", "meta:xdmField": "schema:elevation" }, "latitude": { "title": "Latitude", "type": "number", "minimum": -90, "maximum": 90, "description": "The signed vertical coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:latitude" }, "longitude": { "title": "Longitude", "type": "number", "minimum": -180, "maximum": 180, "description": "The signed horizontal coordinate of a geographic point.", "meta:xdmType": "number", "meta:xdmField": "schema:longitude" } }, "type": "object", "meta:xdmType": "object", "meta:xedConverted": true }, "city": { "title": "City", "type": "string", "description": "The name of the city.", "meta:xdmType": "string", "meta:xdmField": "xdm:city" }, "country": { "title": "Country", "type": "string", "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.", "meta:xdmType": "string", "meta:xdmField": "xdm:country" }, "countryCode": { "title": "Country code", "type": "string", "pattern": "^[A-Z]{2}$", "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.", "meta:xdmType": "string", "meta:xdmField": "xdm:countryCode" }, "createdByBatchID": { "title": "Created by batch identifier", "type": "string", "format": "uri-reference", "description": "The dataset files in Catalog which has been originating the creation of the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:createdByBatchID" }, "dmaID": { "title": "Designated market area", "type": "integer", "description": "The Nielsen media research designated market area.", "meta:xdmType": "int", "meta:xdmField": "xdm:dmaID" }, "label": { "title": "Label", "type": "string", "description": "Free form name of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:label" }, "lastVerifiedDate": { "title": "Last verified date", "type": "string", "format": "date", "description": "The date that the address was last verified as still associated to the person.", "meta:xdmType": "date", "meta:xdmField": "xdm:lastVerifiedDate" }, "modifiedByBatchID": { "title": "Modified by batch identifier", "type": "string", "format": "uri-reference", "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.", "meta:xdmType": "string", "meta:xdmField": "xdm:modifiedByBatchID" }, "msaID": { "title": "Metropolitan statistical area", "type": "integer", "description": "The metropolitan statistical area in the United States where the observation occurred.", "meta:xdmType": "int", "meta:xdmField": "xdm:msaID" }, "postOfficeBox": { "title": "Post office box", "type": "string", "description": "Post office box of the address.", "maxLength": 20, "meta:xdmType": "string", "meta:xdmField": "xdm:postOfficeBox" }, "postalCode": { "title": "Postal code", "type": "string", "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.", "meta:xdmType": "string", "meta:xdmField": "xdm:postalCode" }, "primary": { "title": "Primary", "type": "boolean", "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.", "meta:xdmType": "boolean", "meta:xdmField": "xdm:primary" }, "region": { "title": "Region", "type": "string", "description": "The region, county, or district portion of the address.", "meta:xdmType": "string", "meta:xdmField": "xdm:region" }, "repositoryCreatedBy": { "title": "Created by user identifier", "type": "string", "description": "User ID of who created the record.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryCreatedBy" }, "repositoryLastModifiedBy": { "title": "Modified by user identifier", "type": "string", "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.", "meta:xdmType": "string", "meta:xdmField": "xdm:repositoryLastModifiedBy" }, "state": { "title": "State", "type": "string", "description": "The name of the State. This is a free-form field.", "meta:xdmType": "string", "meta:xdmField": "xdm:state" }, "stateProvince": { "title": "State or province", "type": "string", "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", "examples": [ "US-CA", "DE-BB", "JP-13" ], "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}\|)", "meta:xdmType": "string", "meta:xdmField": "xdm:stateProvince" }, "status": { "title": "Status", "type": "string", "description": "An indication as to the ability to use the address.", "default": "active", "meta:enum": { "active": "Active", "incomplete": "Incomplete", "pending_verification": "Pending verification", "blacklisted": "Blacklisted", "blocked": "Blocked" }, "meta:xdmType": "string", "meta:xdmField": "xdm:status" }, "statusReason": { "title": "Status reason", "type": "string", "description": "A description of the current status.", "meta:xdmType": "string", "meta:xdmField": "xdm:statusReason" }, "street1": { "title": "Street 1", "type": "string", "description": "Primary street level information, apartment number, street number, and street name.", "meta:xdmType": "string", "meta:xdmField": "xdm:street1" }, "street2": { "title": "Street 2", "type": "string", "description": "Optional street information second line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street2" }, "street3": { "title": "Street 3", "type": "string", "description": "Optional street information third line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street3" }, "street4": { "title": "Street 4", "type": "string", "description": "Optional street information fourth line.", "meta:xdmType": "string", "meta:xdmField": "xdm:street4" } }, "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address", "meta:xdmField": "xdm:shippingAddress" } }, "required": [ "personalEmail" ], "imsOrg": "{ORG_ID}", "meta:extensible": false, "meta:abstract": false, "meta:extends": [ "https://ns.adobe.com/xdm/context/profile-person-details", "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details", "https://ns.adobe.com/xdm/context/profile-personal-details", "https://ns.adobe.com/xdm/common/auditable", "https://ns.adobe.com/xdm/data/record", "https://ns.adobe.com/xdm/context/profile", "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691" ], "meta:xdmType": "object", "meta:registryMetadata": { "repo:createdDate": 1673310304048, "repo:lastModifiedDate": 1673380280074, "xdm:createdClientId": "{CLIENT_ID}", "xdm:lastModifiedClientId": "{CLIENT_ID}", "xdm:createdUserId": "{USER_ID}", "xdm:lastModifiedUserId": "{USER_ID}", "eTag": "c590ccc7a293040d85c2b7d93276480ef4b4aa9a4fcd6991f50fbb47f58bced2", "meta:globalLibVersion": "1.38.2" }, "meta:class": "https://ns.adobe.com/xdm/context/profile", "meta:containerId": "tenant", "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d", "meta:sandboxType": "production", "meta:tenantNamespace": "_{TENANT_ID}", "meta:immutableTags": [ "union" ], "meta:allFieldAccess": true }

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:altId": "_{TENANT_ID}.schemas.ee56b80adc7e03b8214e135a28538fe83c7f85bf87f565b3",
  "meta:resourceType": "schemas",
  "version": "1.4",
  "title": "Loyalty Members",
  "type": "object",
  "description": "Information for all members of the loyalty program",
  "properties": {
    "_{TENANT_ID}": {
      "type": "object",
      "properties": {
        "loyaltyTier": {
          "title": "Loyalty Tier",
          "description": "Loyalty tier info",
          "type": "object",
          "meta:xdmType": "object",
          "properties": {
            "id": {
              "title": "Loyalty Tier Identifier",
              "type": "string",
              "description": "Loyalty Tier Identifier.",
              "meta:xdmType": "string"
            },
            "effectiveDate": {
              "title": "Effective Date",
              "type": "string",
              "format": "date-time",
              "description": "Date the member joined their current loyalty tier.",
              "meta:xdmType": "date-time"
            },
            "currentThreshold": {
              "title": "Current Point Threshold",
              "type": "integer",
              "description": "The minimum number of loyalty points the member must maintain to remain in the current tier.",
              "meta:xdmType": "int"
            },
            "nextThreshold": {
              "title": "Next Point Threshold",
              "type": "integer",
              "description": "The number of loyalty points the member must accrue to graduate to the next tier.",
              "meta:xdmType": "int"
            }
          },
          "meta:referencedFrom": "https://ns.adobe.com/{TENANT_ID}/datatypes/c069d13ebfaaa5980d988e7694d794b37b1784fe11d754cb"
        }
      },
      "meta:xdmType": "object"
    },
    "_id": {
      "title": "Identifier",
      "type": "string",
      "format": "uri-reference",
      "description": "A unique identifier for the record.",
      "meta:xdmType": "string",
      "meta:xdmField": "@id"
    },
    "_repo": {
      "properties": {
        "createDate": {
          "type": "string",
          "format": "date-time",
          "meta:immutable": true,
          "meta:usereditable": false,
          "examples": [
            "2004-10-23T12:00:00-06:00"
          ],
          "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
          "meta:xdmType": "date-time",
          "meta:xdmField": "repo:createDate"
        },
        "modifyDate": {
          "type": "string",
          "format": "date-time",
          "meta:usereditable": false,
          "examples": [
            "2004-10-23T12:00:00-06:00"
          ],
          "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
          "meta:xdmType": "date-time",
          "meta:xdmField": "repo:modifyDate"
        }
      },
      "type": "object",
      "meta:xdmType": "object",
      "meta:xedConverted": true
    },
    "billingAddress": {
      "title": "Billing Address",
      "description": "Billing postal address.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "_id": {
          "title": "Coordinates ID",
          "type": "string",
          "format": "uri-reference",
          "description": "The unique identifier of the coordinates.",
          "meta:xdmType": "string",
          "meta:xdmField": "@id"
        },
        "_repo": {
          "properties": {
            "createDate": {
              "type": "string",
              "format": "date-time",
              "meta:immutable": true,
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:createDate"
            },
            "modifyDate": {
              "type": "string",
              "format": "date-time",
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:modifyDate"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "_schema": {
          "properties": {
            "description": {
              "title": "Description",
              "type": "string",
              "description": "A description of what the coordinates identify.",
              "meta:xdmType": "string",
              "meta:xdmField": "schema:description"
            },
            "elevation": {
              "title": "Elevation",
              "type": "number",
              "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:elevation"
            },
            "latitude": {
              "title": "Latitude",
              "type": "number",
              "minimum": -90,
              "maximum": 90,
              "description": "The signed vertical coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:latitude"
            },
            "longitude": {
              "title": "Longitude",
              "type": "number",
              "minimum": -180,
              "maximum": 180,
              "description": "The signed horizontal coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:longitude"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "city": {
          "title": "City",
          "type": "string",
          "description": "The name of the city.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:city"
        },
        "country": {
          "title": "Country",
          "type": "string",
          "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:country"
        },
        "countryCode": {
          "title": "Country code",
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "createdByBatchID": {
          "title": "Created by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The dataset files in Catalog which has been originating the creation of the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:createdByBatchID"
        },
        "dmaID": {
          "title": "Designated market area",
          "type": "integer",
          "description": "The Nielsen media research designated market area.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:dmaID"
        },
        "label": {
          "title": "Label",
          "type": "string",
          "description": "Free form name of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:label"
        },
        "lastVerifiedDate": {
          "title": "Last verified date",
          "type": "string",
          "format": "date",
          "description": "The date that the address was last verified as still associated to the person.",
          "meta:xdmType": "date",
          "meta:xdmField": "xdm:lastVerifiedDate"
        },
        "modifiedByBatchID": {
          "title": "Modified by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:modifiedByBatchID"
        },
        "msaID": {
          "title": "Metropolitan statistical area",
          "type": "integer",
          "description": "The metropolitan statistical area in the United States where the observation occurred.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:msaID"
        },
        "postOfficeBox": {
          "title": "Post office box",
          "type": "string",
          "description": "Post office box of the address.",
          "maxLength": 20,
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postOfficeBox"
        },
        "postalCode": {
          "title": "Postal code",
          "type": "string",
          "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postalCode"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "region": {
          "title": "Region",
          "type": "string",
          "description": "The region, county, or district portion of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:region"
        },
        "repositoryCreatedBy": {
          "title": "Created by user identifier",
          "type": "string",
          "description": "User ID of who created the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryCreatedBy"
        },
        "repositoryLastModifiedBy": {
          "title": "Modified by user identifier",
          "type": "string",
          "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryLastModifiedBy"
        },
        "state": {
          "title": "State",
          "type": "string",
          "description": "The name of the State. This is a free-form field.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:state"
        },
        "stateProvince": {
          "title": "State or province",
          "type": "string",
          "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.",
          "examples": [
            "US-CA",
            "DE-BB",
            "JP-13"
          ],
          "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}|)",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:stateProvince"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the address.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "pending_verification": "Pending verification",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "street1": {
          "title": "Street 1",
          "type": "string",
          "description": "Primary street level information, apartment number, street number, and street name.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street1"
        },
        "street2": {
          "title": "Street 2",
          "type": "string",
          "description": "Optional street information second line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street2"
        },
        "street3": {
          "title": "Street 3",
          "type": "string",
          "description": "Optional street information third line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street3"
        },
        "street4": {
          "title": "Street 4",
          "type": "string",
          "description": "Optional street information fourth line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street4"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address",
      "meta:xdmField": "xdm:billingAddress"
    },
    "createdByBatchID": {
      "title": "Created by batch identifier",
      "type": "string",
      "format": "uri-reference",
      "description": "The dataset files in Catalog which has been originating the creation of the record.",
      "meta:xdmType": "string",
      "meta:xdmField": "xdm:createdByBatchID"
    },
    "faxPhone": {
      "title": "Fax Phone",
      "description": "Fax phone number.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "countryCode": {
          "title": "Country Calling Code",
          "type": "string",
          "description": "Country calling code (CC) as defined by E.164.",
          "minLength": 1,
          "maxLength": 3,
          "pattern": "^[0-9]{1,3}?$",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "extension": {
          "title": "Extension",
          "type": "string",
          "description": "The internal dialing number used to call from a private exchange, operator, or switchboard.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:extension"
        },
        "number": {
          "title": "Number",
          "type": "string",
          "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example,  1-353(0)18391111 or +613 9403600x1234.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:number"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the phone number.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "validity": {
          "title": "Validity",
          "type": "string",
          "description": "A level of technical correctness of the phone number.",
          "meta:enum": {
            "consistent": "Consistent",
            "inconsistent": "Inconsistent",
            "incomplete": "Incomplete",
            "successfullyUsed": "Successfully used"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:validity"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber",
      "meta:xdmField": "xdm:faxPhone"
    },
    "homeAddress": {
      "title": "Home Address",
      "description": "A home postal address.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "_id": {
          "title": "Coordinates ID",
          "type": "string",
          "format": "uri-reference",
          "description": "The unique identifier of the coordinates.",
          "meta:xdmType": "string",
          "meta:xdmField": "@id"
        },
        "_repo": {
          "properties": {
            "createDate": {
              "type": "string",
              "format": "date-time",
              "meta:immutable": true,
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:createDate"
            },
            "modifyDate": {
              "type": "string",
              "format": "date-time",
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:modifyDate"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "_schema": {
          "properties": {
            "description": {
              "title": "Description",
              "type": "string",
              "description": "A description of what the coordinates identify.",
              "meta:xdmType": "string",
              "meta:xdmField": "schema:description"
            },
            "elevation": {
              "title": "Elevation",
              "type": "number",
              "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:elevation"
            },
            "latitude": {
              "title": "Latitude",
              "type": "number",
              "minimum": -90,
              "maximum": 90,
              "description": "The signed vertical coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:latitude"
            },
            "longitude": {
              "title": "Longitude",
              "type": "number",
              "minimum": -180,
              "maximum": 180,
              "description": "The signed horizontal coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:longitude"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "city": {
          "title": "City",
          "type": "string",
          "description": "The name of the city.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:city"
        },
        "country": {
          "title": "Country",
          "type": "string",
          "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:country"
        },
        "countryCode": {
          "title": "Country code",
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "createdByBatchID": {
          "title": "Created by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The dataset files in Catalog which has been originating the creation of the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:createdByBatchID"
        },
        "dmaID": {
          "title": "Designated market area",
          "type": "integer",
          "description": "The Nielsen media research designated market area.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:dmaID"
        },
        "label": {
          "title": "Label",
          "type": "string",
          "description": "Free form name of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:label"
        },
        "lastVerifiedDate": {
          "title": "Last verified date",
          "type": "string",
          "format": "date",
          "description": "The date that the address was last verified as still associated to the person.",
          "meta:xdmType": "date",
          "meta:xdmField": "xdm:lastVerifiedDate"
        },
        "modifiedByBatchID": {
          "title": "Modified by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:modifiedByBatchID"
        },
        "msaID": {
          "title": "Metropolitan statistical area",
          "type": "integer",
          "description": "The metropolitan statistical area in the United States where the observation occurred.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:msaID"
        },
        "postOfficeBox": {
          "title": "Post office box",
          "type": "string",
          "description": "Post office box of the address.",
          "maxLength": 20,
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postOfficeBox"
        },
        "postalCode": {
          "title": "Postal code",
          "type": "string",
          "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postalCode"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "region": {
          "title": "Region",
          "type": "string",
          "description": "The region, county, or district portion of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:region"
        },
        "repositoryCreatedBy": {
          "title": "Created by user identifier",
          "type": "string",
          "description": "User ID of who created the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryCreatedBy"
        },
        "repositoryLastModifiedBy": {
          "title": "Modified by user identifier",
          "type": "string",
          "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryLastModifiedBy"
        },
        "state": {
          "title": "State",
          "type": "string",
          "description": "The name of the State. This is a free-form field.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:state"
        },
        "stateProvince": {
          "title": "State or province",
          "type": "string",
          "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.",
          "examples": [
            "US-CA",
            "DE-BB",
            "JP-13"
          ],
          "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}|)",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:stateProvince"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the address.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "pending_verification": "Pending verification",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "street1": {
          "title": "Street 1",
          "type": "string",
          "description": "Primary street level information, apartment number, street number, and street name.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street1"
        },
        "street2": {
          "title": "Street 2",
          "type": "string",
          "description": "Optional street information second line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street2"
        },
        "street3": {
          "title": "Street 3",
          "type": "string",
          "description": "Optional street information third line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street3"
        },
        "street4": {
          "title": "Street 4",
          "type": "string",
          "description": "Optional street information fourth line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street4"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address",
      "meta:xdmField": "xdm:homeAddress"
    },
    "homePhone": {
      "title": "Home Phone",
      "description": "Home phone number.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "countryCode": {
          "title": "Country Calling Code",
          "type": "string",
          "description": "Country calling code (CC) as defined by E.164.",
          "minLength": 1,
          "maxLength": 3,
          "pattern": "^[0-9]{1,3}?$",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "extension": {
          "title": "Extension",
          "type": "string",
          "description": "The internal dialing number used to call from a private exchange, operator, or switchboard.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:extension"
        },
        "number": {
          "title": "Number",
          "type": "string",
          "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example,  1-353(0)18391111 or +613 9403600x1234.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:number"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the phone number.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "validity": {
          "title": "Validity",
          "type": "string",
          "description": "A level of technical correctness of the phone number.",
          "meta:enum": {
            "consistent": "Consistent",
            "inconsistent": "Inconsistent",
            "incomplete": "Incomplete",
            "successfullyUsed": "Successfully used"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:validity"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber",
      "meta:xdmField": "xdm:homePhone"
    },
    "loyalty": {
      "type": "object",
      "description": "Captures details related to the customer's loyalty rewards.",
      "properties": {
        "joinDate": {
          "title": "Program Join Date",
          "type": "string",
          "format": "date-time",
          "description": "Date which the visitor registered for the loyalty program.",
          "meta:xdmType": "date-time",
          "meta:xdmField": "xdm:joinDate"
        },
        "loyaltyID": {
          "title": "Program ID",
          "type": "array",
          "items": {
            "type": "string",
            "meta:xdmType": "string"
          },
          "description": "The loyalty program ID(s) associated with a specific user, if they are enrolled in the client's loyalty program.",
          "meta:xdmType": "array",
          "meta:xdmField": "xdm:loyaltyID"
        },
        "points": {
          "title": "Program Points Balance",
          "type": "number",
          "description": "Current balance of the loyalty points/awards in a visitor's loyalty account.",
          "meta:xdmType": "number",
          "meta:xdmField": "xdm:points"
        },
        "pointsExpiration": {
          "title": "Points Expiration",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "pointsExpirationDate": {
                "type": "string",
                "format": "date-time",
                "description": "Date on which the given portion of the loyalty points expire.",
                "meta:xdmType": "date-time",
                "meta:xdmField": "xdm:pointsExpirationDate"
              },
              "pointsExpiring": {
                "title": "Points Expiring",
                "type": "number",
                "description": "Point balance expiring as of the associated expiration date.",
                "meta:xdmType": "number",
                "meta:xdmField": "xdm:pointsExpiring"
              }
            },
            "meta:xdmType": "object"
          },
          "meta:xdmType": "array",
          "meta:xdmField": "xdm:pointsExpiration"
        },
        "pointsRedeemed": {
          "title": "Points Redeemed",
          "type": "number",
          "description": "Amount of points applied toward a purchase or otherwise redeemed.",
          "meta:xdmType": "number",
          "meta:xdmField": "xdm:pointsRedeemed"
        },
        "program": {
          "title": "Program Name",
          "type": "string",
          "description": "This should define the loyalty progam in which a visitor is enrolled.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:program"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "Captures the visitor's loyalty progam status, such as active, disabled, or suspended.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "tier": {
          "title": "Tier",
          "type": "string",
          "description": "Captures the loyalty progam tier in which a visitor is enrolled.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:tier"
        },
        "upgradeDate": {
          "title": "Program Name",
          "type": "string",
          "description": "Date which the customer was upgraded to the next tier level.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:upgradeDate"
        }
      },
      "meta:xdmType": "object",
      "meta:xdmField": "xdm:loyalty"
    },
    "mailingAddress": {
      "title": "Mailing Address",
      "description": "Mailing postal address.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "_id": {
          "title": "Coordinates ID",
          "type": "string",
          "format": "uri-reference",
          "description": "The unique identifier of the coordinates.",
          "meta:xdmType": "string",
          "meta:xdmField": "@id"
        },
        "_repo": {
          "properties": {
            "createDate": {
              "type": "string",
              "format": "date-time",
              "meta:immutable": true,
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:createDate"
            },
            "modifyDate": {
              "type": "string",
              "format": "date-time",
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:modifyDate"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "_schema": {
          "properties": {
            "description": {
              "title": "Description",
              "type": "string",
              "description": "A description of what the coordinates identify.",
              "meta:xdmType": "string",
              "meta:xdmField": "schema:description"
            },
            "elevation": {
              "title": "Elevation",
              "type": "number",
              "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:elevation"
            },
            "latitude": {
              "title": "Latitude",
              "type": "number",
              "minimum": -90,
              "maximum": 90,
              "description": "The signed vertical coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:latitude"
            },
            "longitude": {
              "title": "Longitude",
              "type": "number",
              "minimum": -180,
              "maximum": 180,
              "description": "The signed horizontal coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:longitude"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "city": {
          "title": "City",
          "type": "string",
          "description": "The name of the city.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:city"
        },
        "country": {
          "title": "Country",
          "type": "string",
          "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:country"
        },
        "countryCode": {
          "title": "Country code",
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "createdByBatchID": {
          "title": "Created by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The dataset files in Catalog which has been originating the creation of the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:createdByBatchID"
        },
        "dmaID": {
          "title": "Designated market area",
          "type": "integer",
          "description": "The Nielsen media research designated market area.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:dmaID"
        },
        "label": {
          "title": "Label",
          "type": "string",
          "description": "Free form name of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:label"
        },
        "lastVerifiedDate": {
          "title": "Last verified date",
          "type": "string",
          "format": "date",
          "description": "The date that the address was last verified as still associated to the person.",
          "meta:xdmType": "date",
          "meta:xdmField": "xdm:lastVerifiedDate"
        },
        "modifiedByBatchID": {
          "title": "Modified by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:modifiedByBatchID"
        },
        "msaID": {
          "title": "Metropolitan statistical area",
          "type": "integer",
          "description": "The metropolitan statistical area in the United States where the observation occurred.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:msaID"
        },
        "postOfficeBox": {
          "title": "Post office box",
          "type": "string",
          "description": "Post office box of the address.",
          "maxLength": 20,
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postOfficeBox"
        },
        "postalCode": {
          "title": "Postal code",
          "type": "string",
          "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postalCode"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "region": {
          "title": "Region",
          "type": "string",
          "description": "The region, county, or district portion of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:region"
        },
        "repositoryCreatedBy": {
          "title": "Created by user identifier",
          "type": "string",
          "description": "User ID of who created the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryCreatedBy"
        },
        "repositoryLastModifiedBy": {
          "title": "Modified by user identifier",
          "type": "string",
          "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryLastModifiedBy"
        },
        "state": {
          "title": "State",
          "type": "string",
          "description": "The name of the State. This is a free-form field.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:state"
        },
        "stateProvince": {
          "title": "State or province",
          "type": "string",
          "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.",
          "examples": [
            "US-CA",
            "DE-BB",
            "JP-13"
          ],
          "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}|)",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:stateProvince"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the address.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "pending_verification": "Pending verification",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "street1": {
          "title": "Street 1",
          "type": "string",
          "description": "Primary street level information, apartment number, street number, and street name.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street1"
        },
        "street2": {
          "title": "Street 2",
          "type": "string",
          "description": "Optional street information second line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street2"
        },
        "street3": {
          "title": "Street 3",
          "type": "string",
          "description": "Optional street information third line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street3"
        },
        "street4": {
          "title": "Street 4",
          "type": "string",
          "description": "Optional street information fourth line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street4"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address",
      "meta:xdmField": "xdm:mailingAddress"
    },
    "mobilePhone": {
      "title": "Mobile Phone",
      "description": "Mobile phone number.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "countryCode": {
          "title": "Country Calling Code",
          "type": "string",
          "description": "Country calling code (CC) as defined by E.164.",
          "minLength": 1,
          "maxLength": 3,
          "pattern": "^[0-9]{1,3}?$",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "extension": {
          "title": "Extension",
          "type": "string",
          "description": "The internal dialing number used to call from a private exchange, operator, or switchboard.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:extension"
        },
        "number": {
          "title": "Number",
          "type": "string",
          "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example,  1-353(0)18391111 or +613 9403600x1234.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:number"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the phone number.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "validity": {
          "title": "Validity",
          "type": "string",
          "description": "A level of technical correctness of the phone number.",
          "meta:enum": {
            "consistent": "Consistent",
            "inconsistent": "Inconsistent",
            "incomplete": "Incomplete",
            "successfullyUsed": "Successfully used"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:validity"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/context/phonenumber",
      "meta:xdmField": "xdm:mobilePhone"
    },
    "modifiedByBatchID": {
      "title": "Modified by batch identifier",
      "type": "string",
      "format": "uri-reference",
      "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.",
      "meta:xdmType": "string",
      "meta:xdmField": "xdm:modifiedByBatchID"
    },
    "person": {
      "title": "Person",
      "description": "An individual actor, contact, or owner.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "birthDate": {
          "title": "Birth date(YYYY-MM-DD)",
          "type": "string",
          "format": "date",
          "description": "The full date a person was born.",
          "meta:xdmType": "date",
          "meta:xdmField": "xdm:birthDate"
        },
        "birthDayAndMonth": {
          "title": "Birth date (MM-DD)",
          "type": "string",
          "pattern": "[0-1][0-9]-[0-9][0-9]",
          "description": "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:birthDayAndMonth"
        },
        "birthYear": {
          "title": "Birth year",
          "type": "integer",
          "description": "The year a person was born including the century, for example, 1983.  This field should be used when only the person's age is known, not the full birth date.",
          "minimum": 1,
          "maximum": 32767,
          "meta:xdmType": "short",
          "meta:xdmField": "xdm:birthYear"
        },
        "gender": {
          "title": "Gender",
          "type": "string",
          "enum": [
            "male",
            "female",
            "not_specified",
            "non_specific"
          ],
          "meta:enum": {
            "male": "Male",
            "female": "Female",
            "not_specified": "Not Specified",
            "non_specific": "Non-specific"
          },
          "description": "Gender identity of the person.\n",
          "default": "not_specified",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:gender"
        },
        "maritalStatus": {
          "title": "Marital Status",
          "type": "string",
          "enum": [
            "married",
            "single",
            "divorced",
            "widowed",
            "not_specified"
          ],
          "meta:enum": {
            "married": "Married",
            "single": "Single",
            "divorced": "Divorced",
            "widowed": "Widowed",
            "not_specified": "Not Specified"
          },
          "description": "Describes a person's relationship with a significant other.",
          "default": "not_specified",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:maritalStatus"
        },
        "name": {
          "title": "Full name",
          "description": "The person's full name.",
          "type": "object",
          "meta:xdmType": "object",
          "properties": {
            "courtesyTitle": {
              "title": "Courtesy title",
              "type": "string",
              "description": "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr.",
              "meta:xdmType": "string",
              "meta:xdmField": "xdm:courtesyTitle"
            },
            "firstName": {
              "title": "First name",
              "type": "string",
              "description": "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable.",
              "meta:xdmType": "string",
              "meta:xdmField": "xdm:firstName"
            },
            "fullName": {
              "title": "Full name",
              "type": "string",
              "description": "The full name of the person, in writing order most commonly accepted in the language of the name.",
              "meta:xdmType": "string",
              "meta:xdmField": "xdm:fullName"
            },
            "lastName": {
              "title": "Last name",
              "type": "string",
              "description": "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable.",
              "meta:xdmType": "string",
              "meta:xdmField": "xdm:lastName"
            },
            "middleName": {
              "title": "Middle name",
              "type": "string",
              "description": "Middle, alternative, or additional names supplied between the first name and last name.",
              "meta:xdmType": "string",
              "meta:xdmField": "xdm:middleName"
            },
            "suffix": {
              "title": "Suffix",
              "type": "string",
              "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc.",
              "meta:xdmType": "string",
              "meta:xdmField": "xdm:suffix"
            }
          },
          "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person-name",
          "meta:xdmField": "xdm:name"
        },
        "nationality": {
          "title": "Nationality",
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:nationality"
        },
        "taxId": {
          "title": "Tax ID",
          "type": "string",
          "description": "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain.",
          "meta:status": "deprecated",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:taxId"
        },
        "type": {
          "title": "Type",
          "type": "string",
          "description": "The type of individual in different business contexts like B2C.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:type"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person",
      "meta:xdmField": "xdm:person"
    },
    "personID": {
      "title": "Person ID",
      "description": "Unique identifier of Person/Profile fragment.",
      "type": "string",
      "meta:xdmType": "string",
      "meta:xdmField": "xdm:personID"
    },
    "personalEmail": {
      "title": "Personal Email",
      "description": "A personal email address.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "address": {
          "title": "Address",
          "type": "string",
          "format": "email",
          "description": "The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:address",
          "minLength": 1
        },
        "label": {
          "title": "Label",
          "type": "string",
          "description": "Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:label"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary email indicator. A profile can have only one `primary` email address at a given point of time.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the email address.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "pending_verification": "Pending verification",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "type": {
          "title": "Type",
          "type": "string",
          "description": "The way the account relates to the person for example 'work' or 'personal'.",
          "meta:enum": {
            "unknown": "Unknown",
            "personal": "Personal",
            "work": "Work",
            "education": "Education"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:type"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/context/emailaddress",
      "meta:xdmField": "xdm:personalEmail",
      "required": [
        "address"
      ]
    },
    "repositoryCreatedBy": {
      "title": "Created by user identifier",
      "type": "string",
      "description": "User ID of who created the record.",
      "meta:xdmType": "string",
      "meta:xdmField": "xdm:repositoryCreatedBy"
    },
    "repositoryLastModifiedBy": {
      "title": "Modified by user identifier",
      "type": "string",
      "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.",
      "meta:xdmType": "string",
      "meta:xdmField": "xdm:repositoryLastModifiedBy"
    },
    "shippingAddress": {
      "title": "Shipping Address",
      "description": "Shipping postal address.",
      "type": "object",
      "meta:xdmType": "object",
      "properties": {
        "_id": {
          "title": "Coordinates ID",
          "type": "string",
          "format": "uri-reference",
          "description": "The unique identifier of the coordinates.",
          "meta:xdmType": "string",
          "meta:xdmField": "@id"
        },
        "_repo": {
          "properties": {
            "createDate": {
              "type": "string",
              "format": "date-time",
              "meta:immutable": true,
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:createDate"
            },
            "modifyDate": {
              "type": "string",
              "format": "date-time",
              "meta:usereditable": false,
              "examples": [
                "2004-10-23T12:00:00-06:00"
              ],
              "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".",
              "meta:xdmType": "date-time",
              "meta:xdmField": "repo:modifyDate"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "_schema": {
          "properties": {
            "description": {
              "title": "Description",
              "type": "string",
              "description": "A description of what the coordinates identify.",
              "meta:xdmType": "string",
              "meta:xdmField": "schema:description"
            },
            "elevation": {
              "title": "Elevation",
              "type": "number",
              "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:elevation"
            },
            "latitude": {
              "title": "Latitude",
              "type": "number",
              "minimum": -90,
              "maximum": 90,
              "description": "The signed vertical coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:latitude"
            },
            "longitude": {
              "title": "Longitude",
              "type": "number",
              "minimum": -180,
              "maximum": 180,
              "description": "The signed horizontal coordinate of a geographic point.",
              "meta:xdmType": "number",
              "meta:xdmField": "schema:longitude"
            }
          },
          "type": "object",
          "meta:xdmType": "object",
          "meta:xedConverted": true
        },
        "city": {
          "title": "City",
          "type": "string",
          "description": "The name of the city.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:city"
        },
        "country": {
          "title": "Country",
          "type": "string",
          "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:country"
        },
        "countryCode": {
          "title": "Country code",
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:countryCode"
        },
        "createdByBatchID": {
          "title": "Created by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The dataset files in Catalog which has been originating the creation of the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:createdByBatchID"
        },
        "dmaID": {
          "title": "Designated market area",
          "type": "integer",
          "description": "The Nielsen media research designated market area.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:dmaID"
        },
        "label": {
          "title": "Label",
          "type": "string",
          "description": "Free form name of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:label"
        },
        "lastVerifiedDate": {
          "title": "Last verified date",
          "type": "string",
          "format": "date",
          "description": "The date that the address was last verified as still associated to the person.",
          "meta:xdmType": "date",
          "meta:xdmField": "xdm:lastVerifiedDate"
        },
        "modifiedByBatchID": {
          "title": "Modified by batch identifier",
          "type": "string",
          "format": "uri-reference",
          "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:modifiedByBatchID"
        },
        "msaID": {
          "title": "Metropolitan statistical area",
          "type": "integer",
          "description": "The metropolitan statistical area in the United States where the observation occurred.",
          "meta:xdmType": "int",
          "meta:xdmField": "xdm:msaID"
        },
        "postOfficeBox": {
          "title": "Post office box",
          "type": "string",
          "description": "Post office box of the address.",
          "maxLength": 20,
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postOfficeBox"
        },
        "postalCode": {
          "title": "Postal code",
          "type": "string",
          "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:postalCode"
        },
        "primary": {
          "title": "Primary",
          "type": "boolean",
          "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time.",
          "meta:xdmType": "boolean",
          "meta:xdmField": "xdm:primary"
        },
        "region": {
          "title": "Region",
          "type": "string",
          "description": "The region, county, or district portion of the address.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:region"
        },
        "repositoryCreatedBy": {
          "title": "Created by user identifier",
          "type": "string",
          "description": "User ID of who created the record.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryCreatedBy"
        },
        "repositoryLastModifiedBy": {
          "title": "Modified by user identifier",
          "type": "string",
          "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:repositoryLastModifiedBy"
        },
        "state": {
          "title": "State",
          "type": "string",
          "description": "The name of the State. This is a free-form field.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:state"
        },
        "stateProvince": {
          "title": "State or province",
          "type": "string",
          "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.",
          "examples": [
            "US-CA",
            "DE-BB",
            "JP-13"
          ],
          "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}|)",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:stateProvince"
        },
        "status": {
          "title": "Status",
          "type": "string",
          "description": "An indication as to the ability to use the address.",
          "default": "active",
          "meta:enum": {
            "active": "Active",
            "incomplete": "Incomplete",
            "pending_verification": "Pending verification",
            "blacklisted": "Blacklisted",
            "blocked": "Blocked"
          },
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:status"
        },
        "statusReason": {
          "title": "Status reason",
          "type": "string",
          "description": "A description of the current status.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:statusReason"
        },
        "street1": {
          "title": "Street 1",
          "type": "string",
          "description": "Primary street level information, apartment number, street number, and street name.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street1"
        },
        "street2": {
          "title": "Street 2",
          "type": "string",
          "description": "Optional street information second line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street2"
        },
        "street3": {
          "title": "Street 3",
          "type": "string",
          "description": "Optional street information third line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street3"
        },
        "street4": {
          "title": "Street 4",
          "type": "string",
          "description": "Optional street information fourth line.",
          "meta:xdmType": "string",
          "meta:xdmField": "xdm:street4"
        }
      },
      "meta:referencedFrom": "https://ns.adobe.com/xdm/common/address",
      "meta:xdmField": "xdm:shippingAddress"
    }
  },
  "required": [
    "personalEmail"
  ],
  "imsOrg": "{ORG_ID}",
  "meta:extensible": false,
  "meta:abstract": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/context/profile-person-details",
    "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details",
    "https://ns.adobe.com/xdm/context/profile-personal-details",
    "https://ns.adobe.com/xdm/common/auditable",
    "https://ns.adobe.com/xdm/data/record",
    "https://ns.adobe.com/xdm/context/profile",
    "https://ns.adobe.com/{TENANT_ID}/mixins/9068fd4ea2abf813f4fd2fc9c8b413ae453ff0efc7636691"
  ],
  "meta:xdmType": "object",
  "meta:registryMetadata": {
    "repo:createdDate": 1673310304048,
    "repo:lastModifiedDate": 1673380280074,
    "xdm:createdClientId": "{CLIENT_ID}",
    "xdm:lastModifiedClientId": "{CLIENT_ID}",
    "xdm:createdUserId": "{USER_ID}",
    "xdm:lastModifiedUserId": "{USER_ID}",
    "eTag": "c590ccc7a293040d85c2b7d93276480ef4b4aa9a4fcd6991f50fbb47f58bced2",
    "meta:globalLibVersion": "1.38.2"
  },
  "meta:class": "https://ns.adobe.com/xdm/context/profile",
  "meta:containerId": "tenant",
  "meta:sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
  "meta:sandboxType": "production",
  "meta:tenantNamespace": "_{TENANT_ID}",
  "meta:immutableTags": [
    "union"
  ],
  "meta:allFieldAccess": true
}

recommendation-more-help

62e9ffd9-1c74-4cef-8f47-0d00af32fc07

使用建立方案 Schema Registry API

快速入門

使用標準類別撰寫結構描述

指派類別

查詢結構描述

新增欄位群組 add-a-field-group

新增更多欄位群組

定義新的欄位群組

將自訂欄位群組新增到結構描述

檢視目前的結構描述

建立資料型別

在結構描述中使用資料型別

定義身分描述項

啟用結構描述以用於 Real-Time Customer Profile profile

新增 union 標籤

聯合中的清單結構描述

後續步驟

附錄 appendix

完整的熟客會員結構 complete-schema

新增 `union` 標籤