Endpoint "segment jobs"
Un processo di segmentazione è un processo asincrono che crea un segmento di pubblico su richiesta. Fa riferimento a una definizione segmento, nonché a qualsiasi criterio di unione che controlla come Real-Time Customer Profile unisce attributi sovrapposti nei 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.
Questa guida fornisce informazioni utili per comprendere meglio i processi dei segmenti e include chiamate API di esempio per eseguire azioni di base utilizzando l’API.
Introduzione
Gli endpoint utilizzati in questa guida fanno parte dell'API Adobe Experience Platform Segmentation Service. Prima di continuare, consulta la guida introduttiva per informazioni importanti che devi conoscere per effettuare correttamente chiamate all'API, incluse le intestazioni richieste e la lettura delle chiamate API di esempio.
Recuperare un elenco di processi di segmentazione retrieve-list
Per recuperare un elenco di tutti i processi dei segmenti per l'organizzazione, eseguire una richiesta GET all'endpoint /segment/jobs
.
Formato API
L'endpoint /segment/jobs
supporta diversi parametri di query per filtrare i risultati. Anche se questi parametri sono facoltativi, si consiglia vivamente di utilizzarli per ridurre i costi generali. Effettuando una chiamata a questo endpoint senza parametri, verranno recuperati tutti i processi di esportazione disponibili per la tua organizzazione. È possibile includere più parametri, separati da e commerciali (&
).
GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
Parametri query
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
Parametro | Descrizione | Esempio |
start |
Specifica l'offset iniziale per i processi di segmento restituiti. | start=1 |
limit |
Specifica il numero di processi di segmento restituiti per pagina. | limit=20 |
status |
Filtra i risultati in base allo stato. I valori supportati sono NEW, QUEUED, PROCESSING, SUCCESSEDED, FAILED, CANCELING, CANCELED | status=NEW |
sort |
Ordina i processi segmento restituiti. È scritto nel formato `[attributeName]:[desc | asc]`. |
property |
Filtra i processi di segmentazione e ottiene corrispondenze esatte per il filtro specificato. Può essere scritto in uno dei seguenti formati:
|
property=segments~segmentId==workInUS |
Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con un elenco di processi di segmento per l’organizzazione specificata come JSON. Tuttavia, la risposta sarà diversa, a seconda del numero di definizioni di segmento all’interno del processo di segmentazione.
Se nel processo di segmentazione vengono eseguite meno di 1500 definizioni di segmento, nell'attributo children.segments
verrà visualizzato un elenco completo di tutte le definizioni di segmento.
note note |
---|
NOTE |
La seguente risposta è stata troncata per motivi di spazio e mostrerà solo il primo processo restituito. |
accordion | ||
---|---|---|
Una risposta di esempio durante il recupero di un elenco di processi di segmento. | ||
|
Se nel processo di segmentazione vengono eseguite più di 1500 definizioni di segmento, l'attributo children.segments
visualizzerà *
, indicando che tutte le definizioni di segmento sono in fase di valutazione.
note note |
---|
NOTE |
La seguente risposta è stata troncata per motivi di spazio e mostrerà solo il primo processo restituito. |
accordion | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Una risposta di esempio durante la visualizzazione di un elenco di processi di segmentazione. | ||||||||||||||||||||||||||||||
|
Crea un nuovo processo di segmentazione create
Per creare un nuovo processo di segmentazione, devi eseguire una richiesta POST all'endpoint /segment/jobs
e includere nel corpo l'ID della definizione del segmento da cui desideri creare un nuovo pubblico.
Formato API
POST /segment/jobs
Quando crei un nuovo processo di segmentazione, la richiesta e la risposta variano a seconda del numero di definizioni di segmento all’interno del processo di segmentazione.
Richiesta
accordion | ||||||||
---|---|---|---|---|---|---|---|---|
Richiesta di esempio per la creazione di un nuovo processo di segmentazione | ||||||||
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni sul processo di segmentazione appena creato.
accordion | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Una risposta di esempio durante la creazione di un nuovo processo di segmentazione. | ||||||||||||||||
|
Richiesta
note note |
---|
NOTE |
Anche se è possibile creare un processo di segmentazione con più di 1500 definizioni di segmenti, si tratta di operazione non consigliata. |
accordion | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Richiesta di esempio per la creazione di un processo di segmentazione. | ||||||||||
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con i dettagli del processo di segmentazione appena creato.
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Una risposta di esempio durante la creazione di un processo di segmentazione. | ||||||||||||||
|
Recuperare un processo di segmento specifico get
Per recuperare informazioni dettagliate su un processo di segmentazione specifico, effettua una richiesta di GET all'endpoint /segment/jobs
e fornisci l'ID del processo di segmentazione da recuperare nel percorso della richiesta.
Formato API
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
del processo di segmentazione che si desidera recuperare.Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni dettagliate sul processo di segmentazione specificato. Tuttavia, la risposta varia a seconda del numero di definizioni di segmento all’interno del processo di segmentazione.
Se nel processo di segmentazione vengono eseguite meno di 1500 definizioni di segmento, nell'attributo children.segments
verrà visualizzato un elenco completo di tutte le definizioni di segmento.
accordion | ||
---|---|---|
Risposta di esempio per recuperare un processo di segmentazione. | ||
|
Se nel processo di segmentazione vengono eseguite più di 1500 definizioni di segmento, l'attributo children.segments
visualizzerà *
, indicando che tutte le definizioni di segmento sono in fase di valutazione.
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Risposta di esempio per recuperare un processo di segmentazione. | ||||||||||||||||||
|
Processi di recupero in blocco dei segmenti bulk-get
Per recuperare informazioni dettagliate su più processi di segmentazione, effettua una richiesta POST all'endpoint /segment/jobs/bulk-get
e fornisci i valori id
dei processi di segmentazione nel corpo della richiesta.
Formato API
POST /segment/jobs/bulk-get
Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 207 con i processi di segmento richiesti. Tuttavia, il valore dell'attributo children.segments
varia se il processo di segmentazione è in esecuzione per più di 1500 definizioni di segmenti.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Proprietà | Descrizione |
id |
Identificatore di sola lettura generato dal sistema per il processo di segmentazione. |
status |
Lo stato corrente del processo di segmentazione. I valori potenziali per lo stato includono "NEW", "PROCESSING", "CANCELING", "CANCELED", "FAILED" e "SUCCESSEDED". |
segments |
Oggetto contenente informazioni sulle definizioni dei segmenti restituite all’interno del processo di segmentazione. |
segments.segment.id |
ID della definizione del segmento. |
segments.segment.expression |
Oggetto contenente informazioni sull’espressione della definizione del segmento, scritta in PQL. |
Annullare o eliminare un processo di segmento specifico delete
Per eliminare un processo di segmentazione specifico, devi eseguire una richiesta DELETE all'endpoint /segment/jobs
e fornire l'ID del processo di segmentazione da eliminare nel percorso della richiesta.
Formato API
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
del processo di segmentazione da eliminare.Richiesta
code language-shell |
---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 204 con un corpo di risposta vuoto.
Passaggi successivi
Dopo aver letto questa guida hai acquisito una migliore comprensione del funzionamento dei processi di segmentazione.