Endpunkt "Datenschutzaufträge"
In diesem Dokument wird beschrieben, wie Sie mit Datenschutzaufträgen mit API-Aufrufen arbeiten. Insbesondere wird die Verwendung der /job
-Endpunkt im Privacy Service API. Lesen Sie vor dem Lesen dieses Handbuchs das Erste Schritte für wichtige Informationen, die Sie benötigen, um die API erfolgreich aufrufen zu können, einschließlich erforderlicher Kopfzeilen und Informationen zum Lesen von Beispiel-API-Aufrufen.
Alle Aufträge auflisten list
Sie können eine Liste aller in Ihrem Unternehmen verfügbaren Datenschutzaufträge anzeigen, indem Sie eine GET-Anfrage an die /jobs
-Endpunkt.
API-Format
Dieses Anfrageformat verwendet eine regulation
Abfrageparameter im /jobs
-Endpunkt beginnt daher mit einem Fragezeichen (?
), wie unten dargestellt. Bei der Auflistung von Ressourcen gibt die Privacy Service-API bis zu 1000 Aufträge zurück und paginiert die Antwort. Verwenden Sie andere Abfrageparameter (page
, size
, und Datumsfilter), um die Antwort zu filtern. Sie können mehrere Parameter mithilfe von Ampersands (&
) trennen.
status
, fromDate
, und toDate
Abfrageparameter.GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}
GET /jobs?regulation={REGULATION}&fromDate={FROMDATE}&toDate={TODATE}&status={STATUS}
{REGULATION}
Der Regelungstyp für die Abfrage. Zu den zulässigen Werten gehören:
apa_aus
ccpa
cpa
cpra_usa
ctdpa
ctdpa_usa
gdpr
hipaa_usa
lgpd_bra
mhmda
nzpa_nzl
pdpa_tha
ucpa_usa
vcdpa_usa
Siehe Übersicht unter unterstützte Verordnungen für weitere Informationen zu den Datenschutzbestimmungen, die die obigen Werte darstellen.
{PAGE}
0
.{SIZE}
100
und der Maximalwert ist 1000
. Wenn Sie den Maximalwert überschreiten, gibt die API einen 400-Code-Fehler zurück.{status}
Das Standardverhalten besteht darin, alle Status einzuschließen. Wenn Sie einen Statustyp angeben, gibt die Anfrage nur Datenschutzaufträge zurück, die diesem Statustyp entsprechen. Die zulässigen Werte sind:
processing
complete
error
{toDate}
Es akzeptiert das Format JJJJ-MM-TT. Das von Ihnen angegebene Datum wird als das in Greenwich Mean Time (GMT) ausgedrückte Enddatum interpretiert.
Wenn Sie diesen Parameter nicht angeben (und einen entsprechenden
fromDate
), gibt das Standardverhalten Aufträge zurück, die in den letzten sieben Tagen Daten zurückgegeben haben. Wenn Sie toDate
, müssen Sie auch die fromDate
Abfrageparameter. Wenn Sie nicht beide verwenden, gibt der Aufruf einen 400-Fehler zurück.{fromDate}
Es akzeptiert das Format JJJJ-MM-TT. Das von Ihnen angegebene Datum wird als Ursprungsdatum der Anfrage interpretiert, ausgedrückt in Greenwich Mean Time (GMT).
Wenn Sie diesen Parameter nicht angeben (und einen entsprechenden
toDate
), gibt das Standardverhalten Aufträge zurück, die in den letzten sieben Tagen Daten zurückgegeben haben. Wenn Sie fromDate
, müssen Sie auch die toDate
Abfrageparameter. Wenn Sie nicht beide verwenden, gibt der Aufruf einen 400-Fehler zurück.{filterDate}
Anfrage
Die folgende Anfrage ruft eine paginierte Liste aller Aufträge innerhalb eines Unternehmens ab, beginnend mit der dritten Seite mit einer Seitengröße von 50.
curl -X GET \
https://platform.adobe.io/data/core/privacy/jobs?regulation=gdpr&page=2&size=50 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
Antwort
Eine erfolgreiche Antwort gibt eine Liste von Aufträgen zurück, wobei jeder Auftrag Details wie z. B. seine jobId
enthält. In diesem Beispiel würde die Antwort eine Liste von 50 Aufträgen enthalten, beginnend mit der dritten Ergebnisseite.
Zugreifen auf nachfolgende Seiten
Um den nächsten Ergebnissatz in einer paginierten Antwort abzurufen, müssen Sie einen weiteren API-Aufruf an denselben Endpunkt ausführen, während Sie den Abfrageparameter page
um 1 erhöhen.
Erstellen eines Datenschutzauftrags create-job
Bevor Sie eine neue Auftragsanfrage erstellen, müssen Sie zunächst identifizierende Informationen zu den betroffenen Personen erfassen, deren Daten Sie aufrufen, löschen oder für die Sie ein Opt-out aus dem Verkauf erwirken möchten. Sobald Sie über die erforderlichen Daten verfügen, müssen Sie sie in der Payload einer POST-Anfrage an die /jobs
-Endpunkt.
Die Privacy Service API unterstützt zwei Arten von Auftragsanfragen für personenbezogene Daten:
- Zugriff und/oder Löschen: Zugriff (lesen) oder Löschen personenbezogener Daten.
- Opt-out vom Verkauf: Markieren Sie persönliche Daten als nicht verkäuflich.
Erstellen/Löschen eines Auftrags access-delete
In diesem Abschnitt wird gezeigt, wie mithilfe der API eine Anfrage zum Zugriff/Löschen von Aufträgen erstellt wird.
API-Format
POST /jobs
Anfrage
Mit der folgenden Anfrage wird eine neue Auftragsanfrage erstellt, die von den Attributen konfiguriert wird, die in der Payload wie unten beschrieben bereitgestellt werden.
curl -X POST \
https://platform.adobe.io/data/core/privacy/jobs \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-d '{
"companyContexts": [
{
"namespace": "imsOrgID",
"value": "{ORG_ID}"
}
],
"users": [
{
"key": "DavidSmith",
"action": ["access"],
"userIDs": [
{
"namespace": "email",
"value": "dsmith@acme.com",
"type": "standard"
},
{
"namespace": "ECID",
"type": "standard",
"value": "443636576799758681021090721276",
"isDeletedClientSide": false
}
]
},
{
"key": "user12345",
"action": ["access","delete"],
"userIDs": [
{
"namespace": "email",
"value": "ajones@acme.com",
"type": "standard"
},
{
"namespace": "loyaltyAccount",
"value": "12AD45FE30R29",
"type": "integrationCode"
}
]
}
],
"include": ["Analytics", "AudienceManager","profileService"],
"expandIds": false,
"priority": "normal",
"analyticsDeleteMethod": "anonymize",
"mergePolicyId": 124,
"regulation": "ccpa"
}'
companyContexts
(Erforderlich)Ein Array mit Authentifizierungsinformationen für Ihr Unternehmen. Jeder aufgelistete Identifikator enthält die folgenden Attribute:
namespace
: Den Namensraum eines Identifikators.value
: Den Wert des Identifikators.
Es ist erforderlich die einer der Kennungen verwendet imsOrgId
als namespace
mit value
enthält die eindeutige ID für Ihre Organisation.
Zusätzliche IDs können produktspezifische Firmenqualifizierer sein (z. B. Campaign
), die eine Integration mit einer Adobe-Anwendung Ihrer Organisation identifizieren. Mögliche Werte sind Kontonamen, Client-Codes, Mandanten-IDs oder andere Anwendungs-Identifikatoren.
users
(Erforderlich)Ein Array mit einer Sammlung von mindestens einem Benutzer, auf den Sie zugreifen, oder den Sie löschen möchten. In einer einzigen Anfrage können maximal 1.000 Benutzer angegeben werden. Jedes Benutzerobjekt enthält die folgenden Informationen:
key
: Ein Identifikator für einen Benutzer, der verwendet wird, um die separaten Auftrags-Identifikatoren in den Antwortdaten zu qualifizieren. Es gilt als Best Practice, eine eindeutige, leicht identifizierbare Zeichenfolge für diesen Wert zu wählen, damit später einfach darauf verwiesen oder nachgeschlagen werden kann.action
: Ein Array, das die gewünschten Aktionen zur Übernahme der Benutzerdaten auflistet. Je nach den Aktionen, die Sie ausführen möchten, muss dieses Arrayaccess
,delete
oder beide enthalten.userIDs
: Eine Sammlung von Identitäten für den Benutzer. Die Anzahl der Identitäten, die ein einzelner Benutzer haben kann, ist auf neun begrenzt. Jede Identität besteht aus einemnamespace
, einemvalue
und einem Namensraum-Qualifikator (type
). Weitere Informationen zu diesen erforderlichen Eigenschaften finden Sie im Anhang.
Eine ausführlichere Erläuterung zu users
und userIDs
finden Sie im Handbuch zur Fehlerbehebung.
include
(Erforderlich)expandIDs
true
stellt eine Optimierung für die Verarbeitung der IDs in den Anwendungen dar (derzeit nur unterstützt von Analytics). Wenn dieses Wert weggelassen wird, wird standardmäßig false
verwendet.priority
normal
und low
. Wenn keine priority
angegeben wird, lautet das Standardverhalten normal
.analyticsDeleteMethod
Eine optionale Eigenschaft, die angibt, wie Adobe Analytics mit den personenbezogenen Daten umgehen soll. Für dieses Attribut werden zwei mögliche Werte akzeptiert:
anonymize
: Alle Daten, auf die bei der angegebenen Sammlung von Benutzer-IDs verwiesen wird, werden anonym gemacht. WennanalyticsDeleteMethod
ausgelassen wird, ist dies das Standardverhalten.purge
: Alle Daten werden vollständig entfernt.
mergePolicyId
profileService
), können Sie optional die ID der spezifischen Zusammenführungsrichtlinie die Sie für die ID-Zuordnung verwenden möchten. Durch Angabe einer Zusammenführungsrichtlinie können Datenschutzanfragen bei der Rückgabe von Daten an einen Kunden Zielgruppeninformationen enthalten. Pro Anfrage kann nur eine Zusammenführungsrichtlinie angegeben werden. Wenn keine Zusammenführungsrichtlinie angegeben wird, werden Segmentierungsinformationen nicht in die Antwort aufgenommen.regulation
(Erforderlich)Die Verordnung für den Datenschutzauftrag. Folgende Werte werden akzeptiert:
apa_aus
ccpa
cpra_usa
gdpr
hipaa_usa
lgpd_bra
nzpa_nzl
pdpa_tha
vcdpa_usa
Siehe Übersicht unter unterstützte Verordnungen für weitere Informationen zu den Datenschutzbestimmungen, die die obigen Werte darstellen.
Antwort
Eine erfolgreiche Antwort gibt die Details der neu erstellten Aufträge zurück.
{
"jobs": [
{
"jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
"customer": {
"user": {
"key": "DavidSmith",
"action": [
"access"
]
}
}
},
{
"jobId": "6fc09b53-c24f-4a6c-9ca2-c6076be029f3",
"customer": {
"user": {
"key": "user12345",
"action": [
"access"
]
}
}
},
{
"jobId": "6fc09b53-c24f-4a6c-9ca2-c6076bd023j1",
"customer": {
"user": {
"key": "user12345",
"action": [
"delete"
]
}
}
}
],
"requestStatus": 1,
"totalRecords": 3
}
jobId
Nachdem Sie die Auftragsanfrage erfolgreich gesendet haben, können Sie mit dem nächsten Schritt zur Überprüfung des Auftragsstatus fortfahren.
Status eines Auftrags überprüfen check-status
Sie können Informationen zu einem bestimmten Auftrag abrufen, z. B. zu seinem aktuellen Verarbeitungsstatus, indem Sie die jobId
im Pfad einer GET-Anfrage an die /jobs
-Endpunkt.
API-Format
GET /jobs/{JOB_ID}
{JOB_ID}
jobId
in erfolgreichen API-Antworten für Erstellen eines Auftrags und Auflisten aller Aufträge.Anfrage
Die folgende Anfrage ruft die Details des Auftrags ab, dessen jobId
im Anfragepfad angegeben ist.
curl -X GET \
https://platform.adobe.io/data/core/privacy/jobs/6fc09b53-c24f-4a6c-9ca2-c6076b0842b6 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
Antwort
Eine erfolgreiche Antwort gibt die Details des angegebenen Auftrags zurück.
{
"jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
"requestId": "15700479082313109RX-899",
"userKey": "David Smith",
"action": "access",
"status": "complete",
"submittedBy": "{ACCOUNT_ID}",
"createdDate": "10/02/2019 08:25 PM GMT",
"lastModifiedDate": "10/02/2019 08:25 PM GMT",
"userIds": [
{
"namespace": "email",
"value": "dsmith@acme.com",
"type": "standard",
"namespaceId": 6,
"isDeletedClientSide": false
},
{
"namespace": "ECID",
"value": "1123A4D5690B32A",
"type": "standard",
"namespaceId": 4,
"isDeletedClientSide": false
}
],
"productResponses": [
{
"product": "Analytics",
"retryCount": 0,
"processedDate": "10/02/2019 08:25 PM GMT",
"productStatusResponse": {
"status": "complete",
"message": "Success",
"responseMsgCode": "PRVCY-6000-200",
"responseMsgDetail": "Finished successfully."
}
},
{
"product": "Profile",
"retryCount": 0,
"processedDate": "10/02/2019 08:25 PM GMT",
"productStatusResponse": {
"status": "complete",
"message": "Success",
"responseMsgCode": "PRVCY-6000-200",
"responseMsgDetail": "Success dataSetIds = [5dbb87aad37beb18a96feb61], Failed dataSetIds = []"
}
},
{
"product": "AudienceManager",
"retryCount": 0,
"processedDate": "10/02/2019 08:25 PM GMT",
"productStatusResponse": {
"status": "complete",
"message": "Success",
"responseMsgCode": "PRVCY-6054-200",
"responseMsgDetail": "PARTIALLY COMPLETED- Data not found for some requests, check results for more info.",
"results": {
"processed": ["1123A4D5690B32A"],
"ignored": ["dsmith@acme.com"]
}
}
}
],
"downloadURL": "http://...",
"regulation": "ccpa"
}
productStatusResponse
productResponses
-Array enthält Informationen zum aktuellen Status des Auftrags in Bezug auf einen bestimmten Experience Cloud Anwendung.productStatusResponse.status
productStatusResponse.message
productStatusResponse.responseMsgCode
responseMsgDetail
.productStatusResponse.responseMsgDetail
productStatusResponse.results
results
-Objekt, das zusätzliche Informationen bereitstellt, die nicht von responseMsgDetail
.downloadURL
complete
, stellt dieses Attribut eine URL zum Herunterladen der Auftragsergebnisse als ZIP-Datei bereit. Diese Datei kann bis zu 60 Tagen nach Abschluss des Auftrags heruntergeladen werden.Auftragsstatus-Kategorien status-categories
In der folgenden Tabelle sind die verschiedenen möglichen Auftragsstatus-Kategorien und deren entsprechende Bedeutung aufgeführt:
complete
processing
submitted
error
processing
Status, wenn ein abhängiger untergeordneter Auftrag vorhanden ist, der noch verarbeitet wird.Nächste Schritte
Sie wissen jetzt, wie Sie Datenschutzaufträge mit dem Privacy Service API. Informationen zum Ausführen derselben Aufgaben über die Benutzeroberfläche finden Sie in der Privacy Service – UI-Übersicht.