Prévisualisations et estimations des points de terminaison

Au fur et à mesure que vous développez une définition de segment, vous pouvez utiliser les outils d’estimation et de prévisualisation dans Adobe Experience Platform pour vue des informations de synthèse afin de vous assurer que vous isolez l’audience que vous attendez.

  • Les prévisualisations fournissent des listes paginées des profils admissibles pour une définition de segment, ce qui vous permet de comparer les résultats avec vos attentes.

  • Les estimations fournissent des informations statistiques sur une définition de segment, telles que la taille d’audience estimée, l’intervalle de confiance et l’écart-type d’erreur.

REMARQUE

Pour accéder à des mesures similaires liées aux données du Profil client en temps réel, telles que le nombre total de fragments de profil et de profils fusionnés dans des espaces de nommage spécifiques ou la banque de données de Profil dans son ensemble, consultez le guide de point de terminaison prévisualisation de profil (exemple d’état de prévisualisation), qui fait partie du guide de développement d’API de Profil.

Prise en main

Les points de terminaison utilisés dans ce guide font partie de l'API Adobe Experience Platform Segmentation Service. Avant de continuer, consultez le guide de prise en main pour obtenir des informations importantes que vous devez connaître pour pouvoir invoquer l'API, y compris les en-têtes requis et pour savoir comment lire des exemples d'appels d'API.

Comment sont générées les estimations

Lorsque l'ingestion d'enregistrements dans le magasin de Profils augmente ou diminue le nombre total de profils de plus de 5 %, une tâche d'échantillonnage est déclenchée pour mettre à jour le nombre. La façon dont l’échantillonnage des données est déclenché dépend de la méthode d’assimilation :

  • Importation par lot : Pour l'assimilation par lot, dans les 15 minutes suivant l'assimilation réussie d'un lot dans le magasin de Profils, si le seuil de 5 % d'augmentation ou de diminution est atteint, une tâche est exécutée pour mettre à jour le décompte.
  • assimilation en flux continu : Pour les workflows de données en flux continu, une vérification est effectuée sur une base horaire afin de déterminer si le seuil de 5 % d’augmentation ou de diminution a été atteint. Si tel est le cas, une tâche est automatiquement déclenchée pour mettre à jour le décompte.

La taille d’échantillon de l’analyse dépend du nombre total d’entités présentes dans votre magasin de profils. Ces tailles d’échantillon sont représentées dans le tableau suivant :

Entités dans la banque de profils Taille de l’échantillon
Moins de 1 million Jeu de données complet
1 à 20 millions 1 million
Plus de 20 millions 5 % du total
REMARQUE

Les estimations prennent généralement entre 10 et 15 secondes à s'exécuter, en commençant par une estimation approximative et à être affinées au fur et à mesure que les enregistrements sont lus.

Création d’une nouvelle prévisualisation

Vous pouvez créer une nouvelle prévisualisation en effectuant une requête POST au point de terminaison /preview.

REMARQUE

Une tâche d’estimation est automatiquement créée lorsqu’une tâche de prévisualisation est créée. Ces deux tâches partagent le même ID.

Format d’API

POST /preview

Requête

curl -X POST https://platform.adobe.io/data/core/ups/preview \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
    {
        "predicateExpression": "xEvent.metrics.commerce.abandons.value > 0",
        "predicateType": "pql/text",
        "predicateModel": "_xdm.context.profile"
    }'
Propriété Description
predicateExpression L’expression PQL qui servira à effectuer la requête sur les données.
predicateType Type de prédicat pour l'expression de requête sous predicateExpression. Actuellement, la seule valeur acceptée pour cette propriété est pql/text.
predicateModel Nom de la classe de schéma Experience Data Model (XDM) sur laquelle reposent les données du profil.

Réponse

Une réponse réussie renvoie un état HTTP 201 (Created) avec les détails de la prévisualisation que vous venez de créer.

{
    "state": "NEW",
    "previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
    "previewQueryStatus": "NEW",
    "previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
    "previewExecutionId": 0
}
Propriété Description
state L’état actuel de la tâche de prévisualisation. Lors de sa création initiale, il sera à l’état "NOUVEAU". Par la suite, il sera à l’état "EN COURS" jusqu’à ce que le traitement soit terminé, puis devient "RESULT_READY" ou "FAILED".
previewId ID de la tâche de prévisualisation, à utiliser à des fins de recherche lors de l’affichage d’une estimation ou d’une prévisualisation, comme indiqué dans la section suivante.

Récupérer les résultats d'une prévisualisation spécifique

Vous pouvez récupérer des informations détaillées sur une prévisualisation spécifique en adressant une demande de GET au point de terminaison /preview et en indiquant l’identifiant de prévisualisation dans le chemin d’accès de la demande.

Format d’API

GET /preview/{PREVIEW_ID}
Paramètre Description
{PREVIEW_ID} Valeur previewId de la prévisualisation à récupérer.

Requête

curl -X GET https://platform.adobe.io/data/core/ups/preview/MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec des informations détaillées sur la prévisualisation spécifiée.

{
   "results": [{
        "XID_ADOBE-MARKETING-CLOUD-ID-1": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1",
            "endCustomerIds": {
                "XID_COOKIE_ID_1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_1"
                },
                "XID_PROFILE_ID_1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_1"
                }
            }
        }
    },
    {
        "XID_COOKIE-ID-2": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE-ID-2",
            "endCustomerIds": {
                "XID_COOKIE_ID_2-1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_2-1"

                },
                "XID_PROFILE_ID_2": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_2"
                }
            }
        },
        "XID_ADOBE-MARKETING-CLOUD-ID-3": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1000"
        }
    }],
    "state": "RESULT_READY",
    "links": {
        "_self": "https://platform.adobe.io/data/core/ups/preview?expression=<expr-1>&limit=1000",
        "next": "",
        "prev": ""
    },
    "page": {
        "offset": 0,
        "size": 3
    }
}
Propriété Description
results Liste d’identifiants d’entité, ainsi que de leurs identités associées. Les liens fournis peuvent être utilisés pour rechercher les entités spécifiées, à l'aide du point de terminaison de l'API d'accès au profil.

Récupération des résultats d’une tâche d’estimation spécifique

Une fois que vous avez créé une tâche de prévisualisation, vous pouvez utiliser previewId dans le chemin d'une demande de GET vers le point de terminaison /estimate pour obtenir des informations statistiques sur la définition de segment, y compris la taille estimée de l'audience, l'intervalle de fiabilité et l'écart type d'erreur.

Format d’API

GET /estimate/{PREVIEW_ID}
Paramètre Description
{PREVIEW_ID} Une tâche d’estimation n’est déclenchée que lorsqu’une tâche de prévisualisation est créée et que les deux tâches partagent la même valeur d’ID à des fins de recherche. Plus précisément, il s’agit de la valeur previewId renvoyée lors de la création de la tâche de prévisualisation.

Requête

La requête suivante récupère les résultats d’une tâche d’estimation spécifique.

curl -X GET https://platform.adobe.io/data/core/ups/estimate/MDoyOjRhNDVlODUzLWFjOTEtNGJiNy1hNDI2LTE1MDkzN2I2YWY1Yzo0Mg \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec des détails concernant la tâche d’estimation.

{
    "estimatedSize": 4275,
    "numRowsToRead": 4275,
    "estimatedNamespaceDistribution": [
        {
            "namespaceId": "4",
            "profilesMatchedSoFar": 35
        },
        {
            "namespaceId": "6",
            "profilesMatchedSoFar": 4275
        }
    ],
    "state": "RESULT_READY",
    "profilesReadSoFar": 4275,
    "standardError": 0,
    "error": {
        "description": "",
        "traceback": ""
    },
    "profilesMatchedSoFar": 4275,
    "totalRows": 4275,
    "confidenceInterval": "95%",
    "_links": {
        "preview": "https://platform.adobe.io/data/core/ups/preview/app-32be0328-3f31-4b64-8d84-acd0c4fbdad3/execution/0?previewQueryId=e890068b-f5ca-4a8f-a6b5-af87ff0caac3"
    }
}
Propriété Description
estimatedNamespaceDistribution Tableau d’objets indiquant le nombre de profils dans le segment ventilé par espace de nommage d’identité. Le nombre total de profils par espace de nommage (additionnant les valeurs affichées pour chaque espace de nommage) peut être supérieur à la mesure Nombre de profils, car un profil peut être associé à plusieurs espaces de nommage. Par exemple, si un client interagit avec votre marque sur plusieurs canaux, plusieurs espaces de nommage sont associés à ce client individuel.
state L’état actuel de la tâche de prévisualisation. L’état sera "EN COURS" jusqu’à ce que le traitement soit terminé, puis devient "RESULT_READY" ou "FAILED".
_links.preview Si state est "RESULT_READY", ce champ fournit une URL pour vue de l'estimation.

Étapes suivantes

Après avoir lu ce guide, vous devez mieux comprendre comment utiliser les prévisualisations et les estimations à l’aide de l’API de segmentation. Pour savoir comment accéder aux mesures liées à vos données de Profil client en temps réel, telles que le nombre total de fragments de profil et de profils fusionnés dans des espaces de nommage spécifiques ou la banque de données de Profil dans son ensemble, consultez le guide de la prévisualisation de profil (/previewsamplestatus) .

Sur cette page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now