Point d’entrée des tâches de segmentation
Une tâche de segmentation est un processus asynchrone qui crée un segment d’audience à la demande. Elle fait référence à une définition de segment, ainsi qu’à toute politique de fusion qui contrôle la manière dont Real-Time Customer Profile fusionne les attributs qui se chevauchent dans vos fragments de profil. Lorsqu’une tâche de segmentation se termine avec succès, vous pouvez collecter diverses informations sur le segment, telles que les erreurs qui se sont produites au cours du traitement et la taille finale de votre audience.
Ce guide fournit des informations pour vous aider à mieux comprendre les tâches de segmentation et inclut des exemples d’appels API pour exécuter des actions de base à l’aide de l’API.
Prise en main
Les points d’entrée utilisés dans ce guide font partie de l’API Adobe Experience Platform Segmentation Service. Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître afin d’effectuer avec succès des appels vers l’API, y compris les en-têtes requis et la manière de lire des exemples d’appels API.
Obtention d’une liste de tâches de segmentation retrieve-list
Vous pouvez récupérer une liste de toutes les tâches de segmentation pour votre organisation en envoyant une requête GET au point d’entrée /segment/jobs
.
Format d’API
Le point d’entrée /segment/jobs
prend en charge plusieurs paramètres de requête pour vous aider à filtrer vos résultats. Bien que ces paramètres soient facultatifs, leur utilisation est vivement recommandée pour réduire les frais généraux élevés. Si vous effectuez un appel à ce point d’entrée sans paramètre, toutes les tâches d’exportation disponibles pour votre organisation sont récupérées. Plusieurs paramètres peuvent être inclus et séparés par des esperluettes (&
).
GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
Paramètres de requête
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
Paramètre | Description | Exemple |
start |
Spécifie le décalage de départ pour les tâches de segmentation renvoyées. | start=1 |
limit |
Spécifie le nombre de tâches de segmentation renvoyées par page. | limit=20 |
status |
Filtre les résultats selon l’état. Les valeurs prises en charge sont : NEW (nouveau), QUEUED (file d’attente), PROCESSING (traitement en cours), SUCCEEDED (réussite), FAILED (échec), CANCELLING (annulation en cours), CANCELLED (annulé). | status=NEW |
sort |
Commande les tâches de segmentation renvoyées. Codé au format `[attributeName]:[desc | asc]`. |
property |
Filtre les tâches de segmentation et obtient des correspondances exactes pour le filtre donné. Peut être codé dans l’un des formats suivants :
|
property=segments~segmentId==workInUS |
Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec une liste de tâches de segmentation pour l’organisation spécifiée au format JSON. Une liste complète de toutes les définitions de segment s’affiche dans l’attribut children.segments
.
code language-json |
---|
|
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 9-row-2 10-row-2 11-row-2 12-row-2 | |
---|---|
Propriété | Description |
id |
Identifiant en lecture seule généré par le système pour la tâche de segmentation. |
status |
Statut actuel de la tâche de segmentation. Les valeurs potentielles du statut comprennent « NEW », « PROCESSING », « CANCELING », « CANCELED », « FAILED » et « SUCCEEDED ». |
segments |
Objet contenant des informations sur les définitions de segment renvoyées dans la tâche de segmentation. |
segments.segment.id |
Identifiant de la définition de segment. |
segments.segment.expression |
Objet contenant des informations sur l’expression de la définition de segment, écrite dans PQL. |
metrics |
Objet contenant des informations de diagnostic sur la tâche de segmentation. |
metrics.totalTime |
Objet contenant des informations sur les heures de début et de fin de la tâche de segmentation, ainsi que la durée totale prise. |
metrics.profileSegmentationTime |
Objet contenant des informations sur les heures de début et de fin de l’évaluation de segmentation, ainsi que la durée totale prise. |
metrics.segmentProfileCounter |
Nombre de profils qualifiés par segment. |
metrics.segmentedProfileByNamespaceCounter |
Le nombre de profils qualifiés pour chaque espace de noms d’identité sur la base de la définition de segment. |
metrics.segmentProfileByStatusCounter |
Nombre de profils pour chaque statut. Les trois statuts pris en charge sont les suivants :
|
metrics.totalProfilesByMergePolicy |
Nombre total de profils fusionnés par politique de fusion. |
Création d’une tâche de segmentation create
Vous pouvez créer une tâche de segmentation en adressant une requête POST au point d’entrée /segment/jobs
et en incluant les identifiants de la définition de segment dans le corps de la requête.
Format d’API
POST /segment/jobs
Requête
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Propriété | Description |
segmentId |
Identifiant de la définition de segment que vous souhaitez évaluer. Ces définitions de segment peuvent appartenir à différentes politiques de fusion. Vous trouverez plus d’informations sur les définitions de segment dans le guide de point d’entrée de définition de segment. |
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations sur la tâche de segmentation que vous venez de créer.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Propriété | Description |
id |
Identifiant en lecture seule généré par le système pour la tâche de segmentation nouvellement créée. |
status |
Statut actuel de la tâche de segmentation. Comme la tâche de segmentation a été créée récemment, le statut sera toujours « NEW ». |
segments |
Objet contenant des informations sur les définitions de segment pour lesquelles cette tâche de segmentation est en cours d’exécution. |
segments.segment.id |
Identifiant de la définition de segment que vous avez fournie. |
segments.segment.expression |
Objet contenant des informations sur l’expression de la définition de segment, écrite dans PQL. |
Récupération d’une tâche de segmentation spécifique get
Vous pouvez récupérer des informations détaillées sur une tâche de segmentation spécifique en adressant une requête GET au point d’entrée /segment/jobs
et en fournissant l’identifiant de la tâche de segmentation que vous souhaitez récupérer dans le chemin de requête.
Format d’API
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
de la tâche de segmentation que vous souhaitez récupérer.Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations détaillées sur la tâche de segmentation spécifiée. Une liste complète de toutes les définitions de segment s’affiche dans l’attribut children.segments
.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Propriété | Description |
id |
Identifiant en lecture seule généré par le système pour la tâche de segmentation. |
status |
Statut actuel de la tâche de segmentation. Les valeurs potentielles du statut comprennent « NEW », « PROCESSING », « CANCELING », « CANCELED », « FAILED » et « SUCCEEDED ». |
segments |
Objet contenant des informations sur les définitions de segment renvoyées dans la tâche de segmentation. |
segments.segment.id |
Identifiant de la définition de segment. |
segments.segment.expression |
Objet contenant des informations sur l’expression de la définition de segment, écrite dans PQL. |
metrics |
Objet contenant des informations de diagnostic sur la tâche de segmentation. |
[!ENDTABS]
Récupération en bloc des tâches de segment bulk-get
Vous pouvez récupérer des informations détaillées sur plusieurs tâches de segmentation en adressant une requête POST au point d’entrée /segment/jobs/bulk-get
et en fournissant les valeurs id
des tâches de segmentation dans le corps de la requête.
Format d’API
POST /segment/jobs/bulk-get
Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie le statut HTTP 207 avec les tâches de segmentation demandées.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Propriété | Description |
id |
Identifiant en lecture seule généré par le système pour la tâche de segmentation. |
status |
Statut actuel de la tâche de segmentation. Les valeurs potentielles du statut comprennent « NEW », « PROCESSING », « CANCELING », « CANCELED », « FAILED » et « SUCCEEDED ». |
segments |
Objet contenant des informations sur les définitions de segment renvoyées dans la tâche de segmentation. |
segments.segment.id |
Identifiant de la définition de segment. |
segments.segment.expression |
Objet contenant des informations sur l’expression de la définition de segment, écrite dans PQL. |
Annulation ou suppression d’une tâche de segmentation spécifique delete
Vous pouvez supprimer une tâche de segmentation spécifique en adressant une requête DELETE au point d’entrée /segment/jobs
et en fournissant l’identifiant de la tâche de segmentation que vous souhaitez supprimer du chemin d’accès de la requête.
Format d’API
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
de la tâche de segmentation que vous souhaitez supprimer.Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 204 avec un corps de réponse vide.
Étapes suivantes
Après avoir lu ce guide, vous comprenez mieux comment fonctionnent les tâches de segmentation.