Questo documento fornisce un’esercitazione per valutare i segmenti e accedere ai risultati dei segmenti utilizzando Segmentation API.
Questo tutorial richiede una buona conoscenza delle varie Adobe Experience Platform servizi coinvolti nella creazione di segmenti di pubblico. Prima di iniziare questo tutorial, consulta la documentazione dei seguenti servizi:
Questo tutorial richiede anche di aver completato tutorial sull’autenticazione per effettuare correttamente chiamate a Platform API. Il completamento del tutorial sull’autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte Experience Platform Chiamate API, come mostrato di seguito:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Tutte le risorse in Experience Platform sono isolati in specifiche sandbox virtuali. Richieste a Platform Le API richiedono un’intestazione che specifichi il nome della sandbox in cui verrà eseguita l’operazione:
{SANDBOX_NAME}
Per ulteriori informazioni sulle sandbox in Platform, vedere documentazione di panoramica sulla sandbox.
Tutte le richieste di POST, PUT e PATCH richiedono un’intestazione aggiuntiva:
Dopo aver sviluppato, testato e salvato la definizione del segmento, puoi valutarlo tramite valutazione pianificata o su richiesta.
Valutazione programmata (nota anche come "segmentazione pianificata") consente di creare una pianificazione ricorrente per l’esecuzione di un processo di esportazione in un momento specifico, mentre valutazione on-demand implica la creazione di un processo di segmentazione per generare immediatamente il pubblico. Di seguito sono descritti i passaggi per ciascuno di essi.
Se non hai ancora completato creare un segmento utilizzando l’API di segmentazione esercitazione o ha creato una definizione di segmento utilizzando Generatore di segmenti, esegui questa operazione prima di procedere con questa esercitazione.
Mediante la valutazione pianificata, l’organizzazione IMS può creare una pianificazione ricorrente per eseguire automaticamente i processi di esportazione.
La valutazione pianificata può essere abilitata per le sandbox con un massimo di cinque (5) criteri di unione per XDM Individual Profile. Se nell’organizzazione sono presenti più di cinque criteri di unione per XDM Individual Profile in un singolo ambiente sandbox non puoi utilizzare la valutazione pianificata.
Effettuando una richiesta POST al /config/schedules
endpoint, puoi creare una pianificazione e includere l’ora specifica in cui attivare la pianificazione.
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "schedule"
Per impostazione predefinita, una pianificazione non è attiva al momento della creazione, a meno che state
proprietà impostata su active
nel corpo della richiesta create (POST). È possibile abilitare una pianificazione (impostare state
a active
) inoltrando una richiesta PATCH al /config/schedules
e l’ID della pianificazione nel percorso.
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "schedule"
È possibile aggiornare la pianificazione effettuando una richiesta PATCH al /config/schedules
e l’ID della pianificazione nel percorso.
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "schedule"
La valutazione su richiesta consente di creare un processo di segmentazione per generare un segmento di pubblico ogni volta che necessario. A differenza della valutazione pianificata, questa si verifica solo quando richiesto e non è ricorrente.
Un processo di segmentazione è un processo asincrono che crea un segmento di pubblico su richiesta. Fa riferimento a una definizione di segmento, nonché a eventuali criteri di unione che controllano come Real-Time Customer Profile unisce attributi sovrapposti tra i frammenti di profilo. Al termine di un processo di segmentazione, puoi raccogliere varie informazioni sul segmento, ad esempio eventuali errori che si sono verificati durante l’elaborazione e le dimensioni finali del pubblico. È necessario eseguire un processo di segmentazione ogni volta che desideri aggiornare il pubblico attualmente idoneo per la definizione del segmento.
Per creare un nuovo processo di segmentazione, devi effettuare una richiesta POST al /segment/jobs
endpoint nella Real-Time Customer Profile API.
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "segment jobs"
È possibile utilizzare id
per un processo di segmento specifico per eseguire una richiesta di ricerca (GET) per visualizzare lo stato corrente del processo.
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "segment jobs"
Quando i processi di segmentazione vengono eseguiti correttamente, il segmentMembership
La mappa viene aggiornata per ogni profilo incluso nel segmento. segmentMembership
memorizza anche eventuali segmenti di pubblico pre-valutati che vengono acquisiti in Platform, consentendo l'integrazione con altre soluzioni come Adobe Audience Manager.
Nell'esempio seguente viene illustrato il segmentMembership
per ogni singolo record di profilo:
{
"segmentMembership": {
"UPS": {
"04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
"timestamp": "2018-04-26T15:52:25+00:00",
"status": "existing"
},
"53cba6b2-a23b-454a-8069-fc41308f1c0f": {
"lastQualificationTime": "2018-04-26T15:52:25+00:00",
"status": "realized"
}
},
"Email": {
"abcd@adobe.com": {
"lastQualificationTime": "2017-09-26T15:52:25+00:00",
"status": "exited"
}
}
}
}
Proprietà | Descrizione |
---|---|
lastQualificationTime |
La marca temporale in cui è stata effettuata l’asserzione di appartenenza al segmento e il profilo è entrato o uscito dal segmento. |
status |
Lo stato di partecipazione al segmento come parte della richiesta corrente. Deve essere uguale a uno dei seguenti valori noti:
|
Qualsiasi appartenenza a un segmento presente in exited
per più di 30 giorni, in base al lastQualificationTime
, sarà soggetto a cancellazione.
È possibile accedere ai risultati di un processo di segmentazione in uno dei due modi seguenti: accedere a singoli profili o esportare un intero pubblico in un set di dati.
Le sezioni seguenti descrivono queste opzioni in modo più dettagliato.
Se conosci il profilo specifico a cui desideri accedere, utilizza Real-Time Customer Profile API. I passaggi completi per accedere ai singoli profili sono disponibili nella sezione Accedere ai dati del profilo cliente in tempo reale utilizzando l’API del profilo esercitazione.
Dopo il completamento di un processo di segmentazione (il valore della status
è "RIUSCITO"), puoi esportare il pubblico in un set di dati in cui è possibile accedervi e agire di conseguenza.
Per esportare il pubblico, sono necessari i seguenti passaggi:
Durante l’esportazione di un pubblico, è necessario creare prima un set di dati di destinazione. È importante che il set di dati sia configurato correttamente per garantire l’esportazione in modo corretto.
Una delle considerazioni chiave è lo schema su cui si basa il set di dati (schemaRef.id
nella richiesta di esempio API (di seguito). Per esportare un segmento, il set di dati deve essere basato su XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union
). Uno schema di unione è uno schema di sola lettura generato dal sistema che aggrega i campi degli schemi che condividono la stessa classe, in questo caso la classe XDM Individual Profile. Per ulteriori informazioni sugli schemi di visualizzazione unione, consulta la Sezione Profilo cliente in tempo reale della guida per gli sviluppatori del registro dello schema.
Esistono due modi per creare il set di dati necessario:
Se disponi già di un set di dati compatibile e conosci il relativo ID, puoi procedere direttamente al passaggio per generazione di profili di pubblico.
Formato API
POST /dataSets
Richiesta
La richiesta seguente crea un nuovo set di dati, fornendo i parametri di configurazione nel payload.
curl -X POST \
https://platform.adobe.io/data/foundation/catalog/dataSets \
-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 '{
"name": "Segment Export",
"schemaRef": {
"id": "https://ns.adobe.com/xdm/context/profile__union",
"contentType": "application/vnd.adobe.xed+json;version=1"
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome descrittivo del set di dati. |
schemaRef.id |
ID della visualizzazione unione (schema) a cui verrà associato il set di dati. |
Risposta
In caso di esito positivo, la risposta restituisce un array contenente l’ID univoco di sola lettura generato dal sistema per il set di dati appena creato. Per esportare correttamente i membri del pubblico è necessario un ID set di dati configurato correttamente.
[
"@/datasets/5b020a27e7040801dedba61b"
]
Una volta che hai un set di dati persistente nell’unione, puoi creare un processo di esportazione per rendere persistenti i membri del pubblico nel set di dati effettuando una richiesta POST al /export/jobs
endpoint nella Real-Time Customer Profile e fornendo l’ID del set di dati e le informazioni sul segmento per i segmenti che desideri esportare.
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "export jobs"
Durante l’elaborazione di un processo di esportazione, puoi monitorarne lo stato effettuando una richiesta GET al /export/jobs
e che include id
del processo di esportazione nel percorso. Il processo di esportazione viene completato una volta che status
restituisce il valore "SUCCESSEDED".
Informazioni più dettagliate sull’utilizzo di questo endpoint sono disponibili nella sezione guida dell’endpoint "export jobs"
Una volta completata correttamente l’esportazione, i dati sono disponibili all’interno di Data Lake in Experience Platform. È quindi possibile utilizzare Data Access API per accedere ai dati utilizzando batchId
associato all’esportazione. A seconda delle dimensioni del segmento, i dati possono essere in blocchi e il batch può essere costituito da diversi file.
Per istruzioni dettagliate su come utilizzare il Data Access API per accedere e scaricare i file batch, seguire la Tutorial sull’accesso ai dati.
Puoi anche accedere ai dati dei segmenti esportati correttamente utilizzando Adobe Experience Platform Query Service. Utilizzando l’interfaccia utente o l’API RESTful, Query Service consente di scrivere, convalidare ed eseguire query sui dati all'interno di Data Lake.
Per ulteriori informazioni su come eseguire query sui dati del pubblico, consulta la documentazione su Query Service.