使用區段服務API建立區段定義

本檔案提供使用Adobe Experience Platform Segmentation Service API開發、測試、預覽及儲存區段定義的教學課程。

有關如何使用使用者介面建立區段定義的資訊,請參閱區段產生器指南

快速入門

此教學課程需要您實際瞭解建立區段定義所涉及的各種Adobe Experience Platform服務。 在開始本教學課程之前,請先檢閱下列服務的檔案:

下列章節提供您需瞭解的其他資訊,才能成功呼叫Platform 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}
NOTE
如需Platform中沙箱的詳細資訊,請參閱沙箱概觀檔案

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

  • Content-Type: application/json

開發區段定義

區段的第一個步驟是定義區段定義。 區段定義是封裝以Profile Query Language (PQL)撰寫的查詢的物件。 此物件也稱為PQL述詞。 PQL述詞會根據與您提供給Real-Time Customer Profile的任何記錄或時間序列資料相關的條件,定義區段定義的規則。 請參閱PQL指南,以取得有關寫入PQL查詢的詳細資訊。

您可以對Segmentation API中的/segment/definitions端點發出POST要求,以建立新的區段定義。 下列範例概述如何格式化定義要求,包括要成功定義區段定義所需的資訊。

如需如何定義區段定義的詳細說明,請參閱區段定義開發人員指南

預估和預覽對象 estimate-and-preview-an-audience

當您開發區段定義時,可以使用Real-Time Customer Profile中的預估和預覽工具來檢視摘要層級的資訊,以協助確保您隔離預期的對象。 預估可提供區段定義的統計資訊,例如預計對象人數和信賴區間。 預覽可提供符合區段定義之資格設定檔的編頁清單,讓您比較結果與預期。

透過估計和預覽對象,您可以測試和最佳化PQL述詞,直到產生理想的結果,然後可以在更新的區段定義中使用這些述詞。

預覽或取得區段定義的預估值需要兩個步驟:

如何產生預估值

當啟用即時客戶個人檔案的資料擷取到Platform時,會儲存在個人檔案資料存放區中。 當將記錄擷取至設定檔存放區後,設定檔總數增加或減少超過5%,則會觸發取樣工作以更新計數。 如果設定檔計數未變更超過5%,則取樣工作每週都會自動執行。

範例的觸發方式取決於所使用的擷取型別:

  • 對於串流資料工作流程,會每小時進行一次檢查,以判斷是否符合增加或減少5%的臨界值。 如果達到此臨界值,則會自動觸發範例工作以更新計數。
  • 對於批次擷取,在成功將批次擷取到設定檔存放區後15分鐘內,如果符合5%增加或減少臨界值,則會執行工作以更新計數。 使用設定檔API,您可以預覽最新成功的範例作業,以及依資料集和身分名稱空間列出設定檔分佈。

範例大小取決於設定檔存放區中的實體總數。 下表顯示這些範例大小:

設定檔存放區中的實體
抽樣大小
少於100萬
完整資料集
100萬到2000萬
100萬
超過2000萬
總數的5%

預估通常超過10至15秒,從粗略的估計開始,並隨著閱讀更多記錄而調整。

建立預覽工作

您可以對/preview端點發出POST要求,以建立新的預覽作業。

建立預覽工作的詳細指示可以在預覽和估計端點指南中找到。

檢視預估或預覽

預估和預覽程式會以非同步方式執行,因為不同的查詢可能需要不同的時間長度才能完成。 開始查詢後,您可以使用API呼叫來擷取(GET)預估或預覽的目前狀態。

使用Segmentation Service API,您可以依據預覽作業的ID來查詢其目前狀態。 如果狀態為「RESULT_READY」,則可以檢視結果。 若要查詢預覽工作的目前狀態,請閱讀預覽與預估端點指南中擷取預覽工作區段的區段。 若要查詢預估工作的目前狀態,請閱讀預覽與預估端點指南中擷取預估工作一節。

後續步驟

開發、測試並儲存區段定義後,您就可以建立區段工作,以使用Segmentation Service API建立對象。 請參閱有關評估和存取區段結果的教學課程,以瞭解如何完成此工作的詳細步驟。

recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871