Show Menu
主題×

實體端點(配置檔案訪問)

Adobe Experience Platform可讓您使用REST風格的API Real-time Customer Profile 或使用者介面存取資料。 本指南概述如何使用API存取實體(通常稱為「設定檔」)。 有關使用UI存取設定檔的詳細資 Platform 訊,請參閱「設定檔使 用指南」

快速入門

本指南中使用的API端點是的一部分 Real-time Customer Profile API 。 在繼續之前,請先閱讀快速入門 指南 ,以取得相關檔案的連結、閱讀本檔案中範例API呼叫的指南,以及成功呼叫任何 Experience Platform API所需之必要標題的重要資訊。

依身分存取個人檔案資料

通過向端點 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,並傳回訊息「太多相關身分」。 如果您收到此錯誤,請考慮新增更多查詢參數以縮小搜尋範圍。

依身分清單存取個人檔案資料

您可以透過多個描述檔實體的身分,對端點提出POST要求,並在 /access/entities 裝載中提供身分,以存取其身分。 這些身分由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
用於啟用計算屬性以進行查找的功能標籤。 預設值: false。
Response ​成功的回應會傳回請求主體中指定的實體的請求欄位。
{
    "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
請求
以下請求會使用 _links.next.href URI作為請求路徑來擷取下一頁結果。
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.geder
mergePolicyId
標識用於管理返回資料的合併策略。 如果未在服務呼叫中指定此方案,則會使用您組織對該方案的預設值。 如果尚未設定預設的「合併原則」,則預設為無描述檔合併,也無身分聯繫。
orderby
依時間戳記(以預設值寫入)擷取的體驗事 (+/-)timestamp 件排序順序 +timestamp
timeFilter.startTime
指定篩選時間系列物件的開始時間(以毫秒為單位)。
timeFilter.endTime
指定篩選時間系列物件的結束時間(以毫秒為單位)。
limit
指定要返回的最大對象數的數值。 預設值: 1000
withCA
用於啟用計算屬性以進行查找的功能標籤。 預設值: false
回應
成功的回應會傳回與請求中指定的多個描述檔相關聯的已編頁時間系列事件清單。
{
    "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-yD9aoRCPhRROJ-TetAFW")提供值 _links.next.payload ,表示此描述檔有其他的結果頁面。 如需如何存取其他 結果的詳細資訊 ,請參閱以下有關存取其他結果的章節。

存取其他結果

在擷取時間序列事件時,可能會傳回許多結果,因此結果通常會進行編頁。 如果特定描述檔有後續的結果頁面,則該 _links.next.payload 描述檔的值將包含裝載物件。
使用請求主體中的此裝載,您可以對端點執行額外的POST請求,以檢 access/entities 索該配置檔案的後續時間序列資料頁。

訪問多個模式實體中的時間序列事件

可以訪問通過關係描述符連接的多個實體。 下列範例API呼叫假設兩個結構之間已定義了關係。 有關關係描述符的詳細資訊,請閱讀 Schema Registry API開發人員指南描述 符端點指南
您可以在請求路徑中包含查詢參數,以指定要存取的資料。 您可以包含多個參數,以&符號分隔。 附錄的查詢參數部分提供了有 效參數 的完整清單。
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 性還通過向端點發出附加GET請求,為檢索後續頁提供請求URI 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
用於啟用計算屬性以進行查找的功能標籤。 預設值: false
withCA=true