Auftrags-Endpunkt des Profilsystems (Löschanfragen)
- Themen:
- Zusammenführungsrichtlinien
Erstellt für:
- Entwickler
IMPORTANTMit Adobe Experience Platform können Sie Daten aus verschiedenen Quellen erfassen und zuverlässige Profile für einzelne Kunden einrichten. In Experience Platform aufgenommene Daten werden im Data Lake gespeichert. Wenn die Datensätze für das Profil aktiviert wurden, werden diese Daten auch im Real-Time Customer Profile Datenspeicher gespeichert. Gelegentlich kann es erforderlich sein, mit einem Datensatz verknüpfte Profildaten aus dem Profilspeicher zu löschen, um nicht mehr benötigte oder irrtümlich hinzugefügte Daten zu entfernen. Dies erfordert die Verwendung der Real-Time Customer Profile-API zum Erstellen eines Profile Systemauftrags oder „Löschanfrage“.
NOTEErste Schritte
Der in diesem Handbuch verwendete API-Endpunkt ist Teil von Real-Time Customer Profile API. Bevor Sie fortfahren, lesen Sie das Handbuch Erste Schritte mit Links zur zugehörigen Dokumentation, einer Anleitung zum Lesen der API-Beispielaufrufe in diesem Dokument und wichtigen Informationen zu den erforderlichen Kopfzeilen, die für die erfolgreiche Ausführung von Aufrufen an eine Experience Platform-API erforderlich sind.
Löschanfragen anzeigen
Bei einer Löschanfrage handelt es sich um einen langwierigen, asynchronen Prozess, d. h., Ihre Organisation führt möglicherweise mehrere Löschanfragen gleichzeitig aus. Um alle derzeit in Ihrer Organisation ausgeführten Löschanfragen anzuzeigen, können Sie eine GET-Anfrage an den /system/jobs-Endpunkt stellen.
Außerdem können Sie optionale Abfrageparameter verwenden, um die Liste der in der Antwort zurückgegebenen Löschanfragen zu filtern. Um mehrere Parameter zu verwenden, trennen Sie die einzelnen Parameter durch ein kaufmännisches Und-Zeichen (&).
API-Format
AVAILABILITYGET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
startstart=4limitlimit=10pagepage=2sortasc) oder absteigender (desc) Reihenfolge. Der Sortierparameter funktioniert nicht, wenn mehrere Ergebnisseiten zurückgegeben werden.sort=batchId:ascAnfrage
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-Anfrage-Header anstelle des x-sandbox-name-Anfrage-Headers verwenden.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}' \
Antwort
IMPORTANTEine erfolgreiche Antwort enthält ein Array „children“ mit einem Objekt für jede Löschanfrage, das die Details dieser Anfrage enthält.
{
"_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"-Wert ersetzen.jobType"DELETE" zurückgegeben.status"NEW", "PROCESSING", "COMPLETED" und "ERROR".metrics"recordsProcessed"), und die Zeit in Sekunden, die die Anfrage verarbeitet wurde oder wie lange die Anfrage dauerte ("timeTakenInSec").Eine erfolgreiche Antwort gibt ein -Array zurück, das ein -Objekt für jede der Systemanforderungen enthält.
{
[
{
"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 und TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED und IN-PROGRESS.propertiesErstellen einer Löschanfrage
Die Initiierung einer neuen Löschanfrage erfolgt über eine POST-Anfrage an den /systems/jobs-Endpunkt, wobei die Kennung des zu löschenden Datensatzes oder Batches im Text der Anfrage angegeben wird.
Löschen eines Datensatzes und der zugehörigen Profildaten
Um einen Datensatz und alle mit dem Datensatz verknüpften Profildaten aus dem Profilspeicher zu löschen, muss die Datensatz-ID im Hauptteil der POST-Anfrage enthalten sein. Durch diese Aktion werden ALLE Daten für einen bestimmten Datensatz gelöscht. Mit Experience Platform können Sie Datensätze löschen, die sowohl auf Datensatz- als auch auf Zeitreihenschemata basieren.
API-Format
POST /system/jobs
Anfrage
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-Anfrage-Header anstelle des x-sandbox-name-Anfrage-Headers verwenden.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"
}'
dataSetIdAntwort
IMPORTANTEine erfolgreiche Antwort gibt die Details der neu erstellten Löschanfrage zurück, einschließlich einer eindeutigen, vom System generierten und schreibgeschützten Kennung für die Anfrage. Diese kann zum Nachschlagen der Anfrage und Überprüfen ihres Status verwendet werden. Der status (Status) der Anfrage lautet zum Zeitpunkt der Erstellung "NEW", und zwar solange, bis die Verarbeitung beginnt. Die dataSetId in der Antwort sollte mit der in der Anfrage gesendeten dataSetId übereinstimmen.
{
"id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
"imsOrgId": "{ORG_ID}",
"dataSetId": "5c802d3cd83fc114b741c4b5",
"jobType": "DELETE",
"status": "NEW",
"createEpoch": 1559025404,
"updateEpoch": 1559025406
}
iddataSetIdEine erfolgreiche Antwort gibt die Details der neu erstellten Systemanfrage zurück.
{
"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 und TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED und IN-PROGRESS.propertiesBatch löschen
Um einen Batch zu löschen, muss die Batch-Kennung im Text der POST-Anfrage enthalten sein. Beachten Sie, dass Sie Batches für Datensätze, die auf Datensatzschemata basieren, nicht löschen können. Nur Batches für Datensätze, die auf Zeitreihenschemata basieren, können gelöscht werden.
NOTEWeitere Informationen zum Datensatz- und Zeitreihenverhalten finden Sie im Abschnitt zu XDM-Datenverhalten in der XDM System.
API-Format
POST /system/jobs
Anfrage
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-Anfrage-Header anstelle des x-sandbox-name-Anfrage-Headers verwenden.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"
}'
datasetIdbatchIdAntwort
IMPORTANTEine erfolgreiche Antwort gibt die Details der neu erstellten Löschanfrage zurück, einschließlich einer eindeutigen, vom System generierten und schreibgeschützten Kennung für die Anfrage. Diese kann zum Nachschlagen der Anfrage und Überprüfen ihres Status verwendet werden. Der "status" (Status) der Anfrage lautet zum Zeitpunkt der Erstellung "NEW", und zwar solange, bis die Verarbeitung beginnt. Der "batchId" Wert in der Antwort sollte mit dem in der Anfrage gesendeten "batchId" übereinstimmen.
{
"id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
"imsOrgId": "{ORG_ID}",
"datasetId": "66a92c5910df2d1767de13f3",
"batchId": "8d075b5a178e48389126b9289dcfd0ac",
"jobType": "DELETE",
"status": "NEW",
"createEpoch": 1559026131,
"updateEpoch": 1559026132
}
iddatasetIdbatchIdEine erfolgreiche Antwort gibt die Details der neu erstellten Systemanfrage zurück.
{
"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 und TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED und IN-PROGRESS.propertiesAVAILABILITYWenn Sie versuchen, eine Löschanfrage für einen Datensatz-Batch vom Typ Datensatz zu initiieren, tritt ein 400-Fehler auf, der in etwa wie folgt aussieht:
{
"requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
"errors": {
"400": [
{
"code": "500",
"message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
}
]
}
}
Anzeigen einer bestimmten Löschanfrage
Zur Ansicht einer bestimmten Löschanfrage, einschließlich Details wie dem Status, können Sie eine GET-Anfrage (zum Nachschlagen) an den /system/jobs-Endpunkt stellen und die Kennung der Löschanfrage in den Pfad einschließen.
API-Format
GET /system/jobs/{DELETE_REQUEST_ID}
{DELETE_REQUEST_ID}Anfrage
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-Anfrage-Header anstelle des x-sandbox-name-Anfrage-Headers verwenden.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}'
Antwort
IMPORTANTDie Antwort enthält die Details der Löschanfrage, einschließlich ihres aktualisierten Status. Die ID der Löschanfrage in der Antwort (der "id") sollte mit der im Anfragepfad gesendeten ID übereinstimmen.
{
"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" zurückgegeben.statusNEW, PROCESSING, COMPLETED und ERROR.metrics"recordsProcessed") und die Zeit in Sekunden enthält, die die Anfrage verarbeitet wurde, oder die Dauer der Anfrage ("timeTakenInSec").Eine erfolgreiche Antwort gibt die Details der angegebenen Systemanfrage zurück.
{
"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 und TRUNCATE_DATASET.statusNEW, SUCCESS, ERROR, FAILED und IN-PROGRESS.propertiesSobald der Status der Löschanfrage "COMPLETED" ist, können Sie bestätigen, dass die Daten gelöscht wurden, indem Sie versuchen, über die Datenzugriffs-API auf die gelöschten Daten zuzugreifen. Anweisungen zum Zugreifen auf Datensätze und Batches mit der Data Access-API finden Sie in der Dokumentation zu Data Access.
Löschanfrage entfernen
AVAILABILITYExperience Platform können Sie eine frühere Anfrage löschen. Dies kann aus verschiedenen Gründen nützlich sein, z. B. wenn der Löschvorgang nicht abgeschlossen wurde oder in der Verarbeitungsstufe hängen geblieben ist. Um eine Löschanfrage zu entfernen, können Sie eine Löschanfrage an den /system/jobs-Endpunkt stellen und die Kennung der Löschanfrage, die Sie entfernen möchten, in den Anfragepfad einschließen.
API-Format
DELETE /system/jobs/{DELETE_REQUEST_ID}
Anfrage
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}'
Antwort
Bei erfolgreicher Löschanfrage werden der HTTP-Status 200 (OK) und ein leerer Antworttext zurückgegeben. Sie können prüfen, ob die Anfrage gelöscht wurde, indem Sie eine GET-Anfrage ausführen, um die Löschanfrage mittels ihrer Kennung anzuzeigen. Nun sollte ein HTTP-Status 404 (Nicht gefunden) zurückgegeben werden, was bedeutet, dass die Löschanfrage entfernt wurde.
Nächste Schritte
Nachdem Sie nun die Schritte kennen, die beim Löschen von Datensätzen und Batches aus dem Profile store in Experience Platform erforderlich sind, können Sie Daten, die fälschlicherweise hinzugefügt wurden oder die Ihr Unternehmen nicht mehr benötigt, sicher löschen. Beachten Sie, dass Löschanfragen nicht rückgängig gemacht werden können. Daher sollten Sie Daten nur dann löschen, wenn Sie sicher sind, dass Sie sie jetzt und in Zukunft nicht mehr benötigen werden.