Catalog Service 是Adobe Experience Platform中資料位置和世系的記錄系統。 Catalog 可當成中繼資料存放區或「目錄」,讓您在其中找到有關資料的資訊 Experience Platform,而不需存取資料本身。 See the Catalog overview for more information.
本開發人員指南提供協助您開始使用 Catalog API的步驟。 然後,本指南提供使用執行關鍵操作的範例API調用 Catalog。
Catalog 跟蹤中數種資源和操作的元資料 Experience Platform。 本開發人員指南需要對建立和管理這些資 Experience Platform 源所涉及的各種服務有良好的認識:
以下章節提供您必須知道或掌握的額外資訊,才能成功呼叫 Catalog Service API。
本指南提供範例API呼叫,以示範如何格式化您的請求。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱疑難排解指 南中有關如何讀取範例API呼叫的 Experience Platform 章節。
若要呼叫API,您必 Platform 須先完成驗證教 學課程。 完成驗證教學課程後,將提供所有 Experience Platform API呼叫中每個必要標題的值,如下所示:
{ACCESS_TOKEN}
{API_KEY}
{IMS_ORG}
中的所有資 Experience Platform 源都與特定虛擬沙盒隔離。 對API的所 Platform 有請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:
{SANDBOX_NAME}
如需中沙盒的詳細資訊 Platform,請參閱沙 盒概述檔案。
所有包含裝載(POST、PUT、PATCH)的請求都需要額外的標題:
當對 Catalog API執行GET請求時,最佳實務是在請求中加入查詢參數,以便只傳回您需要的物件和屬性。 未篩選的請求可能導致回應負載達到超過3GB的大小,進而降低整體效能。
您可以在請求路徑中加入特定物件的ID,或使用查詢參數(例如和)來 properties
篩選 limit
回應,以檢視其。 篩選器可以作為標題和查詢參數傳遞,而傳遞的作為查詢參數優先。 如需詳細資訊,請 參閱篩選目錄資料 的檔案。
由於某些查詢會給API帶來沈重負載,因此已對查詢實施全域限制,以進 Catalog 一步支援最佳實務。
本檔案涵蓋對 Catalog API進行呼叫所需的先決知識。 您現在可以繼續閱讀本開發人員指南中提供的範例呼叫,並依照其指示進行。
本指南中的大部分範例都使用端 /dataSets
點,但原則可套用至內部的其 Catalog 他端點( /batches
例如和 /accounts
)。 如需每個 端點所有可用呼叫和作業的完整清單 ,請參閱目錄服務API參考。