Adobe Experience Platform consente di accedere Real-time Customer Profile i dati che utilizzano le API RESTful o l’interfaccia utente. Questa guida illustra come accedere alle entità, più comunemente note come "profili", utilizzando l’API. Per ulteriori informazioni sull’accesso ai profili tramite la Platform Interfaccia utente, fai riferimento al Guida utente profilo.
L’endpoint API utilizzato in questa guida fa parte del Real-time Customer Profile API. Prima di continuare, controlla la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio presenti in questo documento e informazioni importanti sulle intestazioni richieste necessarie per effettuare correttamente le chiamate a qualsiasi Experience Platform API.
Puoi accedere a un Profile effettuando una richiesta di GET /access/entities
e fornisce l’identità dell’entità come serie di parametri di query. Questa identità è costituita da un valore ID (entityId
) e lo spazio dei nomi identità (entityIdNS
).
I parametri di query forniti nel percorso di richiesta specificano i dati a cui accedere. Puoi includere più parametri, separati da e commerciale (&). Un elenco completo dei parametri validi viene fornito nella parametri di query sezione dell'appendice.
Formato API
GET /access/entities?{QUERY_PARAMETERS}
Richiesta
La seguente richiesta recupera l'e-mail e il nome di un cliente utilizzando un'identità:
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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
{
"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"
}
}
Se un grafico correlato collega più di 50 identità, questo servizio restituirà lo stato HTTP 422 e il messaggio "Troppe identità correlate". Se ricevi questo errore, puoi aggiungere altri parametri di query per limitare la ricerca.
Puoi accedere a più entità di profilo in base alle loro identità effettuando una richiesta di POST al /access/entities
e fornisce le identità nel payload. Queste identità sono costituite da un valore ID (entityId
) e uno spazio dei nomi di identità (entityIdNS
).
Formato API
POST /access/entities
Richiesta
La seguente richiesta recupera i nomi e gli indirizzi e-mail di diversi clienti tramite un elenco di identità:
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: {ORG_ID}' \
-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
}'
Proprietà | Descrizione |
---|---|
schema.name |
(Obbligatorio) Nome dello schema XDM a cui appartiene l'entità. |
fields |
I campi XDM da restituire, come array di stringhe. Per impostazione predefinita, vengono restituiti tutti i campi. |
identities |
(Obbligatorio) Matrice contenente un elenco di identità per le entità a cui si desidera accedere. |
identities.entityId |
L’ID di un’entità a cui desideri accedere. |
identities.entityIdNS.code |
Spazio dei nomi di un ID entità a cui si desidera accedere. |
timeFilter.startTime |
Ora di inizio del filtro dell’intervallo di tempo, incluso. Deve essere con granularità di millisecondi. L'impostazione predefinita, se non viene specificata, è l'inizio dell'ora disponibile. |
timeFilter.endTime |
Filtro dell’intervallo di tempo di fine, escluso. Deve essere con granularità di millisecondi. L'impostazione predefinita, se non viene specificata, corrisponde alla fine dell'ora disponibile. |
limit |
Numero di record da restituire. Si applica solo al numero di eventi di esperienza restituiti. Predefinito: 1.000. |
orderby |
L’ordinamento degli eventi di esperienza recuperati per marca temporale, scritto come (+/-)timestamp con l'impostazione predefinita +timestamp . |
withCA |
Flag di funzionalità per abilitare gli attributi calcolati per la ricerca. Predefinito: false. |
Risposta
Una risposta corretta restituisce i campi richiesti delle entità specificati nel corpo della richiesta.
{
"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"
}
}
Puoi accedere agli eventi delle serie temporali in base all’identità della relativa entità profilo associata effettuando una richiesta di GET al /access/entities
punto finale. Questa identità è costituita da un valore ID (entityId
) e uno spazio dei nomi di identità (entityIdNS
).
I parametri di query forniti nel percorso di richiesta specificano i dati a cui accedere. Puoi includere più parametri, separati da e commerciale (&). Un elenco completo dei parametri validi viene fornito nella parametri di query sezione dell'appendice.
Formato API
GET /access/entities?{QUERY_PARAMETERS}
Richiesta
La richiesta seguente trova un’entità profilo per ID e recupera i valori per le proprietà endUserIDs
, web
e channel
per tutti gli eventi delle serie temporali associati all’entità.
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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
Una risposta corretta restituisce un elenco impaginato di eventi di serie temporali e campi associati specificati nei parametri di query della richiesta.
La richiesta ha specificato un limite di un (limit=1
), quindi count
nella risposta seguente è 1 e viene restituita una sola entità.
{
"_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"
}
}
}
I risultati vengono impaginati quando si recuperano gli eventi delle serie temporali. Se ci sono pagine successive di risultati, il _page.next
La proprietà conterrà un ID. Inoltre, la _links.next.href
fornisce un URI di richiesta per il recupero della pagina successiva. Per recuperare i risultati, effettua un’altra richiesta di GET al /access/entities
endpoint, tuttavia è necessario assicurarsi di sostituire /entities
con il valore dell’URI fornito.
Assicurati di non ripetere accidentalmente /entities/
nel percorso della richiesta. Dovrebbe apparire solo una volta come, /access/entities?start=...
Formato API
GET /access/{NEXT_URI}
Parametro | Descrizione |
---|---|
{NEXT_URI} |
Valore URI tratto da _links.next.href . |
Richiesta
La richiesta seguente recupera la pagina successiva di risultati utilizzando il _links.next.href
URI come percorso della richiesta.
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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
Una risposta corretta restituisce la pagina successiva di risultati. Questa risposta non ha pagine successive di risultati, come indicato dai valori stringa vuoti di _page.next
e _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": ""
}
}
}
Puoi accedere agli eventi delle serie temporali da più profili associati effettuando una richiesta di POST al /access/entities
e fornisce le identità di profilo nel payload. Ciascuna identità è costituita da un valore ID (entityId
) e uno spazio dei nomi di identità (entityIdNS
).
Formato API
POST /access/entities
Richiesta
La richiesta seguente recupera gli ID utente, l’ora locale e i codici del paese per gli eventi delle serie temporali associati a un elenco di identità di profilo:
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: {ORG_ID}' \
-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
}'
Proprietà | Descrizione |
---|---|
schema.name |
(OBBLIGATORIO) Lo schema XDM dell’entità da recuperare |
relatedSchema.name |
Se schema.name è _xdm.context.experienceevent questo valore deve specificare lo schema per l'entità profilo a cui sono correlati gli eventi delle serie temporali. |
identities |
(OBBLIGATORIO) Elenco array dei profili da cui recuperare gli eventi delle serie temporali associati. Ogni voce della matrice viene impostata in uno dei due modi seguenti: 1) utilizzando un'identità completa costituita dal valore ID e dallo spazio dei nomi o 2) fornendo un XID. |
fields |
Isola i dati restituiti a un set specifico di campi. Utilizzare questa opzione per filtrare i campi dello schema inclusi nei dati recuperati. Esempio: personalEmail,person.name,person.gender |
mergePolicyId |
Identifica i criteri di unione in base ai quali governare i dati restituiti. Se non ne viene specificato uno nella chiamata del servizio, verrà utilizzato il valore predefinito dell'organizzazione per tale schema. Se non è stato configurato alcun criterio di unione predefinito, il valore predefinito è nessuna unione profili e nessuna unione identità. |
orderby |
L’ordinamento degli eventi di esperienza recuperati per marca temporale, scritto come (+/-)timestamp con l'impostazione predefinita +timestamp . |
timeFilter.startTime |
Specifica l’ora di inizio per filtrare gli oggetti della serie temporale (in millisecondi). |
timeFilter.endTime |
Specifica l’ora di fine per filtrare gli oggetti della serie temporale (in millisecondi). |
limit |
Valore numerico che specifica il numero massimo di oggetti da restituire. Predefinito: 1000 |
withCA |
Flag di funzionalità per abilitare gli attributi calcolati per la ricerca. Predefinito: false |
Risposta
Una risposta corretta restituisce un elenco impaginato di eventi di serie temporali associati ai più profili specificati nella richiesta.
{
"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": ""
}
}
}
}`
In questa risposta di esempio, il primo profilo elencato ("GkouAW-yD9aoRCPhRYROJ-TetAFW") fornisce un valore per _links.next.payload
, il che significa che per questo profilo sono disponibili pagine di risultati aggiuntive. Vedi la seguente sezione su accesso a risultati aggiuntivi per informazioni dettagliate su come accedere a tali risultati aggiuntivi.
Quando si recuperano gli eventi delle serie temporali potrebbero essere restituiti molti risultati, pertanto i risultati sono spesso impaginati. Se ci sono pagine successive di risultati per un particolare profilo, il _links.next.payload
Il valore per quel profilo conterrà un oggetto payload.
Utilizzando questo payload nel corpo della richiesta, puoi eseguire una richiesta POST aggiuntiva al access/entities
per recuperare la pagina successiva di dati delle serie temporali per quel profilo.
È possibile accedere a più entità collegate tramite un descrittore di relazione. L’esempio seguente di chiamata API presuppone che sia già stata definita una relazione tra due schemi. Per ulteriori informazioni sui descrittori di relazione, leggere il Schema Registry Guida per gli sviluppatori API guida all'endpoint dei descrittori.
Puoi includere parametri di query nel percorso della richiesta per specificare a quali dati accedere. Puoi includere più parametri, separati da e commerciale (&). Un elenco completo dei parametri validi viene fornito nella parametri di query sezione dell'appendice.
Formato API
GET /access/entities?{QUERY_PARAMETERS}
Richiesta
La richiesta seguente recupera un'entità contenente un descrittore di relazione stabilito in precedenza per accedere alle informazioni tra schemi diversi.
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: {ORG_ID}' \
Risposta
Una risposta corretta restituisce un elenco impaginato di eventi di serie temporali associati a più entità.
{
"_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": ""
}
}
}
I risultati vengono impaginati quando si recuperano gli eventi delle serie temporali. Se ci sono pagine successive di risultati, il _page.next
La proprietà conterrà un ID. Inoltre, la _links.next.href
La proprietà fornisce un URI di richiesta per il recupero della pagina successiva effettuando richieste aggiuntive di GET al access/entities
punto finale.
Seguendo questa guida, hai effettuato l’accesso Real-time Customer Profile campi di dati, profili e dati delle serie temporali. Per scoprire come accedere ad altre risorse dati memorizzate in Platform, vedi Panoramica sull'accesso ai dati.
La sezione seguente fornisce informazioni supplementari sull’accesso Profile i dati utilizzando l’API.
I seguenti parametri vengono utilizzati nel percorso per le richieste di GET al /access/entities
punto finale. Servono a identificare l’entità profilo a cui desideri accedere e a filtrare i dati restituiti nella risposta. I parametri richiesti sono etichettati, mentre gli altri sono facoltativi.
Parametro | Descrizione | Esempio |
---|---|---|
schema.name |
(OBBLIGATORIO) Lo schema XDM dell’entità da recuperare | schema.name=_xdm.context.experienceevent |
relatedSchema.name |
Se schema.name è "_xdm.context.experienceevent", questo valore deve specificare lo schema per l’entità profilo a cui sono correlati gli eventi delle serie temporali. |
relatedSchema.name=_xdm.context.profile |
entityId |
(OBBLIGATORIO) ID dell’entità. Se il valore di questo parametro non è un XID, deve essere fornito anche un parametro dello spazio dei nomi di identità (vedi entityIdNS qui sotto). |
entityId=janedoe@example.com |
entityIdNS |
Se entityId non viene fornito come XID, questo campo deve specificare lo spazio dei nomi identità. |
entityIdNE=email |
relatedEntityId |
Se schema.name è "_xdm.context.experienceevent", questo valore deve specificare lo spazio dei nomi di identità dell’entità profilo correlata. Questo valore segue le stesse regole di entityId . |
relatedEntityId=69935279872410346619186588147492736556 |
relatedEntityIdNS |
Se schema.name è "_xdm.context.experienceevent", questo valore deve specificare lo spazio dei nomi di identità per l'entità specificata in relatedEntityId . |
relatedEntityIdNS=CRMID |
fields |
Filtra i dati restituiti nella risposta. Utilizzare questa opzione per specificare i valori dei campi dello schema da includere nei dati recuperati. Per più campi, separa i valori con una virgola senza spazi tra | fields=personalEmail,person.name,person.gender |
mergePolicyId |
Identifica i criteri di unione in base ai quali governare i dati restituiti. Se non ne viene specificato uno nella chiamata , verrà utilizzato il valore predefinito dell’organizzazione per lo schema specificato. Se non è stato configurato alcun criterio di unione predefinito, il valore predefinito è nessuna unione profili e nessuna unione identità. | mergePoilcyId=5aa6885fcf70a301dabdfa4a |
orderBy |
L’ordinamento degli eventi di esperienza recuperati per marca temporale, scritto come (+/-)timestamp con l'impostazione predefinita +timestamp . |
orderby=-timestamp |
startTime |
Specifica l’ora di inizio per filtrare gli oggetti della serie temporale (in millisecondi). | startTime=1539838505 |
endTime |
Specifica l’ora di fine per filtrare gli oggetti della serie temporale (in millisecondi). | endTime=1539838510 |
limit |
Valore numerico che specifica il numero massimo di oggetti da restituire. Predefinito: 1000 | limit=100 |
property |
Filtra in base al valore della proprietà. Supporta i seguenti valutatori: =, !=, <, <=, >, >=. Può essere utilizzato solo con gli eventi di esperienza, con il supporto di un massimo di tre proprietà. | property=webPageDetails.isHomepage=true&property=localTime<="2020-07-20" |
withCA |
Flag di funzionalità per abilitare gli attributi calcolati per la ricerca. Predefinito: false | withCA=true |