Schema Registry API 안내서

Schema Registry은(는) Adobe Experience Platform 내의 스키마 라이브러리에 액세스하는 데 사용되며 사용 가능한 모든 라이브러리 리소스에 액세스할 수 있는 사용자 인터페이스와 RESTful API를 제공합니다.

스키마 레지스트리 API는 Platform 내에서 사용할 수 있는 모든 스키마 및 관련 XDM(Experience Data Model) 리소스를 프로그래밍 방식으로 관리할 수 있는 몇 가지 끝점을 제공합니다. 여기에는 Adobe, Experience Platform개의 파트너 및 사용 중인 응용 프로그램을 사용하는 공급업체에서 정의한 것이 포함됩니다.

이러한 엔드포인트는 아래에 요약되어 있습니다. 자세한 내용은 개별 엔드포인트 안내서를 참조하고 필수 헤더, 샘플 API 호출 읽기 등에 대한 중요한 정보는 시작 안내서를 참조하십시오.

사용 가능한 모든 끝점 및 CRUD 작업을 보려면 스키마 레지스트리 API 참조를 방문하세요.

스키마

XDM 스키마는 Platform에 수집된 데이터의 구조 및 형식을 나타내고 유효성을 검사합니다. 스키마는 클래스와 0개 이상의 스키마 필드 그룹으로 구성됩니다. /schemas 끝점을 사용하여 스키마를 만들고, 보고, 편집하고, 삭제할 수 있습니다. 이 끝점을 사용하는 방법에 대해 알아보려면 스키마 끝점 안내서를 참조하십시오.

필드 그룹 및 데이터 형식을 만들고 추가하는 등 스키마 레지스트리 API에서 전체 스키마를 수동으로 만드는 방법에 대한 단계별 안내서는 API 스키마 만들기 자습서를 참조하십시오.

CSV 데이터를 수집하는 경우 CSV에서 스키마로 변환에 대한 섹션을 참조하십시오.

비헤이비어

비헤이비어는 스키마가 설명하는 데이터의 특성을 정의합니다. 각 XDM 클래스는 특정 동작을 참조해야 하며, 이 경우 해당 클래스를 사용하는 모든 스키마는 이 동작을 상속합니다. API에서 사용 가능한 동작을 확인하는 방법은 동작 끝점 가이드를 참조하세요.

클래스

클래스는 해당 클래스를 기반으로 하는 모든 스키마에 포함되어야 하는 공통 속성의 기본 구조를 정의하고 해당 스키마에서 사용할 수 있는 필드 그룹을 결정합니다. 모든 클래스는 기존 비헤이비어와 연결되어야 합니다. API의 클래스 작업에 대한 자세한 내용은 클래스 끝점 안내서를 참조하십시오.

필드 그룹

필드 그룹은 개별 사용자, 메일링 주소 또는 웹 브라우저 환경과 같이 특정 개념을 나타내는 하나 이상의 필드를 정의하는 재사용 가능한 구성 요소입니다. 필드 그룹은 나타내는 데이터(레코드 또는 시계열)의 비헤이비어에 따라 호환되는 클래스를 구현하는 스키마의 일부로 포함되어야 합니다. API에서 필드 그룹으로 작업하는 방법을 알아보려면 필드 그룹 끝점 안내서를 참조하세요.

데이터 유형

데이터 형식은 기본 리터럴 필드와 같은 방식으로 클래스나 필드 그룹에서 참조 형식 필드로 사용되며 주요 차이점은 데이터 형식이 여러 하위 필드를 정의할 수 있다는 것입니다. 데이터 유형은 다중 필드 구조를 일관되게 사용할 수 있다는 점에서 필드 그룹과 유사하지만 스키마 구조의 모든 위치에 포함될 수 있으므로 보다 유연하지만 필드 그룹은 루트 수준에서만 추가할 수 있습니다. API에서 데이터 형식을 사용하는 방법에 대한 자세한 내용은 데이터 형식 끝점 안내서를 참조하십시오.

설명자

설명자는 스키마 내의 특정 필드에 할당된 메타데이터 집합으로, 해당 필드(및 스키마 자체)가 다른 스키마와 관련되는 방법을 비롯한 다양한 컨텍스트 세부 정보를 제공합니다. 각 스키마에는 하나 이상의 설명자 엔티티가 적용될 수 있으며, 서로 다른 목적을 제공하는 여러 다른 설명자 유형이 있습니다. API의 설명자 작업에 대한 자세한 내용과 다양한 설명자 유형 및 사용 사례에 대한 개요는 설명자 끝점 안내서를 참조하십시오.

유니온

플랫폼을 사용하면 특정 사용 사례에 맞게 스키마를 구성할 수 있지만 특정 클래스에 속하는 스키마의 "결합"을 구성할 수도 있습니다. 유니온 스키마는 동일한 클래스를 공유하는 모든 스키마의 필드를 단일 표시로 집계합니다. 실시간 고객 프로필에서 사용할 스키마를 활성화하면 해당 스키마가 특정 클래스의 유니온에 포함됩니다. 따라서 유니온 스키마는 직접 편집할 수 없으며 프로필에 사용할 스키마를 포함하거나 제외해야만 영향을 받을 수 있습니다.

스키마 레지스트리 API에서 유니온을 보는 방법에 대한 자세한 내용은 유니온 끝점 안내서를 참조하십시오.

CSV에서 스키마로 전환 csv-to-schema

CSV 파일을 템플릿으로 사용하여 XDM 스키마를 자동으로 생성할 수 있으므로 템플릿을 만들어 스키마 필드를 대량 가져오고 수동 API 또는 UI 작업을 줄일 수 있습니다.

자세한 내용은 CSV에서 스키마로 변환 끝점 안내서를 참조하십시오.

내보내기 export

스키마 레지스트리 API를 사용하면 샌드박스와 조직 간에 XDM 리소스를 전송하고 공유할 수 있습니다. 스키마, 필드 그룹 또는 데이터 유형의 경우 리소스 구조 및 모든 종속 리소스를 포함하는 내보내기 페이로드를 생성할 수 있습니다. 그런 다음 이 페이로드를 사용하여 리소스를 대상 샌드박스 및 조직으로 가져올 수 있습니다.

기존 XDM 리소스에 대한 내보내기 페이로드를 만드는 방법에 대한 자세한 내용은 내보내기 끝점 안내서를 참조하십시오.

가져오기

내보내기 또는 CSV를 스키마 변환 끝점으로 사용하여 내보내기 페이로드를 만드는 경우 해당 페이로드를 대상 조직 및 샌드박스로 보내어 지정된 리소스를 가져올 수 있습니다.

내보내기 페이로드에서 XDM 리소스를 생성하는 방법에 대한 자세한 내용은 끝점 가져오기 안내서를 참조하십시오.

샘플 데이터

스키마 라이브러리 내에 지정된 스키마에 대한 샘플 데이터를 생성할 수 있습니다. 그런 다음 반환된 응답 개체를 데이터 수집의 소스로 사용할 수 있습니다.

이 끝점 사용에 대한 자세한 내용은 샘플 데이터 끝점 안내서를 참조하십시오.

감사 로그

스키마 레지스트리는 서로 다른 업데이트 간에 리소스(클래스, 필드 그룹, 데이터 유형 또는 스키마)에 발생한 모든 변경 사항의 로그를 유지합니다. 이 끝점에 대한 GET 요청의 경로에 $id 또는 meta:altId을(를) 제공하여 특정 리소스에 대한 로그를 검색할 수 있습니다.

이 끝점 사용에 대한 자세한 내용은 감사 로그 끝점 안내서를 참조하십시오.

다음 단계

스키마 레지스트리 API를 사용하여 호출을 시작하려면 시작 안내서를 읽은 다음 끝점 안내서 중 하나를 선택하여 특정 끝점을 사용하는 방법을 알아봅니다.