SubmitUserDeletion
Submit a request for user deletion for a property. Requires the following OAuth scope: https://www.googleapis.com/auth/analytics.edit
Stored Procedure-Specific Information
Google Analytics allows only a small subset of columns to be used in the EXEC query. These columns can typically only be used with the = comparison. Only one of UserId, ClientId, AppInstanceId, or UserProvidedData can be specified in the query.
For example:
EXECUTE SubmitUserDeletion PropertyId='123456', UserProvidedData='[email protected]';
Input
| Name | Type | Required | Description |
| PropertyId | String | True | The id of the property to submit user deletion for. |
| UserId | String | False | Google Analytics user ID. Only one of UserId, ClientId, AppInstanceId, or UserProvidedData can be specified. |
| ClientId | String | False | Google Analytics client ID. Only one of UserId, ClientId, AppInstanceId, or UserProvidedData can be specified. |
| AppInstanceId | String | False | Firebase application instance ID. Only one of UserId, ClientId, AppInstanceId, or UserProvidedData can be specified. |
| UserProvidedData | String | False | User-provided data. May contain either one email address or one phone number. Only one of UserId, ClientId, AppInstanceId, or UserProvidedData can be specified. |
Result Set Columns
| Name | Type | Description |
| Success | String | Whether the stored procedure was successfully executed. |
| DeletionRequestTime | String | Marks the moment for which all visitor data before this point should be deleted. This is set to the time at which the deletion request was received. |