Point d’entrée des tâches système de profils (requêtes de suppression)
Créé pour :
- Développeur
IMPORTANTAdobe Experience Platform vous permet d’ingérer des données provenant de plusieurs sources et de créer des profils fiables pour les clients individuels. Les données ingérées dans Experience Platform sont stockées dans le Data Lake. Si les jeux de données ont été activés pour Profile, ces données sont également stockées dans le magasin de données Real-Time Customer Profile. Il peut parfois être nécessaire de supprimer les données de profil associées à un jeu de données de la banque de profils afin de supprimer des données qui ne sont plus nécessaires ou qui ont été ajoutées par erreur. Pour ce faire, vous devez utiliser l’API Real-Time Customer Profile pour créer une tâche système Profile, ou « requête de suppression ».
NOTEPrise en main
Le point d’entrée dʼAPI utilisé dans ce guide fait partie de Real-Time Customer Profile API. Avant de continuer, consultez le guide de prise en main pour obtenir des liens vers la documentation associée, un guide de lecture des exemples d’appels API dans ce document et des informations importantes sur les en-têtes requis pour réussir des appels vers n’importe quelle API d’Experience Platform.
Affichage des requêtes de suppression
Une requête de suppression est un processus persistant asynchrone, ce qui signifie que votre organisation peut exécuter plusieurs requêtes de suppression simultanément. Pour afficher toutes les requêtes de suppression en cours d’exécution par votre organisation, vous pouvez exécuter une requête GET sur le point d’entrée /system/jobs.
Vous pouvez également utiliser des paramètres de requête facultatifs pour filtrer la liste des requêtes de suppression renvoyées dans la réponse. Pour utiliser plusieurs paramètres, séparez chaque paramètre à l’aide d’une esperluette (&).
Format d’API
AVAILABILITYGET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
startstart=4limitlimit=10pagepage=2sortasc) ou décroissant (desc). Le paramètre de tri ne fonctionne pas lors du renvoi de plusieurs pages de résultats.sort=batchId:ascRequête
IMPORTANTcurl -X GET https://platform.adobe.io/data/core/ups/system/jobs \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
x-sandbox-id au lieu de l’en-tête de requête x-sandbox-name lors de l’utilisation de ce point d’entrée avec AWS.curl -X GET https://platform.adobe.io/data/core/ups/system/jobs \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
Réponse
IMPORTANTUne réponse réussie comprend un tableau « enfants » avec un objet pour chaque requête de suppression contenant les détails de cette requête.
{
"_page": {
"count": 100,
"next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
},
"children": [
{
"id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
"imsOrgId": "{ORG_ID}",
"batchId": "8d075b5a178e48389126b9289dcfd0ac",
"jobType": "DELETE",
"status": "COMPLETED",
"metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
"createEpoch": 1559026134,
"updateEpoch": 1559026137
},
{
"id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
"imsOrgId": "{ORG_ID}",
"dataSetId": "5c802d3cd83fc114b741c4b5",
"jobType": "DELETE",
"status": "PROCESSING",
"metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
"createEpoch": 1559025404,
"updateEpoch": 1559025406
}
]
}
_page.count_page.next"next" fournie.jobType"DELETE".status"NEW", "PROCESSING", "COMPLETED" et "ERROR".metrics"recordsProcessed") et la durée, en secondes, du traitement de la requête, ou la durée nécessaire à l’exécution de la requête ("timeTakenInSec").Une réponse réussie renvoie un tableau contenant un objet pour chacune des requêtes système.
{
[
{
"requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
"requestType": "DELETE_EE_BATCH",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxName": "prod",
"sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
},
"status": "SUCCESS",
"properties": {
"batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
"datasetId": "66a92c5910df2d1767de13f3"
},
"createdAt": "2024-12-22T19:44:50.250006Z",
"updatedAt": "2024-12-22T19:52:13.380706Z"
},
{
"requestId": "38a835eb-b491-4864-902b-be07fa4d6a6d",
"requestType": "TRUNCATE_DATASET",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxName": "prod",
"sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
},
"status": "SUCCESS",
"properties": {
"datasetId": "66a92c5910df2d1767de13f3"
},
"createdAt": "2024-12-22T19:44:50.250006Z",
"updatedAt": "2024-12-22T19:52:13.380706Z"
}
]
}
requestIdrequestTypeBACKFILL_TTL, DELETE_EE_BATCH et TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED et IN-PROGRESS.propertiesCréation d’une requête de suppression
L’exécution d’une nouvelle requête de suppression se fait par le biais d’une requête POST au point d’entrée /systems/jobs, où l’identifiant du jeu de données ou du lot à supprimer est fourni dans le corps de la requête.
Supprimer un jeu de données et les données de profil associées
Pour supprimer un jeu de données et toutes les données de profil associées au jeu de données de la banque de profils, l’identifiant du jeu de données doit être inclus dans le corps de la requête POST. Cette action supprimera TOUTES les données d’un jeu de données. Experience Platform vous permet de supprimer des jeux de données en fonction des schémas d’enregistrement et des séries temporelles.
Format d’API
POST /system/jobs
Requête
IMPORTANTcurl -X POST \
https://platform.adobe.io/data/core/ups/system/jobs \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"dataSetId": "5c802d3cd83fc114b741c4b5"
}'
dataSetIdIMPORTANTx-sandbox-id au lieu de l’en-tête de requête x-sandbox-name lors de l’utilisation de ce point d’entrée avec AWS.curl -X POST \
https://platform.adobe.io/data/core/ups/system/jobs \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-d '{
"dataSetId": "5c802d3cd83fc114b741c4b5"
}'
dataSetIdRéponse
IMPORTANTUne réponse réussie renvoie les détails de la requête de suppression créée, y compris un identifiant unique généré par le système et en lecture seule pour la requête. Vous pouvez l’utiliser pour rechercher la requête et en vérifier l’état. Le status pour la requête au moment de sa création est "NEW" jusqu’à ce qu’elle commence à être traitée. Le dataSetId contenu de la réponse doit correspondre au dataSetId envoyé dans la requête.
{
"id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
"imsOrgId": "{ORG_ID}",
"dataSetId": "5c802d3cd83fc114b741c4b5",
"jobType": "DELETE",
"status": "NEW",
"createEpoch": 1559025404,
"updateEpoch": 1559025406
}
iddataSetIdUne réponse réussie renvoie les détails de la requête système nouvellement créée.
{
"requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
"requestType": "DELETE_EE_BATCH",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxName": "prod",
"sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
},
"status": "SUCCESS",
"properties": {
"batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
"datasetId": "66a92c5910df2d1767de13f3"
},
"createdAt": "2024-12-22T19:44:50.250006Z",
"updatedAt": "2024-12-22T19:52:13.380706Z"
}
requestIdrequestTypeBACKFILL_TTL, DELETE_EE_BATCH et TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED et IN-PROGRESS.propertiesSuppression d’un lot
Pour supprimer un lot, l’identifiant du lot doit être inclus dans le corps de la requête POST. Veuillez noter que vous ne pouvez pas supprimer les lots des jeux de données basés sur des schémas d’enregistrement. Seuls les lots des jeux de données basés sur des schémas de séries temporelles peuvent être supprimés.
NOTEPour plus d’informations sur le comportement des enregistrements et des séries temporelles, consultez la section sur les comportements de données XDM dans la présentation de la XDM System.
Format d’API
POST /system/jobs
Requête
IMPORTANTcurl -X POST \
https://platform.adobe.io/data/core/ups/system/jobs \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"datasetId": "66a92c5910df2d1767de13f3",
"batchId": "8d075b5a178e48389126b9289dcfd0ac"
}'
datasetIdbatchIdIMPORTANTx-sandbox-id au lieu de l’en-tête de requête x-sandbox-name lors de l’utilisation de ce point d’entrée avec AWS.curl -X POST \
https://platform.adobe.io/data/core/ups/system/jobs \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-d '{
"datasetId": "66a92c5910df2d1767de13f3",
"batchId": "8d075b5a178e48389126b9289dcfd0ac"
}'
datasetIdbatchIdRéponse
IMPORTANTUne réponse réussie renvoie les détails de la requête de suppression créée, y compris un identifiant unique généré par le système et en lecture seule pour la requête. Vous pouvez l’utiliser pour rechercher la requête et en vérifier l’état. Le "status" pour la requête au moment de sa création est "NEW" jusqu’à ce qu’elle commence à être traitée. La valeur "batchId" dans la réponse doit correspondre à la valeur "batchId" envoyée dans la requête.
{
"id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
"imsOrgId": "{ORG_ID}",
"datasetId": "66a92c5910df2d1767de13f3",
"batchId": "8d075b5a178e48389126b9289dcfd0ac",
"jobType": "DELETE",
"status": "NEW",
"createEpoch": 1559026131,
"updateEpoch": 1559026132
}
iddatasetIdbatchIdUne réponse réussie renvoie les détails de la requête système nouvellement créée.
{
"requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
"requestType": "DELETE_EE_BATCH",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxName": "prod",
"sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
},
"status": "SUCCESS",
"properties": {
"batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
"datasetId": "66a92c5910df2d1767de13f3"
},
"createdAt": "2024-12-22T19:44:50.250006Z",
"updatedAt": "2024-12-22T19:52:13.380706Z"
}
requestIdrequestTypeBACKFILL_TTL, DELETE_EE_BATCH et TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED et IN-PROGRESS.propertiesAVAILABILITYSi vous tentez d’exécuter une requête de suppression pour un lot de jeux de données d’enregistrement, une erreur de niveau 400 s’affichera, comme suit :
{
"requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
"errors": {
"400": [
{
"code": "500",
"message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
}
]
}
}
Affichage d’une requête de suppression spécifique
Pour afficher une requête de suppression spécifique, y compris des détails tels que son état, vous pouvez exécuter une requête de recherche (GET) sur le point d’entrée/system/jobs et inclure l’identifiant de la requête de suppression dans le chemin.
Format d’API
GET /system/jobs/{DELETE_REQUEST_ID}
{DELETE_REQUEST_ID}Requête
IMPORTANTcurl -X GET https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
x-sandbox-id au lieu de l’en-tête de requête x-sandbox-name lors de l’utilisation de ce point d’entrée avec AWS.curl -X GET https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-id: {SANDBOX_ID}'
Réponse
IMPORTANTLa réponse fournit les détails de la requête de suppression, y compris son état mis à jour. L’identifiant de la requête de suppression dans la réponse (la valeur "id") doit correspondre à l’identifiant envoyé dans le chemin d’accès de la requête.
{
"id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
"imsOrgId": "{ORG_ID}",
"batchId": "8d075b5a178e48389126b9289dcfd0ac",
"jobType": "DELETE",
"status": "COMPLETED",
"metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
"createEpoch": 1559026134,
"updateEpoch": 1559026137
}
jobType"DELETE".statusNEW, PROCESSING, COMPLETED et ERROR.metrics"recordsProcessed") et la durée, en secondes, du traitement de la requête, ou la durée nécessaire à l’exécution de la requête ("timeTakenInSec").Une réponse réussie renvoie les détails de la requête système spécifiée.
{
"requestId": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
"requestType": "DELETE_EE_BATCH",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxName": "prod",
"sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
},
"status": "SUCCESS",
"properties": {
"batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
"datasetId": "66a92c5910df2d1767de13f3"
},
"createdAt": "2024-12-22T19:44:50.250006Z",
"updatedAt": "2024-12-22T19:52:13.380706Z"
}
requestIdrequestTypeBACKFILL_TTL, DELETE_EE_BATCH et TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED et IN-PROGRESS.propertiesUne fois que le statut de la demande de suppression est "COMPLETED", vous pouvez confirmer que les données ont été supprimées en essayant d’accéder aux données supprimées à l’aide de l’API Data Access. Pour savoir comment utiliser l’API Data Access pour accéder aux jeux de données et aux lots, consultez la documentation sur Data Access.
Suppression d’une requête de suppression
AVAILABILITYExperience Platform vous permet de supprimer une requête précédente, ce qui peut s’avérer utile pour plusieurs raisons, notamment si la tâche de suppression n’a pas été terminée ou est restée bloquée en cours de traitement. Pour supprimer une requête de suppression, vous pouvez exécuter une requête DELETE sur le point d’entrée /system/jobs et inclure l’identifiant de la requête de suppression que vous souhaitez supprimer dans le chemin de la requête.
Format d’API
DELETE /system/jobs/{DELETE_REQUEST_ID}
Requête
curl -X POST https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une requête de suppression réussie renvoie un état HTTP 200 (OK) et un corps de réponse vide. Vous pouvez confirmer que la requête a été supprimée en exécutant une requête GET pour afficher la requête de suppression par son identifiant. Ceci doit renvoyer l’état HTTP 404 (Introuvable), indiquant que la requête de suppression a été supprimée.
Étapes suivantes
Maintenant que vous connaissez les étapes nécessaires à la suppression des jeux de données et des lots du Profile store dans Experience Platform, vous pouvez supprimer en toute sécurité les données ajoutées par erreur ou dont votre organisation n’a plus besoin. N’oubliez pas qu’une requête de suppression ne peut pas être annulée. Vous devez donc supprimer uniquement les données dont vous êtes sûr que vous n’avez pas besoin et dont vous n’aurez plus jamais besoin.