Show Menu
主题×

实体端点(用户档案访问)

Adobe Experience Platform允许您 Real-time Customer Profile 使用RESTful API或用户界面访问数据。 本指南概述了如何使用API访问实体(通常称为“用户档案”)。 有关使用UI访问用户档案的详 Platform 细信息,请参阅 用户档案用户指南

入门指南

本指南中使用的API端点是 实时客户用户档案API的一部分 。 在继续之前,请查 看入门指南 ,了解相关文档的链接、阅读此文档中示例API调用的指南,以及成功调用任何API所需标头的重要信 Experience Platform 息。

按身份访问用户档案数据

您可以通过 Profile 向端点发出GET请求并 /access/entities 将实体的标识作为一系列查询参数提供来访问实体。 此标识由ID值() entityId 和标识命名空间( entityIdNS )组成。
查询路径中提供的数据参数指定要访问的数据。 可以包含多个参数,以和号(&)分隔。 附录的“列表参数”部分提供了 有效参数 的完整查询。
API格式
GET /access/entities?{QUERY_PARAMETERS}

请求
以下请求使用标识检索客户的电子邮件和姓名:
curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email&fields=identities,person.name,workEmail' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
{
    "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
        "entityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "janesmith@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316604",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "58832431024964181144308914570411162539",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-28T20:57:24Z"
    }
}

如果相关图链接超过50个身份,则此服务将返回HTTP状态422并返回消息“太多相关身份”。 如果收到此错误,请考虑添加更多查询参数以缩小搜索范围。

通过身份列表访问用户档案数据

您可以通过向端点发出用户档案请求并在有效负荷中提供标识来 /access/entities 通过其标识访问多个POST实体。 这些标识由ID值() entityId 和标识命名空间( entityIdNS )组成。
API格式
POST /access/entities

请求
以下请求按身份列表检索多个客户的姓名和电子邮件地址:
curl -X POST \
  https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "schema":{
            "name":"_xdm.context.profile"
        },
        "fields":[
            "identities",
            "person.name",
            "workEmail"
        ],
        "identities":[
            {
                "entityId":"89149270342662559642753730269986316601",
                "entityIdNS":{
                    "code":"ECID"
                }
            },
            {
                "entityId":"89149270342662559642753730269986316900",
                "entityIdNS":{
                    "code":"ECID"
                }
            },
            {
                "entityId":"89149270342662559642753730269986316602",
                "entityIdNS":{
                    "code":"ECID"
                }
            }
        ],
        "timeFilter": {
            "startTime": 1539838505,
            "endTime": 1539838510
        },
        "limit": 10,
        "orderby": "-timestamp",
        "withCA": true
      }'

属性
描述
schema.name
(必需 )实体所属的XDM模式的名称。
fields
要返回的XDM字段(字符串数组)。 默认情况下,将返回所有字段。
identities
(必需 )包含要访问的实体的标识列表的数组。
identities.entityId
要访问的实体的ID。
identities.entityIdNS.code
要访问的实体ID的命名空间。
timeFilter.startTime
开始时间范围过滤器的时间,包括。 应采用毫秒粒度。 如果未指定,则默认值是可用时间的开始。
timeFilter.endTime
排除的时间范围过滤器的结束时间。 应采用毫秒粒度。 如果未指定,则默认值为可用时间的结束。
limit
要返回的记录数。 仅适用于返回的体验事件数。 默认:1000。
orderby
按时间戳(与默认事件一起写入)的检索体验 (+/-)timestamp 的排序顺序 +timestamp
withCA
用于启用计算属性进行查找的功能标志。 默认:错误。
响应 ​成功的响应返回请求主体中指定的实体的请求字段。
{
    "A29cgveD5y64ezlhxjUXNzcm": {
        "entityId": "A29cgveD5y64ezlhxjUXNzcm",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "05DD23564EC4607F0A490D44",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316603",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janesmith@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316604",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316700",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316701",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "58832431024964181144308914570411162539",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-28T20:57:24Z"
    },
    "A29cgveD5y64e2RixjUXNzcm": {
        "entityId": "A29cgveD5y64e2RixjUXNzcm",
        "sources": [
            ""
        ],
        "entity": {},
        "lastModifiedAt": "1970-01-01T00:00:00Z"
    },
    "A29cgveD5y64ezphxjUXNzcm": {
        "entityId": "A29cgveD5y64ezphxjUXNzcm",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316602",
                    "namespace": {
                        "code": "ecid"
                    },
                    "primary": true
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                }
            ],
            "person": {
                "name": {
                    "firstName": "Jane",
                    "middleName": "F",
                    "lastName": "Doe"
                }
            },
            "workEmail": {
                "primary": true,
                "address": "janedoe@example.com",
                "label": "Jane Doe",
                "type": "work",
                "status": "active"
            }
        },
        "lastModifiedAt": "2018-08-27T23:25:52Z"
    }
}

按身份访问用户档案的时间序列事件

通过向端点发出事件请求,您可以按其关联用户档案实体的标识访问时间序列GET /access/entities 。 此标识由ID值() entityId 和标识命名空间( entityIdNS )组成。
查询路径中提供的数据参数指定要访问的数据。 可以包含多个参数,以和号(&)分隔。 附录的“列表参数”部分提供了 有效参数 的完整查询。
API格式
GET /access/entities?{QUERY_PARAMETERS}

请求
以下请求按ID查找用户档案实体,并检索与该实体关联的属 endUserIDs web channel 以及所有时间序列事件的值。
curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
成功的响应返回在请求列表参数中指定的分页事件和关联字段。
请求指定了一( limit=1 )个限制,因 count 此以下响应中的值为1并且只返回一个实体。
{
    "_page": {
        "orderby": "timestamp",
        "start": "c8d11988-6b56-4571-a123-b6ce74236036",
        "count": 1,
        "next": "c8d11988-6b56-4571-a123-b6ce74236037"
    },
    "children": [
        {
            "relatedEntityId": "A29cgveD5y64e2RixjUXNzcm",
            "entityId": "c8d11988-6b56-4571-a123-b6ce74236036",
            "timestamp": 1531260476000,
            "entity": {
                "endUserIDs": {
                    "_experience": {
                        "ecid": {
                            "id": "89149270342662559642753730269986316900",
                            "namespace": {
                                "code": "ecid"
                            }
                        }
                    }
                },
                "channel": {
                    "_type": "web"
                },
                "web": {
                    "webPageDetails": {
                        "name": "Fernie Snow",
                        "pageViews": {
                            "value": 1
                        }
                    }
                }
            },
            "lastModifiedAt": "2018-08-21T06:49:02Z"
        }
    ],
    "_links": {
        "next": {
            "href": "/entities?start=c8d11988-6b56-4571-a123-b6ce74236037&orderby=timestamp&schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1"
        }
    }
}

访问后续结果页

检索时间序列事件时,结果将分页。 如果有后续的结果页,则 _page.next 属性将包含ID。 此外,该属 _links.next.href 性还提供用于检索下一页的请求URI。 要检索结果,请向端点发 /access/entities 出另一个GET请求,但必 /entities 须确保替换为提供的URI的值。
请确保不要意外在请求 /entities/ 路径中重复。 它应该只出现一次, /access/entities?start=...
API格式
GET /access/{NEXT_URI}

参数
描述
{NEXT_URI}
从获取的URI值 _links.next.href
请求
以下请求使用URI作为请求路径检索 _links.next.href 结果的下一页。
curl -X GET \
  'https://platform.adobe.io/data/core/ups/access/entities?start=c8d11988-6b56-4571-a123-b6ce74236037&orderby=timestamp&schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=89149270342662559642753730269986316900&relatedEntityIdNS=ECID&fields=endUserIDs,web,channel&startTime=1531260476000&endTime=1531260480000&limit=1' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
成功的响应将返回结果的下一页。 此响应没有后续的结果页,如和的空字符串值所 _page.next _links.next.href
{
    "_page": {
        "orderby": "timestamp",
        "start": "c8d11988-6b56-4571-a123-b6ce74236037",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "A29cgveD5y64e2RixjUXNzcm",
            "entityId": "c8d11988-6b56-4571-a123-b6ce74236037",
            "timestamp": 1531260477000,
            "entity": {
                "endUserIDs": {
                    "_experience": {
                        "ecid": {
                            "id": "89149270342662559642753730269986316900",
                            "namespace": {
                                "code": "ecid"
                            }
                        }
                    }
                },
                "channel": {
                    "_type": "web"
                },
                "web": {
                    "webPageDetails": {
                        "name": "Fernie Snow",
                        "pageViews": {
                            "value": 1
                        }
                    }
                }
            },
            "lastModifiedAt": "2018-08-21T06:50:01Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

按身份访问多个用户档案的时间序列事件

您可以通过向端点发出事件请求并在有效负荷中提供POST标识来 /access/entities 访问来自多个关联用户档案的时间序列用户档案。 这些标识每个都由ID值( entityId )和标识命名空间( entityIdNS )组成。
API格式
POST /access/entities

请求
以下请求检索与事件身份列表关联的时序用户档案的用户ID、本地时间和国家代码:
curl -X POST \
  https://platform.adobe.io/data/core/ups/access/entities \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "schema": {
        "name": "_xdm.context.experienceevent"
    },
    "relatedSchema": {
        "name": "_xdm.context.profile"
    },
    "identities": [
        {
            "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW"
        }
        {
            "relatedEntityId": "GkouAW-2u-7iWt5vQ9u2wm40JOZY"
        }
    ],
    "fields": [
        "endUserIDs",
        "placeContext.localTime",
        "placeContext.geo.countryCode"
    ],
    
    "timeFilter": {
        "startTime": 11539838505
        "endTime": 1539838510
    },
    "limit": 10
}'

属性
描述
schema.name
(必需 )要检索的实体的XDM模式
relatedSchema.name
如果 schema.name _xdm.context.experienceevent 此值,则必须指定与时间序列事件相关的用户档案实体的模式。
identities
(必需 )用于从中检索关联时间序列事件的用户档案数组列表。 数组中的每个条目通过以下两种方式之一进行设置:1)使用由ID值和命名空间组成的完全限定身份;或2)提供XID。
fields
将返回的数据隔离到指定的字段集。 使用它过滤检索到的模式中包含哪些数据字段。 示例:personalEmail,person.name,person.gender
mergePolicyId
标识用于管理返回数据的合并策略。 如果未在服务调用中指定,则将使用组织的默认模式。 如果未配置默认的合并策略,则默认为无用户档案合并和无身份拼接。
orderby
按时间戳(与默认事件一起写入)的检索体验 (+/-)timestamp 的排序顺序 +timestamp
timeFilter.startTime
指定筛选时间序列对象的开始时间(以毫秒为单位)。
timeFilter.endTime
指定过滤时间序列对象的结束时间(以毫秒为单位)。
limit
指定要返回的最大对象数的数值。 默认:1000
withCA
用于启用计算属性进行查找的功能标志。 默认:假
响应
成功的响应返回与请求中指定的多个列表关联的分页事件。
{
    "GkouAW-yD9aoRCPhRYROJ-TetAFW": {
        "_page": {
            "orderby": "timestamp",
            "start": "ee0fa8eb-f09c-4d72-a432-fea7f189cfcd",
            "count": 10,
            "next": "40cb2fb3-78cd-49d3-806f-9bdb22748226"
        },
        "children": [
            {
                "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW",
                "entityId": "ee0fa8eb-f09c-4d72-a432-fea7f189cfcd",
                "timestamp": 1537275882000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "67971860962043911970658021809222795905",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "50353446361742744826197433431642033796",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a00003314-2fd9c00000000026",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-18T13:04:42Z",
                        "geo": {
                            "countryCode": "MX"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:35:01Z"
            },
            {
                "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW",
                "entityId": "a9e137b4-1348-4878-8167-e308af523d8b",
                "timestamp": 1537275889000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "67971860962043911970658021809222795905",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "50353446361742744826197433431642033796",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a00003314-2fd9c00000000026",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-18T13:04:49Z",
                        "geo": {
                            "countryCode": "MX"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:35:01Z"
            }
        ],
        "_links": {
            "next": {
                "href": "/entities",
                "payload": {
                    "schema": {
                        "name": "_xdm.context.experienceevent"
                    },
                    "relatedSchema": {
                        "name": "_xdm.context.profile"
                    },
                    "timeFilter": {
                        "startTime": 1537275882000
                    },
                    "fields": [
                        "endUserIDs",
                        "placeContext.localTime",
                        "placeContext.geo.countryCode"
                    ],
                    "identities": [
                        {
                            "relatedEntityId": "GkouAW-yD9aoRCPhRYROJ-TetAFW",
                            "start": "40cb2fb3-78cd-49d3-806f-9bdb22748226"
                        }
                    ],
                    "limit": 10
                }
            }
        }
    },
    "GkouAW-2u-7iWt5vQ9u2wm40JOZY": {
        "_page": {
            "orderby": "timestamp",
            "start": "2746d0db-fa64-4e29-b67e-324bec638816",
            "count": 9,
            "next": ""
        },
        "children": [
            {
                "relatedEntityId": "GkouAW-2u-7iWt5vQ9u2wm40JOZY",
                "entityId": "2746d0db-fa64-4e29-b67e-324bec638816",
                "timestamp": 1537559483000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "76436745599328540420034822220063618863",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "48593470048917738786405847327596263131",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a80007451-03da600000000028",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-21T19:51:23Z",
                        "geo": {
                            "countryCode": "US"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:34:58Z"
            },
            {
                "relatedEntityId": "GkouAW-2u-7iWt5vQ9u2wm40JOZY",
                "entityId": "9bf337a1-3256-431e-a38c-5c0d42d121d1",
                "timestamp": 1537559486000,
                "entity": {
                    "endUserIDs": {
                        "_experience": {
                            "mcid": {
                                "id": "76436745599328540420034822220063618863",
                                "namespace": {
                                    "code": "ECID"
                                }
                            },
                            "aacustomid": {
                                "id": "48593470048917738786405847327596263131",
                                "namespace": {
                                    "code": "CRMID"
                                },
                                "primary": true
                            },
                            "acid": {
                                "id": "2de32e9a80007451-03da600000000028",
                                "namespace": {
                                    "code": "AVID"
                                }
                            }
                        }
                    },
                    "placeContext": {
                        "localTime": "2018-09-21T19:51:26Z",
                        "geo": {
                            "countryCode": "US"
                        }
                    }
                },
                "lastModifiedAt": "2018-10-24T17:34:58Z"
            }
        ],
        "_links": {
            "next": {
                "href": ""
            }
        }
    }
}`

在此示例响应中,第一个列出的用户档案(“GkouAW-yD9aoRCPhRYROJ-TetAFW”)为提供一个值 _links.next.payload ,表示此用户档案还有其他的结果页。 有关如何访问这些附 加结果的详细信息 ,请参阅访问其他结果的下一节。

访问其他结果

检索时间序列事件时,可能会返回许多结果,因此结果通常会分页。 如果特定用户档案有后续的结果页,则该 _links.next.payload 用户档案的值将包含有效负荷对象。
在请求主体中使用此有效负荷,您可以对端点执行额外的POST请 access/entities 求,以检索该用户档案的后续时间序列数据页。

访问多个事件实体中的时间序列模式

您可以访问通过关系描述符连接的多个实体。 以下示例API调用假定两个模式之间已定义关系。 有关关系描述符的详细信息,请阅读API开 Schema Registry 发人员指南描述 符端点指南
您可以在请求路径中包含查询参数,以指定要访问的数据。 可以包含多个参数,以和号(&)分隔。 附录的“列表参数”部分提供了 有效参数 的完整查询。
API格式
GET /access/entities?{QUERY_PARAMETERS}

请求
以下请求检索包含先前建立的关系描述符的实体,以访问不同模式的信息。
curl -X GET \
  https://platform.adobe.io/data/core/ups/access/entities?relatedSchema.name=_xdm.context.profile&schema.name=_xdm.context.experienceevent&relatedEntityId=GkouAW-2Xkftzer3bBtHiW8GkaFL \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

响应
成功的响应返回与多个实体关联的分页列表时间序列事件。
{
    "_page": {
        "orderby": "timestamp",
        "start": "cb10369f-a47b-4e65-afb4-06e1ad78a648",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "GkouAW-2Xkftzer3bBtHiW8GkaFL",
            "entityId": "cb10369f-a47b-4e65-afb4-06e1ad78a648",
            "timestamp": 1564614939000,
            "entity": {
                "environment": {
                    "browserDetails": {}
                },
                "identityMap": {
                    "CRMId": [
                        {
                            "id": "78520026455138218785449796480922109723",
                            "primary": true
                        }
                    ]
                },

                "commerce": {
                    "productViews": {
                        "value": 1
                    }
                },
                "productListItems": [
                    {
                        "name": "Red shoe",
                        "quantity": 85,
                        "storesAvailableIn": [
                            "da6dced5-9574-4dda-89b5-9dc106903f80",
                            "981bb433-2ee5-4db0-a19a-449ec9dbf39f"
                        ],
                        "SKU": "8f998279-797b-4da2-9e60-88bf73a9f15a",
                        "priceTotal": 934.8
                    }
                ],
                "_id": "cb10369f-a47b-4e65-afb4-06e1ad78a648",
                "commerce": {
                    "order": {}
                },
                "placeContext": {
                    "geo": {
                        "_schema": {}
                    }
                },
                "device": {},
                "timestamp": "2019-07-31T23:15:39Z",
                "_experience": {
                    "profile": {
                        "identityNamespaces": {
                            "/productListItems[*]/SKU": {
                                "namespace": {
                                    "code": "ECID"
                                }
                            }
                        }
                    }
                }
            },
            "lastModifiedAt": "2019-10-10T00:14:19Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

访问后续结果页

检索时间序列事件时,结果将分页。 如果有后续的结果页,则 _page.next 属性将包含ID。 此外,该属 _links.next.href 性还提供一个请求URI,用于通过向端点发出额外的GET请求来检索后续 access/entities 页面。

后续步骤

按照本指南,您成功访问 Real-time Customer Profile 了数据字段、用户档案和时间序列数据。 要了解如何访问存储在中的其他数据资 Platform源,请参 阅数据访问概述

附录

下节提供有关使用API访 Profile 问数据的补充信息。

查询参数

在向端点发送GET请求的路径中使用以下 /access/entities 参数。 它们用于标识您希望访问和过滤响应中返回的用户档案实体。 必需的参数将被标记,其余参数则是可选的。
参数
描述
示例
schema.name
(必需 )要检索的实体的XDM模式
schema.name=_xdm.context.experienceevent
relatedSchema.name
schema.name 果为“_xdm.context.experienceevent”,则此值必须指定与时间序列事件相关的用户档案实体的模式。
relatedSchema.name=_xdm.context.profile
entityId
(必需 )实体的ID。 如果此参数的值不是XID,则还必须提供标识命名空间参数(请参 entityIdNS 阅下文)。
entityIdNS
entityId 果未作为XID提供,则此字段必须指定标识命名空间。
entityIdNE=email
relatedEntityId
schema.name 果为“_xdm.context.experienceevent”,则此值必须指定相关用户档案实体的标识命名空间。 此值遵循与相同的规则 entityId
relatedEntityId=69935279872410346619186588147492736556
relatedEntityIdNS
schema.name 果为“_xdm.context.experienceevent”,则此值必须指定中指定的实体的标识命名空间 relatedEntityId
relatedEntityIdNS=CRMID
fields
过滤器响应中返回的数据。 使用它指定要包括在检索到的模式中的字段值。 对于多个字段,以逗号分隔值,中间不带空格
fields=personalEmail,person.name,person.gender
mergePolicyId
标识用于管理返回数据的合并策略。 如果未在调用中指定,则将使用组织的默认模式。 如果未配置默认的合并策略,则默认为无用户档案合并和无身份拼接。
mergePoilcyId=5aa6885fcf70a301dabdfa4a
orderBy
按时间戳(与默认事件一起写入)的检索体验 (+/-)timestamp 的排序顺序 +timestamp
orderby=-timestamp
startTime
指定筛选时间序列对象的开始时间(以毫秒为单位)。
startTime=1539838505
endTime
指定过滤时间序列对象的结束时间(以毫秒为单位)。
endTime=1539838510
limit
指定要返回的最大对象数的数值。 默认:1000
limit=100
withCA
用于启用计算属性进行查找的功能标志。 默认:假
withCA=true