區段作業端點
區段作業為非同步程式,可依需求建立對象區段。 它參考區段定義,以及任何合併原則,可控制Real-Time Customer Profile如何在您的設定檔片段中合併重疊的屬性。 當區段作業成功完成時,您可以收集關於區段的各種資訊,例如處理期間可能發生的任何錯誤以及您的對象的最終規模。
本指南提供的資訊可協助您更清楚瞭解區段作業,並提供使用API執行基本動作的範例API呼叫。
快速入門
本指南中使用的端點是Adobe Experience Platform Segmentation Service API的一部分。 繼續之前,請檢閱快速入門手冊以取得您成功呼叫API所需瞭解的重要資訊,包括必要的標頭以及如何讀取範例API呼叫。
擷取區段作業清單 retrieve-list
您可以藉由對/segment/jobs
端點發出GET要求,擷取貴組織的所有區段工作清單。
API格式
/segment/jobs
端點支援數個查詢引數,以協助篩選結果。 雖然這些引數是選用的,但強烈建議使用這些引數來協助減少昂貴的額外負荷。 在不使用引數的情況下呼叫此端點將會擷取您的組織可用的所有匯出作業。 可以包含多個引數,以&符號(&
)分隔。
GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
查詢引數
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
參數 | 說明 | 範例 |
start |
指定傳回之區段作業的開始位移。 | start=1 |
limit |
指定每頁傳回的區段工作數。 | limit=20 |
status |
根據狀態篩選結果。 支援的值為NEW、QUEUED、PROCESSING、SUCCEEDED、FAILED、CANCELING、CANCELED | status=NEW |
sort |
已傳回區段作業的訂單。 是以`[attributeName]:[desc | asc]`格式撰寫。 |
property |
篩選區段作業,並取得指定篩選器的完全相符專案。 它可採用下列其中一種格式撰寫:
|
property=segments~segmentId==workInUS |
要求
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態200,其中包含指定組織的區段作業清單,格式為JSON。 不過,回應會因區段作業中的區段定義數量而異。
如果您的區段作業中執行的區段定義少於1500個,則children.segments
屬性內將顯示所有區段定義的完整清單。
note note |
---|
NOTE |
下列回應已因空間而截斷,且僅會顯示第一個傳回的工作。 |
accordion | ||
---|---|---|
擷取區段作業清單時的範例回應。 | ||
|
如果您的區段作業中執行的區段定義超過1500個,則children.segments
屬性將顯示*
,表示正在評估所有區段定義。
note note |
---|
NOTE |
下列回應已因空間而截斷,且僅會顯示第一個傳回的工作。 |
accordion | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
檢視區段作業清單時的範例回應。 | ||||||||||||||||||||||||||||||
|
建立新的區段工作 create
您可以對/segment/jobs
端點發出POST要求,並在內文中加入您要建立新對象之區段定義的ID,藉此建立新的區段作業。
API格式
POST /segment/jobs
建立新區段作業時,請求和回應會因區段作業中的區段定義數量而異。
要求
accordion | ||||||||
---|---|---|---|---|---|---|---|---|
建立新區段作業的範例請求 | ||||||||
|
回應
成功的回應會傳回HTTP狀態200,其中包含您新建立區段作業的相關資訊。
accordion | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
建立新區段作業時的範例回應。 | ||||||||||||||||
|
要求
note note |
---|
NOTE |
雖然您可以建立超過1500個區段定義的區段作業,但 強烈不建議這麼做。 |
accordion | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
建立區段作業的範例請求。 | ||||||||||
|
回應
成功的回應會傳回HTTP狀態200以及您新建立的區段工作的詳細資訊。
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
建立區段作業時的範例回應。 | ||||||||||||||
|
擷取特定區段工作 get
您可以向/segment/jobs
端點發出GET要求,並在要求路徑中提供您要擷取之區段作業的識別碼,藉此擷取特定區段作業的詳細資訊。
API格式
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
值。要求
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態200,其中包含指定區段工作的詳細資訊。 不過,回應會因區段作業中的區段定義數目而異。
如果您的區段作業中執行的區段定義少於1500個,則children.segments
屬性內將顯示所有區段定義的完整清單。
accordion | ||
---|---|---|
擷取區段作業的範例回應。 | ||
|
如果您的區段作業中執行的區段定義超過1500個,則children.segments
屬性將顯示*
,表示正在評估所有區段定義。
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
擷取區段作業的範例回應。 | ||||||||||||||||||
|
大量擷取區段作業 bulk-get
您可以對/segment/jobs/bulk-get
端點發出POST要求,並在要求內文中提供區段作業的id
值,以擷取有關多個區段作業的詳細資訊。
API格式
POST /segment/jobs/bulk-get
要求
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態207以及請求的區段作業。 不過,如果區段作業的執行時間超過1500個區段定義,則children.segments
屬性的值會有所不同。
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
屬性 | 說明 |
id |
區段作業的系統產生唯讀識別碼。 |
status |
區塊作業的目前狀態。 狀態的潛在值包括「NEW」、「PROCESSING」、「CANCELING」、「CANCELLED」、「FAILED」和「SUCCEEDED」。 |
segments |
此物件包含區段作業中傳回之區段定義的相關資訊。 |
segments.segment.id |
區段定義的ID。 |
segments.segment.expression |
一個物件,包含有關在PQL中寫入的區段定義運算式的資訊。 |
取消或刪除特定區段工作 delete
您可以向/segment/jobs
端點發出DELETE要求,並在要求路徑中提供您要刪除之區段作業的識別碼,藉此刪除特定區段作業。
API格式
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
值。要求
code language-shell |
---|
|
回應
成功的回應會傳回HTTP狀態204和空白的回應本文。
後續步驟
閱讀本指南後,您現在已能更清楚瞭解區段工作的運作方式。