Show Menu
화제×

API를 사용하여 두 스키마 간의 관계 Schema Registry 정의

다양한 채널에서 고객과의 관계와 브랜드와의 상호 작용을 파악할 수 있는 기능은 Adobe Experience Platform의 중요한 부분입니다. XDM(Structure Relationship) 스키마 구조 내에서 이러한 관계를 정의하면 Experience Data Model 고객 데이터에 대한 복잡한 통찰력을 얻을 수 있습니다.
스키마 관계는 조합 스키마 및 조합 스키마 사용을 통해 유추할 수 있지만, 이 Real-time Customer Profile는 동일한 클래스를 공유하는 스키마에만 적용됩니다. 다른 클래스에 속하는 두 스키마 간의 관계를 설정하려면 전용 관계 필드를 소스 스키마에 추가해야 대상 스키마의 ID를 참조합니다.

시작하기

이 자습서에서는 Experience Data Model (XDM) 및 을(를) 제대로 파악해야 XDM System합니다. 이 자습서를 시작하기 전에 다음 설명서를 검토하십시오.
이 자습서를 시작하기 전에 개발자 가이드에서 API를 성공적으로 호출하기 위해 알아야 할 중요한 정보가 있는지 Schema Registry 확인하십시오. 여기에는 사용자 {TENANT_ID} , "컨테이너"의 개념, 요청을 만드는 데 필요한 머리글이 포함됩니다(헤더와 가능한 값에 특별히 Accept 주의).

소스 및 대상 스키마 정의

관계에 정의될 두 개의 스키마를 이미 생성한 것으로 예상됩니다. 이 자습서는 조직의 현재 로열티 프로그램("Loyalty Members" 스키마에 정의됨)의 멤버와 자주 사용하는 호텔("Hotels" 스키마에 정의됨) 간의 관계를 만듭니다.
스키마 관계는 대상 스키마 내의 다른 필드를 참조하는 필드가 있는 소스 스키마에 의해 표현됩니다 . 다음 단계에서 "Loyalty Members"는 소스 스키마가 되고 "Hotels"는 대상 스키마로 작동합니다.
관계를 설정하려면 두 스키마 모두 기본 ID를 정의했고 에 대해 활성화되어야 합니다 Real-time Customer Profile. 스키마 구성 방법에 대한 지침 이 필요한 경우 스키마 생성 자습서에서 프로필에 사용할 스키마를 활성화하는 방법을 참조하십시오.
두 스키마 간의 관계를 정의하려면 먼저 두 스키마 모두에 대한 $id 값을 얻어야 합니다. 스키마의 표시 이름( title )을 알고 있는 경우 $id API의 /tenant/schemas Schema Registry 종단점에 GET 요청을 하여 해당 값을 찾을 수 있습니다.
API 형식
GET /tenant/schemas

요청
curl -X GET \
  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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

헤더는 결과 스키마의 제목, ID 및 버전만 Accept application/vnd.adobe.xed-id+json 반환합니다.
응답
성공적인 응답은 조직에서 정의한 스키마 목록(예: 해당, name $id , meta:altId version 포함)을 반환합니다.
{
    "results": [
        {
            "title": "Newsletter Subscriptions",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/192a66930afad02408429174c311ae73",
            "meta:altId": "_{TENANT_ID}.schemas.192a66930afad02408429174c311ae73",
            "version": "1.2"
        },
        {
            "title": "Loyalty Members",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
            "meta:altId": "_{TENANT_ID}.schemas.2c66c3a4323128d3701289df4468e8a6",
            "version": "1.5"
        },
        {
            "title": "Hotels",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
            "meta:altId": "_{TENANT_ID}.schemas.d4ad4b8463a67f6755f2aabbeb9e02c7",
            "version": "1.0"
        }
    ],
    "_page": {
        "orderby": "updated",
        "next": null,
        "count": 3
    },
    "_links": {
        "next": null,
        "global_schemas": {
            "href": "https://platform-stage.adobe.io/data/foundation/schemaregistry/global/schemas"
        }
    }
}

관계를 정의할 두 스키마의 $id 값을 기록합니다. 이러한 값은 이후 단계에서 사용됩니다.

소스 스키마의 참조 필드 정의

관계 설명자는 Schema Registry관계형 데이터베이스 테이블의 외래 키와 비슷하게 작동합니다.소스 스키마의 필드는 대상 스키마의 기본 ID 필드에 대한 참조 역할을 합니다. 소스 스키마에 이 용도로 사용할 필드가 없으면 새 필드와 혼합을 만들어 스키마에 추가해야 할 수 있습니다. 이 새 필드에는 " type 값"이 있어야string합니다.
대상 스키마와 달리 소스 스키마는 기본 ID를 참조 필드로 사용할 수 없습니다.
이 자습서에서는 대상 스키마 "Hotels"에 스키마의 기본 ID로 사용되는 email 필드가 포함되어 있으므로 해당 참조 필드로도 작동합니다. 그러나 소스 스키마 "Loyalty Members"에 참조로 사용할 전용 필드가 없으며 스키마에 새 필드를 추가하는 새 믹스인이 주어져야 합니다. favoriteHotel .
소스 스키마에 참조 필드로 사용할 전용 필드가 이미 있는 경우 참조 설명자 생성 단계로 건너뛸 수 있습니다 .

새로운 믹싱 만들기

스키마에 새 필드를 추가하려면 먼저 혼합에서 정의해야 합니다. 종단점에 대한 POST 요청을 만들어 새 혼합을 만들 수 /tenant/mixins 있습니다.
API 형식
POST /tenant/mixins

요청
다음 요청은 추가되는 스키마의 네임스페이스 아래에 favoriteHotel 필드를 추가하는 새 _{TENANT_ID} 혼합을 만듭니다.
curl -X POST\
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/mixins \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'content-type: application/json' \
  -d '{
        "type": "object",
        "title": "Favorite Hotel",
        "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"],
        "description": "Favorite hotel mixin for the Loyalty Members schema.",
        "definitions": {
            "favoriteHotel": {
              "properties": {
                "_{TENANT_ID}": {
                  "type":"object",
                  "properties": {
                    "favoriteHotel": {
                      "title": "Favorite Hotel",
                      "type": "string",
                      "description": "Favorite hotel for a Loyalty Member."
                    }
                  }
                }
              }
            }
        },
        "allOf": [
            {
              "$ref": "#/definitions/favoriteHotel"
            }
        ]
      }'

응답
성공적인 응답은 새로 만든 믹싱의 세부 사항을 반환합니다.
{
    "$id": "https://ns.adobe.com/{TENANT_ID}/mixins/3387945212ad76ee59b6d2b964afb220",
    "meta:altId": "_{TENANT_ID}.mixins.3387945212ad76ee59b6d2b964afb220",
    "meta:resourceType": "mixins",
    "version": "1.0",
    "type": "object",
    "title": "Favorite Hotel",
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "Favorite hotel mixin for the Loyalty Members schema.",
    "definitions": {
        "favoriteHotel": {
            "properties": {
                "_{TENANT_ID}": {
                    "type": "object",
                    "properties": {
                        "favoriteHotel": {
                            "title": "Favorite Hotel",
                            "type": "string",
                            "description": "Favorite hotel for a Loyalty Member.",
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/favoriteHotel"
        }
    ],
    "meta:xdmType": "object",
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:containerId": "tenant",
    "meta:tenantNamespace": "_{TENANT_ID}",
    "meta:registryMetadata": {
        "eTag": "quM2aMPyb2NkkEiZHNCs/MG34E4=",
        "palm:sandboxName": "prod"
    }
}

속성
설명
$id
읽기 전용 시스템에서 새 혼합의 고유한 식별자를 생성했습니다. URI 형식을 취합니다.
소스 스키마에 혼합을 추가하는 다음 단계에서 사용할 믹신의 $id URI를 기록합니다.

소스 스키마에 혼합 추가

믹싱을 만든 후에는 끝점에 PATCH 요청을 만들어 소스 스키마에 추가할 수 /tenant/schemas/{SCHEMA_ID} 있습니다.
API 형식
PATCH /tenant/schemas/{SCHEMA_ID}

매개 변수
설명
{SCHEMA_ID}
소스 스키마의 URL 인코딩 $id URI meta:altId 입니다.
요청
다음 요청은 "Favorite Hotel" 스키마에 "Loyalty Members" 혼합을 추가합니다.
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
    { 
      "op": "add", 
      "path": "/allOf/-", 
      "value":  {
        "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/3387945212ad76ee59b6d2b964afb220"
      }
    }
  ]'

속성
설명
op
수행할 PATCH 작업입니다. 이 요청에서는 작업을 add 사용합니다.
path
새 리소스를 추가할 스키마 필드의 경로입니다. 스키마에 혼합을 추가할 때 값은 "/allOf/-"여야 합니다.
value.$ref
추가할 혼합 $id 의 수입니다.
응답
성공적인 응답은 업데이트된 스키마의 세부 사항을 반환합니다. 여기에는 이제 배열에 추가된 혼합의 $ref 값이 allOf 포함됩니다.
{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
    "meta:altId": "_{TENANT_ID}.schemas.2c66c3a4323128d3701289df4468e8a6",
    "meta:resourceType": "schemas",
    "version": "1.1",
    "type": "object",
    "title": "Loyalty Members",
    "description": "",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/ec16dfa484358f80478b75cde8c430d3"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/identitymap"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/3387945212ad76ee59b6d2b964afb220"
        }
    ],
    "meta:containerId": "tenant",
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:tenantNamespace": "_{TENANT_ID}",
    "imsOrg": "{IMS_ORG}",
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/profile",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/xdm/common/extensible",
        "https://ns.adobe.com/xdm/common/auditable",
        "https://ns.adobe.com/xdm/context/profile-person-details",
        "https://ns.adobe.com/xdm/context/profile-personal-details",
        "https://ns.adobe.com/{TENANT_ID}/mixins/ec16dfa484358f80478b75cde8c430d3",
        "https://ns.adobe.com/{TENANT_ID}/mixins/61969bc646b66a6230a7e8840f4a4d33"
    ],
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557525483804,
        "repo:lastModifiedDate": 1566419670915,
        "xdm:createdClientId": "{API_KEY}",
        "xdm:lastModifiedClientId": "{CLIENT_ID}",
        "eTag": "ITNzu8BVTO5pw9wfCtTTpk6U4WY="
    }
}

참조 ID 설명자 만들기

스키마 필드가 관계의 다른 스키마에서 참조로 사용되는 경우 해당 스키마 필드에 참조 ID 설명자가 적용되어야 합니다. " favoriteHotel "의Loyalty Members필드가 " email "의Hotels필드를 참조하므로 참조 ID 설명자 email 가제공되어야 합니다.
종단점에 POST 요청을 만들어 대상 스키마에 대한 참조 설명자를 /tenant/descriptors 만듭니다.
API 형식
POST /tenant/descriptors

요청
다음 요청은 대상 스키마 " email "에 있는 필드에 대한 참조 설명자를Hotels만듭니다.
curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "@type": "xdm:descriptorReferenceIdentity",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/email",
    "xdm:identityNamespace": "Email"
  }'

매개 변수
설명
@type
정의할 설명자 유형입니다. 참조 설명자의 경우 값은 "xdm:descriptorReferenceIdentity"여야 합니다.
xdm:sourceSchema
대상 스키마의 $id URL.
xdm:sourceVersion
대상 스키마의 버전 번호입니다.
sourceProperty
대상 스키마의 기본 ID 필드의 경로입니다.
xdm:identityNamespace
참조 필드의 ID 네임스페이스입니다. 이 네임스페이스는 스키마의 기본 ID로 필드를 정의할 때 사용되는 네임스페이스와 동일해야 합니다. 자세한 내용은 ID 네임스페이스 개요를 참조하십시오.
응답
성공적인 응답은 대상 스키마에 대해 새로 만든 참조 설명자의 세부 정보를 반환합니다.
{
    "@type": "xdm:descriptorReferenceIdentity",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/email",
    "xdm:identityNamespace": "Email",
    "meta:containerId": "tenant",
    "@id": "53180e9f86eed731f6bf8bf42af4f59d81949ba6"
}

관계 설명자 만들기

관계 설명자는 소스 스키마와 대상 스키마 간에 일대일 관계를 설정합니다. 대상 스키마에 대한 참조 설명자를 정의하면 종단점에 대한 POST 요청을 수행하여 새 관계 설명자를 만들 수 /tenant/descriptors 있습니다.
API 형식
POST /tenant/descriptors

요청
다음 요청은 "Loyalty Members"를 소스 스키마로, "Legacy Loyalty Members"를 대상 스키마로 사용하여 새 관계 설명자를 만듭니다.
curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "@type": "xdm:descriptorOneToOne",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/favoriteHotel",
    "xdm:destinationSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
    "xdm:destinationVersion": 1,
    "xdm:destinationProperty": "/_{TENANT_ID}/email"
  }'

매개 변수
설명
@type
생성할 설명자 유형입니다. 관계 설명자의 @type 값은 "xdm:descriptorOneToOne"입니다.
xdm:sourceSchema
소스 스키마의 $id URL.
xdm:sourceVersion
소스 스키마의 버전 번호입니다.
xdm:sourceProperty
소스 스키마의 참조 필드 경로입니다.
xdm:destinationSchema
대상 스키마의 $id URL.
xdm:destinationVersion
대상 스키마의 버전 번호입니다.
xdm:destinationProperty
대상 스키마의 참조 필드 경로입니다.

응답

성공적인 응답은 새로 만든 관계 설명자의 세부 정보를 반환합니다.
{
    "@type": "xdm:descriptorOneToOne",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/2c66c3a4323128d3701289df4468e8a6",
    "xdm:sourceVersion": 1,
    "xdm:sourceProperty": "/_{TENANT_ID}/favoriteHotel",
    "xdm:destinationSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/d4ad4b8463a67f6755f2aabbeb9e02c7",
    "xdm:destinationVersion": 1,
    "xdm:destinationProperty": "/_{TENANT_ID}/hotelId",
    "meta:containerId": "tenant",
    "@id": "76f6cc7105f4eaab7eb4a5e1cb4804cadc741669"
}

다음 단계

이 튜토리얼을 따라 두 스키마 간의 1:1 관계를 성공적으로 만들었습니다. API를 사용한 설명자 작업에 대한 자세한 내용은 Schema Registry 스키마 레지스트리 개발자 안내서를 참조하십시오 설명자 . UI에서 스키마 관계를 정의하는 방법에 대한 단계는 스키마 편집기를 사용하여 스키마 관계를 정의하는 자습서를 참조하십시오 .