Referência da API

Este é o guia de referência para a API de gerenciamento versão 3.0. Ele fornece detalhes completos sobre consultas e respostas para a configuração de dados do Google Analytics. Para ver um guia de conceitos e estrutura dos dados de configuração, consulte a Visão geral da versão 3.0.

Cada uma das seções deste guia define o método de solicitação e resposta para o tipo de entidade nos dados de configuração de um usuário autenticado.  Todas as solicitações são mostradas no formato REST.  No final da página de cada método, você pode testar a solicitação de maneira interativa no APIs Explorer usando o link "Faça um teste".

Tipos de recurso

  1. Resumos da conta
  2. Contas
  3. Propriedades da Web
  4. Vistas (perfis)
  5. Filtros
  6. Metas
  7. Segmentos
  8. Links do usuário da conta
  9. Links do usuário da propriedade da Web
  10. Links do usuário do perfil
  11. Links do filtro do perfil
  12. Links do Google AdWords
  13. Fontes de dados personalizadas
  14. Métricas personalizadas
  15. Dimensões personalizadas
  16. Uploads
  17. Experimentos
  18. Relatórios sem dados de amostra
  19. Públicos de remarketing

Resumos da conta

Para ver detalhes sobre o recurso de resumos da conta, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
list GET  /management/accountSummaries Lista resumos da conta (árvore simples composta de contas/propriedade/perfis) aos quais o usuário tem acesso.

Contas

Para detalhes do recurso de contas, consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
list GET  /management/accounts Lista todas as contas às quais o usuário tem acesso.

Propriedades da Web

Para detalhes do recurso de propriedades da Web, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
get GET  /management/accounts/accountId/webproperties/webPropertyId Mostra uma propriedade a qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties Cria uma nova propriedade.
list GET  /management/accounts/accountId/webproperties Lista as propriedades às quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId Atualiza uma propriedade existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId Atualiza uma propriedade existente.

Vistas (perfis)

Para detalhes do recurso de Vistas (perfis), consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Exclui uma vista da propriedade (perfil).
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Consulta uma vista da propriedade (perfil) à qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles Cria uma nova vista da propriedade (perfil).
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles Lista as vistas da propriedade (perfis) às quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Atualiza uma vista (perfil) existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId Atualiza uma vista da propriedade (perfil) existente.

Filtros

Para detalhes do recurso de filtros, consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/filters/filterId Exclui um filtro.
get GET  /management/accounts/accountId/filters/filterId Retorna os filtros aos quais o usuário tem acesso.
insert POST  /management/accounts/accountId/filters Cria um novo filtro.
list GET  /management/accounts/accountId/filters Lista todos os filtros de uma conta
patch PATCH  /management/accounts/accountId/filters/filterId Atualiza um filtro existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/filters/filterId Atualiza um filtro existente.

Metas

Para detalhes do recurso de metas, consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId Indica uma meta à qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals Cria uma nova meta.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals Lista as metas às quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId Atualiza uma vista (perfil) existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId Atualiza uma vista da propriedade (perfil) existente.

Segmentos

Para detalhes do recurso de segmentos, consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
list GET  /management/segments Lista os segmentos aos quais o usuário tem acesso.

Para ver detalhes sobre o recurso de links do usuário da conta, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/entityUserLinks/linkId Remove um usuário da conta determinada.
insert POST  /management/accounts/accountId/entityUserLinks Adiciona um novo usuário à conta em questão desde que ele tenha menos de cem contas.
list GET  /management/accounts/accountId/entityUserLinks Lista links de usuários de uma determinada conta.
update PUT  /management/accounts/accountId/entityUserLinks/linkId Atualiza permissões para um usuário existente em uma conta específica.

Para ver detalhes sobre o recurso de links do usuário da propriedade da Web, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId Remove um usuário da propriedade da Web determinada.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks Adiciona um novo usuário à propriedade da Web determinada.
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks Lista links do usuário de uma determinada propriedade da Web.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId Atualiza permissões para um usuário existente em uma determinada propriedade da Web.

Para ver detalhes sobre o recurso de links do usuário do perfil, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId Remove um usuário da vista (perfil) determinada.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks Adiciona um novo usuário à vista (perfil) determinada.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks Lista links de usuário do perfil de uma determinada vista (perfil).
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId Atualiza permissões para um usuário existente na vista (perfil) determinada.

Para ver detalhes sobre o recurso de links do filtro do perfil, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Exclui um link de filtro de perfil.
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Retorna um único link de filtro de perfil.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks Cria um novo link de filtro de perfil.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks Lista todos os links de filtro de um perfil.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Atualiza um link de filtro do perfil existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId Atualiza um link de filtro do perfil existente.

Para ver detalhes sobre o recurso de links do Google AdWords, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Exclui um link entre a propriedade da Web e o Google AdWords.
get GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Retorna um link entre a propriedade da Web e o Google AdWords ao qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks Cria um link entre a propriedade da Web e o Google AdWords.
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks Lista links entre a propriedade da Web e o Google AdWords de uma determinada propriedade da Web.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Atualiza um link existente entre a propriedade da Web e o Google AdWords. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId Atualiza um link existente entre a propriedade da Web e o Google AdWords.

Fontes de dados personalizadas

Para detalhes sobre o recurso de fontes de dados personalizadas, consulte a página representação de recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources Lista as fontes de dados personalizadas a que o usuário tem acesso.

Métricas personalizadas

Para detalhes sobre o recurso de métricas personalizadas, consulte a página representação de recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
get GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId Cria uma métrica personalizada à qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customMetrics Cria uma nova métrica personalizada.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics Lista métricas personalizadas às quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId Atualiza uma métrica personalizada existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId Atualiza uma métrica personalizada existente.

Dimensões personalizadas

Para detalhes sobre o recurso de dimensões personalizadas, consulte a página representação de recurso.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId Exibe uma dimensão personalizada à qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customDimensions Cria uma nova dimensão personalizada.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions Lista dimensões personalizadas às quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId Atualiza uma dimensão personalizada existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId Atualiza uma dimensão personalizada existente.

Uploads

Para detalhes do recurso de uploads, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
deleteUploadData POST  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/deleteUploadData Exclui dados associados a um upload anterior.
get GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads/uploadId Lista os uploads aos quais o usuário tem acesso.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads Lista os uploads aos quais o usuário tem acesso.
uploadData POST
https://www.googleapis.com/upload/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads
Faz o upload de dados para uma fonte de dados personalizada.

Experimentos

Para detalhes do recurso de experimentos, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Exclui um experimento.
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Retorna um experimento ao qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments Cria um novo experimento.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments Lista os experimentos aos quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Atualiza um experimento existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId Atualiza um experimento existente.

Relatórios sem dados de amostra

Para detalhes do recurso de relatórios sem dados de amostra, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relativos a https://www.googleapis.com/analytics/v3, a menos que especificado de outra forma
delete DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId Exclui um relatório sem dados de amostra.
get GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId Retorna um único relatório sem dados de amostra.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports Cria um novo relatório sem dados de amostra.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports Lista relatórios sem dados de amostra aos quais o usuário tem acesso.

Públicos de remarketing

Para ver detalhes sobre o recurso de públicos de remarketing, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/analytics/v3alpha, a menos que informado de outra forma
get GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Obtém um público de remarketing ao qual o usuário tem acesso.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences Cria um novo público de remarketing.
list GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences Lista os públicos de remarketing aos quais o usuário tem acesso.
patch PATCH  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Atualiza um público de remarketing existente. Esse método é compatível com a semântica de patch.
update PUT  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId Atualiza um público de remarketing existente.