區段作業端點

區段工作是非同步程式,可依需求建立受眾區段。 它會參考 區段定義,以及任何 合併策略 控制方式 Real-time Customer Profile 合併您的設定檔片段的重疊屬性。 區段工作成功完成後,您可以收集區段的各種資訊,例如處理期間可能發生的任何錯誤,以及對象的最終大小。

本指南提供相關資訊,協助您更清楚了解區段作業,並包含使用API執行基本動作的範例API呼叫。

快速入門

本指南中使用的端點屬於 Adobe Experience Platform Segmentation Service API。 繼續之前,請檢閱 快速入門手冊 若要成功對API進行呼叫,您必須知道的重要資訊,包括必要的標題以及如何讀取範例API呼叫。

擷取區段作業清單

您可以向提出GET請求,以擷取IMS組織的所有區段作業清單 /segment/jobs 端點。

API格式

/segment/jobs 端點支援數個查詢參數,可協助篩選結果。 雖然這些參數為可選參數,但強烈建議使用這些參數,以幫助降低昂貴的開銷。 對此端點發出呼叫(沒有參數)將檢索組織可用的所有導出作業。 可包含多個參數,以&符號分隔(&)。

GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}

查詢參數

參數 說明 範例
start 指定傳回之區段作業的起始位移。 start=1
limit 指定每頁傳回的區段作業數。 limit=20
status 根據狀態篩選結果。 支援的值為「新」、「排隊」、「處理」、「成功」、「失敗」、「取消」、「已取消」 status=NEW
sort 訂購傳回的區段作業。 以格式寫入 `[attributeName]:[desc asc]`.
property 篩選群體工作,並取得指定篩選的完全相符項目。 可以以下列任一格式寫入:
  • [jsonObjectPath]==[value] — 篩選物件索引鍵
  • [arrayTypeAttributeName]~[objectKey]==[value] — 在陣列中篩選
property=segments~segmentId==workInUS

要求

curl -X GET https://platform.adobe.io/data/core/ups/segment/jobs?status=SUCCEEDED \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態200,並將指定IMS組織的區段作業清單顯示為JSON。 下列回應會傳回IMS組織所有成功區段作業的清單。

注意

下列回應已因空間而截斷,且只會顯示第一個傳回的工作。

{
    "_page": {
        "totalCount": 14,
        "pageSize": 14
    },
    "children": [
        {
            "id": "b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
            "imsOrgId": "E95186D65A28ABF00A495D82@AdobeOrg",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "profileInstanceId": "ups",
            "source": "scheduler",
            "status": "SUCCEEDED",
            "batchId": "678f53bc-e21d-4c47-a7ec-5ad0064f8e4c",
            "computeJobId": 8811,
            "computeGatewayJobId": "9ea97b25-a0f5-410e-ae87-b2d85e58f399",
            "segments": [
                {
                    "segmentId": "30230300-ccf1-48ad-8012-c5563a007069",
                    "segment": {
                        "id": "30230300-ccf1-48ad-8012-c5563a007069",
                        "expression": {
                            "type": "PQL",
                            "format": "pql/json",
                            "value": "{PQL_EXPRESSION}"
                        },
                        "mergePolicyId": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
                        "mergePolicy": {
                            "id": "25c548a0-ca7f-4dcd-81d5-997642f178b9",
                            "version": 1
                        }
                    }
                }
            ],
            "metrics": {
                "totalTime": {
                    "startTimeInMs": 1573203617195,
                    "endTimeInMs": 1573204395655,
                    "totalTimeInMs": 778460
                },
                "profileSegmentationTime": {
                    "startTimeInMs": 1573204266727,
                    "endTimeInMs": 1573204395655,
                    "totalTimeInMs": 128928
                },
                "totalProfiles":13146432,
                "segmentedProfileCounter":{
                    "94509dba-7387-452f-addc-5d8d979f6ae8":1033
                },
                "segmentedProfileByNamespaceCounter":{
                    "94509dba-7387-452f-addc-5d8d979f6ae8":{
                        "tenantiduserobjid":1033,
                        "campaign_profile_mscom_mkt_prod2":1033
                    }
                },
                "segmentedProfileByStatusCounter":{
                    "94509dba-7387-452f-addc-5d8d979f6ae8":{
                        "exited":144646,
                        "existing":10,
                        "realized":2056
                    }
                },
                "totalProfilesByMergePolicy":{
                    "25c548a0-ca7f-4dcd-81d5-997642f178b9":13146432
                }
            },
            "requestId": "4e538382-dbd8-449e-988a-4ac639ebe72b-1573203600264",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "properties": {
                "scheduleId": "4e538382-dbd8-449e-988a-4ac639ebe72b",
                "runId": "e6c1308d-0d4b-4246-b2eb-43697b50a149"
            },
            "_links": {
                "cancel": {
                    "href": "/segment/jobs/b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
                    "method": "DELETE"
                },
                "checkStatus": {
                    "href": "/segment/jobs/b31aed3d-b3b1-4613-98c6-7d3846e8d48f",
                    "method": "GET"
                }
            },
            "updateTime": 1573204395000,
            "creationTime": 1573203600535,
            "updateEpoch": 1573204395
        }
    ],
    "_links": {
        "next": {}
    }
}
屬性 說明
id 系統產生的區段作業唯讀識別碼。
status 區段作業的目前狀態。 狀態的可能值包括「新」、「處理」、「取消」、「已取消」、「失敗」和「成功」。
segments 一個物件,包含區段工作中傳回之區段定義的相關資訊。
segments.segment.id 區段定義的ID。
segments.segment.expression 包含有關PQL中寫入的段定義表達式的資訊的對象。
metrics 包含區段作業相關診斷資訊的物件。
metrics.totalTime 此物件包含分段工作開始和結束時間,以及所花時間總計的相關資訊。
metrics.profileSegmentationTime 此物件包含分段評估開始和結束時間,以及所用總時間的相關資訊。
metrics.segmentProfileCounter 每個區段合格的設定檔數量。
metrics.segmentedProfileByNamespaceCounter 每個區段中符合每個身分命名空間資格的設定檔數量。
metrics.segmentProfileByStatusCounter 每個狀態的設定檔計數。 支援下列三種狀態:
  • 「已實現」 — 進入區段的新設定檔數量。
  • 「現有」 — 區段中繼續存在的設定檔數目。
  • 「退出」 — 區段中已不存在的設定檔區段數。
metrics.totalProfilesByMergePolicy 每個合併策略的合併配置檔案總數。

建立新區段作業

您可以透過向 /segment/jobs 端點,並在內文中納入您要建立新受眾之區段定義的ID。

API格式

POST /segment/jobs

要求

curl -X POST https://platform.adobe.io/data/core/ups/segment/jobs \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
[
  {
    "segmentId": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
  }
]'
屬性 說明
segmentId 您要建立區段作業的區段定義ID。 這些區段定義可以屬於不同的合併原則。 如需區段定義的詳細資訊,請參閱 segment definition endpoint wide.

回應

成功的回應會傳回HTTP狀態200,並包含您新建立之區段工作的詳細資訊。

{
    "id": "d3b4a50d-dfea-43eb-9fca-557ea53771fd",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "profileInstanceId": "ups",
    "source": "api",
    "status": "NEW",
    "segments": [
        {
            "segmentId": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
            "segment": {
                "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
                "expression": {
                    "type": "PQL",
                    "format": "pql/text",
                    "value": "workAddress.country = \"US\""
                },
                "mergePolicyId": "e161dae9-52f0-4c7f-b264-dc43dd903d56",
                "mergePolicy": {
                    "id": "e161dae9-52f0-4c7f-b264-dc43dd903d56",
                    "version": 1
                }
            }
        }
    ],
    "requestId": "Hw1jdAHeuWHVKVxcAPFrLCbbjkriDl9v",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "_links": {
        "cancel": {
            "href": "/segment/jobs/d3b4a50d-dfea-43eb-9fca-557ea53771fd",
            "method": "DELETE"
        },
        "checkStatus": {
            "href": "/segment/jobs/d3b4a50d-dfea-43eb-9fca-557ea53771fd",
            "method": "GET"
        }
    },
    "updateTime": 1579304260000,
    "creationTime": 1579304260897,
    "updateEpoch": 1579304260
}
屬性 說明
id 系統產生的新建立的區段作業唯讀識別碼。
status 區段作業的目前狀態。 由於區段作業是新建立的,因此狀態將一律為「NEW」。
segments 此物件包含此區段作業所執行之區段定義的相關資訊。
segments.segment.id 您提供的區段定義ID。
segments.segment.expression 包含有關PQL中寫入的段定義表達式的資訊的對象。

擷取特定區段作業

您可以向提出GET請求,以擷取特定區段工作的詳細資訊 /segment/jobs 端點,並提供您要在請求路徑中擷取之區段作業的ID。

API格式

GET /segment/jobs/{SEGMENT_JOB_ID}
屬性 說明
{SEGMENT_JOB_ID} id 您要擷取的區段作業值。

要求

curl -X GET https://platform.adobe.io/data/core/ups/segment/jobs/d3b4a50d-dfea-43eb-9fca-557ea53771fd \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態200,並包含指定區段作業的詳細資訊。

{
    "id": "d3b4a50d-dfea-43eb-9fca-557ea53771fd",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "profileInstanceId": "ups",
    "source": "api",
    "status": "SUCCEEDED",
    "batchId": "651fc109-3963-48d2-aa98-9e3cc2003bac",
    "computeJobId": 39312,
    "computeGatewayJobId": "a0099ab6-11ab-4c2b-a0ea-6162e16806bd",
    "segments": [
        {
            "segmentId": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
            "segment": {
                "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
                "expression": {
                    "type": "PQL",
                    "format": "pql/text",
                    "value": "workAddress.country = \"US\""
                },
                "mergePolicyId": "e161dae9-52f0-4c7f-b264-dc43dd903d56",
                "mergePolicy": {
                    "id": "e161dae9-52f0-4c7f-b264-dc43dd903d56",
                    "version": 1
                }
            }
        }
    ],
    "metrics": {
        "totalTime": {
            "startTimeInMs": 1579304313411
        },
        "profileSegmentationTime": {}
    },
    "requestId": "Hw1jdAHeuWHVKVxcAPFrLCbbjkriDl9v",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "_links": {
        "cancel": {
            "href": "/segment/jobs/d3b4a50d-dfea-43eb-9fca-557ea53771fd",
            "method": "DELETE"
        },
        "checkStatus": {
            "href": "/segment/jobs/d3b4a50d-dfea-43eb-9fca-557ea53771fd",
            "method": "GET"
        }
    },
    "updateTime": 1579304339000,
    "creationTime": 1579304260897,
    "updateEpoch": 1579304339
}
屬性 說明
id 系統產生的區段作業唯讀識別碼。
status 區段作業的目前狀態。 狀態的可能值包括「新」、「處理」、「取消」、「已取消」、「失敗」和「成功」。
segments 一個物件,包含區段工作中傳回之區段定義的相關資訊。
segments.segment.id 區段定義的ID。
segments.segment.expression 包含有關PQL中寫入的段定義表達式的資訊的對象。
metrics 包含區段作業相關診斷資訊的物件。

大量擷取區段作業

您可以向 /segment/jobs/bulk-get 端點和提供 id 請求內文中區段作業的值。

API格式

POST /segment/jobs/bulk-get

要求

curl -X POST https://platform.adobe.io/data/core/ups/segment/jobs/bulk-get \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "ids": [
            {
                "id": "cc3419d3-0389-47f1-b174-fead6b3c830d"
            },
            {
                "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8"
            }
        ]
    }'

回應

成功的回應會傳回HTTP狀態207及請求的區段作業。

注意

下列回應已因空間而截斷,僅顯示每個區段工作的部分詳細資料。 完整回應會列出所請求之區段作業的完整詳細資訊。

{
    "results": {
        "cc3419d3-0389-47f1-b174-fead6b3c830d": {
            "id": "cc3419d3-0389-47f1-b174-fead6b3c830d",
            "imsOrgId": "{IMS_ORG}",
            "status": "SUCCEEDED",
            "segments": [
                {
                    "segmentId": "30230300-ccf1-48ad-8012-c5563a007069",
                    "segment": {
                        "id": "30230300-ccf1-48ad-8012-c5563a007069",
                        "expression": {
                            "type": "PQL",
                            "format": "pql/json",
                            "value": "{PQL_EXPRESSION}"
                        },
                        "mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
                        "mergePolicy": {
                            "id": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
                            "version": 1
                        }
                    }
                }
            ],
            "updateTime": 1573204395000,
            "creationTime": 1573203600535,
            "updateEpoch": 1573204395
        },
        "c527dc3f-07fe-4b96-be4e-23f38e734ff8": {
            "id": "c527dc3f-07fe-4b96-be4e-23f38e734ff8",
            "imsOrgId": "{IMS_ORG}",
            "status": "SUCCEEDED",
            "segments": [
                {
                    "segmentId": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
                    "segment": {
                        "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
                        "expression": {
                            "type": "PQL",
                            "format": "pql/json",
                            "value": "{PQL_EXPRESSION}"
                        },
                        "mergePolicyId": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
                        "mergePolicy": {
                            "id": "b83185bb-0bc6-489c-9363-0075eb30b4c8",
                            "version": 1
                        }
                    }
                }
            ],
            "updateTime": 1573204395000,
            "creationTime": 1573203600535,
            "updateEpoch": 1573204395
        }
    }
}
屬性 說明
id 系統產生的區段作業唯讀識別碼。
status 區段作業的目前狀態。 狀態的可能值包括「新」、「處理」、「取消」、「已取消」、「失敗」和「成功」。
segments 一個物件,包含區段工作中傳回之區段定義的相關資訊。
segments.segment.id 區段定義的ID。
segments.segment.expression 包含有關PQL中寫入的段定義表達式的資訊的對象。

取消或刪除特定區段作業

您可以透過向 /segment/jobs 端點,並提供您要在請求路徑中刪除之區段作業的ID。

注意

刪除請求的API會立即回應。 不過,實際刪除區段作業是非同步的。 換句話說,對區段作業提出刪除請求與套用刪除請求之間會有時間差異。

API格式

DELETE /segment/jobs/{SEGMENT_JOB_ID}
屬性 說明
{SEGMENT_JOB_ID} id 要刪除的區段作業的值。

要求

curl -X DELETE https://platform.adobe.io/data/core/ups/segment/jobs/d3b4a50d-dfea-43eb-9fca-557ea53771fd \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態204,並提供下列資訊。

{
    "status": true,
    "message": "Segment job with id 'd3b4a50d-dfea-43eb-9fca-557ea53771fd' has been marked for cancelling"
}

後續步驟

閱讀本指南後,您現在更了解區段作業的運作方式。

本頁內容