Show Menu
SUJETS×

Prévisualisations et estimations des points de terminaison

As you develop your segment definition, you can use the estimate and preview tools within Adobe Experience Platform to view summary-level information to help ensure you are isolating the expected audience. 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.

Prise en main

The endpoints used in this guide are part of the Adobe Experience Platform Segmentation Service API. Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including required headers and how to read example API calls.

Comment sont générées les estimations

La façon dont l’échantillonnage des données est déclenché dépend de la méthode d’assimilation.
Pour l’assimilation par lot, le magasin de profils est automatiquement analysé toutes les quinze minutes afin de déterminer si un nouveau lot a été correctement assimilé depuis l’exécution de la dernière tâche d’échantillonnage. Si tel est le cas, le magasin de profils est ensuite analysé pour voir s'il y a eu au moins 5 % de changement dans le nombre d'enregistrements. Si ces conditions sont remplies, une nouvelle tâche d’échantillonnage est déclenchée.
Pour l’assimilation en flux continu, le magasin de profils est automatiquement analysé toutes les heures afin de déterminer s’il y a eu au moins 5 % de changement dans le nombre d’enregistrements. Si cette condition est remplie, une nouvelle tâche d’échantillonnage est déclenchée.
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
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 .
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
The name of the Experience Data Model (XDM) schema the profile data is based on.
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

You can retrieve detailed information about a specific preview by making a GET request to the /preview endpoint and providing the preview ID in the request path.
Format d’API
GET /preview/{PREVIEW_ID}

Paramètre
Description
{PREVIEW_ID}
The previewId value of the preview you want to retrieve.
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 de l'API d'accès au Profil Point de terminaison Entités (accès 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 l’utiliser previewId /estimate dans le chemin d’une demande de GET vers le point de terminaison vers les informations statistiques de la vue 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 previewId valeur 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": 0,
    "numRowsToRead": 1,
    "state": "RESULT_READY",
    "profilesReadSoFar": 1,
    "standardError": 0,
    "error": {
        "description": "",
        "traceback": ""
    },
    "profilesMatchedSoFar": 0,
    "totalRows": 1,
    "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
state
L’état actuel de la tâche de prévisualisation. Affichera « RUNNING » jusqu’à la fin du traitement, et deviendra alors « RESULT_READY » ou « FAILED ».
_links.preview
Lorsque l’état actuel de la tâche de prévisualisation affiche « RESULT_READY », cet attribut fournit une URL pour afficher l’estimation.

Étapes suivantes

Après avoir lu ce guide, vous comprenez mieux comment utiliser les prévisualisations et les estimations. Pour en savoir plus sur les autres points de terminaison Segmentation Service API, consultez la présentation du guide du développeur Segmentation Service.