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,您必須先完成authentication tutorial。 完成驗證教學課程後,將提供所有Experience Platform API呼叫中每個必要標題的值,如下所示:

  • 授權:承載{ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有資源都與特定虛擬沙箱隔離。 對Platform API的所有請求都需要標題,以指定作業將在下列位置進行的沙箱名稱:

  • x-sandbox-name: {SANDBOX_NAME}
注意

如需Platform中沙箱的詳細資訊,請參閱沙箱概觀檔案

所有包含裝載(POST、PUT、PATCH)的請求都需要額外的標題:

  • 內容類型:application/json

Catalog API呼叫的最佳作法

對Catalog API執行GET要求時,最佳實務是在要求中納入查詢參數,以便只傳回您需要的物件和屬性。 未篩選的請求可能會導致回應裝載的大小超過3GB,進而降低整體效能。

您可以在請求路徑中加入特定物件的ID,或使用propertieslimit等查詢參數來篩選回應,以檢視特定物件。 篩選器可以作為標題和查詢參數傳遞,而傳遞的則以查詢參數為優先。 如需詳細資訊,請參閱篩選目錄資料的相關檔案。

由於某些查詢可能會對API造成大量負載,因此已對Catalog查詢實作全域限制,以進一步支援最佳實務。

後續步驟

本檔案說明呼叫Catalog API所需的先決條件知識。 您現在可以繼續閱讀開發人員指南中提供的範例呼叫,並遵循其指示。

本指南中的大多數範例使用/dataSets端點,但原則可套用至Catalog內的其他端點(例如/batches/accounts)。 如需每個端點可用的所有呼叫和操作的完整清單,請參閱目錄服務API參考

如需示範Catalog API如何與資料擷取相關的逐步工作流程,請參閱建立資料集的教學課程。

本頁內容