Endpoint "external audiences"
I tipi di pubblico esterni ti consentono di caricare i dati del profilo da sorgenti esterne in Adobe Experience Platform. È possibile utilizzare l'endpoint /external-audience
nell'API del servizio di segmentazione per acquisire un pubblico esterno in Experience Platform, visualizzare i dettagli e aggiornare i tipi di pubblico esterni, nonché eliminarli.
Introduzione
/core/ais
, invece di /core/ups
.Per utilizzare le API di Experience Platform, è necessario aver completato l'esercitazione sull'autenticazione. Il completamento del tutorial di autenticazione fornisce i valori per ciascuna delle intestazioni richieste nelle chiamate API di Experience Platform, come mostrato di seguito:
- Autorizzazione:
Bearer {ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Tutte le risorse in Experience Platform sono isolate in specifiche sandbox virtuali. Tutte le richieste alle API Experience Platform richiedono un'intestazione che specifichi il nome della sandbox in cui verrà eseguita l'operazione:
- x-sandbox-name:
{SANDBOX_NAME}
Creare un pubblico esterno create-audience
Per creare un pubblico esterno, devi eseguire una richiesta POST all'endpoint /external-audience/
.
Formato API
POST /external-audience/
Richiesta
code language-shell |
---|
|
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 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
name |
Stringa | Il nome del pubblico esterno. |
description |
Stringa | Una descrizione facoltativa per il pubblico esterno. |
customAudienceId |
Stringa | Un identificatore opzionale per il pubblico esterno. |
fields |
Array di oggetti |
L’elenco dei campi e i relativi tipi di dati. Durante la creazione dell’elenco di campi, puoi aggiungere i seguenti elementi:
|
sourceSpec |
Oggetto |
Oggetto contenente le informazioni in cui si trova il pubblico esterno. Quando utilizzi questo oggetto, devi includere le seguenti informazioni:
|
ttlInDays |
Intero | La scadenza dei dati per il pubblico esterno, in giorni. Questo valore può essere impostato da 1 a 90. Per impostazione predefinita, la scadenza dei dati è impostata su 30 giorni. |
audienceType |
Stringa | Il tipo di pubblico per il pubblico esterno. Attualmente, è supportato solo people . |
originName |
Stringa | Obbligatorio L'origine del pubblico. Indica da dove proviene il pubblico. Per i tipi di pubblico esterni, utilizzare CUSTOM_UPLOAD . |
namespace |
Stringa | Lo spazio dei nomi per il pubblico. Per impostazione predefinita, questo valore è impostato su CustomerAudienceUpload . |
labels |
Array di stringhe | Etichette di controllo di accesso applicabili al pubblico esterno. Ulteriori informazioni sulle etichette di controllo di accesso disponibili sono disponibili nel glossario etichette di utilizzo dati. |
tags |
Array di stringhe | I tag che desideri applicare al pubblico esterno. Ulteriori informazioni sui tag sono disponibili nella guida gestione tag. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 202 con i dettagli del pubblico esterno appena creato.
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 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
operationId |
Stringa | ID dell’operazione. Successivamente puoi utilizzare questo ID per recuperare lo stato di creazione del pubblico. |
operationDetails |
Oggetto | Oggetto contenente i dettagli della richiesta inviata per creare il pubblico esterno. |
name |
Stringa | Il nome del pubblico esterno. |
description |
Stringa | Descrizione del pubblico esterno. |
fields |
Array di oggetti | L’elenco dei campi e i relativi tipi di dati. Questo array determina i campi necessari nel pubblico esterno. |
sourceSpec |
Oggetto | Oggetto contenente le informazioni in cui si trova il pubblico esterno. |
ttlInDays |
Intero | La scadenza dei dati per il pubblico esterno, in giorni. Questo valore può essere impostato da 1 a 90. Per impostazione predefinita, la scadenza dei dati è impostata su 30 giorni. |
audienceType |
Stringa | Il tipo di pubblico per il pubblico esterno. |
originName |
Stringa | Obbligatorio L'origine del pubblico. Indica da dove proviene il pubblico. |
namespace |
Stringa | Lo spazio dei nomi per il pubblico. |
labels |
Array di stringhe | Etichette di controllo di accesso applicabili al pubblico esterno. Ulteriori informazioni sulle etichette di controllo di accesso disponibili sono disponibili nel glossario etichette di utilizzo dati. |
Recuperare lo stato di creazione del pubblico retrieve-status
Per recuperare lo stato dell'invio del pubblico esterno, devi eseguire una richiesta GET all'endpoint /external-audiences/operations
e fornire l'ID dell'operazione ricevuta dalla risposta di creazione del pubblico esterno.
Formato API
GET /external-audiences/operations/{OPERATION_ID}
{OPERATION_ID}
id
dell'operazione da recuperare.Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli dello stato delle attività del pubblico esterno.
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 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
operationId |
Stringa | ID dell'operazione da recuperare. |
status |
Stringa | Stato dell'operazione. Può essere uno dei seguenti valori: SUCCESS , FAILED , PROCESSING . |
operationDetails |
Oggetto | Oggetto contenente i dettagli del pubblico. |
audienceId |
Stringa | ID del pubblico esterno che viene inviato dall’operazione. |
createdBy |
Stringa | ID dell’utente che ha creato il pubblico esterno. |
createdAt |
Timestamp dell’epoca lunga | La marca temporale, in secondi, di invio della richiesta di creazione del pubblico esterno. |
updatedBy |
Stringa | ID dell’ultimo utente che ha aggiornato il pubblico. |
updatedAt |
Timestamp dell’epoca lunga | La marca temporale, in secondi, di quando il pubblico è stato aggiornato l’ultima volta. |
Aggiornare un pubblico esterno update-audience
audienceId
del pubblico esterno. Puoi ottenere audienceId
da una chiamata all'endpoint GET /external-audiences/operations/{OPERATION_ID}
riuscita.Per aggiornare i campi del pubblico esterno, devi eseguire una richiesta PATCH all'endpoint /external-audience
e fornire l'ID del pubblico nel percorso della richiesta.
Quando utilizzi questo endpoint, puoi aggiornare i campi seguenti:
- Descrizione del pubblico
- Etichette di controllo dell’accesso a livello di campo
- Etichette di controllo dell’accesso a livello di pubblico
- Scadenza dei dati del pubblico
L'aggiornamento del campo utilizzando questo endpoint sostituisce il contenuto del campo richiesto.
Formato API
PATCH /external-audience/{AUDIENCE_ID}
Richiesta
code language-shell |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
description |
Stringa | Descrizione aggiornata per il pubblico esterno. |
Inoltre, puoi aggiornare i seguenti parametri:
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
labels |
Array | Matrice contenente l’elenco aggiornato delle etichette di accesso per il pubblico. Ulteriori informazioni sulle etichette di controllo di accesso disponibili sono disponibili nel glossario etichette di utilizzo dati. |
fields |
Array di oggetti | Un array contenente i campi e le relative etichette associate per il pubblico esterno. Solo i campi elencati nella richiesta PATCH verranno aggiornati. Ulteriori informazioni sulle etichette di controllo di accesso disponibili sono disponibili nel glossario etichette di utilizzo dati. |
ttlInDays |
Intero | La scadenza dei dati per il pubblico esterno, in giorni. Questo valore può essere impostato da 1 a 90. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli del pubblico esterno aggiornato.
code language-json |
---|
|
Avvia l’acquisizione del pubblico start-audience-ingestion
audienceId
del pubblico esterno. Puoi ottenere audienceId
da una chiamata all'endpoint GET /external-audiences/operations/{OPERATION_ID}
riuscita.Per avviare l’acquisizione di un pubblico, effettua una richiesta POST all’endpoint seguente e specifica l’ID del pubblico.
Formato API
POST /external-audience/{AUDIENCE_ID}/runs
Richiesta
La seguente richiesta attiva un’acquisizione eseguita per il pubblico esterno.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
dataFilterStartTime |
Timestamp epoca | Obbligatorio L'intervallo che specifica l'ora di inizio dell'esecuzione del flusso per selezionare i file da elaborare. |
dataFilterEndTime |
Timestamp epoca | L’intervallo che specifica l’ora di fine in cui il flusso verrà eseguito per selezionare i file da elaborare. |
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con dettagli sull’esecuzione dell’acquisizione.
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 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
audienceName |
Stringa | Il nome del pubblico per il quale stai avviando un’esecuzione di acquisizione. |
audienceId |
Stringa | ID del pubblico. |
runId |
Stringa | ID dell’esecuzione dell’acquisizione avviata. |
differentialIngestion |
Booleano | Campo che determina se l’acquisizione è un’acquisizione parziale in base alla differenza rispetto all’ultima acquisizione o a un’acquisizione completa di pubblico. |
dataFilterStartTime |
Timestamp epoca | L’intervallo che specifica l’ora di inizio dell’esecuzione del flusso per selezionare i file elaborati. |
dataFilterEndTime |
Timestamp epoca | L’intervallo che specifica il tempo finale di esecuzione del flusso per selezionare i file elaborati. |
createdAt |
Timestamp dell’epoca lunga | La marca temporale, in secondi, di invio della richiesta di creazione del pubblico esterno. |
createdBy |
Stringa | ID dell’utente che ha creato il pubblico esterno. |
Recuperare lo stato di acquisizione di un pubblico specifico retrieve-ingestion-status
audienceId
del pubblico esterno che del runId
dell’ID esecuzione dell’acquisizione. Puoi ottenere audienceId
da una chiamata all'endpoint GET /external-audiences/operations/{OPERATION_ID}
e runId
da una precedente chiamata riuscita dell'endpoint POST /external-audience/{AUDIENCE_ID}/runs
.Per recuperare lo stato di un’acquisizione di pubblico, effettua una richiesta GET al seguente endpoint e allo stesso tempo fornisce sia l’ID del pubblico che gli ID di esecuzione.
Formato API
GET /external-audience/{AUDIENCE_ID}/runs/{RUN_ID}
Richiesta
La seguente richiesta recupera lo stato di acquisizione per il pubblico esterno.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con dettagli sull’acquisizione del pubblico esterno.
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 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
audienceName |
Stringa | Il nome del pubblico. |
audienceId |
Stringa | ID del pubblico. |
runId |
Stringa | ID dell’esecuzione dell’acquisizione. |
status |
Stringa | Stato dell’esecuzione dell’acquisizione. Gli stati possibili includono SUCCESS e FAILED . |
differentialIngestion |
Booleano | Campo che determina se l’acquisizione è un’acquisizione parziale in base alla differenza rispetto all’ultima acquisizione o a un’acquisizione completa di pubblico. |
dataFilterStartTime |
Timestamp epoca | L’intervallo che specifica l’ora di inizio dell’esecuzione del flusso per selezionare i file elaborati. |
dataFilterEndTime |
Timestamp epoca | L’intervallo che specifica il tempo finale di esecuzione del flusso per selezionare i file elaborati. |
createdAt |
Timestamp dell’epoca lunga | La marca temporale, in secondi, di invio della richiesta di creazione del pubblico esterno. |
createdBy |
Stringa | ID dell’utente che ha creato il pubblico esterno. |
details |
Array di oggetti |
Oggetto contenente i dettagli dell’esecuzione dell’acquisizione.
|
Elencare esecuzioni dell’acquisizione del pubblico list-ingestion-runs
audienceId
del pubblico esterno. Puoi ottenere audienceId
da una chiamata all'endpoint GET /external-audiences/operations/{OPERATION_ID}
riuscita.Per recuperare tutte le esecuzioni dell’acquisizione per il pubblico esterno selezionato, effettua una richiesta GET al seguente endpoint e fornisci l’ID del pubblico. È possibile includere più parametri, separati da e commerciali (&
).
Formato API
GET /external-audience/{AUDIENCE_ID}/runs
Richiesta
La richiesta seguente recupera tutte le esecuzioni dell’acquisizione per il pubblico esterno.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con un elenco di esecuzioni di acquisizione per il pubblico esterno specificato.
code language-json |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Proprietà | Tipo | Descrizione |
runs |
Oggetto | Oggetto contenente l’elenco delle esecuzioni di acquisizione che appartiene al pubblico. Ulteriori informazioni su questo oggetto sono disponibili nella sezione recupero stato acquisizione. |
Eliminare un pubblico esterno delete-audience
audienceId
del pubblico esterno. Puoi ottenere audienceId
da una chiamata all'endpoint GET /external-audiences/operations/{OPERATION_ID}
riuscita.Per eliminare un pubblico esterno, effettua una richiesta DELETE al seguente endpoint e fornisci l’ID del pubblico.
Formato API
DELETE /external-audience/{AUDIENCE_ID}
Richiesta
La richiesta seguente elimina il pubblico esterno specificato.
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 204 con un corpo di risposta vuoto.
Passaggi successivi next-steps
Dopo aver letto questa guida, ora hai una migliore comprensione di come creare, gestire ed eliminare i tipi di pubblico esterni utilizzando le API di Experience Platform. Per informazioni su come utilizzare i tipi di pubblico esterni con l'interfaccia utente di Experience Platform, consulta la documentazione di Audience Portal.
Appendice appendix
Nella sezione seguente sono elencati i codici di errore disponibili quando si utilizza l’API per tipi di pubblico esterni.
BAD_REQUEST
BAD_REQUEST
UNAUTHORIZED
UNAUTHORIZED
imsOrgId
non valido.UNAUTHORIZED
NOT_FOUND
DUPLICATE_RESOURCE
UNPROCESSABLE_ENTITY
INTERNAL_SERVER_ERROR
BAD_GATEWAY