Best practices for Privacy Service

Use Privacy Service to automate compliance with data privacy regulations when customers wish to access or delete their personal data from your data stores. To address these evolving business needs, Privacy Service offers a RESTful API and UI to submit access and deletion requests for customer data across Adobe Experience Cloud applications.

This guide outlines the best practices to efficiently process privacy requests and optimize completion response times when managing customer data requests.

Getting started getting-started

This guide requires a working understanding of Privacy Service and how it allows you to manage access and delete requests from your data subjects (customers) across Adobe Experience Cloud applications. You are also recommended to have read the guide on creating a privacy job request in the UI or the API, and understand how to perform these operations programmatically.

Prerequisites prerequisites

Access to Adobe Experience Platform Privacy Service is controlled through granular role-based permissions in Adobe Admin Console. You need the relevant permissions in a product profile to use specific features in the Privacy Service UI and API. Contact your system administrator if you require additional permissions.

Administrators can refer to the guide on managing permissions for Privacy Service for more information.

Privacy job creation guidelines creation-guidelines

To streamline your request processing and improve response times, consider the following guidelines when creating privacy jobs. This applies to both the API and UI methods.

Monitor privacy jobs status monitor-status

To effectively monitor privacy jobs and check their status, Privacy Service provides three methods. The available methods are listed below in order of monitoring efficiency and productivity. Each method includes best practice guidelines to improve your experience, followed by an ideal scenario example that combines all the approaches.

Receive real-time notifications real-time-notifications

I/O Events offer near real-time status monitoring through status events. This is the most efficient method as it avoids the need to implement polling mechanisms and incur additional API traffic.

Recommendations:

See the documentation on subscribing to Privacy Service events for instructions on setting up an event registration for Privacy Service notifications and how to interpret notification payloads.

Retrieve all jobs based on filters retrieve-filtered-responses-for-all-jobs

To retrieve all your privacy job data based on any specified filters, perform a GET request to the /jobs endpoint. This API call is useful to provide a high-level view of the current job status for large sets of job IDs with only a single request. It does lack detailed product responses, but they can be found using the /jobs/{jobID} endpoint.

A GET request to the /jobs endpoint is best used to gather or compare the status data of a large set of job IDs but is not meant for regular polling type activities.

Recommendations:

You can view a list of all the current privacy jobs in your organization through the Privacy Service UI. See the managing privacy jobs in the UI documentation for information on how to filter the job request list. Alternatively, see the documentation on the use of the /job endpoint in the Privacy Service API.

The Privacy Service API documentation contains details on the available query parameter filters.

Retrieve detailed responses for a single job retrieve-detailed-responses-for-specific-jobs

To retrieve detailed responses for a single job, perform a GET request to the /jobs/{jobID} endpoint. This method is intended for deeper information gathering, like product-specific responses and success messages. A call to this endpoint is the best way to see which products have responded and which are still pending, although it is not meant for regular polling activity.

See the /jobs/{JOB_ID} endpoint documentation for details on how to check the status of a specific job.

Ideal scenario example ideal-scenario

Use a webhook so that the system can automatically update records and provide reporting or alerts when groups of the IDs from a request are complete. If jobs are still outstanding, the system retrieves these job statuses with a GET request to the Privacy Service API /jobs endpoint and provides a high-level update of the list.

If a particular job is still pending, or has returned an error, you can retrieve the detailed response with a GET request to the /job/{jobId} endpoint.

Access request data access-request-data

When data-subject information is requested, each service returns data in a format that is consistent with the way they store and use that data. Once all services have completed the request, a .ZIP archive file URL is provided in the job details to allow for this data to be downloaded. See the troubleshooting guide for information on how to download privacy job results.

The following are key items of note relating to the management of the data archive:

Recommendations:

Technical considerations technical-considerations

There are certain technical considerations to be aware of when completing Privacy Service requests:

Next steps

By reading this document, you now have the necessary knowledge and practices for efficient and effective use of the Privacy Service. Next, see the troubleshooting guide for answers to frequently asked questions about Privacy Service, and information on commonly encountered errors in the API.