API MANAGEMENT
Este é o guia de referência para a API Management 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 estão 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
- Resumos da conta
- Links de usuários da conta
- Contas
- Links do Google AdWords
- Origens de dados personalizadas
- Dimensões personalizadas
- Métricas personalizadas
- Experimentos
- Filtros
- Metas
- ID do cliente
- Links de filtros do perfil
- Links de usuários do perfil
- Públicos de remarketing
- Segmentos
- Relatórios sem dados de amostra
- Uploads
- Vistas (perfis)
- Propriedades da Web
- Links de usuários da propriedade da Web
Resumos da conta
Para ver detalhes sobre os 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 por contas/propriedades/perfis) aos quais o usuário tem acesso. |
Links de usuários da conta
Para ver detalhes sobre os links de usuários 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 de uma conta específica. |
| insert |
POST /management/accounts/accountId/entityUserLinks
|
Adiciona um novo usuário a uma conta específica 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 na conta especificada. |
Contas
Para ver detalhes sobre as contas, 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/accounts
|
Lista todas as contas às quais o usuário tem acesso. |
Links do Google AdWords
Para ver detalhes sobre os 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. |
Origens de dados personalizadas
Para ver detalhes sobre as origens de dados personalizadas, 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/accounts/accountId/webproperties/webPropertyId/customDataSources
|
Lista as origens de dados personalizadas às quais o usuário tem acesso. |
Dimensões personalizadas
Para ver detalhes sobre as dimensões personalizadas, 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 | ||
| 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. |
Métricas personalizadas
Para ver detalhes sobre as métricas personalizadas, 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 | ||
| 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. |
Experimentos
Para ver detalhes sobre os experimentos, 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/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. |
Filtros
Para ver detalhes sobre os filtros, 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/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 ver detalhes sobre as metas, 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 | ||
| 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 meta 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 meta existente. |
ID do cliente
Para ver detalhes sobre o Management.clientId, 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 | ||
| hashClientId |
POST /management/clientId:hashClientId
|
Os hashes informam o ID do cliente. |
Links de filtros do perfil
Para ver detalhes sobre os links de filtros 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 do perfil. |
| get |
GET /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId
|
Retorna um único link de filtro do perfil. |
| insert |
POST /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks
|
Cria um novo link de filtro do perfil. |
| list |
GET /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks
|
Lista todos os links de filtros de um perfil. |
| patch |
PATCH /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId
|
Atualiza um link de filtro de 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 de perfil existente. |
Links de usuários do perfil
Para ver detalhes sobre os links de usuários 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 de uma vista (perfil) específica. |
| insert |
POST /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks
|
Adiciona um novo usuário a uma vista (perfil) específica. |
| list |
GET /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks
|
Lista links de usuários 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) especificada. |
Públicos de remarketing
Para ver detalhes sobre os públicos de remarketing, 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/remarketingAudiences/remarketingAudienceId
|
Exclui um público de remarketing. |
| 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. |
Segmentos
Para ver detalhes sobre os segmentos, 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/segments
|
Lista os segmentos aos quais o usuário tem acesso. |
Relatórios sem dados de amostra
Para ver detalhes sobre os relatórios sem dados de amostra, 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/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. |
Uploads
Para ver detalhes sobre os uploads, 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 | ||
| 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
|
Faz o upload de dados para uma origem de dados personalizada. |
Vistas (perfis)
Para ver detalhes sobre as vistas (perfis), 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
|
Exclui uma vista (perfil). |
| get |
GET /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId
|
Consulta uma vista (perfil) à qual o usuário tem acesso. |
| insert |
POST /management/accounts/accountId/webproperties/webPropertyId/profiles
|
Cria uma nova vista (perfil). |
| list |
GET /management/accounts/accountId/webproperties/webPropertyId/profiles
|
Lista as vistas (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 (perfil) existente. |
Propriedades da Web
Para ver detalhes sobre as propriedades 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 | ||
| get |
GET /management/accounts/accountId/webproperties/webPropertyId
|
Mostra uma propriedade à 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. |
Links de usuários da propriedade da Web
Para ver detalhes sobre os links de usuários 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 de uma propriedade da Web específica. |
| insert |
POST /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks
|
Adiciona um novo usuário a uma propriedade da Web específica. |
| list |
GET /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks
|
Lista links de usuários 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. |