Schema Registry API 안내서

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

스키마 레지스트리 API는 Platform 내에서 사용할 수 있는 모든 스키마 및 관련 XDM(Experience Data Model) 리소스를 프로그래밍 방식으로 관리할 수 있도록 해주는 몇 가지 엔드포인트를 제공합니다. 여기에는 Adobe에 의해 정의된 항목이 포함됩니다. Experience Platform 사용자가 사용하는 애플리케이션을 소유한 파트너 및 공급업체

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

중요

XDM은 JSON 스키마 형식을 사용하여 수집된 고객 경험 데이터의 구조를 설명하고 확인합니다. 스키마 레지스트리 API를 사용하기 전에 공식 JSON 스키마 설명서 이 기초 기술을 더 잘 이해하려고

사용 가능한 모든 엔드포인트 및 CRUD 작업을 보려면 스키마 레지스트리 API 참조.

스키마

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

필드 그룹 및 데이터 유형 만들기 및 추가 등 스키마 레지스트리 API에서 전체 스키마를 만드는 방법에 대한 단계별 안내서는 를 참조하십시오. API 스키마 만들기 튜토리얼.

비헤이비어

비헤이비어는 스키마에 대해 설명하는 데이터의 특성을 정의합니다. 각 XDM 클래스는 특정 동작을 참조해야 하며 이 동작은 해당 클래스를 사용하는 모든 스키마에서 상속됩니다. 자세한 내용은 비헤이비어 엔드포인트 안내서 api에서 사용 가능한 동작을 보는 방법을 알아봅니다.

클래스

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

필드 그룹

필드 그룹은 사용 가능한 구성 요소로, 개별 개인, 우편 주소 또는 웹 브라우저 환경과 같이 특정 개념을 나타내는 필드를 하나 이상 정의합니다. 필드 그룹은 필드 그룹이 나타내는 데이터(레코드 또는 시계열)의 동작에 따라 호환 클래스를 구현하는 스키마의 일부로 포함되도록 합니다. 자세한 내용은 필드 그룹 끝점 안내서 api에서 필드 그룹을 사용하는 방법을 알아봅니다.

데이터 유형

데이터 유형은 기본 리터럴 필드와 같은 방식으로 클래스 또는 필드 그룹에서 참조 형식 필드로 사용되며, 데이터 형식은 여러 하위 필드를 정의할 수 있다는 점에서 중요한 차이가 있습니다. 의 필드 그룹과 유사하지만, 여러 필드 구조를 일관되게 사용할 수 있다는 점에서 데이터 유형은 스키마 구조의 어느 곳에서든 포함할 수 있지만 필드 그룹은 루트 수준에서만 추가할 수 있으므로 보다 유연합니다. 자세한 내용은 data types endpoint 안내서 를 참조하십시오.

설명자

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

노조

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

스키마 레지스트리 API에서 조합을 보는 방법에 대한 자세한 내용은 노조의 종단점 안내서.

CSV로 스키마 변환

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

자세한 내용은 CSV로 스키마 변환 끝점 안내서 추가 정보.

내보내기

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

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

가져오기

를 사용하는 경우 내보내기 또는 CSV로 스키마 변환 엔드포인트는 내보내기 페이로드를 생성하기 위해 target 조직 및 샌드박스에 해당 페이로드를 전송하여 지정된 리소스를 가져올 수 있습니다.

자세한 내용은 끝점 가져오기 안내서 를 참조하십시오.

샘플 데이터

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

자세한 내용은 샘플 데이터 엔드포인트 안내서 이 종단점 사용에 대한 자세한 정보.

감사 로그

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

자세한 내용은 감사 로그 끝점 안내서 이 종단점 사용에 대한 자세한 정보.

다음 단계

스키마 레지스트리 API를 사용하여 호출을 시작하려면 다음을 참조하십시오. 시작 안내서 그런 다음 엔드포인트 가이드 중 하나를 선택하여 특정 엔드포인트를 사용하는 방법을 알아봅니다.

이 페이지에서는