임시 스키마 만들기

특정 상황에서는 단일 데이터 집합에서만 사용하도록 지정된 필드가 있는 Experience Data Model (XDM) 스키마를 만들어야 할 수 있습니다. 이를 "임시" 스키마라고 합니다. 애드혹 스키마는 CSV 파일 인제스트 및 특정 유형의 소스 연결 만들기를 포함하여 Experience Platform에 대한 다양한 데이터 통합 워크플로에서 사용됩니다.

이 문서에서는 스키마 레지스트리 API를 사용하여 임시 스키마를 만드는 일반적인 단계를 제공합니다. 이 도구는 작업 과정의 일부로 임시 스키마를 만들어야 하는 다른 Experience Platform 튜토리얼과 함께 사용됩니다. 이러한 각 문서는 특정 사용 사례에 대한 임시 스키마를 적절히 구성하는 방법에 대한 자세한 정보를 제공합니다.

시작하기

이 자습서에서는 Experience Data Model (XDM) 시스템에 대한 작업 이해를 필요로 합니다. 이 자습서를 시작하기 전에 다음 XDM 설명서를 검토하십시오.

이 자습서를 시작하기 전에 Schema Registry API를 성공적으로 호출하기 위해 알아야 할 중요한 정보는 개발자 안내서를 참조하십시오. 여기에는 {TENANT_ID}, "컨테이너" 개념 및 요청 수행에 필요한 머리글이 포함됩니다(수락 헤더와 가능한 값에 특히 유의함).

임시 클래스 만들기

XDM 스키마의 데이터 동작은 기본 클래스에 의해 결정됩니다. 임시 스키마를 만드는 첫 번째 단계는 adhoc 비헤이비어를 기반으로 클래스를 만드는 것입니다. 이 작업은 /tenant/classes 끝점에 POST 요청을 함으로써 수행됩니다.

API 형식

POST /tenant/classes

요청

다음 요청은 페이로드에 제공된 특성으로 구성된 새 XDM 클래스를 만듭니다. allOf 배열에서 https://ns.adobe.com/xdm/data/adhoc에 설정된 $ref 속성을 제공하면 이 클래스는 adhoc 비헤이비어를 상속합니다. 또한 이 요청은 클래스에 대한 사용자 정의 필드를 포함하는 _adhoc 객체도 정의합니다.

노트

_adhoc에 정의된 사용자 정의 필드는 임시 스키마의 사용 사례에 따라 달라집니다. 사용 사례에 따라 필수 사용자 정의 필드에 대해서는 해당 자습서의 특정 워크플로우를 참조하십시오.

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes \
  -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 '{
        "title":"New ad-hoc class",
        "description": "New ad-hoc class description",
        "type":"object",
        "allOf": [
          {
            "$ref":"https://ns.adobe.com/xdm/data/adhoc"
          },
          {
            "properties": {
              "_adhoc": {
                "type":"object",
                "properties": {
                  "field1": {
                    "type":"string"
                  },
                  "field2": {
                    "type":"string"
                  }
                }
              }
            }
          }
        ]
      }'
속성 설명
$ref 새 클래스에 대한 데이터 비헤이비어입니다. 임시 클래스의 경우 이 값을 https://ns.adobe.com/xdm/data/adhoc으로 설정해야 합니다.
properties._adhoc 필드 이름 및 데이터 유형의 키 값 쌍으로 표현되는 클래스의 사용자 정의 필드를 포함하는 객체입니다.

응답

성공적인 응답으로 properties._adhoc 개체의 이름을 클래스에 대한 읽기 전용 GUID로 대체하여 새 클래스의 세부 사항을 반환합니다. meta:datasetNamespace 속성도 자동으로 생성되어 응답에 포함됩니다.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:altId": "_{TENANT_ID}.classes.6395cbd58812a6d64c4e5344f7b9120f",
    "meta:resourceType": "classes",
    "version": "1.0",
    "title": "New Class",
    "description": "New class description",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/data/adhoc"
        },
        {
            "properties": {
                "_6395cbd58812a6d64c4e5344f7b9120f": {
                    "type": "object",
                    "properties": {
                        "field1": {
                            "type": "string",
                            "meta:xdmType": "string"
                        },
                        "field2": {
                            "type": "string",
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557527784822,
        "repo:lastModifiedDate": 1557527784822,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "Jggrlh4PQdZUvDUhQHXKx38iTQo="
    }
}
속성 설명
$id 새 애드혹 클래스에 대해 시스템이 생성한 읽기 전용 ID로 사용되는 URI입니다. 이 값은 임시 스키마를 만드는 다음 단계에서 사용됩니다.

임시 스키마 만들기

애드혹 클래스를 만든 후에는 /tenant/schemas 끝점에 POST 요청을 하여 해당 클래스를 구현하는 새 스키마를 만들 수 있습니다.

API 형식

POST /tenant/schemas

요청

다음 요청은 페이로드에서 이전에 만든 애드혹 클래스의 $id에 대한 참조($ref)를 제공하는 새 스키마를 만듭니다.

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas \
  -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 '{
        "title":"New Schema",
        "description": "New schema description.",
        "type":"object",
        "allOf": [
          {
            "$ref":"https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f"
          }
        ]
      }'

응답

성공적인 응답은 시스템에서 생성된 읽기 전용 $id 등 새로 만든 스키마의 세부 정보를 반환합니다.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/26f6833e55db1dd8308aa07a64f2042d",
    "meta:altId": "_{TENANT_ID}.schemas.26f6833e55db1dd8308aa07a64f2042d",
    "meta:resourceType": "schemas",
    "version": "1.0",
    "title": "New Schema",
    "description": "New schema description.",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f"
        }
    ],
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557528570542,
        "repo:lastModifiedDate": 1557528570542,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "Jggrlh4PQdZUvDUhQHXKx38iTQo="
    }
}

전체 임시 스키마 보기

노트

조건을 추가합니다. 임시 스키마의 필드 구조를 검사하지 않으려는 경우 이 자습서의 끝에 있는 다음 단계 섹션으로 건너뛸 수 있습니다.

임시 스키마가 생성되면 조회(GET) 요청을 만들어 확장된 형식으로 스키마를 볼 수 있습니다. 이 작업은 아래에 설명된 대로 GET 요청에 적절한 수락 헤더를 사용하여 수행됩니다.

API 형식

GET /tenant/schemas/{SCHEMA_ID}
매개 변수 설명
{SCHEMA_ID} 액세스하려는 임시 스키마의 URL 인코딩 $id URI 또는 meta:altId.

요청

다음 요청에서는 스키마의 확장된 양식을 반환하는 수락 헤더 application/vnd.adobe.xed-full+json; version=1을 사용합니다. Schema Registry에서 특정 리소스를 검색할 때 요청의 수락 헤더에 해당 리소스의 주요 버전이 포함되어야 합니다.

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas/_{TENANT_ID}.schemas.26f6833e55db1dd8308aa07a64f2042d \
  -H 'Accept: application/vnd.adobe.xed-full+json; version=1' \
  -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}' \

응답

성공적인 응답은 properties 아래에 중첩된 모든 필드를 포함하여 스키마의 세부 정보를 반환합니다.

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/26f6833e55db1dd8308aa07a64f2042d",
    "meta:altId": "_{TENANT_ID}.schemas.26f6833e55db1dd8308aa07a64f2042d",
    "meta:resourceType": "schemas",
    "version": "1.0",
    "title": "New Schema",
    "description": "New schema description.",
    "type": "object",
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{IMS_ORG}",
    "meta:xdmType": "object",
    "properties": {
        "_6395cbd58812a6d64c4e5344f7b9120f": {
            "type": "object",
            "meta:xdmType": "object",
            "properties": {
                "field1": {
                    "type": "string",
                    "meta:xdmType": "string"
                },
                "field2": {
                    "type": "string",
                    "meta:xdmType": "string"
                }
            }
        }
    },
    "meta:registryMetadata": {
        "repo:createdDate": 1557528570542,
        "repo:lastModifiedDate": 1557528570542,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "bTogM1ON2LO/F7rlcc1iOWmNVy0="
    }
}

다음 단계

이 자습서를 따라 새 임시 스키마를 만들었습니다. 이 문서를 다른 자습서의 일부로 가져온 경우, 이제 임시 스키마의 $id을 사용하여 지정된 대로 워크플로우를 완료할 수 있습니다.

Schema Registry API 작업에 대한 자세한 내용은 개발자 안내서를 참조하십시오.

이 페이지에서는

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free