Show Menu
SUJETS×

Configure a dataset for Profile and Identity Service using APIs

This tutorial covers the process of enabling a dataset for use in Real-time Customer Profile and Identity Service, broken down into the following steps:
  1. Enable a dataset for use in Real-time Customer Profile, using one of two options:

Prise en main

This tutorial requires a working understanding of the various Adobe Experience Platform services involved in managing Profile-enabled datasets. Before beginning this tutorial, please review the documentation for these related Platform services:
  • Profil client en temps réel : Fournit un profil de consommation unifié en temps réel basé sur des données agrégées provenant de plusieurs sources.
  • Service d'identité : Permet Real-time Customer Profile de relier des identités provenant de sources de données disparates et qui sont incorporées Platformdans.
  • Service de catalogue : API RESTful qui vous permet de créer des jeux de données et de les configurer pour Real-time Customer Profile et Identity Service.
  • Modèle de données d’expérience(XDM) : Cadre normalisé selon lequel Platform organiser les données d’expérience client.
Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour passer avec succès des appels à des API Platform.

Lecture d’exemples d’appels API

Ce tutoriel fournit des exemples d’appels API pour démontrer comment formater vos requêtes. Il s’agit notamment de chemins d’accès, d’en-têtes requis et de payloads de requêtes correctement formatés. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Collecte des valeurs des en-têtes requis

In order to make calls to Platform APIs, you must first complete the authentication tutorial . Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Toutes les requêtes contenant un payload (POST, PUT, PATCH) requièrent un en-tête supplémentaire :
  • Content-Type: application/json
All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in. For more information on sandboxes in Platform, see the sandbox overview documentation .
  • x-sandbox-name: {SANDBOX_NAME}

Créez un jeu de données activé pour Profile et Identity

You can enable a dataset for Real-time Customer Profile and Identity Service immediately upon creation or at any point after the dataset has been created. Si vous souhaitez activer un jeu de données déjà créé, suivez les étapes de configuration d’un jeu de données existant qui se trouvent plus bas dans ce document. Pour créer un jeu de données, vous devez connaître l’identifiant d’un schéma XDM existant et activé pour Real-time Customer Profile. Pour plus d’informations sur la recherche ou la création d’un schéma activé pour Profile, reportez-vous au tutoriel sur la création d’un schéma à l’aide de l’API Schema Registry . The following call to the Catalog API enables a dataset for Profile and Identity Service.
Format d’API
POST /dataSets

Requête
En incluant unifiedProfile et unifiedIdentity sous tags dans le corps de la requête, le jeu de données sera immédiatement activé pour et , respectivement. Identity Service Les valeurs de ces balises doivent être un tableau contenant la chaîne "enabled:true" .
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 '{
    "fileDescription" : {
    "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    },
    "fields":[],
    "schemaRef" : {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags" : {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'

Propriété
Description
schemaRef.id
The ID of the Profile-enabled schema upon which the dataset will be based.
{TENANT_ID}
The namespace within the Schema Registry which contains resources belonging to your IMS Organization. See the TENANT_ID section of the Schema Registry developer guide for more information.
Réponse
Une réponse réussie affiche un tableau contenant l’identifiant du jeu de données nouvellement créé sous la forme d’un "@/dataSets/{DATASET_ID}" . Une fois le jeu de données créé et activé, passez à l’étape du chargement des données .
[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

Configuration d’un jeu de données existant

The following steps cover how to enable a previously created dataset for Real-time Customer Profile and Identity Service. Si vous avez déjà créé un jeu de données activé pour Profile, passez à l’étape de l’ ingestion de données .

Vérifiez si le jeu de données est activé

Using the Catalog API, you can inspect an existing dataset to determine whether it is enabled for use in Real-time Customer Profile and Identity Service. L’appel suivant récupère les détails d’un jeu de données via son identifiant.
Format d’API
GET /dataSets/{DATASET_ID}

Paramètre
Description
{DATASET_ID}
Identifiant du jeu de données à examiner.
Requête
curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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}'

Réponse
{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "fileDescription": {
            "persisted": true,
            "containerFormat": "parquet",
            "format": "parquet"
        },
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Sous la propriété tags , vous pouvez voir que unifiedProfile et unifiedIdentity sont tous les deux présents et affichent la valeur enabled:true . Therefore, Real-time Customer Profile and Identity Service are enabled for this dataset, respectively.

Activation du jeu de données

If the existing dataset has not been enabled for Profile or Identity Service, you can enable it by making a PATCH request using the dataset ID.
Format d’API
PATCH /dataSets/{DATASET_ID}

Paramètre
Description
{DATASET_ID}
Identifiant du jeu de données à mettre à jour.
Requête
curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -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 '{
    "tags" : {
        "unifiedProfile": ["enabled:true"],
        "unifiedIdentity": ["enabled:true"]
    }
  }'

Le corps de la requête comprend une propriété tags , qui contient deux sous-propriétés : "unifiedProfile" et "unifiedIdentity" . Les valeurs de ces sous-propriétés sont des tableaux contenant la chaîne "enabled:true" .
Réponse Une requête PATCH réussie renvoie un état HTTP 200 (OK) et un tableau contenant l’identifiant du jeu de données mis à jour. Cet identifiant doit correspondre à celui envoyé dans la requête PATCH. Les balises "unifiedProfile" et "unifiedIdentity" ont maintenant été ajoutées, et le jeu de données est activé pour une utilisation dans Profile et Identity Service.
[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Ingestion de données dans le jeu de données

Both Real-time Customer Profile and Identity Service consume XDM data as it is being ingested into a dataset. Pour apprendre à charger des données dans un jeu de données, reportez-vous au tutoriel sur la création d’un jeu de données à l’aide d’API . When planning what data to send to your Profile-enabled dataset, consider the following best practices:
  • Incluez toutes les données à utiliser comme critères de segments ciblés.
  • Incluez autant d’identifiants que vous pouvez en valider à partir des données de profil afin d’optimiser le graphique d’identités. This allows Identity Service to stitch identities across datasets more effectively.

Confirm data ingest by Real-time Customer Profile

Lors du premier chargement de données vers un nouveau jeu de données ou dans le cadre d’un processus impliquant un nouveau ETL ou une nouvelle source de données, il est recommandé de vérifier soigneusement les données afin de s’assurer qu’elles ont été chargées comme prévu. Using the Real-time Customer Profile Access API, you can retrieve batch data as it gets loaded into a dataset. Si vous ne parvenez pas à récupérer les entités attendues, il se peut que votre jeu de données ne soit pas activé pour Real-time Customer Profile. Une fois que vous avez confirmé que votre jeu de données a été activé, assurez-vous que le format et les identifiants des données sources répondent à vos attentes. Pour obtenir des instructions détaillées sur l'utilisation de l' Real-time Customer Profile API pour accéder aux Profile données, veuillez suivre le guide des points de terminaison entités, également appelé "Profile Access API".

Confirmation de l’ingestion des données par Identity Service

Chaque fragment de données ingéré contenant plusieurs identités crée un lien dans votre graphique d’identités privé. Pour plus d’informations sur les graphiques d’identités et sur l’accès aux données d’identité, veuillez commencer par lire la présentation d’Identity Service .