Generare profili di esempio in base a uno schema di origine sample-profile-api-operations
https://platform.adobe.io/data/core/activation/authoring/sample-profilesIn questa pagina sono elencate e descritte tutte le operazioni API che è possibile eseguire utilizzando l'endpoint API /authoring/sample-profiles.
Generare diversi tipi di profilo per API diverse different-profiles-different-apis
- generare profili da utilizzare quando si crea e si verifica un modello di trasformazione dei messaggi - utilizzando ID destinazione come parametro di query.
- genera profili da utilizzare quando si effettuano chiamate a test se la destinazione è configurata correttamente - utilizzando ID istanza di destinazione come parametro di query.
Puoi generare profili di esempio in base allo schema di origine XDM di Adobe (da utilizzare durante il test della destinazione) o allo schema di destinazione supportato dalla destinazione (da utilizzare per la creazione del modello). Per capire la differenza tra lo schema di origine XDM Adobe e lo schema di destinazione, leggi la sezione panoramica dell'articolo Formato del messaggio.
Si noti che gli scopi per i quali è possibile utilizzare i profili di esempio non sono intercambiabili. I profili generati in base al ID destinazione possono essere utilizzati solo per creare i modelli di trasformazione dei messaggi e i profili generati in base al ID istanza destinazione possono essere utilizzati solo per testare l'endpoint di destinazione.
Guida introduttiva alle operazioni API di generazione dei profili di esempio get-started
Prima di continuare, consulta la guida introduttiva per informazioni importanti che devi conoscere per effettuare correttamente chiamate all'API, tra cui come ottenere l'autorizzazione di authoring della destinazione richiesta e le intestazioni richieste.
Genera profili di esempio in base allo schema di origine da utilizzare durante il test della destinazione generate-sample-profiles-source-schema
GET È possibile generare profili di esempio in base allo schema di origine effettuando una richiesta all'endpoint authoring/sample-profiles/ e fornendo l'ID di un'istanza di destinazione creata in base alla configurazione di destinazione da testare.
Per ottenere l’ID di un’istanza di destinazione, devi innanzitutto creare una connessione nell’interfaccia utente di Experience Platform con la destinazione prima di tentare di testare la destinazione. Leggi l'esercitazione attiva destinazione e vedi il suggerimento di seguito per ottenere l'ID istanza delle destinazioni da utilizzare per questa API.
- Per utilizzare questa API, è necessario disporre di una connessione esistente alla destinazione nell’interfaccia utente di Experience Platform. Leggi connettiti alla destinazione e attiva profili e pubblico a una destinazione per ulteriori informazioni.
- Dopo aver stabilito la connessione alla destinazione, ottieni l'ID dell'istanza di destinazione da utilizzare nelle chiamate API a questo endpoint quando sfoglia una connessione con la destinazione.
Formato API
GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}
{DESTINATION_INSTANCE_ID}{COUNT}1 - 1000.Se il parametro count non è specificato, il numero predefinito di profili generati è determinato dal valore
maxUsersPerRequest nella configurazione del server di destinazione. Se questa proprietà non è definita, Adobe genera un profilo di esempio.Richiesta
La richiesta seguente genera profili di esempio, configurati dai parametri di query {DESTINATION_INSTANCE_ID} e {COUNT}.
curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con il numero specificato di profili di esempio, con l’appartenenza al pubblico, le identità e gli attributi di profilo che corrispondono allo schema XDM di origine.
[
{
"segmentMembership": {
"ups": {
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
"lastQualificationTime": "2021-06-30T18:40:07.591378Z",
"status": "realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530": {
"lastQualificationTime": "2021-06-30T18:40:07.591380Z",
"status": "realized"
}
}
},
"personalEmail": {
"address": "john.smith@abc.com"
},
"identityMap": {
"ECID": [
{
"id": "ECID-7VEsJ"
}
]
},
"person": {
"name": {
"firstName": "string"
}
}
},
{
"segmentMembership": {
"ups": {
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
"lastQualificationTime": "2021-06-30T18:40:07.591378Z",
"status": "realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530": {
"lastQualificationTime": "2021-06-30T18:40:07.591380Z",
"status": "realized"
}
}
},
"personalEmail": {
"address": "john.smith@abc.com"
},
"identityMap": {
"ECID": [
{
"id": "ECID-Y55JJ"
}
]
},
"person": {
"name": {
"firstName": "string"
}
}
},
{
"segmentMembership": {
"ups": {
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
"lastQualificationTime": "2021-06-30T18:40:07.591378Z",
"status": "realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530": {
"lastQualificationTime": "2021-06-30T18:40:07.591380Z",
"status": "realized"
}
}
},
"personalEmail": {
"address": "john.smith@abc.com"
},
"identityMap": {
"ECID": [
{
"id": "ECID-Nd9GK"
}
]
},
"person": {
"name": {
"firstName": "string"
}
}
}
]
segmentMembershipsegmentMembership, leggere Dettagli appartenenza pubblico.lastQualificationTimexdm:statusCampo stringa che indica se l’appartenenza al pubblico è stata realizzata come parte della richiesta corrente. Sono accettati i seguenti valori:
realized: il profilo fa parte del segmento.exited: il profilo sta uscendo dal pubblico come parte della richiesta corrente.
identityMapidentityMap, leggere Base della composizione dello schema.Generare profili di esempio in base allo schema di destinazione da utilizzare per la creazione di un modello di trasformazione dei messaggi generate-sample-profiles-target-schema
È possibile generare profili di esempio in base allo schema di destinazione effettuando una richiesta di GET all'endpoint authoring/sample-profiles/ e fornendo l'ID di destinazione della configurazione di destinazione in base alla quale si sta creando il modello.
- L'ID di destinazione da utilizzare è
instanceIdche corrisponde a una configurazione di destinazione, creata utilizzando l'endpoint/destinations. Per ulteriori dettagli, consultare recuperare una configurazione di destinazione.
Formato API
GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}
{DESTINATION_ID}{COUNT}1 - 1000.Se il parametro count non è specificato, il numero predefinito di profili generati è determinato dal valore
maxUsersPerRequest nella configurazione del server di destinazione. Se questa proprietà non è definita, Adobe genera un profilo di esempio.Richiesta
La richiesta seguente genera profili di esempio, configurati dai parametri di query {DESTINATION_ID} e {COUNT}.
curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con il numero specificato di profili di esempio, con l’appartenenza al pubblico, le identità e gli attributi di profilo che corrispondono allo schema XDM di destinazione.
[
{
"segmentMembership": {
"ups": {
"segmentid1": {
"lastQualificationTime": "2021-06-30T18:42:27.609326Z",
"status": "realized"
},
"segmentid3": {
"lastQualificationTime": "2021-06-30T18:42:27.609328Z",
"status": "exited"
},
"segmentid2": {
"lastQualificationTime": "2021-06-30T18:42:27.609328Z",
"status": "realized"
}
}
},
"identityMap": {
"phone_sha256": [
{
"id": "phone_sha256-vizii"
}
],
"gaid": [
{
"id": "gaid-adKYs"
}
],
"idfa": [
{
"id": "idfa-t4sKv"
}
],
"extern_id": [
{
"id": "extern_id-C3enB"
}
],
"email_lc_sha256": [
{
"id": "email_lc_sha256-bfnbs"
}
]
}
},
{
"segmentMembership": {
"ups": {
"segmentid1": {
"lastQualificationTime": "2021-06-30T18:42:27.609626Z",
"status": "realized"
},
"segmentid3": {
"lastQualificationTime": "2021-06-30T18:42:27.609627Z",
"status": "exited"
},
"segmentid2": {
"lastQualificationTime": "2021-06-30T18:42:27.609627Z",
"status": "realized"
}
}
},
"identityMap": {
"phone_sha256": [
{
"id": "phone_sha256-6YjGc"
}
],
"gaid": [
{
"id": "gaid-SfJ21"
}
],
"idfa": [
{
"id": "idfa-eQMWS"
}
],
"extern_id": [
{
"id": "extern_id-d3WzP"
}
],
"email_lc_sha256": [
{
"id": "email_lc_sha256-eWfFn"
}
]
}
},
{
"segmentMembership": {
"ups": {
"segmentid1": {
"lastQualificationTime": "2021-06-30T18:42:27.609823Z",
"status": "realized"
},
"segmentid3": {
"lastQualificationTime": "2021-06-30T18:42:27.609824Z",
"status": "exited"
},
"segmentid2": {
"lastQualificationTime": "2021-06-30T18:42:27.609824Z",
"status": "realized"
}
}
},
"identityMap": {
"phone_sha256": [
{
"id": "phone_sha256-2PMjZ"
}
],
"gaid": [
{
"id": "gaid-3aLez"
}
],
"idfa": [
{
"id": "idfa-D2H1J"
}
],
"extern_id": [
{
"id": "extern_id-i6PsF"
}
],
"email_lc_sha256": [
{
"id": "email_lc_sha256-VPUtZ"
}
]
}
}
]
Gestione degli errori API api-error-handling
Gli endpoint API di Destination SDK seguono i principi generali dei messaggi di errore API di Experience Platform. Consulta Codici di stato API e errori di intestazione della richiesta nella guida alla risoluzione dei problemi di Platform.
Passaggi successivi
Dopo aver letto questo documento, sai come generare profili di esempio da utilizzare quando viene eseguito il test di un modello di trasformazione dei messaggi o quando viene verificato se la destinazione è configurata correttamente.