Stay organized with collections
Save and categorize content based on your preferences.
This document explains how you can delete data associated with a given user ID
using the Google Analytics User Deletion API. This tool is one of several tools
available to help you safeguard your
data.
You can use Firebase projects or Google Analytics properties to send User
Deletion API requests. The
https://www.googleapis.com/auth/analytics.user.deletion OAuth 2.0 scope is
required for the requests in this guide.
Send a deletion request
Use the
upsert
method to request the data deletion for a given user. The upsert method takes
a
userDeletionRequest
as its only parameter.
Specify the user whose data you want to delete by setting one of the IDs inside
the id.userId field. The type of the ID must be specified inside the id.type
field.
Here's a list of supported user ID types:
CLIENT_ID: Google Analytics client
ID (only supported when
propertyId field is set).
USER_ID: Google Analytics User
ID (only supported when
propertyId field is set).
APP_INSTANCE_ID: Firebase application instance ID
(only supported when firebaseProjectId or propertyId field is set).
Each data deletion request processes only the ID submitted in that request.
If you have multiple IDs associated with the same user, you must submit separate
deletion requests for each ID associated with that user. If you Use BigQuery
export, you must also process your own deletions there.
The
upsert
method returns a User Deletion Request
Resource
with the deletionRequestTime field set. The deletionRequestTime field tells
you the time at which the deletion request was received by Google Analytics.
Once deletion is requested, data associated with the user ID will be removed
from the Individual User Report within 72 hours, and then deleted from Analytics
servers during the next deletion process. Deletion processes are scheduled to
occur every two months. If you have exported the user data outside of Google
Analytics, we recommend you delete it there first.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThe Google Analytics User Deletion API allows you to delete data associated with a specific user ID, helping safeguard user data.\u003c/p\u003e\n"],["\u003cp\u003eData is removed from the Individual User Report within 72 hours of the request and permanently deleted from Analytics servers within two months.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.user.deletion\u003c/code\u003e OAuth 2.0 scope and utilizes the \u003ccode\u003eupsert\u003c/code\u003e method for deletion requests.\u003c/p\u003e\n"],["\u003cp\u003eSupported user ID types for deletion include \u003ccode\u003eCLIENT_ID\u003c/code\u003e, \u003ccode\u003eUSER_ID\u003c/code\u003e, and \u003ccode\u003eAPP_INSTANCE_ID\u003c/code\u003e, requiring separate requests for each ID associated with a user.\u003c/p\u003e\n"],["\u003cp\u003eIt's crucial to note that the API doesn't remove previously aggregated data or data exported to external platforms like BigQuery, requiring separate deletion processes.\u003c/p\u003e\n"]]],["The Google Analytics User Deletion API allows deletion of user data using the `upsert` method with a `userDeletionRequest`. Specify the user's ID ( `CLIENT_ID`, `USER_ID`, or `APP_INSTANCE_ID`) and its type. Each ID requires a separate request. Data is removed from the Individual User Report within 72 hours and from Analytics servers within two months, but not from aggregated reports or external exports. OAuth 2.0 scope `https://www.googleapis.com/auth/analytics.user.deletion` is necessary.\n"],null,["# Delete user data\n\nThis document explains how you can delete data associated with a given user ID\nusing the Google Analytics User Deletion API. This tool is one of several tools\navailable to help you [safeguard your\ndata](//support.google.com/analytics/answer/6004245).\n| **Important:** The User Deletion API doesn't remove data from reports based on previously aggregated data, such as user counts in the audience overview report, or from other places you may have exported data to, such as BigQuery.\n\nFor more details, see the [reference\ndocumentation](/analytics/devguides/config/userdeletion/v3/reference).\n\nYou can use Firebase projects or Google Analytics properties to send User\nDeletion API requests. The\n**https://www.googleapis.com/auth/analytics.user.deletion** OAuth 2.0 scope is\nrequired for the requests in this guide.\n\nSend a deletion request\n-----------------------\n\nUse the\n[`upsert`](/analytics/devguides/config/userdeletion/v3/reference/userDeletion/userDeletionRequest/upsert)\nmethod to request the data deletion for a given user. The `upsert` method takes\na\n[`userDeletionRequest`](/analytics/devguides/config/userdeletion/v3/reference/userDeletion/userDeletionRequest)\nas its only parameter.\n\nSpecify the user whose data you want to delete by setting one of the IDs inside\nthe `id.userId` field. The type of the ID must be specified inside the `id.type`\nfield.\n\nHere's a list of supported user ID types:\n\n- `CLIENT_ID`: Google Analytics [client\n ID](//support.google.com/analytics/answer/11593727) (only supported when `propertyId` field is set).\n- `USER_ID`: Google Analytics [User\n ID](//firebase.google.com/docs/analytics/userid) (only supported when `propertyId` field is set).\n- `APP_INSTANCE_ID`: Firebase [application instance ID](//firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId) (only supported when `firebaseProjectId` or `propertyId` field is set).\n\nEach data deletion request processes only the ID submitted in that request.\n\nIf you have multiple IDs associated with the same user, you must submit separate\ndeletion requests for each ID associated with that user. If you Use BigQuery\nexport, you must also process your own deletions there.\n\nLearn more about [user IDs](//support.google.com/analytics/answer/9213390).\n\nDeletion timeline\n-----------------\n\nThe\n[upsert](/analytics/devguides/config/userdeletion/v3/reference/userDeletion/userDeletionRequest/upsert)\nmethod returns a [User Deletion Request\nResource](/analytics/devguides/config/userdeletion/v3/reference/userDeletion/userDeletionRequest)\nwith the `deletionRequestTime` field set. The `deletionRequestTime` field tells\nyou the time at which the deletion request was received by Google Analytics.\n\nOnce deletion is requested, data associated with the user ID will be removed\nfrom the Individual User Report within 72 hours, and then deleted from Analytics\nservers during the next deletion process. Deletion processes are scheduled to\noccur every two months. If you have exported the user data outside of Google\nAnalytics, we recommend you delete it there first."]]
