Method: properties.submitUserDeletion

Submits a request for user deletion for a property.

HTTP request

POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*}:submitUserDeletion

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the property to submit user deletion for.

Request body

The request body contains data with the following structure:

JSON representation 
{

  // Union field user can be only one of the following:
  "userId": string,
  "clientId": string,
  "appInstanceId": string,
  "userProvidedData": string
  // End of list of possible types for union field user.
}
Fields
Union field user. The user to submit a deletion request for user can be only one of the following:
userId

string

Google Analytics user ID.
clientId

string

Google Analytics client ID.
appInstanceId

string

Firebase application instance ID.
userProvidedData

string

The un-hashed, unencrypted, user-provided data.

Response body

Response message for properties.submitUserDeletion RPC.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "deletionRequestTime": string
}
Fields
deletionRequestTime

string (Timestamp format)

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.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit