API User Deletion: visão geral

Este documento apresenta uma visão geral de alto nível da API de exclusão de usuários do Google Analytics.

Introdução

Com a API de exclusão de usuários do Google Analytics, os clientes podem processar exclusões de dados associados a um determinado identificador de usuários. Ela é uma das várias ferramentas disponíveis para ajudar na proteção dos seus dados.

Visão geral

Usando a API de exclusão de usuários, um cliente do Google Analytics pode excluir dados de um determinado identificador de usuários em um projeto ou propriedade da Web. As solicitações de exclusão de usuários podem ser feitas por meio de projetos do Firebase ou propriedades do Google Analytics.

Como solicitar a exclusão de dados

Use o método upsert para solicitar a exclusão de dados de um determinado usuário. Ele usa um Recurso de solicitação de exclusão de usuário como único parâmetro. Uma solicitação de exclusão de dados pode ser aplicada a uma propriedade da Web do Google Analytics (especificada pelo campo webPropertyId) ou a uma propriedade do GA4(especificada pelo campo propertyId). Defina um dos identificadores dentro do campo id.userId para especificar o usuário cujos dados serão excluídos. O tipo do identificador precisa ser especificado no campo id.type. Tipos de identificadores de usuário aceitos:

  • CLIENT_ID: Client-ID do Google Analytics (aceito apenas quando o campo webPropertyId ou propertyId está definido).
  • USER_ID: User ID do Google Analytics (aceito apenas quando o campo webPropertyId ou propertyId está definido).
  • APP_INSTANCE_ID: ID da instância do aplicativo do Firebase (aceito apenas quando o campo firebaseProjectId ou propertyId está definido).

Saiba mais sobre os recursos User ID e Client ID na Central de Ajuda do Google Analytics.

Exclusão de dados

O método upsert retorna um Recurso de solicitação de exclusão de usuário com o campo deletionRequestTime definido. O campo deletionRequestTime marca o momento em que a solicitação de exclusão foi recebida pelo Google Analytics.

O escopo do OAuth 2.0 https://www.googleapis.com/auth/analytics.user.deletion é necessário para chamar o método upsert.