Method: projects.addGoogleAnalytics

Vincula o FirebaseProject especificado a uma conta do Google Analytics.

Com ela, é possível:

  • Especifique um analyticsAccountId para provisionar uma nova propriedade do Google Analytics na conta especificada e associar a nova propriedade ao FirebaseProject.
  • Especifique um analyticsPropertyId para associar a propriedade ao FirebaseProject.

Observe que, ao chamar projects.addGoogleAnalytics:

  1. A primeira verificação determina se algum fluxo de dados na propriedade do Google Analytics corresponde a algum app do Firebase na FirebaseProject (com base no packageName ou no bundleId associados ao fluxo de dados). Em seguida, conforme aplicável, os fluxos de dados e os apps são vinculados. Essa vinculação automática só se aplica a AndroidApps e IosApps.
  2. Se nenhum fluxo de dados correspondente for encontrado para os apps do Firebase, novos fluxos de dados serão provisionados na propriedade do Google Analytics para cada um dos apps do Firebase. Um novo fluxo de dados é sempre provisionado para um app da Web, mesmo que ele tenha sido associado anteriormente a um fluxo na propriedade do Google Analytics.

Saiba mais sobre a hierarquia e a estrutura das contas do Google Analytics na documentação do produto.

O resultado dessa chamada é um Operation. Pesquise o Operation para acompanhar o processo de provisionamento chamando operations.get até que done seja true. Quando done for true, a Operation foi bem-sucedida ou falhou. Se a Operation for bem-sucedida, o response dela será definido como AnalyticsDetails. Se o Operation falhar, o error vai ser definido como google.rpc.Status.

Para chamar projects.addGoogleAnalytics, um membro do projeto precisa ser proprietário do FirebaseProject e ter a permissão Edit na conta do Google Analytics.

Se a FirebaseProject já tiver o Google Analytics ativado e você chamar projects.addGoogleAnalytics usando um analyticsPropertyId diferente da propriedade associada no momento, a chamada vai falhar. É possível que o Google Analytics já tenha sido ativado no Console do Firebase ou especificando timeZone e regionCode na chamada para projects.addFirebase.

Solicitação HTTP

POST https://firebase.googleapis.com/v1beta1/{parent=projects/*}:addGoogleAnalytics

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O nome do recurso de FirebaseProject que vai ser vinculado a uma conta do Google Analytics, no formato:

projects/PROJECT_IDENTIFIER

Consulte o campo FirebaseProject name para saber detalhes sobre os valores PROJECT_IDENTIFIER.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{

  // Union field analytics_resource can be only one of the following:
  "analyticsAccountId": string,
  "analyticsPropertyId": string
  // End of list of possible types for union field analytics_resource.
}
Campos
Campo de união analytics_resource.

Apenas um recurso do Google Analytics pode ser especificado no corpo da solicitação.
  • Para provisionar uma nova propriedade do Google Analytics e associá-la ao FirebaseProject, informe analyticsAccountId.
  • Para associar uma propriedade do Google Analytics a FirebaseProject, informe analyticsPropertyId.


analytics_resource só pode ser de um dos tipos a seguir:
analyticsAccountId

string

O ID da conta do Google Analytics que você quer vincular ao FirebaseProject.

Se você especificar esse campo, uma nova propriedade do Google Analytics será provisionada na sua conta e associará a nova propriedade ao FirebaseProject.

analyticsPropertyId

string

O ID da propriedade atual do Google Analytics que você quer associar ao FirebaseProject.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

Para saber mais, consulte a Visão geral da autenticação.