Het eindpunt van privacytaken

Laatste update: 2023-10-11
  • Onderwerpen:
  • Privacy
    Meer informatie over dit onderwerp
  • Gemaakt voor:
  • Developer
    User
    Admin
    Leader

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.

OPMERKING

Als u toestemmings- of opt-outverzoeken van klanten wilt beheren, raadpleegt u de leidraad voor het eindpunt van de overeenkomst.

Alle taken weergeven

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. De reactie wordt gepagineerd, toestaand u andere vraagparameters (page en size) om de reactie te filteren. U kunt meerdere parameters scheiden met ampersands (&).

GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}
Parameter Beschrijving
{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
  • 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} De pagina met gegevens die moet worden weergegeven met een op 0 gebaseerde nummering. De standaardwaarde is 0.
{SIZE} Het aantal resultaten dat op elke pagina moet worden weergegeven. De standaardwaarde is 1 en het maximum 100. Als het maximum wordt overschreden, retourneert de API een fout van 400 code.

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

BELANGRIJK

Privacy Service is alleen bedoeld voor betrokkenen en verzoeken om consumentenrechten. Elk ander gebruik van Privacy Service voor het opschonen of onderhouden van gegevens wordt niet ondersteund of toegestaan. Adobe is wettelijk verplicht deze tijdig te vervullen. Als zodanig is het testen van belasting op Privacy Service niet toegestaan, omdat dit een productieomgeving is en een onnodige achterstand oplevert bij geldige privacyverzoeken.

Er is nu een vaste uploadlimiet voor dagelijks gebruik om misbruik van de service te voorkomen. Gebruikers die misbruik van het systeem kunnen maken, hebben toegang tot de service uitgeschakeld. Daarna zal er een vergadering met hen worden gehouden om hun acties te bespreken en te bespreken of Privacy Service aanvaardbaar is.

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.

OPMERKING

Compatibele Adobe Experience Cloud-toepassingen gebruiken verschillende waarden voor het identificeren van betrokkenen. Zie de handleiding op Privacy Service- en Experience Cloud-toepassingen voor meer informatie over vereiste id's voor uw toepassing(en). Meer algemene richtlijnen voor het bepalen van welke id's u wilt verzenden naar Privacy Service, zie het document op identiteitsgegevens in privacyverzoeken.

De Privacy Service API ondersteunt twee soorten taakaanvragen voor persoonlijke gegevens:

BELANGRIJK

Terwijl toegang en schrappingsverzoeken als één enkele API vraag kunnen worden gecombineerd, opt-out verzoeken moeten afzonderlijk worden gemaakt.

Een toegangs-/verwijdertaak maken

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"
}'
Eigenschap Beschrijving
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 array access, 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 een namespace, valueen 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) Een array met producten van de Adobe die in de verwerking moeten worden opgenomen. Als deze waarde ontbreekt of anderszins leeg is, wordt het verzoek afgewezen. Omvat slechts producten die uw organisatie een integratie met heeft. Zie de sectie over aanvaarde productwaarden in het aanhangsel voor meer informatie.
expandIDs Een optionele eigenschap die, wanneer ingesteld op 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 Een optionele eigenschap die door Adobe Analytics wordt gebruikt en die de prioriteit voor het verwerken van aanvragen instelt. Accepteerde waarden zijn 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. Indien analyticsDeleteMethod wordt weggelaten, is dit het standaardgedrag.
  • purge: Alle gegevens worden volledig verwijderd.
mergePolicyId Bij het indienen van privacyverzoeken voor realtime-klantprofiel (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
}
Eigenschap Beschrijving
jobId Een alleen-lezen, unieke door het systeem gegenereerde id voor een taak. Deze waarde wordt gebruikt in de volgende stap van het opzoeken van een specifieke taak.

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

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.

BELANGRIJK

Gegevens voor eerder gemaakte taken kunnen alleen binnen 30 dagen na de einddatum van de taak worden opgehaald.

API-indeling

GET /jobs/{JOB_ID}
Parameter Beschrijving
{JOB_ID} De id van de taak die u wilt opzoeken. Deze id is geretourneerd onder 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"
}
Eigenschap Beschrijving
productStatusResponse Elk object in het dialoogvenster productResponses array bevat informatie over de huidige status van de taak ten opzichte van een specifieke Experience Cloud toepassing.
productStatusResponse.status De huidige statuscategorie van de taak. Zie de onderstaande tabel voor een lijst met beschikbare statuscategorieën en hun overeenkomstige betekenis.
productStatusResponse.message De specifieke status van de taak, die overeenkomt met de statuscategorie.
productStatusResponse.responseMsgCode Een standaardcode voor productresponsberichten die worden ontvangen door Privacy Service. De details van het bericht worden verstrekt onder responseMsgDetail.
productStatusResponse.responseMsgDetail Een gedetailleerdere uitleg van de status van de baan. Berichten voor vergelijkbare statussen kunnen per product verschillen.
productStatusResponse.results Voor bepaalde statussen kunnen sommige producten a results object dat aanvullende informatie biedt die niet wordt gedekt door responseMsgDetail.
downloadURL Als de status van de taak 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

In de volgende tabel worden de verschillende mogelijke taakstatuscategorieën en de bijbehorende betekenis weergegeven:

Status categorie Betekenis
complete De taak is voltooid en (indien vereist) worden bestanden vanuit elke toepassing geüpload.
processing Toepassingen hebben de taak erkend en worden momenteel verwerkt.
submitted De taak wordt voorgelegd aan elke toepasselijke toepassing.
error Er is iets misgegaan in de verwerking van de taak - er kan meer specifieke informatie worden verkregen door individuele taakdetails op te halen.
OPMERKING

Een ingediende baan kan in een 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.

Op deze pagina