Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
Method: properties.submitUserDeletion
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-19 UTC.
[null,null,["Última atualização 2025-08-19 UTC."],[],[],null,["# Method: properties.submitUserDeletion\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SubmitUserDeletionResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nSubmits a request for user deletion for a property.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*}:submitUserDeletion`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the property to submit user deletion for. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { // 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`. } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Union field `user`. The user to submit a deletion request for `user` can be only one of the following: ||\n| `userId` | `string` Google Analytics [user ID](https://firebase.google.com/docs/analytics/userid). |\n| `clientId` | `string` Google Analytics [client ID](https://support.google.com/analytics/answer/11593727). |\n| `appInstanceId` | `string` Firebase [application instance ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId). |\n| `userProvidedData` | `string` [User-provided data](https://support.google.com/analytics/answer/14077171). May contain either one email address or one phone number. Email addresses should be normalized as such: - lowercase - remove periods before @ for gmail.com/googlemail.com addresses - remove all spaces Phone numbers should be normalized as such: - remove all non digit characters - add + prefix |\n\n### Response body\n\nResponse message for properties.submitUserDeletion RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------|\n| ``` { \"deletionRequestTime\": string } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletionRequestTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#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\"`. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]