Contas controladas pelo parceiro de provisionamento – Guia do desenvolvedor de API

Introdução

O createAccountTree faz parte da API de provisionamento que pode ser usada para criar novas contas do Google Analytics em grande escala. Ao contrário do createAccountTicket, o createAccountTree não exige nenhuma interação do usuário final para concluir a criação da conta. O processo é totalmente automatizado. Isso é útil quando é necessário provisionar uma conta do Google Analytics que você controla em nome do cliente e ao fornecer a ele uma vista personalizada dos dados.

Essa API é reservada para os parceiros que controlam os sites ou as propriedades da Web dos usuários. Se os usuários controlam os próprios sites ou propriedades da Web, você deve criar contas do Google Analytics controladas pelo usuário.

Antes de começar

Todas as Google Analytics APIs são acessadas de maneira semelhante. Antes de começar a usar a API de aprovisionamento:

  • Leia a página Bibliotecas cliente para ver uma lista completa de bibliotecas cliente específicas de linguagens de programação que funcionam com a API.
  • Leia o Guia de referência para saber mais sobre a interface da API e sobre como acessar dados sem uma biblioteca cliente.

Cada biblioteca cliente fornece um único objeto de serviço de análise para acessar a API de provisionamento. Para criar o objeto de serviço, geralmente é necessário seguir estas etapas:

  1. Registre seu aplicativo no console de APIs do Google.
  2. Autorize a criação de uma nova conta do Google Analytics.
  3. Crie um objeto de serviço "Analytics".

Se você não tiver concluído essas etapas, pare e leia o Tutorial de apresentação da Google Analytics API. Ele orienta sobre as etapas iniciais de criação de um aplicativo da API Google Analytics. Depois de concluir essa etapa, você saberá como acessar as APIs do Google Analytics para realizar tarefas reais.

Conta modelo

Como parte da autorização para usar essa API, você precisará fornecer uma nova conta do Google Analytics, que serve como a conta modelo para a API. Quando novas contas são criadas, elas herdam várias configurações da conta de modelo, incluindo o aceitador dos Termos de Serviço, a Organização e várias configurações de compartilhamento de dados. Consulte a referência do createAccountTree para mais detalhes sobre a conta de modelo, incluindo uma lista de todos os dados herdados.

Provisionar uma conta

Para provisionar uma nova conta do Google Analytics, faça uma solicitação ao endpoint da API createAccountTree. Você precisará dos seguintes detalhes de provisionamento:

  • Campos Conta
    • Um accountName para a conta.
  • Campos da propriedade da Web
    • Um webpropertyName para a propriedade.
    • websiteUrl. Deve ser o URL associado à propriedade do usuário para essa conta do Google Analytics.
  • Campos de visualização
    • Um profileName para a visualização.
    • Um timezone para a visualização.

Depois de ter acesso aos detalhes, faça uma chamada autenticada para o endpoint da API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

Se for bem-sucedida, a API vai responder com os detalhes da conta, da propriedade da Web e da vista recém-criadas:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Propriedade e gerenciamento da conta

A conta criada do Google Analytics será de propriedade de qualquer conta de usuário que tenha autorizado a resposta por meio do OAuth. Por isso, recomendamos que sua organização use uma conta de serviço para gerenciar a conta do Google Analytics, em vez de uma conta de usuário individual.

Depois de criar a conta, você pode configurá-la com a API Management. Estas são algumas tarefas comuns para uma conta recém-criada:

Esclarecimento de relacionamentos de conta

Como acontece com todas as APIs do Google, é necessário um projeto do Google Cloud como ponto de partida para solicitar autorização. Conforme descrito na documentação do OAuth 2.0, essa conta é onde você gerencia suas credenciais para solicitações de API. No entanto, a conta do Google Analytics criada não está diretamente afiliada de forma alguma ao projeto do Cloud ou às contas de gerenciamento dele. Ela só é afiliada à conta de usuário ou serviço que autorizou a solicitação. Você pode usar a API Management se precisar configurar o acesso à conta do Google Analytics.