Method: properties.submitUserDeletion

Envía una solicitud para borrar un usuario de una propiedad.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es el nombre de la propiedad para la que se enviará la solicitud de eliminación del usuario.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{

  // 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.
}
Campos
Campo de unión user. El usuario para el que se enviará una solicitud de eliminación user solo puede ser uno de los siguientes:
userId

string

Es el ID de usuario de Google Analytics.
clientId

string

Es el ID de cliente de Google Analytics.
appInstanceId

string

Es el ID de instancia de la aplicación de Firebase.
userProvidedData

string

Son los datos proporcionados por el usuario. Pueden contener una dirección de correo electrónico o un número de teléfono.

Las direcciones de correo electrónico deben normalizarse de la siguiente manera:

  • minúscula
  • quitar los puntos antes de @ para las direcciones de gmail.com o googlemail.com
  • quitar todos los espacios

Los números de teléfono deben normalizarse de la siguiente manera:

  • quitar todos los caracteres que no sean dígitos
  • agregar el prefijo +

Cuerpo de la respuesta

Es el mensaje de respuesta de la RPC properties.submitUserDeletion.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "deletionRequestTime": string
}
Campos
deletionRequestTime

string (Timestamp format)

Marca el momento en el que se deben borrar todos los datos de los visitantes anteriores. Se establece en la hora en la que se recibió la solicitud de eliminación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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