Endpoint "audience"
Un pubblico è una raccolta di persone che condividono comportamenti e/o caratteristiche simili. Queste raccolte di persone possono essere generate utilizzando Adobe Experience Platform o da origini esterne. È possibile utilizzare /audiences
nell’API di segmentazione, che consente di recuperare, creare, aggiornare ed eliminare in modo programmatico i tipi di pubblico.
Introduzione
Gli endpoint utilizzati in questa guida fanno parte del Adobe Experience Platform Segmentation Service API. Prima di continuare, controlla guida introduttiva per informazioni importanti che devi conoscere per effettuare correttamente chiamate all’API, incluse le intestazioni richieste e la lettura di esempi di chiamate API.
Recuperare un elenco di tipi di pubblico list
Per recuperare un elenco di tutti i tipi di pubblico per la tua organizzazione, devi effettuare una richiesta GET al /audiences
endpoint.
Formato API
Il /audiences
l’endpoint supporta diversi parametri di query per aiutare a filtrare i risultati. Anche se questi parametri sono facoltativi, si consiglia vivamente di utilizzarli per ridurre i costi comuni quando si elencano le risorse. Se effettui una chiamata a questo endpoint senza parametri, verranno recuperati tutti i tipi di pubblico disponibili per la tua organizzazione. È possibile includere più parametri, separati da e commerciali (&
).
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
Durante il recupero di un elenco di tipi di pubblico è possibile utilizzare i seguenti parametri di query:
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
.sort=updateTime:desc
property
property=
property=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
Richiesta
La richiesta seguente recupera gli ultimi due tipi di pubblico creati nell’organizzazione.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con un elenco di tipi di pubblico creati nell’organizzazione come JSON.
code language-json |
---|
|
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 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 | ||
---|---|---|
Proprietà | Tipo di pubblico | Descrizione |
id |
Entrambi | Identificatore di sola lettura generato dal sistema per il pubblico. |
audienceId |
Entrambi | Se il pubblico è generato da Platform, è lo stesso valore del pubblico id . Se il pubblico è generato esternamente, questo valore viene fornito dal client. |
schema |
Entrambi | Lo schema Experience Data Model (XDM) del pubblico. |
imsOrgId |
Entrambi | ID dell’organizzazione a cui appartiene il pubblico. |
sandbox |
Entrambi | Informazioni sulla sandbox a cui appartiene il pubblico. Ulteriori informazioni sulle sandbox sono disponibili nella sezione panoramica sulle sandbox. |
name |
Entrambi | Il nome del pubblico. |
description |
Entrambi | Una descrizione del pubblico. |
expression |
Generato da piattaforma | L’espressione PQL (Profile Query Language) del pubblico. Ulteriori informazioni sulle espressioni PQL sono disponibili nella sezione Guida alle espressioni PQL. |
mergePolicyId |
Generato da piattaforma | ID del criterio di unione a cui è associato il pubblico. Ulteriori informazioni sui criteri di unione sono disponibili nella sezione guida ai criteri di unione. |
evaluationInfo |
Generato da piattaforma | Mostra come verrà valutato il pubblico. I possibili metodi di valutazione includono batch, sincrono (streaming) o continuo (edge). Ulteriori informazioni sui metodi di valutazione sono disponibili nella sezione panoramica sulla segmentazione |
dependents |
Entrambi | Un array di ID di pubblico che dipendono dal pubblico corrente. Questa opzione è utile per creare un pubblico che è un segmento di un segmento. |
dependencies |
Entrambi | Un array di ID di pubblico da cui dipende il pubblico. Questa opzione è utile per creare un pubblico che è un segmento di un segmento. |
type |
Entrambi | Campo generato dal sistema che indica se il pubblico è generato da Platform o da un pubblico generato esternamente. I valori possibili includono SegmentDefinition e ExternalSegment . A SegmentDefinition fa riferimento a un pubblico generato in Platform, mentre un ExternalSegment fa riferimento a un pubblico non generato in Platform. |
originName |
Entrambi | Campo che fa riferimento al nome dell’origine del pubblico. Per il pubblico generato da Platform, questo valore sarà REAL_TIME_CUSTOMER_PROFILE . Per i tipi di pubblico generati in Audience Orchestration, questo valore sarà AUDIENCE_ORCHESTRATION . Per i tipi di pubblico generati in Adobe Audience Manager, questo valore sarà AUDIENCE_MANAGER . Per altri tipi di pubblico generati esternamente, questo valore sarà CUSTOM_UPLOAD . |
createdBy |
Entrambi | ID dell’utente che ha creato il pubblico. |
labels |
Entrambi | Etichette di controllo dell’accesso basate su attributi e utilizzo dati a livello di oggetto rilevanti per il pubblico. |
namespace |
Entrambi | Lo spazio dei nomi a cui appartiene il pubblico. I valori possibili includono AAM , AAMSegments , AAMTraits , e AEPSegments . |
linkedAudienceRef |
Entrambi | Oggetto che contiene identificatori di altri sistemi relativi al pubblico. |
Creare un nuovo pubblico create
Per creare un nuovo pubblico, devi effettuare una richiesta POST al /audiences
endpoint.
Formato API
POST /audiences
Richiesta
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Richiesta di esempio per la creazione di un pubblico generato da Platform | ||||||||||||||||||||
|
accordion | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Richiesta di esempio per la creazione di un pubblico generato esternamente | ||||||||||||||||||||||||||||
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni sul pubblico appena creato.
accordion | ||
---|---|---|
Una risposta di esempio durante il recupero di un pubblico generato da Platform. | ||
|
accordion | ||
---|---|---|
Una risposta di esempio durante il recupero di un pubblico generato esternamente. | ||
|
Aggiornare un campo in un pubblico update-field
Puoi aggiornare i campi di un pubblico specifico effettuando una richiesta PATCH al /audiences
e fornendo l’ID del pubblico da aggiornare nel percorso della richiesta.
Formato API
PATCH /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
ed è non il audienceId
campo.Richiesta
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Proprietà | Descrizione |
op |
Per aggiornare il pubblico, questo valore è sempre add . |
path |
Percorso del campo da aggiornare. |
value |
Il valore a cui desideri aggiornare il campo. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni sul pubblico appena aggiornato.
code language-json |
---|
|
Aggiornare un pubblico put
Per aggiornare (sovrascrivere) un pubblico specifico, devi effettuare una richiesta PUT al /audiences
e fornendo l’ID del pubblico da aggiornare nel percorso della richiesta.
Formato API
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
ed è non il audienceId
campo.Richiesta
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Proprietà | Descrizione |
audienceId |
ID del pubblico. Per i tipi di pubblico generati esternamente, questo valore può essere fornito dall’utente. |
name |
Il nome del pubblico. |
namespace |
Lo spazio dei nomi per il pubblico. |
description |
Una descrizione del pubblico. |
type |
Campo generato dal sistema che indica se il pubblico è generato da Platform o da un pubblico generato esternamente. I valori possibili includono SegmentDefinition e ExternalSegment . A SegmentDefinition fa riferimento a un pubblico generato in Platform, mentre un ExternalSegment fa riferimento a un pubblico non generato in Platform. |
lifecycleState |
Stato del pubblico. I valori possibili includono draft , published , e inactive . draft rappresenta quando viene creato il pubblico, published quando viene pubblicato il pubblico e inactive quando il pubblico non è più attivo. |
datasetId |
ID del set di dati in cui è possibile trovare i dati sul pubblico. |
labels |
Etichette di controllo dell’accesso basate su attributi e utilizzo dati a livello di oggetto rilevanti per il pubblico. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli del pubblico appena aggiornato. Tieni presente che i dettagli del pubblico variano a seconda che si tratti di un pubblico generato da Platform o da un pubblico generato esternamente.
code language-json |
---|
|
Eliminare un pubblico delete
Per eliminare un pubblico specifico, devi effettuare una richiesta DELETE al /audiences
e fornendo l’ID del pubblico da eliminare nel percorso della richiesta.
Formato API
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
ed è non il audienceId
campo.Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 204 senza messaggio.
Recuperare più tipi di pubblico bulk-get
Per recuperare più tipi di pubblico, devi effettuare una richiesta POST al /audiences/bulk-get
e fornendo gli ID dei tipi di pubblico da recuperare.
Formato API
POST /audiences/bulk-get
Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 207 con le informazioni relative ai tipi di pubblico richiesti.
code language-json |
---|
|
Passaggi successivi
Dopo aver letto questa guida, ora hai una migliore comprensione di come creare, gestire ed eliminare i tipi di pubblico utilizzando l’API di Adobe Experience Platform. Per ulteriori informazioni sulla gestione dell'audience tramite l'interfaccia utente, leggi guida all’interfaccia utente di segmentazione.