스키마 레지스트리 API 안내서 부록

이 문서에서는 Schema Registry API 작업과 관련된 추가 정보를 제공합니다.

쿼리 매개 변수 사용 query

Schema Registry은(는) 리소스를 나열할 때 페이지 및 필터 결과를 쿼리 매개 변수로 사용할 수 있도록 지원합니다.

NOTE
여러 쿼리 매개 변수를 결합할 때는 앰퍼샌드(&)로 구분해야 합니다.

페이징 paging

페이징에 가장 일반적인 쿼리 매개 변수는 다음과 같습니다.

매개변수
설명
orderby
특정 속성별로 결과를 정렬합니다. 예: orderby=title은(는) 제목별로 오름차순(A-Z)으로 결과를 정렬합니다. 매개 변수 값(orderby=-title) 앞에 -을(를) 추가하면 제목별로 내림차순(Z-A)으로 항목이 정렬됩니다.
limit
orderby 매개 변수와 함께 사용하는 경우 limit은(는) 주어진 요청에 대해 반환해야 하는 최대 항목 수를 제한합니다. orderby 매개 변수가 없으면 이 매개 변수를 사용할 수 없습니다.

limit 매개 변수는 반환해야 하는 최대 항목 수에 대해 양의 정수(0에서 500 사이)를 힌트(으)로 지정합니다. 예를 들어 limit=5은(는) 목록에 있는 5개의 리소스만 반환합니다. 그러나 이 값은 엄격히 적용되지 않습니다. 실제 응답 크기는 start 매개 변수의 신뢰할 수 있는 작업을 제공할 필요가 있는 경우 제한되므로 더 작거나 더 클 수 있습니다.
start
orderby 매개 변수와 함께 사용하는 경우 start은(는) 하위 집합 항목 목록이 시작되는 위치를 지정합니다. orderby 매개 변수가 없으면 이 매개 변수를 사용할 수 없습니다. 이 값은 목록 응답의 _page.next 특성에서 가져올 수 있으며 다음 결과 페이지에 액세스하는 데 사용할 수 있습니다. _page.next 값이 null이면 사용할 수 있는 추가 페이지가 없습니다.

일반적으로 이 매개 변수는 결과의 첫 페이지를 얻기 위해 생략됩니다. 그 후에는 start을(를) 이전 페이지에서 받은 orderby 필드의 기본 정렬 속성의 최대값으로 설정해야 합니다. 그런 다음 API 응답은 지정된 값보다 엄격하게 큰( 오름차순) 또는 엄격하게 작은( 내림차순) orderby의 기본 정렬 속성이 있는 항목으로 시작하는 항목을 반환합니다.

예를 들어 orderby 매개 변수가 orderby=name,firstname(으)로 설정된 경우 start 매개 변수에는 name 속성의 값이 포함됩니다. 이 경우 "Miller" 이름 바로 다음에 리소스의 다음 항목 20개를 표시하려면 ?orderby=name,firstname&start=Miller&limit=20을(를) 사용합니다.

필터링 filtering

검색된 리소스 내의 특정 JSON 속성에 대해 특정 연산자를 적용하는 데 사용되는 property 매개 변수를 사용하여 결과를 필터링할 수 있습니다. 지원되는 연산자는 다음과 같습니다.

연산자
설명
==
속성이 제공된 값과 동일한지 여부를 기준으로 필터링합니다.
property=title==test
!=
속성이 제공된 값과 같지 않은지 여부로 필터링합니다.
property=title!=test
<
속성이 제공된 값보다 작은지 여부를 기준으로 필터링합니다.
property=version<5
>
속성이 제공된 값보다 큰지 여부를 기준으로 필터링합니다.
property=version>5
<=
속성이 제공된 값보다 작거나 같은지 여부를 기준으로 필터링합니다.
property=version<=5
>=
속성이 제공된 값보다 크거나 같은지 여부를 기준으로 필터링합니다.
property=version>=5
(없음)
속성 이름만 입력하면 속성이 있는 항목만 반환됩니다.
property=title
TIP
property 매개 변수를 사용하여 호환 가능한 클래스별로 스키마 필드 그룹을 필터링할 수 있습니다. 예를 들어 property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile은(는) XDM Individual Profile 클래스와 호환되는 필드 그룹만 반환합니다.

호환성 모드 compatibility

Experience Data Model (XDM)은 디지털 경험의 상호 운용성, 표현력 및 기능을 개선하기 위해 Adobe을 기반으로 하는, 공개적으로 문서화된 사양입니다. Adobe은 GitHub의 오픈 소스 프로젝트에서 소스 코드 및 공식 XDM 정의를 유지 관리합니다. 이러한 정의는 XDM 스키마를 정의하기 위한 문법으로 JSON-LD(연결된 데이터에 대한 JavaScript 개체 표기법) 및 JSON 스키마를 사용하여 XDM 표준 표기법으로 작성됩니다.

공개 저장소의 공식 XDM 정의를 보면 표준 XDM이 Adobe Experience Platform에 표시되는 것과 다르다는 것을 알 수 있습니다. Experience Platform에서 표시되는 항목을 호환 모드라고 하며 표준 XDM과 Platform 내에서 사용하는 방식 간에 간단한 매핑을 제공합니다.

호환성 모드 작동 방식

호환성 모드를 사용하면 의미 체계를 동일하게 유지하면서 표준 XDM 내에서 값을 변경하여 XDM JSON-LD 모델을 기존 데이터 인프라에서 작업할 수 있습니다. 중첩된 JSON 구조를 사용하여 스키마를 트리와 유사한 형식으로 표시합니다.

표준 XDM과 호환성 모드 간의 주요 차이점은 필드 이름에 대한 "xdm:" 접두사의 제거입니다.

다음은 표준 XDM과 호환성 모드 모두에서 생일 관련 필드("설명" 속성이 제거된)를 보여 주는 나란히 비교입니다. 호환성 모드 필드에는 "meta:xdmField" 및 "meta:xdmType" 속성의 XDM 필드 및 해당 데이터 유형에 대한 참조가 포함됩니다.

표준 XDM
호환성 모드
{
  "xdm:birthDate": {
    "title": "생일",
    "type": "string",
    "format": "date"
  },
  "xdm:birthDayAndMonth": {
    "title": "생일",
    "type": "string",
    "pattern": "[0-1][0-9]-[0-9][0-9]"
  },
  "xdm:birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767
  }
}

{
  "birthDate": {
    "title": "생일",
    "type": "string",
    "format": "date",
    "meta:xdmField": "xdm:birthDate",
    "meta:xdmType": "date"
  },
  "birthDayAndMonth": {
    "title": "생일",
    "type": "string",
    "pattern": "[0-1][0-9]-[0-9][0-9]",
    "meta:xdmField": "xdm:birthDayAndMonth",
    "meta:xdmType": "string"
  },
  "birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767,
    "meta:xdmField": "xdm:birthyear",
    "meta:xdmType": "short"
  }
}

호환성 모드가 필요한 이유는 무엇입니까?

Adobe Experience Platform은 여러 솔루션 및 서비스와 함께 작동하도록 설계되었으며, 각 솔루션에는 고유한 기술적 과제와 제한 사항(예: 특정 기술이 특수 문자를 처리하는 방법)이 있습니다. 이러한 한계를 극복하기 위하여 호환성 모드(Compatibility Mode)를 개발하였다.

Catalog, Data Lake 및 Real-Time Customer Profile을(를) 포함한 대부분의 Experience Platform 서비스는 표준 XDM 대신 Compatibility Mode을(를) 사용합니다. Schema Registry API도 Compatibility Mode을(를) 사용하며 이 문서의 예제는 모두 Compatibility Mode을(를) 사용하여 표시됩니다.

매핑은 표준 XDM과 Experience Platform에서 작동하는 방식 간에 수행되지만 Platform 서비스 사용에 영향을 주지 않아야 합니다.

공개 소스 프로젝트를 사용할 수 있지만 Schema Registry을(를) 통해 리소스와 상호 작용하는 경우 이 문서의 API 예는 알고 따라야 할 모범 사례를 제공합니다.

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07