Catalog Service 개발자 가이드

Catalog Service adobe experience platform의 데이터 위치와 혈통에 대한 기록 시스템이다. Catalog 데이터 자체에 액세스할 필요 없이 데이터 내에서 데이터에 대한 정보를 찾을 수 Experience Platform있는 메타데이터 저장소 또는 "카탈로그"로 작동합니다. See the Catalog overview for more information.

이 개발자 안내서에서는 Catalog API 사용을 시작하는 데 도움이 되는 단계를 제공합니다. 그런 다음 이 안내서에서는 를 사용하여 키 작업을 수행하기 위한 샘플 API 호출을 제공합니다 Catalog.

전제 조건

Catalog 여러 종류의 리소스 및 작업에 대한 메타데이터를 Experience Platform추적합니다. 이 개발자 가이드는 이러한 리소스를 만들고 관리하는 것과 관련된 다양한 Experience Platform 서비스에 대해 작업해야 합니다.

• Experience Data Model (XDM):고객 경험 데이터를 Platform 구성하는 표준화된 프레임워크
• 일괄 처리:CSV 및 Experience Platform Portable과 같은 데이터 파일의 데이터를 인제스트 및 저장하는 방법입니다.
• 스트리밍 통합:클라이언트 Experience Platform 및 서버측 디바이스에서 실시간으로 데이터를 인제스트 및 저장하는 방법

다음 섹션에서는 Catalog Service API를 성공적으로 호출하기 위해 알아야 하거나 현 상태로 두어야 할 추가 정보를 제공합니다.

샘플 API 호출 읽기

이 안내서에서는 요청의 서식을 지정하는 방법을 보여주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 올바른 형식의 요청 페이로드가 포함됩니다. API 응답으로 반환된 샘플 JSON도 제공됩니다. 샘플 API 호출 설명서에 사용된 규칙에 대한 자세한 내용은 문제 해결 안내서의 예제 API 호출 을 읽는 방법에 대한 섹션을 Experience Platform 참조하십시오.

필수 헤더에 대한 값 수집

API를 호출하려면 Platform 먼저 인증 자습서를 완료해야 합니다. 인증 자습서를 완료하면 아래와 같이 모든 Experience Platform API 호출에서 각 필수 헤더에 대한 값을 제공합니다.

• 인증:무기명 {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {IMS_ORG}

의 모든 리소스 Experience Platform 는 특정 가상 샌드박스와 분리됩니다. API에 대한 모든 Platform 요청에는 작업이 수행할 샌드박스의 이름을 지정하는 헤더가 필요합니다.

• x-sandbox-name: {SANDBOX_NAME}

페이로드(POST, PUT, PATCH)이 포함된 모든 요청에는 추가 헤더가 필요합니다.

• 컨텐츠 유형:application/json

API 호출에 대한 우수 Catalog 사례

API에 대한 GET 요청을 수행할 때 Catalog 필요한 개체 및 속성만 반환하기 위해 요청에 쿼리 매개 변수를 포함하는 것이 좋습니다. 필터링되지 않은 요청은 응답 페이로드가 지난 3GB에 도달하여 전반적인 성능이 저하될 수 있습니다.

요청 경로에 해당 ID를 포함하거나 응답 필터와 같은 쿼리 매개 변수 properties 를 사용하여 특정 개체를 볼 수 limit 있습니다. 필터는 쿼리 매개 변수로 전달된 필터가 우선하므로 헤더와 쿼리 매개 변수로 전달될 수 있습니다. 자세한 내용은 카탈로그 데이터 필터링에 관한 문서를 참조하십시오.

일부 쿼리는 API에 많은 부하를 줄 수 있으므로 우수 사례를 더 지원하기 위해 Catalog 쿼리에 글로벌 제한이 구현되었습니다.

다음 단계

이 문서에서는 Catalog API를 호출하는 데 필요한 사전 요구 사항에 대해 설명합니다. 이제 이 개발자 안내서에 제공된 샘플 호출을 진행하여 지침을 따라 수행할 수 있습니다.

이 안내서의 대부분의 예제는 /dataSets 끝점을 사용하지만, 원칙은 Catalog 및 /batches /accounts같은 다른 끝점에 적용될 수 있습니다. 각 종단점에 대해 사용할 수 있는 모든 호출 및 작업의 전체 목록은 카탈로그 서비스 API 참조를 참조하십시오.

API가 데이터 수집과 관련된 방법을 보여주는 단계별 작업 과정을 보려면 데이터 세트 Catalog 생성 에 대한 자습서를 참조하십시오.