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 de acceso

Parámetros
name

string

Es 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 que envía una solicitud de eliminación para user solo puede ser uno de los siguientes:
userId

string

User-ID de Google Analytics
clientId

string

ID de cliente de Google Analytics
appInstanceId

string

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

string

Datos proporcionados por el usuario Puede 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
  • Quita los puntos antes del signo @ en las direcciones de gmail.com o googlemail.com.
  • Quita todos los espacios.

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

  • Quita todos los caracteres que no sean dígitos.
  • agregar + prefijo

Cuerpo de la respuesta

Es el mensaje de respuesta para la RPC de 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 a partir del cual se deben borrar todos los datos de los visitantes anteriores a este punto. Se establece en la fecha y hora en que se recibió la solicitud de eliminación.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 0, 3, 6 o 9 dígitos fraccionarios. 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