Point d’entrée des définitions de segment
Adobe Experience Platform vous permet de créer des définitions de segment qui définissent un groupe d’attributs ou de comportements spécifiques à partir d’un groupe de profils. Une définition de segment est un objet qui encapsule une requête écrite dans Profile Query Language (PQL). Les définitions de segment sont appliquées aux profils pour créer des audiences. Cet objet (définition de segment) est également appelé prédicat PQL. Les prédicats PQL définissent les règles de la définition de segment en fonction des conditions liées à tout enregistrement ou à toute donnée de série temporelle que vous fournissez à Real-Time Customer Profile. Pour plus d’informations sur l’écriture de requêtes PQL, reportez-vous au guide de PQL.
Ce guide fournit des informations pour vous aider à mieux comprendre les définitions de segment et inclut des exemples d’appels API pour effectuer des actions de base à l’aide de l’API.
Commencer
Les points de terminaison 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 comment lire des exemples d’appels API.
Obtention d’une liste de définitions de segment list
Vous pouvez récupérer une liste de toutes les définitions de segment pour votre organisation en envoyant une requête de GET au point de terminaison /segment/definitions
.
Format d’API
Le point d’entrée /segment/definitions
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. Un appel à ce point de terminaison sans paramètre permet de récupérer toutes les définitions de segment disponibles pour votre organisation. Plusieurs paramètres peuvent être inclus et séparés par des esperluettes (&
).
GET /segment/definitions
GET /segment/definitions?{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 |
Indique le décalage de début pour les définitions de segment renvoyées. | start=4 |
limit |
Indique le nombre de définitions de segment renvoyées par page. | limit=20 |
page |
Indique à partir de quelle page commencent les résultats des définitions de segment. | page=5 |
sort |
Indique le champ d’après lequel trier les résultats. Est écrit au format suivant : [attributeName]:[desc/asc] . |
sort=updateTime:desc |
evaluationInfo.continuous.enabled |
Indique si la définition de segment est activée dans le flux. | evaluationInfo.continuous.enabled=true |
Requête
La requête suivante récupère les deux dernières définitions de segment publiées dans votre organisation.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec une liste de définitions de segment pour l’organisation spécifiée sous JSON.
code language-json |
---|
|
Création d’une définition de segment create
Vous pouvez créer une définition de segment en envoyant une requête POST au point d’entrée /segment/definitions
.
Format d’API
POST /segment/definitions
Requête
Lors de la création d’une définition de segment, vous pouvez la créer au format pql/text
ou pql/json
.
accordion | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Exemple de requête pour créer une définition de segment. | ||||||||||||||||||||||
|
accordion | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Exemple de requête pour créer une définition de segment. | ||||||||||||||||||||||
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec les détails de la définition de segment que vous venez de créer.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
Propriété | Description |
id |
Identifiant généré par le système de votre définition de segment nouvellement créée. |
evaluationInfo |
Objet qui indique le type d’évaluation que la définition de segment va subir. Il peut s’agir d’une segmentation par lots, par flux (également appelée continue) ou par périphérie (également appelée synchrone). |
Récupération d’une définition de segment spécifique get
Vous pouvez récupérer des informations détaillées sur une définition de segment spécifique en envoyant une requête GET au point de terminaison /segment/definitions
et en fournissant l’identifiant de la définition de segment que vous souhaitez récupérer dans le chemin d’accès de la requête.
Format d’API
GET /segment/definitions/{SEGMENT_ID}
{SEGMENT_ID}
id
de la définition de segment que vous souhaitez récupérer.Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec les informations détaillées de la définition de segment spécifiée.
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 | |
---|---|
Propriété | Description |
id |
Identifiant en lecture seule généré par le système de la définition de segment. |
name |
Un nom unique qui fait référence à la définition de segment. |
schema |
Schéma associé aux entités du segment. Se compose d’un champ id ou name . |
expression |
Entité contenant des champs d’informations sur la définition de segment. |
expression.type |
Indique le type d’expression. Actuellement, seul « PQL » est pris en charge. |
expression.format |
Indique la structure de l’expression en valeur. Actuellement, le format suivant est pris en charge :
|
expression.value |
Une expression conforme au type indiqué dans expression.format . |
description |
Une description lisible par l’utilisateur de la définition. |
evaluationInfo |
Objet qui indique le type d’évaluation, de lot, de diffusion en continu (également appelé continue) ou de périphérie (également appelé synchrone), auquel la définition de segment sera appliquée. |
Récupération en masse de définitions de segment bulk-get
Vous pouvez récupérer des informations détaillées sur plusieurs définitions de segment spécifiées en envoyant une requête de POST au point de terminaison /segment/definitions/bulk-get
et en fournissant les valeurs id
des définitions de segment dans le corps de la requête.
Format d’API
POST /segment/definitions/bulk-get
Requête
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Propriété | Description |
ids |
Tableau contenant des objets indiquant les identifiants des définitions de segment que vous souhaitez récupérer. |
Réponse
Une réponse réussie renvoie un état HTTP 207 avec les définitions de segment demandées.
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 | |
---|---|
Propriété | Description |
id |
Identifiant en lecture seule généré par le système de la définition de segment. |
name |
Un nom unique qui fait référence à la définition de segment. |
schema |
Schéma associé aux entités du segment. Se compose d’un champ id ou name . |
expression |
Entité contenant des champs d’informations sur la définition de segment. |
expression.type |
Indique le type d’expression. Actuellement, seul « PQL » est pris en charge. |
expression.format |
Indique la structure de l’expression en valeur. Actuellement, le format suivant est pris en charge :
|
expression.value |
Une expression conforme au type indiqué dans expression.format . |
description |
Une description lisible par l’utilisateur de la définition. |
evaluationInfo |
Objet qui indique le type d’évaluation, de lot, de diffusion en continu (également appelé continue) ou de périphérie (également appelé synchrone), auquel la définition de segment sera appliquée. |
Suppression d’une définition de segment spécifique delete
Vous pouvez demander la suppression d’une définition de segment spécifique en envoyant une requête de DELETE au point de terminaison /segment/definitions
et en fournissant l’identifiant de la définition de segment que vous souhaitez supprimer dans le chemin d’accès de la requête.
Format d’API
DELETE /segment/definitions/{SEGMENT_ID}
{SEGMENT_ID}
id
de la définition de segment à supprimer.Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 sans message.
Mise à jour d’une définition de segment spécifique
Vous pouvez mettre à jour une définition de segment spécifique en envoyant une requête de PATCH au point de terminaison /segment/definitions
et en fournissant l’identifiant de la définition de segment que vous souhaitez mettre à jour dans le chemin d’accès de la requête.
Format d’API
PATCH /segment/definitions/{SEGMENT_ID}
{SEGMENT_ID}
id
de la définition de segment à mettre à jour.Requête
La requête suivante mettra à jour le pays de l'adresse de travail des Etats-Unis vers le Canada.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec les détails de la définition de segment que vous venez de mettre à jour.
code language-json |
---|
|
Conversion de la définition de segment
Vous pouvez convertir une définition de segment entre pql/text
et pql/json
ou pql/json
en pql/text
en effectuant une requête de POST vers le point de terminaison /segment/conversion
.
Format d’API
POST /segment/conversion
Requête
La requête suivante changera le format de la définition de segment de pql/text
à pql/json
.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec les détails de la définition de segment que vous venez de convertir.
code language-json |
---|
|
Étapes suivantes
Après avoir lu ce guide, vous comprenez mieux le fonctionnement des définitions de segment. Pour plus d’informations sur la création d’un segment, consultez le tutoriel Création d’un segment .