Política de suspensão de dados para APIs do Google Analytics

Este documento descreve a política de suspensão de uso de dados para a API de relatórios principais e API de metadados.

Visão geral

Dimensões e métricas (colunas) são usadas para consultar as APIs de relatórios do Google Analytics. Às vezes, é necessário adicionar, remover ou alterar o nome dessas colunas. A política de suspensão de uso de dados existe para aumentar a transparência da forma com que essas alterações são feitas.

Todas as alterações nas colunas são comunicadas por meio de registros de alterações, e a API de metadados é atualizada automaticamente para refletir essas alterações.

O que esta política aborda

Esta política aborda as dimensões e métricas expostas por APIs públicas. Ela não cobre a solicitação da API (parâmetros de consulta), a resposta da API, os valores retornados pela API e as combinações válidas de dimensões e métricas.

Novos dados

Quando colunas novas são adicionadas a uma API:

Remoção de dados

Quando colunas são removidas de uma API:

  • O registro de alterações da API correspondente é atualizado com detalhes sobre as colunas sendo removidas.
  • Na API de metadados, o atributo status da coluna é definido como DEPRECATED.
  • As colunas continuam a funcionar nas consultas de relatórios por no mínimo seis meses.
  • Depois de seis meses, as colunas são removidas da API de metadados e a consulta das colunas na API de relatórios resulta em um erro 400 Bad Request.

Alteração do nome de dados

Quando as colunas são renomeadas:

  • O registro de alterações da API correspondente é atualizado com detalhes sobre a coluna original e a de substituição.
  • Na API de metadados, o atributo status da coluna original é definido como DEPRECATED, e o atributo replacedBy é definido como o ID da coluna de substituição.
  • As colunas originais continuam a funcionar nas consultas de relatórios por no mínimo seis meses.
  • Depois de seis meses, as colunas originais são removidas da API de metadados e a consulta das colunas na API de relatórios resulta em um erro 400 Bad Request.

Remoção de atributos

Quando atributos são removidos da API de metadados:

Grupos

Às vezes, é necessário alterar o nome de um grupo ou a ordem das colunas. Quando isso ocorre: