Évaluation et accès aux résultats de segmentation

Ce document fournit un didacticiel pour évaluer les segments et accéder aux résultats des segments à l'aide de Segmentation API.

Prise en main

Ce didacticiel nécessite une bonne compréhension des différents services Adobe Experience Platform impliqués dans la création de segments d'audience. Avant de commencer ce tutoriel, veuillez consulter la documentation relative aux services suivants :

• Real-time Customer Profile: Fournit un profil client unifié en temps réel basé sur des données agrégées provenant de plusieurs sources.
• Adobe Experience Platform Segmentation Service: Permet de créer des segments d’audience à partir de Real-time Customer Profile données.
• Experience Data Model (XDM): Cadre normalisé selon lequel la plate-forme organise les données d’expérience client.
• Sandbox : Experience Platform fournit des sandbox virtuels qui partitionnent une Platform instance unique en environnements virtuels distincts pour aider à développer et à développer des applications d'expérience numérique.

En-têtes requis

Ce tutoriel exige aussi que vous ayez terminé le tutoriel sur l’authentification pour passer des appels à des API Platform Le tutoriel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’API Experience Platform, comme indiqué ci-dessous :

• Authorization: Bearer {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {IMS_ORG}

Toutes les ressources de Experience Platform sont isolées dans des sandbox virtuels spécifiques. Les requêtes d'API Platform nécessitent un en-tête spécifiant le nom du sandbox dans lequel l'opération aura lieu :

• x-sandbox-name: {SANDBOX_NAME}

Toutes les requêtes POST, PUT et PATCH requièrent un en-tête supplémentaire :

• Content-Type: application/json

Évaluation d’un segment

Une fois que vous avez développé, testé et enregistré votre définition de segment, vous pouvez ensuite évaluer le segment soit par une évaluation planifiée soit par l’évaluation sur demande.

L’évaluation planifiée (également appelée « segmentation planifiée ») vous permet de créer un planning récurrent pour exécuter une tâche d’exportation à un moment précis, tandis que l’évaluation sur demande implique la création d’une tâche de segmentation pour créer immédiatement l’audience. Les étapes à suivre pour chaque type d’évaluation sont décrites ci-dessous.

Si vous n'avez pas encore terminé la création d'un segment à l'aide du didacticiel de l'API de segmentation](./create-a-segment.md) ou créé une définition de segment à l'aide du Créateur de segments, faites-le avant de suivre ce didacticiel.[

Évaluation planifiée

L’évaluation planifiée permet à votre organisation IMS de créer un planning récurrent pour exécuter automatiquement les tâches d’exportation.

Création d’un planning

En effectuant une requête POST sur le point de terminaison /config/schedules, vous pouvez créer un planning et inclure l’heure spécifique à laquelle le planning doit être déclenché.

Pour plus d'informations sur l'utilisation de ce point de terminaison, consultez le guide du point de terminaison des planifications.

Activation d’un planning

Par défaut, un planning est inactif lors de la création, sauf si la propriété state est définie sur active dans le corps de la requête de création (POST). Vous pouvez activer un planning (définissez state sur active) en effectuant une requête PATCH sur le point de terminaison /config/schedules et en incluant l’identifiant du planning dans le chemin.

Pour plus d'informations sur l'utilisation de ce point de terminaison, consultez le guide du point de terminaison des planifications.

Mise à jour de l’heure du planning

Vous pouvez mettre à jour l’heure du planning en effectuant une requête PATCH sur le point de terminaison /config/schedules et en incluant l’identifiant du planning dans le chemin.

Pour plus d'informations sur l'utilisation de ce point de terminaison, consultez le guide du point de terminaison des planifications.

Évaluation sur demande

L’évaluation sur demande vous permet de créer une tâche de segmentation afin de générer un segment ciblé chaque fois que vous en avez besoin. Contrairement à l’évaluation planifiée, celle-ci n’a lieu que sur demande et n’est pas récurrente.

Création d’une tâche de segmentation

Une tâche de segmentation est un processus asynchrone qui crée un nouveau segment ciblé. Il fait référence à une définition de segment, ainsi qu’à toute stratégie de fusion contrôlant la manière dont Real-time Customer Profile fusionne des 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.

Vous pouvez créer une tâche de segmentation en exécutant une requête POST sur le point de terminaison /segment/jobs dans l’API Real-time Customer Profile

Vous trouverez des informations plus détaillées sur l’utilisation de ce point de terminaison dans le guide des points de terminaison des tâches de segment.

Recherche de l’état de la tâche de segmentation

Vous pouvez utiliser l’id pour une tâche de segmentation spécifique afin d’effectuer une requête de recherche (GET) pour afficher l’état actuel de la tâche.

Vous trouverez des informations plus détaillées sur l’utilisation de ce point de terminaison dans le guide des points de terminaison des tâches de segment.

Interprétation des résultats de segmentation

Lorsque les tâches de segmentation sont exécutées avec succès, le mappage segmentMembership est mis à jour pour chaque profil inclus dans le segment. segmentMembership stocke également tous les segments d’audience préévalués qui sont assimilés Platform, ce qui permet l’intégration à d’autres solutions, telles que Adobe Audience Managerles solutions.

L’exemple suivant illustre l’attribut segmentMembership pour chaque enregistrement de profil individuel :

{
  "segmentMembership": {
    "UPS": {
      "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
        "timestamp": "2018-04-26T15:52:25+00:00",
        "status": "existing"
      },
      "53cba6b2-a23b-454a-8069-fc41308f1c0f": {
        "lastQualificationTime": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      }
    },
    "Email": {
      "abcd@adobe.com": {
        "lastQualificationTime": "2017-09-26T15:52:25+00:00",
        "status": "exited"
      }
    }
  }
}

Accès aux résultats de segmentation

Vous pouvez accéder aux résultats d’une tâche de segmentation de deux manières : en accédant aux profils individuels ou en exportant une audience entière vers un jeu de données.

Les sections suivantes décrivent ces options de manière plus détaillée.

Recherche d’un profil

Si vous connaissez le profil spécifique auquel vous souhaitez accéder, vous pouvez le faire à l'aide de l'API Real-time Customer Profile. Toutes les étapes pour accéder aux profils individuels sont disponibles dans le tutoriel sur l’accès aux données de Real-time Customer Profile à l’aide de l’API Profile.

Exportation d’un segment

Une fois la tâche de segmentation terminée (la valeur de l’attribut status correspond à "SUCCEEDED"), vous pouvez exporter votre audience vers un jeu de données permettant son accès et son utilisation.

Les étapes suivantes sont requises pour exporter votre audience :

• Création d’un jeu de données cible : créez le jeu de données permettant de contenir les membres de l’audience.
• Génération de profils d’audience dans le jeu de données : renseignez le jeu de données avec des profils individuels XDM en fonction des résultats d’une tâche de segmentation.
• Contrôle de la progression de l’exportation : vérifiez la progression actuelle du processus d’exportation.
• Lecture des données d’audience : récupérez les profils individuels XDM obtenus représentant les membres de votre audience.

Création d’un jeu de données cible

Lors de l’exportation d’une audience, un jeu de données cible doit d’abord être créé. Il est important que le jeu de données soit correctement configuré pour garantir la réussite de l’exportation.

Le schéma sur lequel repose le jeu de données est l’une des principales considérations (schemaRef.id dans l’exemple de requête API ci-dessous). Pour exporter un segment, le jeu de données doit être basé sur le XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union). Un schéma d’union est un schéma en lecture seule généré par le système regroupant les champs des schémas qui partagent la même classe, dans ce cas précis, la classe XDM Individual Profile. Pour plus d’informations sur la vue d’union des schémas, consultez la section Real-time Customer Profile du guide de développement du registre des schémas.

Il existe deux manières de créer le jeu de données nécessaire :

• Utilisation des API : les étapes qui suivent dans ce didacticiel expliquent comment créer un jeu de données qui fait référence à l’ XDM Individual Profile Union Schema utilisation de l’ Catalog API.
• Utilisation de l’interface utilisateur : Pour utiliser l’interface Adobe Experience Platform utilisateur pour créer un jeu de données qui référence le schéma d’union, suivez les étapes du didacticiel de l’interface utilisateur, puis revenez à ce didacticiel pour passer à la procédure de génération de profils d’audience.

Si vous disposez déjà d’un jeu de données compatible et que vous connaissez son identifiant, vous pouvez passer directement à l’étape de génération de profils.

Format d’API

POST /dataSets

Requête

La requête suivante crée un jeu de données et fournit des paramètres de configuration dans le payload.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "Segment Export",
    "schemaRef": {
        "id": "https://ns.adobe.com/xdm/context/profile__union",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    },
    "fileDescription": {
        "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    }
}'

Réponse

Une réponse réussie renvoie un tableau contenant l’ID unique et en lecture seule généré par le système du jeu de données que vous venez de créer. Un identifiant de jeu de données correctement configuré est nécessaire pour exporter les membres de l’audience.

[
  "@/datasets/5b020a27e7040801dedba61b"
] 

Génération de profils pour les membres de l’audience

Une fois que vous disposez d’un jeu de données d’union persistant, vous pouvez créer une tâche d’exportation afin de conserver les membres de l’audience dans le jeu de données, en effectuant une requête POST sur le point de terminaison /export/jobs dans l’API et en fournissant l’identifiant du jeu de données et les informations sur les segments que vous souhaitez exporter.Real-time Customer Profile

Vous trouverez des informations plus détaillées sur l'utilisation de ce point de terminaison dans le guide du point de terminaison des tâches d'exportation.

Contrôle de la progression de l’exportation

Lorsqu’une tâche d’exportation est en cours de traitement, vous pouvez contrôler son état en effectuant une requête GET sur le point de terminaison /export/jobs et en incluant l’id de la tâche d’exportation dans le chemin. La tâche d’exportation est terminée lorsque le champ status renvoie la valeur "SUCCEEDED".

Vous trouverez des informations plus détaillées sur l'utilisation de ce point de terminaison dans le guide du point de terminaison des tâches d'exportation.

Étapes suivantes

Une fois l'exportation terminée, vos données sont disponibles dans Data Lake dans Experience Platform. Vous pouvez ensuite utiliser Data Access API pour accéder aux données à l'aide de batchId associé à l'exportation. Selon la taille du segment, les données peuvent se présenter sous forme de blocs et le lot peut être constitué de plusieurs fichiers.

Pour obtenir des instructions détaillées sur l'utilisation de l'API Data Access pour accéder aux fichiers de commandes et les télécharger, suivez le didacticiel d'accès aux données.

Vous pouvez également accéder aux données de segment exportées avec succès à l’aide de Adobe Experience Platform Query Service. En utilisant l'interface utilisateur ou l'API RESTful, Query Service vous permet d'écrire, de valider et d'exécuter des requêtes sur des données dans Data Lake.

Pour plus d'informations sur la façon de requête des données d'audience, veuillez consulter la documentation sur Query Service.