Dokumentation Experience Platform Användarhandbok om XDM (Experience Data Model)

Skapa ett schema med Schema Registry API

Last update: Thu Jan 19 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Schemas

Skapat för:

Developer

The Schema Registry används för att komma åt Schema Library inom Adobe Experience Platform. The Schema Library innehåller resurser som Adobe ställt till ditt förfogande, Experience Platform partners och leverantörer vars program ni använder. Registret innehåller ett användargränssnitt och RESTful API från vilket alla tillgängliga biblioteksresurser är tillgängliga.

I den här självstudiekursen används Schema Registry API för att vägleda dig genom stegen för att skapa ett schema med en standardklass. Om du föredrar att använda användargränssnittet i Experience Platform, Schemaredigeraren, genomgång innehåller stegvisa instruktioner för att utföra liknande åtgärder i schemaredigeraren.

NOTE

Om du importerar CSV-data till plattformen kan du mappa dessa data till ett XDM-schema som skapats av AI-genererade rekommendationer (för närvarande i beta) utan att behöva skapa schemat manuellt själv.

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

Experience Data Model (XDM) System: Det standardiserade ramverk som Experience Platform organiserar kundupplevelsedata.
- Grunderna för schemakomposition: Lär dig mer om de grundläggande byggstenarna i XDM-scheman, inklusive viktiga principer och bästa praxis när det gäller schemakomposition.
Real-Time Customer Profile: Ger en enhetlig konsumentprofil i realtid baserad på aggregerade data från flera källor.
Sandboxes: Experience Platform innehåller virtuella sandlådor som partitionerar en enda Platform till separata virtuella miljöer för att utveckla och utveckla applikationer för digitala upplevelser.

Innan du startar den här självstudiekursen bör du gå igenom utvecklarhandbok för viktig information som du behöver känna till för att kunna ringa Schema Registry API. Detta inkluderar {TENANT_ID}, begreppet "behållare" och de rubriker som krävs för att göra en förfrågan (med särskild uppmärksamhet på Accept header och dess möjliga värden).

Den här självstudiekursen går igenom stegen för att skapa ett bonusmedlemsschema som beskriver data som är relaterade till medlemmarna i ett butiksbonusprogram. Innan du börjar kanske du vill förhandsgranska fullständigt medlemsschema för lojalitet i bilagan.

Skapa ett schema med en standardklass

Ett schema kan ses som en plan för de data du vill importera till Experience Platform. Varje schema består av en klass och noll eller flera schemafältgrupper. Du behöver alltså inte lägga till en fältgrupp för att definiera ett schema, men i de flesta fall används minst en fältgrupp.

Tilldela en klass

Schemadispositionsprocessen börjar med att en klass väljs. Klassen definierar viktiga beteendeaspekter för data (post- eller tidsserier) samt de minimifält som krävs för att beskriva de data som ska importeras.

Schemat som du gör i den här självstudien använder XDM Individual Profile klassen. XDM Individual Profile är en standardklass som tillhandahålls av Adobe för att definiera postbeteende. Mer information om beteenden finns i grunderna för schemakomposition.

Om du vill tilldela en klass görs ett API-anrop för att skapa (POST) ett nytt schema i innehavarbehållaren. Det här anropet innehåller den klass som schemat ska implementera. Varje schema kan bara implementera en klass.

API-format

POST /tenant/schemas

Begäran

Begäran måste innehålla en allOf som refererar till $id av en klass. Det här attributet definierar den "basklass" som schemat ska implementera. I det här exemplet är basklassen XDM Individual Profile klassen. The $id i XDM Individual Profile -klassen används som värdet för $ref i allOf nedan.

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"
            }
        ]
      }'

Svar

En slutförd begäran returnerar HTTP-svarsstatus 201 (Skapad) med en svarstext som innehåller information om det nyligen skapade schemat, inklusive $id, meta:altItoch version. Dessa värden är skrivskyddade och tilldelas av 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"
}

Söka efter ett schema

Om du vill visa det nya schemat utför du en sökning (GET) med meta:altId eller webbadressen är kodad $id URI för schemat.

API-format

GET /tenant/schemas/{SCHEMA_ID}

Parameter

Beskrivning

{SCHEMA_ID}

The meta:altId eller URL-kodad $id av schemat som du vill söka efter.

Begäran

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'

Svar

Svarsformatet beror på Accept huvud skickat med begäran. Experimentera med olika Accept sidhuvuden för att se vilken som bäst uppfyller dina behov.

{
  "$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
}

Lägg till en fältgrupp add-a-field-group

Nu när schemat för bonusmedlemmar har skapats och bekräftats kan fältgrupper läggas till i det.

Det finns olika standardfältgrupper som kan användas, beroende på vilken schemaklass som har valts. Varje fältgrupp innehåller en intendedToExtend fält som definierar den eller de klasser som fältgruppen är kompatibel med.

Fältgrupper definierar begrepp, till exempel"namn" eller"adress", som kan återanvändas i alla scheman som behöver hämta samma information.

API-format

PATCH /tenant/schemas/{SCHEMA_ID}

Parameter

Beskrivning

{SCHEMA_ID}

The meta:altId eller URL-kodad $id för schemat som du lägger till fältgruppen i.

Begäran

Denna begäran uppdaterar schemat för lojalitetsmedlemmar så att fälten i Demographic Details fältgrupp (profile-person-details).

Genom att lägga till profile-person-details fältgrupp, schemat för lojalitetsmedlemmar samlar nu in demografisk information för lojalitetsprogrammedlemmar som förnamn, efternamn och födelsedag.

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"}}
      ]'

Svar

Svaret visar den nyligen tillagda fältgruppen i meta:extends -array och innehåller $ref till fältgruppen i allOf -attribut.

{
  "$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": []
  }
}

Lägg till fler fältgrupper

Schemana för bonusmedlemmar kräver ytterligare två standardfältgrupper som du kan lägga till genom att upprepa stegen med en annan fältgrupp.

TIP

Det är värt att granska alla tillgängliga fältgrupper för att bekanta dig med fälten som ingår i varje. Du kan visa (GET) alla fältgrupper som är tillgängliga för användning med en viss klass genom att utföra en begäran mot var och en av behållarna "global" och "tenant", och bara returnera de fältgrupper där fältet "meta:intendedToExtend" matchar klassen som du använder. I det här fallet är det XDM Individual Profile -klassen, så XDM Individual Profile $id används:

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-format

PATCH /tenant/schemas/{SCHEMA_ID}

Parameter

Beskrivning

{SCHEMA_ID}

The meta:altId eller URL-kodad $id för det schema som du uppdaterar.

Begäran

Denna begäran uppdaterar schemat för lojalitetsmedlemmar så att fälten i följande standardfältgrupper inkluderas:

Personal Contact Details (profile-personal-details): Lägger till kontaktinformation som hemadress, e-postadress och hemtelefon.
Loyalty Details (profile-loyalty-details): Lägger till kontaktinformation som hemadress, e-postadress och hemtelefon.

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"}}
      ]'

Svar

Svaret visar de nya fältgrupperna i meta:extends -array och innehåller $ref till fältgruppen i allOf -attribut.

Schemat för lojalitetsmedlemmar bör nu innehålla fyra $ref värden i allOf array: profile, profile-person-details, profile-personal-detailsoch profile-loyalty-details enligt nedan.

{
  "$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": []
  }
}

Definiera en ny fältgrupp

Medan standarden Loyalty Details fältgruppen tillhandahåller användbara lojalitetsrelaterade fält till schemat, men det finns ytterligare lojalitetsfält som inte ingår i någon standardfältgrupp.

Om du vill lägga till de här fälten kan du definiera egna fältgrupper i tenant behållare. Dessa fältgrupper är unika för din organisation och är inte synliga eller redigerbara av någon utanför din organisation.

För att kunna skapa (POST) en ny fältgrupp måste din begäran innehålla en meta:intendedToExtend fältet som innehåller $id för den eller de basklasser som fältgruppen är kompatibel med, tillsammans med de egenskaper som fältgruppen kommer att innehålla.

Alla anpassade egenskaper måste kapslas under din TENANT_ID för att undvika kollisioner med andra fältgrupper eller fält.

API-format

POST /tenant/fieldgroups

Begäran

Denna begäran skapar en ny fältgrupp som har en loyaltyTier objekt som innehåller fyra fält som är specifika för ett företags specifika lojalitetsprogram: id, effectiveDate, currentThresholdoch 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"
          }
        ]
      }'

Svar

En slutförd begäran returnerar HTTP-svarsstatus 201 (Skapad) med en svarstext som innehåller information om den nyligen skapade fältgruppen, inklusive $id, meta:altItoch version. Dessa värden är skrivskyddade och tilldelas av 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}"
}

Lägg till den anpassade fältgruppen i schemat

Nu kan du följa samma steg för lägga till en standardfältgrupp om du vill lägga till den här nyligen skapade fältgruppen i ditt schema.

API-format

PATCH /tenant/schemas/{SCHEMA_ID}

Parameter

Beskrivning

{SCHEMA_ID}

The meta:altId eller URL-kodad $id av schemat.

Begäran

Denna begäran uppdaterar (PATCH) schemat för lojalitetsmedlemmar så att fälten i den nya fältgruppen "Bonusnivå" inkluderas.

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"}}
      ]'

Svar

Du kan se att fältgruppen har lagts till eftersom svaret nu visar den nyligen tillagda fältgruppen i meta:extends -array och innehåller $ref till fältgruppen i allOf -attribut.

{
    "$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": []
    }
}

Visa aktuellt schema

Nu kan du utföra en GET-begäran för att visa det aktuella schemat och se hur de tillagda fältgrupperna har bidragit till schemats övergripande struktur.

API-format

GET /tenant/schemas/{SCHEMA_ID}

Parameter

Beskrivning

{SCHEMA_ID}

The meta:altId eller URL-kodad $id av schemat.

Begäran

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'

Svar

Genom att använda application/vnd.adobe.xed-full+json; version=1 Accept kan du se hela schemat med alla egenskaper. Dessa egenskaper är de fält som tillhandahålls av den klass och de fältgrupper som har använts för att komponera schemat. I exempelsvaret nedan visas endast de nyligen tillagda fälten för blanksteg. Du kan visa hela schemat, inklusive alla egenskaper och deras attribut, i appendix i slutet av det här dokumentet.

Under "properties"kan du se _{TENANT_ID} namnutrymme som skapades när du lade till den anpassade fältgruppen. Inom namnutrymmet är loyaltyTier -objekt och de fält som definierades när fältgruppen skapades.

{
  "$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}"
}

Skapa en datatyp

Fältgruppen Förmånsnivå som du skapade innehåller specifika egenskaper som kan vara användbara i andra scheman. Data kan till exempel importeras som en del av en upplevelsehändelse eller användas av ett schema som implementerar en annan klass. I det här fallet är det bra att spara objekthierarkin som en datatyp så att det blir enklare att återanvända definitionen någon annanstans.

Med datatyper kan du definiera en objekthierarki en gång och referera till den i ett fält på ungefär samma sätt som för andra skalära typer.

Med andra ord möjliggör datatyper konsekvent användning av flerfältsstrukturer, med större flexibilitet än fältgrupper, eftersom de kan inkluderas var som helst i ett schema genom att lägga till dem som"typ" av ett fält.

API-format

POST /tenant/datatypes

Begäran

Definiering av en datatyp kräver inte meta:extends eller meta:intendedToExtend fält och fält behöver inte kapslas under ditt klient-ID för att undvika kollisioner.

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"
          }
        ]
      }'

Svar

En slutförd begäran returnerar HTTP-svarsstatus 201 (Skapad) med en svarstext som innehåller information om den nya datatypen, inklusive $id, meta:altItoch version. Dessa värden är skrivskyddade och tilldelas av 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}"
}

Du kan utföra en sökning (GET) med URL-kodad $id URI för att visa den nya datatypen direkt. Var noga med att inkludera version i Accept huvud för en uppslagsbegäran.

Använd datatyp i schema

Nu när datatypen Loyalty Tier har skapats kan du uppdatera (PATCH) loyaltyTier i fältgruppen som du skapade för att referera till datatypen i stället för de fält som tidigare fanns där.

API-format

PATCH /tenant/fieldgroups/{FIELD_GROUP_ID}

Parameter

Beskrivning

{FIELD_GROUP_ID}

The meta:altId eller URL-kodad $id för den fältgrupp som ska uppdateras.

Begäran

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"
            }
          }
        }
      ]'

Svar

Svaret innehåller nu en referens ($ref) till datatypen i loyaltyTier i stället för de fält som tidigare definierats.

{
  "$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": []
  }
}

Om du gör en GET-förfrågan om att söka efter schemat nu, loyaltyTier egenskapen visar referensen till datatypen under 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"
    }
  }
}

Definiera en identitetsbeskrivning

Scheman används för inmatning av data i Experience Platform. Dessa data används slutligen för flera tjänster för att skapa en enda, enhetlig vy av en individ. Nyckelfält kan markeras som"Identitet" som hjälp med den här processen, och när data har matats in infogas data i dessa fält i"Identitetsdiagram" för den aktuella personen. Diagramdata kan sedan nås av Real-Time Customer Profile och andra Experience Platform för att ge en sammanslagen bild av varje enskild kund.

Fält som vanligen markeras som"Identitet" är: e-postadress, telefonnummer, Experience Cloud ID (ECID), CRM-ID eller andra unika ID-fält. Överväg alla unika identifierare som är specifika för din organisation, eftersom de också kan vara bra identifieringsfält.

Identitetsbeskrivare signalerar att sourceProperty i sourceSchema är en unik identifierare som bör betraktas som en identitet.

Mer information om hur du arbetar med beskrivningar finns i Utvecklarhandbok för schemaregister.

API-format

POST /tenant/descriptors

Begäran

Följande begäran definierar en identitetsbeskrivning på personalEmail.address för Lojalitetsmedlemsschemat. Det här säger Experience Platform om du vill använda lojalitetsmedlemmens e-postadress som en identifierare för att sammanfoga information om den enskilda personen. Det här anropet anger även det här fältet som primär identitet för schemat genom att ange xdm:isPrimary till true, vilket är ett krav för aktivera schemat för användning i kundprofilen i realtid.

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

Du kan visa tillgängliga xdm:namespace-värden eller skapa nya med hjälp av Identity Service API. Värdet för xdm:property kan vara antingen xdm:code eller xdm:id, beroende på vilket xdm:namespace som används.

Svar

Ett lyckat svar returnerar HTTP-status 201 (Skapad) med en svarstext som innehåller information om den nyligen skapade beskrivningen, inklusive dess @id. The @id är ett skrivskyddat fält som tilldelats av Schema Registry och används för att referera till beskrivningen i API:t.

{
  "@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"
}

Aktivera schema för användning i Real-Time Customer Profile profile

När schemat har en primär identitetsbeskrivning aktiverad kan du aktivera schemat för lojalitetsmedlemmar som kan användas av Real-Time Customer Profile genom att lägga till en union taggen till meta:immutableTags -attribut.

NOTE

Mer information om hur du arbetar med unionsvyer finns i avsnittet om föreningar i Schema Registry utvecklarhandbok.

Lägg till en `union` tag

För att ett schema ska kunna inkluderas i den sammanfogade unionsvyn, union -taggen måste läggas till i meta:immutableTags schemats attribut. Detta görs via en PATCH-begäran om att uppdatera schemat och lägga till en meta:immutableTags array med värdet union.

API-format

PATCH /tenant/schemas/{SCHEMA_ID}

Parameter

Beskrivning

{SCHEMA_ID}

The meta:altId eller URL-kodad $id för det schema som du aktiverar för profil.

Begäran

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"]}
      ]'

Svar

Svaret visar att åtgärden utfördes korrekt och att schemat nu innehåller ett attribut på den översta nivån. meta:immutableTags, som är en array som innehåller värdet "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": []
  }
}

Visa scheman i en union

Du har nu lagt till ditt schema i XDM Individual Profile union. Om du vill se en lista över alla scheman som ingår i samma union kan du utföra en GET-förfrågan med hjälp av frågeparametrar för att filtrera svaret.

Använda property frågeparameter, du kan ange att endast scheman som innehåller en meta:immutableTags fält som har meta:class lika med $id i XDM Individual Profile -klassen returneras.

API-format

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

Begäran

Exempelbegäran nedan returnerar alla scheman som är en del av XDM Individual Profile union.

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}'

Svar

Svaret är en filtrerad lista med scheman som endast innehåller de som uppfyller båda kraven. Kom ihåg att när du använder flera frågeparametrar antas en AND-relation vara. Formatet på listsvaret beror på Accept huvud som skickades i begäran.

{
  "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"
    }
  }
}

Nästa steg

Genom att följa den här självstudiekursen har du komponerat ett schema med både standardfältgrupper och en fältgrupp som du har definierat. Du kan nu använda det här schemat för att skapa en datauppsättning och importera postdata till Adobe Experience Platform.

Schemat för fullständiga lojalitetsmedlemmar, som det har skapats genom den här självstudiekursen, finns i följande bilaga. När du tittar på schemat kan du se hur fältgrupperna bidrar till den övergripande strukturen och vilka fält som är tillgängliga för datainmatning.

När du har skapat mer än ett schema kan du definiera relationer mellan dem med hjälp av relationsbeskrivare. Se självstudiekursen för definiera en relation mellan två scheman för mer information. Detaljerade exempel på hur du utför alla åtgärder (GET, POST, PUT, PATCH och DELETE) i registret finns i Utvecklarhandbok för schemaregister när du arbetar med API:t.

Bilaga appendix

Följande information kompletterar API-självstudiekursen.

Fullständigt medlemsschema complete-schema

Under den här självstudiekursen består ett schema som beskriver medlemmarna i ett lojalitetsprogram för detaljhandeln.

Schemat implementerar XDM Individual Profile och kombinerar flera fältgrupper. Här hämtas information om lojalitetsmedlemmar som använder standarden Demographic Details, Personal Contact Detailsoch Loyalty Details fältgrupper samt via en anpassad fältgrupp för lojalitetsnivån som definieras under självstudiekursen.

I följande exempel visas det slutförda schemat för lojalitetsmedlemmar i JSON-format:

Visa fullständigt schema

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

Skapa ett schema med Schema Registry API

Komma igång

Skapa ett schema med en standardklass

Tilldela en klass

Söka efter ett schema

Lägg till en fältgrupp add-a-field-group

Lägg till fler fältgrupper

Definiera en ny fältgrupp

Lägg till den anpassade fältgruppen i schemat

Visa aktuellt schema

Skapa en datatyp

Använd datatyp i schema

Definiera en identitetsbeskrivning

Aktivera schema för användning i Real-Time Customer Profile profile

Lägg till en union tag

Visa scheman i en union

Nästa steg

Bilaga appendix

Fullständigt medlemsschema complete-schema

Lägg till en `union` tag