Adobe Experience Platform ger dig åtkomst Real-time Customer Profile data med RESTful API:er eller användargränssnittet. I den här handboken beskrivs hur du får åtkomst till entiteter, som ofta kallas"profiler", med API:t. Mer information om hur du får åtkomst till profiler med Platform Gränssnittet, se Användarhandbok för profil.
API-slutpunkten som används i den här guiden är en del av Real-time Customer Profile API. Läs igenom komma igång-guide för länkar till relaterad dokumentation, en guide till hur du läser exempel-API-anrop i det här dokumentet och viktig information om vilka huvuden som behövs för att kunna ringa anrop till Experience Platform API.
Du kan komma åt en Profile genom att göra en GET-förfrågan till /access/entities
slutpunkt och ange entitetens identitet som en serie frågeparametrar. Den här identiteten består av ett ID-värde (entityId
) och identitetsnamnutrymmet (entityIdNS
).
Frågeparametrar som anges i sökvägen anger vilka data som ska användas. Du kan inkludera flera parametrar, avgränsade med et-tecken (&). En fullständig lista över giltiga parametrar finns i frågeparametrar i bilagan.
API-format
GET /access/entities?{QUERY_PARAMETERS}
Begäran
Följande begäran hämtar en kunds e-postadress och namn med hjälp av en identitet:
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}'
Svar
{
"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"
}
}
Om ett relaterat diagram länkar mer än 50 identiteter returnerar den här tjänsten HTTP-status 422 och meddelandet"För många relaterade identiteter". Om du får det här felet kan du lägga till fler frågeparametrar för att begränsa sökningen.
Du kan få åtkomst till flera profilentiteter via deras identiteter genom att göra en POST-förfrågan till /access/entities
slutpunkt och tillhandahåller identiteterna i nyttolasten. Dessa identiteter består av ett ID-värde (entityId
) och ett identitetsnamnutrymme (entityIdNS
).
API-format
POST /access/entities
Begäran
Följande begäran hämtar namnen och e-postadresserna för flera kunder med hjälp av en lista över identiteter:
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
}'
Egenskap | Beskrivning |
---|---|
schema.name |
(Obligatoriskt) Namnet på XDM-schemat som entiteten tillhör. |
fields |
XDM-fälten som ska returneras, som en array med strängar. Som standard returneras alla fält. |
identities |
(Obligatoriskt) En array som innehåller en lista med identiteter för de entiteter som du vill komma åt. |
identities.entityId |
ID:t för en enhet som du vill komma åt. |
identities.entityIdNS.code |
Namnområdet för ett enhets-ID som du vill komma åt. |
timeFilter.startTime |
Starttid för tidsintervallfiltret, som ingår. Ska vara i millisekundens granularitet. Om inget anges är standardvärdet början av tillgänglig tid. |
timeFilter.endTime |
Sluttid för tidsintervallfilter, exkluderad. Ska vara i millisekundens granularitet. Om inget anges är standardvärdet slutet av tillgänglig tid. |
limit |
Antal poster som ska returneras. Gäller endast antalet returnerade upplevelsehändelser. Standard: 1000. |
orderby |
Sorteringsordningen för hämtade upplevelsehändelser efter tidsstämpel, skriven som (+/-)timestamp med standardvärdet +timestamp . |
withCA |
Funktionsflagga för aktivering av beräknade attribut för sökning. Standard: false. |
Svar
Ett lyckat svar returnerar de begärda fälten för entiteter som anges i begärandetexten.
{
"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"
}
}
Du kan komma åt tidsseriehändelser via identiteten för deras associerade profilentitet genom att göra en GET-förfrågan till /access/entities
slutpunkt. Den här identiteten består av ett ID-värde (entityId
) och ett identitetsnamnutrymme (entityIdNS
).
Frågeparametrar som anges i sökvägen anger vilka data som ska användas. Du kan inkludera flera parametrar, avgränsade med et-tecken (&). En fullständig lista över giltiga parametrar finns i frågeparametrar i bilagan.
API-format
GET /access/entities?{QUERY_PARAMETERS}
Begäran
Följande begäran hittar en profilentitet efter ID och hämtar värdena för egenskaperna endUserIDs
, web
och channel
för alla tidsseriehändelser som är associerade med entiteten.
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}'
Svar
Ett lyckat svar returnerar en numrerad lista över händelser i tidsserier och associerade fält som har angetts i frågeparametrarna för begäran.
Begäran angav en gräns på ett (limit=1
) och därför count
i svaret nedan är 1 och endast en enhet returneras.
{
"_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"
}
}
}
Resultaten sidnumreras när tidsseriehändelser hämtas. Om det finns efterföljande resultatsidor _page.next
-egenskapen kommer att innehålla ett ID. Dessutom finns _links.next.href
-egenskapen tillhandahåller en URI för begäran för hämtning av nästa sida. Om du vill hämta resultaten skickar du en ny GET-förfrågan till /access/entities
slutpunkt, men du måste se till att ersätta /entities
med värdet för angiven URI.
Se till att du inte råkar upprepa /entities/
i sökvägen till begäran. Den ska bara visas en gång. /access/entities?start=...
API-format
GET /access/{NEXT_URI}
Parameter | Beskrivning |
---|---|
{NEXT_URI} |
URI-värdet hämtas från _links.next.href . |
Begäran
Följande begäran hämtar nästa resultatsida med _links.next.href
URI som begärandesökväg.
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}'
Svar
Ett godkänt svar returnerar nästa resultatsida. Svaret har inga efterföljande resultatsidor, vilket anges av de tomma strängvärdena för _page.next
och _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": ""
}
}
}
Du kan komma åt tidsseriehändelser från flera associerade profiler genom att göra en POST-förfrågan till /access/entities
slutpunkt och ange profilidentiteterna i nyttolasten. Dessa identiteter består av ett ID-värde (entityId
) och ett identitetsnamnutrymme (entityIdNS
).
API-format
POST /access/entities
Begäran
Följande begäran hämtar användar-ID:n, lokala tider och landskoder för tidsseriehändelser som är associerade med en lista över profilidentiteter:
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
}'
Egenskap | Beskrivning |
---|---|
schema.name |
(OBLIGATORISKT) XDM-schemat för entiteten som ska hämtas |
relatedSchema.name |
If schema.name är _xdm.context.experienceevent det här värdet måste ange schemat för den profilentitet som tidsseriehändelser är relaterade till. |
identities |
(OBLIGATORISKT) En array med profiler som associerade tidsseriehändelser ska hämtas från. Varje post i arrayen anges på ett av två sätt: 1) med en fullständigt kvalificerad identitet som består av ID-värde och namnutrymme eller 2) som tillhandahåller ett XID. |
fields |
Isolerar de data som returneras till en angiven uppsättning fält. Använd detta för att filtrera vilka schemafält som ska inkluderas i hämtade data. Exempel: personalEmail,person.namn,person.kön |
mergePolicyId |
Identifierar den sammanslagningsprincip som ska användas för att styra returnerade data. Om ingen anges i servicesamtalet kommer din organisations standardinställning för det schemat att användas. Om ingen standardprincip för sammanslagning har konfigurerats är standardinställningen ingen profilsammanslagning och ingen identitetssammanfogning. |
orderby |
Sorteringsordningen för hämtade upplevelsehändelser efter tidsstämpel, skriven som (+/-)timestamp med standardvärdet +timestamp . |
timeFilter.startTime |
Ange starttid för att filtrera tidsserieobjekt (i millisekunder). |
timeFilter.endTime |
Ange sluttiden för filtrering av tidsserieobjekt (i millisekunder). |
limit |
Numeriskt värde som anger det maximala antalet objekt som ska returneras. Standard: 1000 |
withCA |
Funktionsflagga för aktivering av beräknade attribut för sökning. Standard: false |
Svar
Ett lyckat svar returnerar en numrerad lista över händelser i tidsserier som är associerade med de flera profiler som anges i begäran.
{
"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": ""
}
}
}
}`
I det här exemplet ger den första listade profilen ("GkouAW-yD9aoRCPhRYROJ-TetAFW") ett värde för _links.next.payload
, vilket innebär att det finns ytterligare resultatsidor för den här profilen. Se följande avsnitt på få tillgång till ytterligare resultat om du vill ha mer information om hur du får tillgång till dessa ytterligare resultat.
När tidsseriehändelser hämtas kan det finnas många resultat som returneras, och därför sidnumreras ofta resultaten. Om det finns efterföljande resultatsidor för en viss profil visas _links.next.payload
värdet för den profilen kommer att innehålla ett nyttolastobjekt.
Om du använder den här nyttolasten i begärandetexten kan du utföra ytterligare en begäran om POST till access/entities
slutpunkt för att hämta efterföljande sida med tidsseriedata för den profilen.
Du kan komma åt flera enheter som är anslutna via en relationsbeskrivare. I följande exempel på API-anrop förutsätts att en relation redan har definierats mellan två scheman. Mer information om relationsbeskrivningar finns i Schema Registry Utvecklarhandbok för API slutpunktshandbok för beskrivningar.
Du kan inkludera frågeparametrar i sökvägen för begäran för att ange vilka data som ska användas. Du kan inkludera flera parametrar, avgränsade med et-tecken (&). En fullständig lista över giltiga parametrar finns i frågeparametrar i bilagan.
API-format
GET /access/entities?{QUERY_PARAMETERS}
Begäran
Följande begäran hämtar en entitet som innehåller en tidigare etablerad relationsbeskrivare för att få tillgång till information över olika scheman.
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}' \
Svar
Ett lyckat svar returnerar en numrerad lista över händelser i tidsserier som är associerade med de flera entiteterna.
{
"_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": ""
}
}
}
Resultaten sidnumreras när tidsseriehändelser hämtas. Om det finns efterföljande resultatsidor _page.next
-egenskapen kommer att innehålla ett ID. Dessutom finns _links.next.href
egenskapen innehåller en URI för begäran om att hämta efterföljande sida genom att göra ytterligare GET-begäranden till access/entities
slutpunkt.
Genom att följa den här guiden har du fått åtkomst till Real-time Customer Profile datafält, profiler och tidsseriedata. Så här får du lära dig att komma åt andra dataresurser som lagras i Platform, se Dataåtkomstöversikt.
Följande avsnitt innehåller ytterligare information om åtkomst Profile data med API:t.
Följande parametrar används i sökvägen för GET-begäranden till /access/entities
slutpunkt. De används för att identifiera den profilentitet som du vill komma åt och filtrera data som returneras i svaret. Obligatoriska parametrar är märkta, medan resten är valfria.
Parameter | Beskrivning | Exempel |
---|---|---|
schema.name |
(OBLIGATORISKT) XDM-schemat för entiteten som ska hämtas | schema.name=_xdm.context.experienceevent |
relatedSchema.name |
If schema.name är "_xdm.context.experience.event", måste det här värdet ange schemat för den profilentitet som tidsseriehändelser är relaterade till. |
relatedSchema.name=_xdm.context.profile |
entityId |
(OBLIGATORISKT) ID för entiteten. Om värdet för den här parametern inte är ett XID måste även en parameter för identitetsnamnrymd anges (se entityIdNS nedan). |
entityId=janedoe@example.com |
entityIdNS |
If entityId anges inte som ett XID. Det här fältet måste ange identitetsnamnutrymmet. |
entityIdNE=email |
relatedEntityId |
If schema.name är "_xdm.context.experience.event", måste det här värdet ange den relaterade profilentitetens identitetsnamnutrymme. Detta värde följer samma regler som entityId . |
relatedEntityId=69935279872410346619186588147492736556 |
relatedEntityIdNS |
If schema.name är "_xdm.context.experienceevent", måste det här värdet ange identitetsnamnutrymmet för entiteten som anges i relatedEntityId . |
relatedEntityIdNS=CRMID |
fields |
Filtrerar de data som returneras i svaret. Använd detta för att ange vilka schemafältvärden som ska inkluderas i hämtade data. För flera fält avgränsar du värden med kommatecken utan blanksteg mellan | fields=personalEmail,person.name,person.gender |
mergePolicyId |
Identifierar den sammanslagningsprincip som ska användas för att styra returnerade data. Om ingen anges i samtalet används organisationens standardvärde för det schemat. Om ingen standardprincip för sammanslagning har konfigurerats är standardinställningen ingen profilsammanslagning och ingen identitetssammanfogning. | mergePoilcyId=5aa6885fcf70a301dabdfa4a |
orderBy |
Sorteringsordningen för hämtade upplevelsehändelser efter tidsstämpel, skriven som (+/-)timestamp med standardvärdet +timestamp . |
orderby=-timestamp |
startTime |
Ange starttid för att filtrera tidsserieobjekt (i millisekunder). | startTime=1539838505 |
endTime |
Ange sluttiden för filtrering av tidsserieobjekt (i millisekunder). | endTime=1539838510 |
limit |
Numeriskt värde som anger det maximala antalet objekt som ska returneras. Standard: 1000 | limit=100 |
property |
Filtrerar efter egenskapsvärdet. Stöder följande utvärderare: =, !=, <, <=, >, >=. Kan endast användas med upplevelsehändelser med stöd för maximalt tre egenskaper. | property=webPageDetails.isHomepage=true&property=localTime<="2020-07-20" |
withCA |
Funktionsflagga för aktivering av beräknade attribut för sökning. Standard: false | withCA=true |