使用區段服務API建立區段定義
本檔案提供開發、測試、預覽和儲存區段定義的教學課程,使用 Adobe Experience Platform Segmentation Service API.
如需如何使用使用者介面建立區段定義的詳細資訊,請參閱 區段產生器指南.
快速入門
本教學課程需要您實際瞭解各種 Adobe Experience Platform 與建立區段定義有關的服務。 在開始本教學課程之前,請先檢閱下列服務的檔案:
- Real-Time Customer Profile:根據來自多個來源的彙總資料,提供統一的即時消費者個人檔案。
- Adobe Experience Platform Segmentation Service:可讓您使用區段定義或其他外部來源,從即時客戶設定檔資料建立對象。
- Experience Data Model (XDM):Platform 據以組織客戶體驗資料的標準化框架。為善用分段,請確保您的資料已根據 資料模型化的最佳實務.
以下小節提供您需瞭解的其他資訊,才能成功對 Platform API。
讀取範例 API 呼叫
本教學課程提供範例API呼叫,示範如何格式化您的請求。 這些包括路徑、必要的標頭和正確格式化的請求承載。 此外,也提供 API 回應中傳回的範例 JSON。 如需文件中用於範例 API 呼叫的慣例相關資訊,請參閱 疑難排解指南中的如何讀取範例 API 呼叫Experience Platform一節。
收集所需標頭的值
為了對 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}
所有包含承載 (POST、PUT、PATCH) 的請求都需有額外的標頭:
- Content-Type: application/json
開發區段定義
區段的第一個步驟是定義區段定義。 區段定義是一個物件,可封裝寫入的查詢 Profile Query Language (PQL)。 此物件也稱為PQL述詞。 PQL述詞會根據與您提供至的任何記錄或時間序列資料相關的條件,定義區段定義的規則 Real-Time Customer Profile. 請參閱 PQL指南 以取得有關寫入PQL查詢的詳細資訊。
您可以透過向以下網站發出POST請求,建立新的區段定義: /segment/definitions
中的端點 Segmentation API。 下列範例概述如何格式化定義要求,包括要成功定義區段定義所需的資訊。
如需如何定義區段定義的詳細說明,請參閱 區段定義開發人員指南.
預估和預覽對象 estimate-and-preview-an-audience
當您開發區段定義時,可以使用中的預估和預覽工具 Real-Time Customer Profile 以檢視摘要層級資訊,協助確保您隔離預期的對象。 預估可提供區段定義的統計資訊,例如預計對象人數和信賴區間。 預覽可提供符合區段定義之資格設定檔的編頁清單,讓您比較結果與預期。
透過估計和預覽對象,您可以測試和最佳化PQL述詞,直到產生理想的結果,然後可以在更新的區段定義中使用這些述詞。
預覽或取得區段定義的預估值需要兩個步驟:
如何產生預估值
資料範例可用來評估區段定義,以及估計合格設定檔的數量。 每天早上(上午12點至凌晨2點,也就是UTC時間早上7點至晚上9點)都有新資料載入記憶體,而所有分段查詢都是使用當天的範例資料來估計。 因此,任何新增的欄位或收集的其他資料都會反映在第二天的估計值中。
範例大小取決於設定檔存放區中的實體總數。 下表顯示這些範例大小:
預估通常超過10至15秒,從粗略的估計開始,並隨著閱讀更多記錄而調整。
建立預覽工作
您可以透過向以下專案發出POST請求來建立新的預覽作業: /preview
端點。
有關建立預覽工作的詳細說明,請參閱 預覽和估計端點指南.
檢視預估或預覽
預估和預覽程式會以非同步方式執行,因為不同的查詢可能需要不同的時間長度才能完成。 開始查詢後,您可以使用API呼叫來擷取(GET)預估或預覽的目前狀態。
使用 Segmentation Service API後,您可以依ID查詢預覽作業的目前狀態。 如果狀態為「RESULT_READY」,則可以檢視結果。 若要查詢預覽工作的目前狀態,請閱讀以下章節: 擷取預覽作業區段 在預覽和預估端點指南中。 若要查詢預估工作的目前狀態,請閱讀以下章節: 擷取預估工作 在預覽和預估端點指南中。
後續步驟
開發、測試並儲存區段定義後,您就可以使用建立區段作業來建立受眾。 Segmentation Service API。 請參閱上的教學課程 評估及存取區段結果 以取得如何完成此作業的詳細步驟。