Query Service API指南

本開發人員指南提供在Adobe Experience PlatformQuery Service API中執行各種操作的步驟。

快速入門

本指南要求對使用Query Service的Adobe Experience Platform各服務部門有切實的瞭解。

  • Query Service:提供查詢資料集並將生成的查詢捕獲為中的新資料集的能力 Experience Platform。
  • Experience Data Model (XDM) System:組織客戶體驗資 Experience Platform 料的標準化架構。
  • Sandboxes: Experience Platform 提供虛擬沙盒,可將單一執行個體分 Platform 割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。

以下各節提供您必須知道的其他資訊,才能使用API成功使用Query Service。

讀取範例API呼叫

本指南提供範例API呼叫,以示範如何格式化您的請求。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 有關本文檔中用於示例API調用的約定的資訊,請參閱Experience Platform故障排除指南中如何讀取示例API調用一節。

收集必要標題的值

若要呼叫Experience Platform API,您必須先完成驗證教學課程。 完成驗證教學課程後,所有Platform API呼叫中每個所需標題的值都會顯示在下面:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key:{API_KEY}
  • x-gw-ims-org-id:{IMS_ORG}

Experience Platform中的所有資源都隔離到特定的虛擬沙盒。 對Platform API的所有請求都需要一個標題,該標題指定執行操作的沙盒的名稱:

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

如需在Experience Platform中使用沙盒的詳細資訊,請參閱沙盒概觀檔案

範例API呼叫

現在您已瞭解要使用哪些標題,可以開始呼叫Query Service API。 以下檔案會逐步瞭解您可使用Query Service API進行的各種API呼叫。 每個範例呼叫都包含一般API格式、顯示必要標題的範例要求,以及範例回應。

後續步驟

現在您已學會如何使用Query Service API進行呼叫,您可以建立自己的非互動式查詢。 有關如何建立查詢的詳細資訊,請閱讀SQL參考指南

本頁內容