Het eindpunt van privacytaken
In dit document wordt beschreven hoe u met privacytaken werkt met API-aanroepen. Het gaat met name om het gebruik van de /job
in de Privacy Service API. Raadpleeg voordat u deze handleiding leest de gids Aan de slag voor belangrijke informatie die u moet weten om met succes vraag aan API te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.
Alle taken weergeven list
U kunt een lijst weergeven met alle beschikbare privacytaken binnen uw organisatie door een aanvraag in te dienen bij de GET /jobs
eindpunt.
API-indeling
Deze aanvraagindeling gebruikt een regulation
queryparameter voor de /jobs
eindpunt, daarom begint het met een vraagteken (?
) zoals hieronder weergegeven. Wanneer het vermelden van middelen, keert Privacy Service API tot 1000 banen terug en pagineert de reactie. Andere queryparameters gebruiken (page
, size
en datumfilters) om de reactie te filteren. U kunt meerdere parameters scheiden met ampersands (&
).
status
, fromDate
, en toDate
queryparameters.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}
Het regulatietype waarvoor u een query wilt uitvoeren. Tot de geaccepteerde waarden behoren:
apa_aus
ccpa
cpa
cpra_usa
ctdpa
ctdpa_usa
gdpr
hipaa_usa
lgpd_bra
mhmda
nzpa_nzl
pdpa_tha
ucpa_usa
vcdpa_usa
Zie het overzicht op ondersteunde verordeningen voor meer informatie over de privacyregels die de bovenstaande waarden vertegenwoordigen .
{PAGE}
0
.{SIZE}
100
en het maximum 1000
. Als het maximum wordt overschreden, retourneert de API een fout van 400 code.{status}
Standaard worden alle statussen opgenomen. Als u een statustype opgeeft, worden alleen privacytaken geretourneerd die overeenkomen met dat statustype. De toegestane waarden zijn onder meer:
processing
complete
error
{toDate}
De notatie YYYY-MM-DD wordt geaccepteerd. De datum die u opgeeft, wordt geïnterpreteerd als de beëindigingsdatum uitgedrukt in Greenwich Mean Time (GMT).
Als u deze parameter (en een bijbehorende
fromDate
), retourneert het standaardgedrag taken die de afgelopen zeven dagen zijn teruggestuurd. Als u toDate
moet u ook de fromDate
queryparameter. Als u niet allebei gebruikt, keert de vraag een fout 400 terug.{fromDate}
De notatie YYYY-MM-DD wordt geaccepteerd. De datum die u opgeeft, wordt geïnterpreteerd als de datum van oorsprong van het verzoek, uitgedrukt in Greenwich Mean Time (GMT).
Als u deze parameter (en een bijbehorende
toDate
), retourneert het standaardgedrag taken die de afgelopen zeven dagen zijn teruggestuurd. Als u fromDate
moet u ook de toDate
queryparameter. Als u niet allebei gebruikt, keert de vraag een fout 400 terug.{filterDate}
Verzoek
Met het volgende verzoek wordt een gepagineerde lijst opgehaald van alle taken binnen een organisatie, te beginnen bij de derde pagina met een paginaformaat van 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}'
Antwoord
Een succesvol antwoord retourneert een lijst met taken, waarbij elke taak details bevat zoals de bijbehorende jobId
. In dit voorbeeld bevat het antwoord een lijst met 50 taken, te beginnen op de derde pagina met resultaten.
Volgende pagina's openen
Om de volgende reeks resultaten in een gepagineerde reactie te halen, moet u een andere API vraag aan het zelfde eindpunt maken terwijl het verhogen van page
query parameter by 1.
Een privacytaak maken create-job
Voordat u een nieuwe taakaanvraag maakt, moet u eerst identificatiegegevens verzamelen over de betrokkenen van wie u de gegevens wilt benaderen, verwijderen of niet wilt verkopen. Zodra u de vereiste gegevens hebt, moet het in de lading van een verzoek van de POST aan /jobs
eindpunt.
De Privacy Service API ondersteunt twee soorten taakaanvragen voor persoonlijke gegevens:
- Toegang en/of verwijderen: Persoonlijke gegevens openen (lezen) of verwijderen.
- Uitschakelen: Persoonlijke gegevens markeren als niet te verkopen gegevens.
Een toegangs-/verwijdertaak maken access-delete
In deze sectie ziet u hoe u een aanvraag voor een toegangs-/verwijdertaak uitvoert met de API.
API-indeling
POST /jobs
Verzoek
Het volgende verzoek leidt tot een nieuw baanverzoek, dat door de attributen wordt gevormd die in de nuttige lading worden geleverd zoals hieronder beschreven.
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
(Vereist)Een array met verificatiegegevens voor uw organisatie. Elke weergegeven id bevat de volgende kenmerken:
namespace
: De naamruimte van een id.value
: De waarde van de id.
Het is vereist dat een van de id's gebruikt imsOrgId
als namespace
, met value
bevat de unieke id voor uw organisatie.
Aanvullende id's kunnen productspecifieke bedrijfsaanduidingen zijn (bijvoorbeeld Campaign
), die een integratie met een toepassing van de Adobe identificeren die tot uw organisatie behoort. Mogelijke waarden zijn accountnamen, clientcodes, gebruikers-id's of andere toepassings-id's.
users
(Vereist)Een array die een verzameling van ten minste één gebruiker bevat waarvan u de gegevens wilt openen of verwijderen. Een maximum van 1000 gebruikers kan in één enkel verzoek worden verstrekt. Elk gebruikersobject bevat de volgende informatie:
key
: Een id voor een gebruiker die wordt gebruikt om de afzonderlijke taak-id's in de reactiegegevens te kwalificeren. Het is aan te raden een unieke, gemakkelijk identificeerbare tekenreeks voor deze waarde te kiezen, zodat er later gemakkelijk naar kan worden verwezen of deze kan worden opgezocht.action
: Een array die de gewenste handelingen bevat die moeten worden uitgevoerd op de gegevens van de gebruiker. Afhankelijk van de handelingen die u wilt uitvoeren, moet deze arrayaccess
,delete
, of beide.userIDs
: Een verzameling identiteiten voor de gebruiker. Het aantal identiteiten dat één gebruiker kan hebben, is beperkt tot negen. Elke identiteit bestaat uit eennamespace
,value
en een naamruimtekwalificatie (type
). Zie de aanhangsel voor meer informatie over deze vereiste eigenschappen.
Voor een gedetailleerdere uitleg van users
en userIDs
, zie de gids voor problemen.
include
(Vereist)expandIDs
true
, is een optimalisatie voor het verwerken van de id's in de toepassingen (momenteel alleen ondersteund door Analytics). Indien weggelaten, wordt deze waarde standaard ingesteld op false
.priority
normal
en low
. Indien priority
wordt weggelaten, is het standaardgedrag normal
.analyticsDeleteMethod
Een optionele eigenschap die aangeeft hoe Adobe Analytics de persoonlijke gegevens moet verwerken. Voor dit kenmerk worden twee mogelijke waarden geaccepteerd:
anonymize
: Alle gegevens waarnaar wordt verwezen door de opgegeven verzameling van gebruikers-id's, worden anoniem gemaakt. IndienanalyticsDeleteMethod
wordt weggelaten, is dit het standaardgedrag.purge
: Alle gegevens worden volledig verwijderd.
mergePolicyId
profileService
), kunt u naar keuze identiteitskaart van specifiek verstrekken samenvoegingsbeleid die u wilt gebruiken voor het stikken van id's. Door een samenvoegbeleid te specificeren, kunnen de privacyverzoeken publieksinformatie omvatten wanneer het terugkeren van gegevens over een klant. Per aanvraag kan slechts één samenvoegbeleid worden opgegeven. Als er geen samenvoegingsbeleid is opgegeven, wordt segmenteringsinformatie niet opgenomen in de reactie.regulation
(Vereist)De verordening voor de privacybaan. De volgende waarden worden geaccepteerd:
apa_aus
ccpa
cpra_usa
gdpr
hipaa_usa
lgpd_bra
nzpa_nzl
pdpa_tha
vcdpa_usa
Zie het overzicht op ondersteunde verordeningen voor meer informatie over de privacyregels die de bovenstaande waarden vertegenwoordigen .
Antwoord
Een succesvol antwoord geeft de details van de nieuwe banen terug.
{
"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
Nadat de taakaanvraag is verzonden, kunt u verdergaan met de volgende stap van controleren van de status van de baan.
De status van een taak controleren check-status
U kunt informatie over een specifieke taak ophalen, zoals de huidige verwerkingsstatus, door de taak jobId
op het pad van een verzoek van de GET aan de /jobs
eindpunt.
API-indeling
GET /jobs/{JOB_ID}
{JOB_ID}
jobId
in geslaagde API-reacties voor een taak maken en aanbieden, alle taken.Verzoek
Met het volgende verzoek worden de gegevens opgehaald van de taak waarvan jobId
wordt opgegeven in het aanvraagpad.
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}'
Antwoord
Een geslaagde reactie retourneert de details van de opgegeven taak.
{
"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 bevat informatie over de huidige status van de taak ten opzichte van een specifieke Experience Cloud toepassing.productStatusResponse.status
productStatusResponse.message
productStatusResponse.responseMsgCode
responseMsgDetail
.productStatusResponse.responseMsgDetail
productStatusResponse.results
results
object dat aanvullende informatie biedt die niet wordt gedekt door responseMsgDetail
.downloadURL
complete
, biedt dit kenmerk een URL om de taakresultaten te downloaden als een ZIP-bestand. Dit bestand kan 60 dagen nadat de taak is voltooid, worden gedownload.Taakstatuscategorieën status-categories
In de volgende tabel worden de verschillende mogelijke taakstatuscategorieën en de bijbehorende betekenis weergegeven:
complete
processing
submitted
error
processing
staat als het een afhankelijke kindbaan heeft die nog verwerkt.Volgende stappen
U weet nu hoe u met de Privacy Service API. Voor informatie over hoe te om de zelfde taken uit te voeren gebruikend het gebruikersinterface, zie Overzicht van de gebruikersinterface voor Privacys Service.