Generare profili di esempio in base a uno schema di origine
Il primo passaggio nel test della destinazione basata su file consiste nell'utilizzare l'endpoint /sample-profiles
per generare un profilo di esempio basato sullo schema di origine esistente.
I profili di esempio possono aiutarti a comprendere la struttura JSON di un profilo. Inoltre, ti forniscono un valore predefinito che puoi personalizzare con i tuoi dati di profilo, per ulteriori test di destinazione.
Introduzione getting-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.
Prerequisiti prerequisites
Prima di poter utilizzare l'endpoint /sample-profiles
, verificare di soddisfare le seguenti condizioni:
-
Hai già una destinazione basata su file creata tramite la Destination SDK e la puoi visualizzare nel catalogo delle destinazioni.
-
Nell’interfaccia utente di Experience Platform è stato creato almeno un flusso di attivazione per la destinazione. L'endpoint
/sample-profiles
crea i profili in base allo schema di origine definito nel flusso di attivazione. Per informazioni su come creare un flusso di attivazione, consulta l'esercitazione sull'attivazione. -
Per eseguire correttamente la richiesta API, è necessario disporre dell’ID dell’istanza di destinazione corrispondente all’istanza di destinazione da testare. Ottieni dall’URL l’ID dell’istanza di destinazione da utilizzare nella chiamata API per la navigazione di una connessione con la destinazione nell’interfaccia utente di Platform.
Generare profili di esempio per il test della destinazione generate-sample-profiles
È possibile generare profili di esempio in base allo schema di origine effettuando una richiesta di GET all'endpoint /sample-profiles
con l'ID dell'istanza di destinazione della destinazione da testare.
Formato API
GET /authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={NUMBER_OF_GENERATED_PROFILES}
destinationInstanceId
count
1 - 1000
. Se questa proprietà non è definita, l’API genera un singolo profilo di esempio.Richiesta
La richiesta seguente genera un profilo di esempio basato sullo schema di origine definito nell'istanza di destinazione con destinationInstanceId
corrispondente.
curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H '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":{
"fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
"lastQualificationTime":"2022-01-13T11:33:28.211895Z",
"status":"realized"
},
"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
"lastQualificationTime":"2022-01-13T11:33:28.211893Z",
"status":"realized"
}
}
},
"personalEmail":{
"address":"john.smith@abc.com"
},
"identityMap":{
"crmid":[
{
"id":"crmid-P1A7l"
}
]
},
"person":{
"name":{
"firstName":"string",
"lastName":"string"
}
}
}
]
segmentMembership
segmentMembership
, leggere Dettagli appartenenza pubblico.lastQualificationTime
status
Campo 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.
identityMap
identityMap
, vedere base della composizione dello schema.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, ora sai come generare profili di esempio in base allo schema di origine configurato nel flusso di attivazione di destinazione.
È ora possibile personalizzare questi profili o utilizzarli mentre vengono restituiti dall'API, per verificare la configurazione di destinazione basata su file.