段作业端点

段作业是创建新受众段的异步进程。 它引用区 段定义,以及任何合并策 ,控制如何在用户档案片段 Real-time Customer Profile 中合并重叠属性。 当区段作业成功完成时,您可以收集有关区段的各种信息,如处理过程中可能发生的任何错误以及受众的最终大小。

本指南提供相关信息,帮助您更好地了解细分作业,并包含使用API执行基本操作的示例API调用。

入门指南

本指南中使用的端点是API的一 Adobe Experience Platform Segmentation Service 部分。 在继续之前,请查 看入门指南 ,了解成功调用API需要了解的重要信息,包括必需的头以及如何读取示例API调用。

检索列表段作业

您可以通过向端点发出列表请求,为IMS组织检索所有段作业的GET /segment/jobs 符。

API格式

端点 /segment/jobs 支持多个查询参数,以帮助筛选结果。 虽然这些参数是可选的,但强烈建议使用它们以帮助降低昂贵的开销。 调用此端点时,无参数将检索组织可用的所有导出作业。 可以包括多个参数,用和号(&)分隔。

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

查询参数

参数 描述 示例
start 指定返回的段作业的起始偏移。 start=1
limit 指定每页返回的段作业数。 limit=20
status 过滤器基于状态的结果。 支持的值有NEW、QUEUDED、PROCESSING、SUCCEEDED、FAILED、CANCELLED、CANCELLED status=NEW
sort 对返回的区段作业进行排序。 以格式编写 [attributeName]:[desc|asc] sort=creationTime:desc
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 区段作业的当前状态。 状态的潜在值包括“NEW”、“PROCESSING”、“CANCELLING”、“CANCELLED”、“FAILED”和“SUCCEEDED”。
segments 包含有关在区段作业中返回的区段定义的信息的对象。
segments.segment.id 区段定义的ID。
segments.segment.expression 包含有关段定义表达式的信息的对象,用PQL编写。
metrics 包含有关段作业的诊断信息的对象。
metrics.totalTime 包含分段作业开始和结束时间以及所用总时间的信息的对象。
metrics.profileSegmentationTime 包含分段评估开始和结束时间以及所花费总时间的信息的对象。
metrics.segmentProfileCounter 按每个细分合格的用户档案数。
metrics.segmentedProfileByNamespaceCounter 每个细分中每个身份命名空间的合格用户档案数。
metrics.segmentProfileByStatusCounter 每个状态的用户档案数。 支持以下三种状态:
  • “已实现”-进入区段的新用户档案数。
  • “现有”-区段中继续存在的用户档案数。
  • “已退出”-用户档案段中不再存在的数据段数。
metrics.totalProfilesByMergePolicy 每个合并策略的合并用户档案总数。

创建新区段作业

您可以通过向端点发出POST请求并在正文中包 /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。 这些段定义可以属于不同的合并策略。 有关段定义的更多信息,请参阅 段定义端点指南

响应

成功的响应会返回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 区段作业的当前状态。 状态的潜在值包括“NEW”、“PROCESSING”、“CANCELLING”、“CANCELLED”、“FAILED”和“SUCCEEDED”。
segments 包含有关在区段作业中返回的区段定义的信息的对象。
segments.segment.id 区段定义的ID。
segments.segment.expression 包含有关段定义表达式的信息的对象,用PQL编写。
metrics 包含有关段作业的诊断信息的对象。

批量检索段作业

通过向端点发出POST请求并在请求主体中提供段作 /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 区段作业的当前状态。 状态的潜在值包括“NEW”、“PROCESSING”、“CANCELLING”、“CANCELLED”、“FAILED”和“SUCCEEDED”。
segments 包含有关在区段作业中返回的区段定义的信息的对象。
segments.segment.id 区段定义的ID。
segments.segment.expression 包含有关段定义表达式的信息的对象,用PQL编写。

取消或删除特定区段作业

您可以通过向端点发出DELETE请求并提供您希望在请求路径 /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"
}

后续步骤

阅读本指南后,您现在可以更好地了解细分作业的工作方式。

在此页面上