DocumentazioneExperience PlatformGuida al profilo cliente in tempo reale

Endpoint entità (accesso profilo)

Last update: Wed Aug 27 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Sviluppatore

Adobe Experience Platform consente di accedere ai dati di Real-Time Customer Profile utilizzando 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 l'interfaccia utente di Experience Platform, fare riferimento alla Guida utente del profilo.

Introduzione

L'endpoint API utilizzato in questa guida fa parte di Real-Time Customer Profile API. Prima di continuare, consulta la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio in questo documento e informazioni importanti sulle intestazioni necessarie per effettuare correttamente le chiamate a qualsiasi API Experience Platform.

recommendation-more-help

Risoluzione entità

Come parte dell’aggiornamento dell’architettura, Adobe sta introducendo la risoluzione delle entità per account e opportunità, utilizzando la corrispondenza degli ID deterministici basata sui dati più recenti. Il processo di risoluzione delle entità viene eseguito quotidianamente durante la segmentazione batch, prima di valutare tipi di pubblico con più entità con attributi B2B.

Questo miglioramento consente ad Experience Platform di identificare e unificare più record che rappresentano la stessa entità, migliorando la coerenza dei dati e consentendo una segmentazione del pubblico più accurata.

In precedenza, Account e opportunità si basavano su una risoluzione basata su un grafico di identità che collegava le identità, incluse tutte le acquisizioni storiche. Nel nuovo approccio di risoluzione delle entità, le identità sono collegate solo in base ai dati più recenti

Come funziona la risoluzione delle entità?

  • Prima: se è stato utilizzato un numero DUNS (Data Universal Numbering System) come identità aggiuntiva e il numero DUNS dell'account è stato aggiornato in un sistema di origine come CRM, l'ID account è collegato sia ai numeri DUNS vecchi che a quelli nuovi.
  • Dopo: se il numero DUNS è stato utilizzato come identità aggiuntiva e il numero DUNS dell'account è stato aggiornato in un sistema di origine come CRM, l'ID account viene collegato solo al nuovo numero DUNS, riflettendo in tal modo lo stato corrente dell'account in modo più accurato.

In seguito a questo aggiornamento, l'API Profile Access riflette ora la visualizzazione del profilo di unione più recente dopo il completamento di un processo di risoluzione entità. Inoltre, i dati coerenti forniscono casi di utilizzo come segmentazione, attivazione e analisi con una maggiore precisione e coerenza dei dati.

style
shade-box

Recuperare un’entità retrieve-entity

IMPORTANT
Le seguenti entità B2B non sono più supportate per le richieste di ricerca tramite l'API: Relazione account-persona, Relazione opportunità-persona, Campagna, Membro della campagna, Elenco marketing e Membro dell'elenco marketing.
Il supporto per queste entità è stato dichiarato obsoleto. Se disponi di integrazioni o flussi di lavoro esistenti che si basano sull’accesso a tali entità, aggiornali per utilizzare i tipi di entità supportati per garantire funzionalità continue.

È possibile recuperare un'entità profilo effettuando una richiesta GET all'endpoint /access/entities insieme ai parametri di query richiesti.

Entità profilo

Formato API

code language-http 
GET /access/entities?{QUERY_PARAMETERS}

I parametri di query forniti nel percorso della richiesta specificano a quali dati accedere. Puoi includere più parametri, separati da e commerciali (&).

Per accedere a un'entità profilo, devi fornire i seguenti parametri di query:

  • schema.name: nome dello schema XDM dell'entità. In questo caso d'uso, schema.name=_xdm.context.profile.
  • entityId: ID dell'entità da recuperare.
  • entityIdNS: spazio dei nomi dell'entità che si sta tentando di recuperare. Questo valore deve essere fornito se entityId è not un XID.

Un elenco completo dei parametri validi è fornito nella sezione parametri di query dell'appendice.

Richiesta

La richiesta seguente recupera l’e-mail e il nome di un cliente utilizzando un’identità.

accordion
Richiesta di esempio per recuperare un’entità utilizzando un’identità
code language-shell 
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

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con l’entità richiesta.

accordion
Risposta di esempio contenente l’entità richiesta
code language-json 
{
    "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
        "entityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
        "sources": [
            "1000000000"
        ],
        "entity": {
            "identities": [
                {
                    "id": "89149270342662559642753730269986316601",
                    "namespace": {
                        "code": "ecid"
                    }
                },
                {
                    "id": "janedoe@example.com",
                    "namespace": {
                        "code": "email"
                    }
                },
                {
                    "id": "johnsmith@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"
    }
}
note note
NOTE
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 restringere la ricerca.
Account B2B

Formato API

code language-http 
GET /access/entities?{QUERY_PARAMETERS}

I parametri di query forniti nel percorso della richiesta specificano a quali dati accedere. Puoi includere più parametri, separati da e commerciali (&).

Per accedere ai dati dell'account B2B, devi fornire i seguenti parametri di query:

  • schema.name: nome dello schema XDM dell'entità. In questo caso d'uso, il valore è schema.name=_xdm.context.account.
  • entityId: ID dell'entità da recuperare.
  • entityIdNS: spazio dei nomi dell'entità che si sta tentando di recuperare. Questo valore deve essere fornito se entityId è not un XID.

Un elenco completo dei parametri validi è fornito nella sezione parametri di query dell'appendice.

Richiesta

accordion
Una richiesta di esempio per recuperare un account B2B
code language-shell 
curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.account&entityIdNs=b2b_account&entityId=2334262' \
  -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

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con l’entità richiesta.

accordion
Risposta di esempio contenente l’entità richiesta
code language-json 
{
    "GuQ-AUFjgjaeIw": {
        "entityId": "GuQ-AUFjgjaeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "{SOURCE_ID}",
                    "sourceKey": "{SOURCE_KEY}",
                    "sourceInstanceID": "{SOURCE_INSTANCE_ID}",
                    "sourceType": "{SOURCE_TYPE}"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_account": [
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    },
                    {
                        "id": "{SOURCE_ID}"
                    }
                ]
            },
            "isDeleted": false,
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    }
}
Opportunità B2B

Formato API

code language-http 
GET /access/entities?{QUERY_PARAMETERS}

I parametri di query forniti nel percorso della richiesta specificano a quali dati accedere. Puoi includere più parametri, separati da e commerciali (&).

Per accedere a un'entità opportunità B2B, devi fornire i seguenti parametri di query:

  • schema.name: nome dello schema XDM dell'entità. In questo caso d'uso, schema.name=_xdm.context.opportunity.
  • entityId: ID dell'entità da recuperare.
  • entityIdNS: spazio dei nomi dell'entità che si sta tentando di recuperare. Questo valore deve essere fornito se entityId è not un XID.

Un elenco completo dei parametri validi è fornito nella sezione parametri di query dell'appendice.

Richiesta

accordion
Richiesta di esempio per recuperare un’entità opportunità B2B
code language-shell 
curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.opportunity&entityIdNs=b2b_opportunity&entityId=2334262' \
  -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

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con l’entità richiesta.

accordion
Risposta di esempio contenente l’entità richiesta
code language-json 
{
  "Ggw_AUFjgjaeIw": {
        "entityId": "Ggw_AUFjgjaeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    },
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    }
}

Recuperare più entità retrieve-entities

Per recuperare più entità profilo, devi eseguire una richiesta POST all'endpoint /access/entities e fornire le identità nel payload.

Entità profilo

Formato API

code language-http 
POST /access/entities

Richiesta

La richiesta seguente recupera i nomi e gli indirizzi e-mail di diversi clienti da un elenco di identità.

accordion
Una richiesta di esempio per recuperare più entità
code language-shell 
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"
      }'
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3
Proprietà Tipo Descrizione
schema.name Stringa (Obbligatorio) Il nome dello schema XDM a cui appartiene l'entità.
fields Array I campi XDM da restituire, sotto forma di array di stringhe. Per impostazione predefinita, vengono restituiti tutti i campi.
identities Array (Obbligatorio) Matrice contenente un elenco di identità per le entità alle quali si desidera accedere.
identities.entityId Stringa L’ID di un’entità a cui desideri accedere.
identities.entityIdNS.code Stringa Lo spazio dei nomi di un ID di entità a cui desideri accedere.
timeFilter.startTime Intero Specifica l'ora di inizio per filtrare le entità profilo (in millisecondi). Per impostazione predefinita, questo valore viene impostato come inizio del tempo disponibile.
timeFilter.endTime Intero Specifica l'ora di fine per filtrare le entità profilo (in millisecondi). Per impostazione predefinita, questo valore viene impostato come fine del tempo disponibile.
limit Intero Numero massimo di record da restituire. Per impostazione predefinita, questo valore è impostato su 1000.
orderby Stringa Ordinamento degli eventi esperienza recuperati per marca temporale, scritti come (+/-)timestamp con valore predefinito +timestamp.

Risposta

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i campi richiesti delle entità specificate nel corpo della richiesta.

accordion
Risposta di esempio contenente le entità richieste
code language-json 
{
    "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"
    }
}
Account B2B

Formato API

code language-http 
POST /access/entities

Richiesta

La richiesta seguente recupera gli account B2B richiesti.

accordion
Una richiesta di esempio per recuperare più entità
code language-shell 
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.account"
        },
        "identities": [
            {
                "entityId": "2334262",
                "entityIdNS": {
                    "code":"b2b_account"
                }
            },
            {
                "entityId": "2334263",
                "entityIdNS": {
                    "code":"b2b_account"
                }
            },
            {
                "entityId": "2334264",
                "entityIdNS": {
                    "code":"b2b_account"
                }
            }
        ]
    }'
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3
Proprietà Tipo Descrizione
schema.name Stringa (Obbligatorio) Il nome dello schema XDM a cui appartiene l'entità.
identities Array (Obbligatorio) Matrice contenente un elenco di identità per le entità alle quali si desidera accedere.
identities.entityId Stringa L’ID di un’entità a cui desideri accedere.
identities.entityIdNS.code Stringa Lo spazio dei nomi di un ID di entità a cui desideri accedere.

Risposta

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con le entità richieste.

accordion
Risposta di esempio contenente le entità richieste
code language-json 
{
    "GuQ-AUFjgjeeIw": {
        "requestedIdentity": {
            "entityId": "2334263",
            "entityIdNS": {
                "code": "b2b_account"
            }
        },
        "entityId": "GuQ-AUFjgjeeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_account": [
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    },
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "GuQ-AUFjgjaeIw": {
        "requestedIdentity": {
            "entityId": "2334262",
            "entityIdNS": {
                "code": "b2b_account"
            }
        },
        "entityId": "GuQ-AUFjgjaeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_account": [
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    },
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "GuQ-AUFjgjmeIw": {
        "requestedIdentity": {
            "entityId": "2334265",
            "entityIdNS": {
                "code": "b2b_account"
            }
        },
        "entityId": "GuQ-AUFjgjmeIw",
        "mergePolicy": {
            "id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334265",
            "identityMap": {
            "b2b_account": [
                {
                    "id": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                },
                {
                    "id": "2334265"
                }
            ]
        },
        "isDeleted": false,
        "accountKey": {
            "sourceID": "2334265",
            "sourceKey": "2334265",
            "sourceInstanceID": "2334265",
            "sourceType": "Random"
        }
    }
}
Opportunità B2B

Formato API

code language-http 
POST /access/entities

Richiesta

La richiesta seguente recupera le opportunità B2B richieste.

accordion
Una richiesta di esempio per recuperare più entità
code language-shell 
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.opportunity"
        },
        "identities": [
            {
                "entityId": "2334262",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            },
            {
                "entityId": "2334263",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            },
            {
                "entityId": "2334264",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            },
            {
                "entityId": "2334265",
                "entityIdNS": {
                    "code":"b2b_opportunity"
                }
            }
        ]
    }'
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3
Proprietà Tipo Descrizione
schema.name Stringa (Obbligatorio) Il nome dello schema XDM a cui appartiene l'entità.
identities Array (Obbligatorio) Matrice contenente un elenco di identità per le entità alle quali si desidera accedere.
identities.entityId Stringa L’ID di un’entità a cui desideri accedere.
identities.entityIdNS.code Stringa Lo spazio dei nomi di un ID di entità a cui desideri accedere.

Risposta

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con le entità richieste.

accordion
Risposta di esempio contenente le entità richieste
code language-json 
{
    "Ggw_AUFjgjaeIw": {
        "requestedIdentity": {
            "entityId": "2334262",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjaeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    },
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "Ggw_AUFjgjieIw": {
        "requestedIdentity": {
            "entityId": "2334264",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjieIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0041c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334264",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "2334264"
                    },
                    {
                        "id": "0041c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334264",
                "sourceKey": "2334264",
                "sourceInstanceID": "2334264",
                "sourceType": "Salesforce"
            }
        }
    },
    "Ggw_AUFjgjeeIw": {
        "requestedIdentity": {
            "entityId": "2334263",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjeeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334262",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    },
                    {
                        "id": "2334263"
                    },
                    {
                        "id": "2334262"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            }
        }
    },
    "Ggw_AUFjgjmeIw": {
        "requestedIdentity": {
            "entityId": "2334265",
            "entityIdNS": {
                "code": "b2b_opportunity"
            }
        },
        "entityId": "Ggw_AUFjgjmeIw",
        "mergePolicy": {
            "id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
        },
        "sources": [
            "er_m_attr"
        ],
        "entity": {
            "_id": "id1",
            "extSourceSystemAudit": {
                "lastReferencedDate": "2024-03-09 12:21:43.0",
                "lastActivityDate": "2024-03-09 12:21:43.0",
                "lastUpdatedDate": "2024-03-09 12:21:43.0",
                "lastUpdatedBy": "{USER_ID}",
                "externalKey": {
                    "sourceID": "00394S0001xpG6xABE",
                    "sourceKey": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
                    "sourceInstanceID": "00DC0000000Q35nMAC",
                    "sourceType": "Salesforce"
                },
                "lastViewedDate": "2024-03-09 12:21:43.0",
                "createdDate": "2024-03-09 12:21:43.0"
            },
            "accountID": "2334265",
            "identityMap": {
                "b2b_opportunity": [
                    {
                        "id": "2334265"
                    },
                    {
                        "id": "0054c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
                    }
                ]
            },
            "isDeleted": false,
            "opportunityKey": {
                "sourceID": "2334262",
                "sourceKey": "2334262",
                "sourceInstanceID": "2334262",
                "sourceType": "Random"
            },
            "accountKey": {
                "sourceID": "2334265",
                "sourceKey": "2334265",
                "sourceInstanceID": "2334265",
                "sourceType": "Random"
            }
        }
    }
}

Accedere a una pagina di risultati successiva

I risultati vengono impaginati durante il recupero degli eventi delle serie temporali. Se sono presenti pagine successive di risultati, la proprietà _page.next conterrà un ID. Inoltre, la proprietà _links.next.href fornisce un URI di richiesta per recuperare la pagina successiva. Per recuperare i risultati, eseguire un'altra richiesta GET all'endpoint /access/entities e sostituire /entities con il valore dell'URI specificato.

NOTE
Assicurarsi di non ripetere accidentalmente /entities/ nel percorso della richiesta. Deve apparire solo una volta come, /access/entities?start=...

Formato API

GET /access/{NEXT_URI}
Parametro
Descrizione
{NEXT_URI}
Valore URI preso da _links.next.href.

Richiesta

La richiesta seguente recupera la pagina successiva dei risultati utilizzando l'URI _links.next.href come percorso della richiesta.

Una richiesta di esempio per accedere alla pagina successiva dei risultati
code language-shell 
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

In caso di esito positivo, la risposta restituisce la pagina successiva di risultati. Questa risposta non contiene pagine successive di risultati, come indicato dai valori stringa vuoti di _page.next e _links.next.href.

Risposta di esempio contenente la pagina successiva di entità
code language-json 
{
    "_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": ""
        }
    }
}

Eliminare un’entità delete-entity

IMPORTANT
Le richieste di eliminazione per le seguenti entità B2B sono diventate obsolete:
  • Account
  • Relazione account-persona
  • Opportunità
  • Relazione opportunità-persona
  • Campaign
  • Membro della campagna
  • Elenco marketing
  • Membri di elenco marketing

È possibile eliminare un'entità dall'archivio profili effettuando una richiesta DELETE all'endpoint /access/entities insieme ai parametri di query richiesti.

Formato API

DELETE /access/entities?{QUERY_PARAMETERS}

I parametri di query forniti nel percorso della richiesta specificano a quali dati accedere. Puoi includere più parametri, separati da e commerciali (&).

Per eliminare un'entità, devi fornire i seguenti parametri di query:

  • schema.name: nome dello schema XDM dell'entità. In questo caso d'uso, puoi solo usare schema.name=_xdm.context.profile.
  • entityId: ID dell'entità da recuperare.
  • entityIdNS: spazio dei nomi dell'entità che si sta tentando di recuperare. Questo valore deve essere fornito se entityId è not un XID.
  • mergePolicyId: ID del criterio di unione dell'entità. Il criterio di unione contiene informazioni sull’unione di identità e l’unione di oggetti XDM chiave-valore. Se questo valore non viene fornito, verrà utilizzato il criterio di unione predefinito.

Richiesta

La richiesta seguente elimina l’entità specificata.

Richiesta di esempio per eliminare un’entità
code language-shell 
curl -X DELETE 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email' \
  -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

In caso di esito positivo, la risposta restituisce lo stato HTTP 202 con un corpo di risposta vuoto.

Passaggi successivi

Seguendo questa guida hai effettuato l'accesso a Real-Time Customer Profile campi dati, profili e dati di serie temporali. Per informazioni su come accedere ad altre risorse di dati archiviate in Experience Platform, vedere la panoramica sull'accesso ai dati.

Appendice appendix

La sezione seguente fornisce informazioni supplementari sull'accesso ai dati di Profile tramite l'API.

Parametri della query query-parameters

I seguenti parametri vengono utilizzati nel percorso per le richieste GET all'endpoint /access/entities. 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) Il nome dello schema XDM dell'entità.
schema.name=_xdm.context.profile
relatedSchema.name
Se schema.name è _xdm.context.experienceevent, questo valore deve specificare lo schema per l'entità profilo a cui sono correlati gli eventi della serie temporale.
relatedSchema.name=_xdm.context.profile
entityId
(Obbligatorio) ID dell'entità. Se il valore di questo parametro non è un XID, è necessario fornire anche un parametro dello spazio dei nomi dell'identità (entityIdNS).
entityId=janedoe@example.com
entityIdNS
Se entityId non viene fornito come XID, il campo deve specificare lo spazio dei nomi dell'identità.
entityIdNS=email
relatedEntityId
Se schema.name è _xdm.context.experienceevent, questo valore deve specificare l'ID 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 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 il criterio di unione in base al quale gestire i dati restituiti. Se non ne è specificato uno nella chiamata, verrà utilizzato lo schema predefinito della tua organizzazione. Se non è stato configurato alcun criterio di unione predefinito, l’impostazione predefinita è nessuna unione di profili e nessuna unione di identità.
mergePolicyId=5aa6885fcf70a301dabdfa4a
orderBy
Ordinamento delle entità recuperate per marca temporale. Scritto come (+/-)timestamp, il valore predefinito è +timestamp.
orderby=-timestamp
startTime
Specifica l'ora di inizio per filtrare le entità (in millisecondi).
startTime=1539838505
endTime
Specifica l'ora di fine per filtrare le entità (in millisecondi).
endTime=1539838510
limit
Specifica il numero massimo di entità da restituire. Per impostazione predefinita, questo valore è impostato su 1000.
limit=100
property
Filtra per valore della proprietà. Questo parametro di query supporta i seguenti valutatori: =, !=, <, <=, >, >=. Questa può essere utilizzata solo con eventi di esperienza, con un massimo di tre proprietà supportate.
property=webPageDetails.isHomepage=true&property=localTime<="2020-07-20"
54550d5b-f1a1-4065-a394-eb0f23a2c38b