O que é a API de metadados – visão geral

Este documento fornece uma visão geral de nível superior da API de metadados do Google Analytics. Para uma referência detalhada da API, consulte a Referência da API.

Introdução

A API de metadados retorna a lista e os atributos de colunas (ou seja, dimensões e métricas) expostos nas API de relatórios do Google Analytics. Os atributos retornados incluem o nome da interface do usuário, a descrição, o suporte a segmentos e mais.

Você pode usar a API de metadados para:

  • Automaticamente descobrir novas colunas
  • Acessar todos os atributos de dimensões e de métricas das APIs de relatórios do Google Analytics

Veja uma resposta ao vivo da API de metadados e saiba como você pode usá-la consultando o Guia do desenvolvedor.

Visão geral conceitual

Os conceitos fundamentais que regem a API de metadados são:

Colunas

Um recurso de colunas na API de metadados representa uma única dimensão ou métrica e contém informações como o ID e outros atributos dessa coluna. Um conjunto de recursos Column representa todas as dimensões e métricas de uma API de relatórios.

Uso da API

Ao consultar a API, você especifica o tipo de relatório para o qual deseja recuperar metadados. A resposta da API inclui um conjunto de todas as colunas (ou seja, dimensões e métricas) disponíveis para esse tipo de relatório. Consulte o Guia de referência da API de metadados para mais informações sobre a resposta da API e exemplos de código, e o Guia do desenvolvedor da API de metadados para detalhes sobre como trabalhar com a API.

Acesso à API

A API de metadados não requer autenticação e autorização. A única exigência é que seu aplicativo se identifique sempre que enviar uma solicitação para a Google Analytics API. Para detalhes sobre como fazer isso, consulte a seção Acesso à API do Guia do desenvolvedor.

Políticas de cotas e de suspensão de uso

A API de metadados lida com milhões de operações. Para impedir que o sistema receba mais operações do que pode processar e para garantir uma distribuição equitativa dos respectivos recursos, é necessário empregar um sistema de cotas. Consulte o guia Limites e cota para mais detalhes.

Para detalhes sobre como são tratadas as alterações às colunas da API de relatórios (ou seja, dimensões e métricas), consulte a Política de suspensão de uso de dados. Para saber como a API de metadados pode ser usada para verificar a existência de colunas com uso suspenso, consulte o Guia do desenvolvedor da API de metadados.