Catalog Service API指南
Catalog Service是Adobe Experience Platform中資料位置和歷程的記錄系統。 Catalog充當中繼資料存放區或「目錄」，您可在Experience Platform中找到有關您資料的資訊，而無需存取資料本身。 如需詳細資訊，請參閱Catalog 概觀。
本開發人員指南提供了協助您開始使用 Catalog API 的步驟。 然後指南會提供使用Catalog執行關鍵作業的API呼叫範例。
先決條件
Catalog追蹤Experience Platform內多種資源與作業的中繼資料。 此開發人員指南需要實際瞭解與建立和管理這些資源有關的各種Experience Platform服務：
- Experience Data Model (XDM)： Platform用來組織客戶體驗資料的標準化架構。
- 批次內嵌： Experience Platform如何內嵌及儲存資料檔案（例如CSV和Parquet）中的資料。
- 串流擷取： Experience Platform如何從使用者端和伺服器端裝置即時擷取及儲存資料。
下列章節提供您需知道或有手頭的其他資訊，才能成功呼叫Catalog Service API。
讀取範例 API 呼叫
本指南提供範例 API 呼叫，示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外，也提供 API 回應中傳回的範例 JSON。 如需檔案中所使用範例API呼叫慣例的詳細資訊，請參閱Experience Platform疑難排解指南中如何讀取範例API呼叫一節。
收集所需標頭的值
若要呼叫Platform API，您必須先完成驗證教學課程。 完成驗證教學課程會提供所有 Experience Platform API 呼叫中每個必要標頭的值，如下所示：
- 授權：持有人
{ACCESS_TOKEN} - x-api-key：
{API_KEY} - x-gw-ims-org-id：
{ORG_ID}
Experience Platform中的所有資源都與特定的虛擬沙箱隔離。 對Platform API的所有請求都需要標頭，以指定將在其中執行作業的沙箱名稱：
- x-sandbox-name：
{SANDBOX_NAME}
所有包含承載 (POST、PUT、PATCH) 的請求都需有額外的標頭：
- Content-Type： application/json
Catalog API呼叫的最佳實務
對Catalog API執行GET要求時，最佳實務是在要求中包含查詢引數，以便僅傳回您需要的物件和屬性。 未篩選的請求可能會導致回應裝載的大小超過3GB，進而減慢整體效能。
您可以在要求路徑中包含特定物件的識別碼，或使用properties和limit等查詢引數來篩選回應，藉此檢視特定物件。 篩選器可作為標題和查詢引數傳遞，以作為查詢引數傳遞的篩選器優先。 如需詳細資訊，請參閱篩選目錄資料上的檔案。
由於某些查詢可能會對API造成大量負載，因此已在Catalog個查詢上實作全域限制，以進一步支援最佳實務。
後續步驟
本文件說明對 Catalog API 進行呼叫所需的先決條件知識。您現在可以繼續進行本開發人員指南中提供的範例呼叫，並遵循其指示進行作業。
本指南中的大多數範例使用/dataSets端點，但原則可套用至Catalog內的其他端點（例如/batches）。 如需每個端點可用的所有呼叫和作業的完整清單，請參閱目錄服務API參考。
如需示範Catalog API如何參與資料擷取的逐步工作流程，請參閱建立資料集的教學課程。