유니온 엔드포인트

유니온(또는 유니온 뷰)은 동일한 클래스( )를 공유하는 모든 스키마의 필드를 집계하는 시스템 생성 읽기 전용 스키마입니다.XDM ExperienceEvent 또는 XDM Individual Profile) 및에 대해 활성화됩니다. Real-Time Customer Profile.

이 문서에서는 다양한 작업에 대한 샘플 호출을 포함하여 스키마 레지스트리 API에서 유니온을 사용하여 작업하기 위한 필수 개념을 다룹니다. XDM의 조합에 대한 일반 정보는 스키마 컴포지션 기본 사항.

유니온 스키마 필드

다음 Schema Registry 유니온 스키마 내에 다음 세 개의 키 필드가 자동으로 포함됩니다. identityMap, timeSeriesEvents, 및 segmentMembership.

ID 맵

유니온 스키마 identityMap 는 유니온의 연결된 레코드 스키마 내에 있는 알려진 id를 나타냅니다. ID 맵은 ID를 네임스페이스로 처리된 다른 배열로 구분합니다. 나열된 각 ID는 그 자체로 고유한 ID를 포함하는 객체입니다 id 값. 다음을 참조하십시오. Identity Service 설명서 추가 정보.

시계열 이벤트

다음 timeSeriesEvents 배열은 유니온과 연결된 레코드 스키마와 관련된 시계열 이벤트 목록입니다. 프로필 데이터를 데이터 세트로 내보내면 이 배열이 각 레코드에 포함됩니다. 이 기능은 모델이 레코드 특성 외에 프로필의 전체 동작 기록이 필요한 머신 러닝과 같은 다양한 사용 사례에 유용합니다.

세그먼트 멤버십 맵

다음 segmentMembership 맵은 세그먼트 정의 평가 결과를 저장합니다. 다음을 사용하여 세그먼트 작업이 성공적으로 실행되는 경우 세그먼테이션 API를 입력하면 맵이 업데이트됩니다. segmentMembership 또한 Platform에 수집되는 사전 평가된 모든 대상을 저장하여 Adobe Audience Manager과 같은 다른 솔루션과 통합할 수 있습니다. 다음 튜토리얼 참조: api를 사용하여 대상자 만들기 추가 정보.

유니온 목록 검색 list

을(를) 설정할 때 union 태그에 스키마 추가, Schema Registry 스키마가 기반으로 하는 클래스의 유니온에 스키마를 자동으로 추가합니다. 해당 클래스에 대한 유니온이 없는 경우 새 유니온이 자동으로 생성됩니다. 다음 $id (연합의 경우)는 표준과 유사합니다 $id 기타 Schema Registry 리소스(두 개의 밑줄 및 "union"이라는 단어가 추가된 유일한 차이점)__union).

에 GET 요청을 하여 사용 가능한 조합 목록을 볼 수 있습니다. /tenant/unions 엔드포인트.

API 형식

GET /tenant/unions

요청

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

응답 형식은 다음에 따라 다릅니다. Accept 헤더가 요청에서 전송되었습니다. 다음 Accept 헤더는 유니온 목록을 만드는 데 사용할 수 있습니다.

Accept 머리글
설명
application/vnd.adobe.xed-id+json
각 리소스에 대한 간단한 요약을 반환합니다. 리소스 목록을 만드는 데 권장되는 헤더입니다. (제한: 300)
application/vnd.adobe.xed+json
원본과 함께 각 리소스에 대한 전체 JSON 클래스를 반환합니다. $refallOf 포함. (제한: 300)

응답

성공적인 응답은 HTTP 상태 200(OK) 및 results 응답 본문의 배열입니다. 유니온이 정의된 경우 각 유니온에 대한 세부 사항이 배열 내의 객체로 제공됩니다. 유니온이 정의되지 않은 경우 HTTP 상태 200(OK)이 여전히 반환되지만 results 배열이 비어 있습니다.

{
    "results": [
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile__union",
            "meta:altId": "_xdm.context.profile__union",
            "version": "1"
        },
        {
            "title": "Property",
            "$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590__union",
            "meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590__union",
            "version": "1"
        }
    ]
}

유니온 조회 lookup

다음을 포함하는 GET 요청을 수행하여 특정 결합을 볼 수 있습니다. $id 또한 Accept 헤더에 따라 결합 세부 정보의 일부 또는 전체가 표시됩니다.

NOTE
조합 조회는 다음을 사용하여 사용할 수 있습니다. /unions/schemas 에서 사용하도록 설정하기 위한 엔드포인트 Profile 를 데이터 세트로 내보냅니다.

API 형식

GET /tenant/unions/{UNION_ID}
GET /tenant/schemas/{UNION_ID}
매개변수
설명
{UNION_ID}
URL로 인코딩됨 $id 조회할 조합의 URI입니다. 유니온 스키마의 URI에 "union__이 추가됩니다.

요청

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions/https%3A%2F%2Fns.adobe.com%2Fxdm%2Fcontext%2Fprofile__union \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed+json; version=1'

유니온 조회 요청에는 version Accept 헤더에 포함됩니다.

유니온 스키마 조회에 다음 Accept 헤더를 사용할 수 있습니다.

Accept
설명
application/vnd.adobe.xed+json; version=1
원시 $refallOf. 제목 및 설명을 포함합니다.
application/vnd.adobe.xed-full+json; version=1
$ref 속성 및 allOf 해결되었습니다. 제목 및 설명을 포함합니다.

응답

성공적인 응답은 클래스를 구현하는 모든 스키마의 유니온 보기를 반환합니다. $id 이(가) 요청 경로에 제공되었습니다.

응답 형식은 요청에서 전송된 Accept 헤더에 따라 다릅니다. 다른 Accept 헤더로 테스트하여 응답을 비교하고 사용 사례에 가장 적합한 헤더를 결정합니다.

{
    "type": "object",
    "description": "Union view of all schemas that extend https://ns.adobe.com/xdm/context/profile",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/477bb01d7125b015b4feba7bccc2e599"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"
        }
    ],
    "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/{TENANT_ID}/mixins/477bb01d7125b015b4feba7bccc2e599",
        "https://ns.adobe.com/xdm/context/profile-personal-details"
    ],
    "title": "Union object for https://ns.adobe.com/xdm/context/profile",
    "$id": "https://ns.adobe.com/xdm/context/profile__union",
    "meta:containerId": "tenant",
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:altId": "_xdm.context.profile__union",
    "version": "1.0",
    "meta:resourceType": "unions",
    "meta:registryMetadata": {}
}

유니온 멤버십에 대한 스키마 활성화 enable

스키마가 해당 클래스의 유니온에 포함되려면 union 태그를 스키마의 meta:immutableTags 특성. PATCH에 을(를) 추가하도록 요청하여 이를 수행할 수 있습니다. meta:immutableTags 단일 문자열 값이 인 배열 union 해당 스키마에 매핑됩니다. 다음을 참조하십시오. 스키마 엔드포인트 안내서 (자세한 예:

유니온에 스키마 나열 list-schemas

GET 특정 유니온에 포함된 스키마를 확인하기 위해 /tenant/schemas 엔드포인트. 사용 property 쿼리 매개 변수에서 다음을 포함하는 스키마만 반환하도록 응답을 구성할 수 있습니다 meta:immutableTags 필드와 a meta:class 액세스 중인 유니온의 클래스와 같습니다.

API 형식

GET /tenant/schemas?property=meta:immutableTags==union&property=meta:class=={CLASS_ID}
매개변수
설명
{CLASS_ID}
다음 $id 유니온 활성화 스키마를 나열할 클래스의 입니다.

요청

다음 요청은 의 유니온에 포함된 모든 스키마 목록을 검색합니다. XDM Individual Profile 클래스.

curl -X GET \
  'https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile' \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

응답 형식은 다음에 따라 다릅니다. Accept 헤더가 요청에서 전송되었습니다. 다음 Accept 머리글을 사용하여 스키마를 나열할 수 있습니다.

Accept 머리글
설명
application/vnd.adobe.xed-id+json
각 리소스에 대한 간단한 요약을 반환합니다. 리소스 목록을 만드는 데 권장되는 헤더입니다. (제한: 300)
application/vnd.adobe.xed+json
원본과 함께 각 리소스에 대한 전체 JSON 스키마를 반환합니다. $refallOf 포함. (제한: 300)

응답

성공한 응답은 유니온 멤버십에 대해 활성화된 지정된 클래스에 속하는 스키마만 포함하는 필터링된 스키마 목록을 반환합니다. 여러 쿼리 매개 변수를 사용할 때는 AND 관계가 가정된다는 점을 기억하십시오.

{
    "results": [
        {
            "title": "Schema 1",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/142afb78d8b368a5ba97a6cc8fc7e033",
            "meta:altId": "_{TENANT_ID}.schemas.142afb78d8b368a5ba97a6cc8fc7e033",
            "version": "1.2"
        },
        {
            "title": "Schema 2",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/e7297a6ddfc7812ab3a7b504a1ab98da",
            "meta:altId": "_{TENANT_ID}.schemas.e7297a6ddfc7812ab3a7b504a1ab98da",
            "version": "1.5"
        },
        {
            "title": "Schema 3",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/50f960bb810e99a21737254866a477bf",
            "meta:altId": "_{TENANT_ID}.schemas.50f960bb810e99a21737254866a477bf",
            "version": "1.2"
        },
        {
            "title": "Schema 4",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/a39655ca8ea3d5c1f36a463b45fccca8",
            "meta:altId": "_{TENANT_ID}.schemas.a39655ca8ea3d5c1f36a463b45fccca8",
            "version": "1.1"
        },
        {
            "title": "Schema 5",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/c063fac45c6d6285ef33b0e2af09f633",
            "meta:altId": "_{TENANT_ID}.schemas.c063fac45c6d6285ef33b0e2af09f633",
            "version": "1.2"
        },
        {
            "title": "Schema 6",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/dfebb19b93827b70bbad006137812537",
            "meta:altId": "_{TENANT_ID}.schemas.dfebb19b93827b70bbad006137812537",
            "version": "1.7"
        }
    ],
    "_links": {
        "global_schemas": {
            "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile"
        }
    }
}
recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07