Catalog Service 是Adobe Experience Platform中資料位置和譜系的記錄系統。 Catalog 做為中繼資料存放區或「目錄」,您可在其中找到有關您資料的資訊 Experience Platform,而不需要存取資料本身。 請參閱 Catalog 概述 以取得詳細資訊。
本開發人員指南提供了協助您開始使用 Catalog API 的步驟。 接著,指南會提供範例API呼叫,說明如何使用執行關鍵作業 Catalog.
Catalog 在中追蹤數種資源和作業的中繼資料 Experience Platform. 這份開發人員指南需要您實際瞭解各種 Experience Platform 與建立和管理這些資源相關的服務:
以下小節提供您需瞭解或有手頭的其他資訊,才能成功呼叫 Catalog Service API。
本指南提供範例 API 呼叫,示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外,也提供 API 回應中傳回的範例 JSON。 如需文件中用於範例 API 呼叫的慣例相關資訊,請參閱 疑難排解指南中的如何讀取範例 API 呼叫Experience Platform一節。
為了對 Platform API 進行呼叫,您必須先完成驗證教學課程。完成驗證教學課程會提供所有 Experience Platform API 呼叫中每個必要標頭的值,如下所示:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
中的所有資源 Experience Platform 會隔離至特定的虛擬沙箱。 所有要求至 Platform API需要標頭,用以指定將進行作業的沙箱名稱:
{SANDBOX_NAME}
如需中沙箱的詳細資訊 Platform,請參閱 沙箱概述檔案.
所有包含承載 (POST、PUT、PATCH) 的請求都需有額外的標頭:
執行對的GET請求時 Catalog API的最佳作法是在您的要求中包含查詢引數,以便僅傳回您需要的物件和屬性。 未篩選的請求可能會導致回應裝載的大小超過3GB,進而減慢整體效能。
您可以在請求路徑中包含特定物件的ID來檢視這些物件,或使用查詢引數,例如 properties
和 limit
以篩選回應。 篩選器可作為標題和查詢引數傳遞,以作為查詢引數傳遞的篩選器優先。 檢視檔案: 篩選目錄資料 以取得詳細資訊。
由於某些查詢可能會對API造成大量負載,因此已在上實施全域限制 Catalog 進一步支援最佳實務的查詢。
本文件說明對 Catalog API 進行呼叫所需的先決條件知識。您現在可以繼續進行本開發人員指南中提供的範例呼叫,並遵循其指示進行作業。
本指南中的大多數範例使用 /dataSets
端點,但原則可套用至內的其他端點 Catalog (例如 /batches
)。 請參閱 目錄服務API參考 以取得每個端點所有可用呼叫和作業的完整清單。
如需逐步工作流程,此工作流程會示範 Catalog API與資料擷取有關,請參閱以下主題上的教學課程: 建立資料集.