Method: properties.submitUserDeletion

Envia uma solicitação de exclusão de usuário para uma propriedade.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome da propriedade para enviar a exclusão do usuário.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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ão user. O usuário que envia uma solicitação de exclusão para user pode ser apenas um dos seguintes:
userId

string

User-ID do Google Analytics.
clientId

string

ID do cliente do Google Analytics.
appInstanceId

string

ID da instância do aplicativo do Firebase.
userProvidedData

string

Dados fornecidos pelo usuário. Pode conter um endereço de e-mail ou um número de telefone.

Os endereços de e-mail precisam ser normalizados da seguinte forma:

  • Letras minúsculas
  • Remover pontos antes de @ nos endereços gmail.com/googlemail.com
  • Remoção de todos os espaços

Os números de telefone precisam ser normalizados da seguinte forma:

  • Remoção de todos os caracteres não alfanuméricos
  • adicionar + prefixo

Corpo da resposta

Mensagem de resposta para o RPC "properties.submitUserDeletion".

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "deletionRequestTime": string
}
Campos
deletionRequestTime

string (Timestamp format)

Marca o momento em que todos os dados de visitantes anteriores a esse ponto devem ser excluídos. Definido como o horário em que a solicitação de exclusão foi recebida.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Escopos de autorização

Requer o seguinte escopo OAuth:

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