Apresentação da Google Analytics API: início rápido de Python para contas de serviço

Este tutorial mostra as etapas necessárias para acessar uma conta do Google Analytics, consultar as APIs do Google Analytics, lidar com as respostas da API e gerar os resultados. A API de relatórios principais v3.0, a API de gerenciamento v3.0 e o OAuth2.0 são usados neste tutorial.

Etapa 1: ativar a Google Analytics API

Para começar a usar a Google Analytics API, primeiro use a ferramenta de configuração, que fornece orientações para você criar um projeto no console de APIs do Google, ativar a API e criar credenciais.

Criar um ID de cliente

  1. Abra a página Contas de serviço. Se solicitado, selecione um projeto.
  2. Clique em Criar conta de serviço.
  3. Na janela Criar conta de serviço, atribua um nome à conta de serviço e selecione Fornecer uma nova chave privada. Se você deseja conceder autoridade de todo o domínio do G Suite à conta de serviço, selecione também Habilitar a delegação em todo o domínio do G Suite. Em seguida, clique em Criar.

Seu novo par de chave pública/privada é gerado, e o download dele é feito na sua máquina. Essa é a única cópia da chave. Você é responsável por armazená-la com segurança.

Adicionar conta de serviço à conta do Google Analytics

A conta de serviço recém-criada terá um endereço de e-mail, &ltprojectId&gt-&ltuniqueId&gt@developer.gserviceaccount.com. Use-o para adicionar um usuário à conta do Google Analytics que você deseja acessar por meio da API. Apenas para este tutorial, são necessárias permissões de leitura e análise.

Etapa 2: instalar a biblioteca cliente do Google

Você pode usar um gerenciador de pacotes ou fazer o download e instalar a biblioteca cliente de Python manualmente:

pip

Use pip, a ferramenta recomendada para a instalação de pacotes Python:

sudo pip install --upgrade google-api-python-client

Setuptools

Use a ferramenta easy_install incluída no pacote setuptools:

sudo easy_install --upgrade google-api-python-client

Instalação manual

Faça o download da biblioteca cliente para python mais recente, descompacte o código e execute:

sudo python setup.py install

Talvez seja necessário chamar o comando usando privilégios de superusuário (sudo) para instalar no Python do sistema.

Etapa 3: configurar a amostra

Será necessário criar um único arquivo chamado HelloAnalytics.py, que conterá o código de amostra em questão.

  1. Copie ou faça o download do código de amostra a seguir para HelloAnalytics.py.
  2. Mova o client_secrets.p12 recebido anteriormente para o mesmo diretório que o código de amostra.
  3. Substitua os valores de service_account_email e key_file_location pelos valores apropriados do console do desenvolvedor.
"""A simple example of how to access the Google Analytics API."""

import argparse

from apiclient.discovery import build
from oauth2client.service_account import ServiceAccountCredentials

import httplib2
from oauth2client import client
from oauth2client import file
from oauth2client import tools

def get_service(api_name, api_version, scope, key_file_location,
                service_account_email):
  """Get a service that communicates to a Google API.

  Args:
    api_name: The name of the api to connect to.
    api_version: The api version to connect to.
    scope: A list auth scopes to authorize for the application.
    key_file_location: The path to a valid service account p12 key file.
    service_account_email: The service account email address.

  Returns:
    A service that is connected to the specified API.
  """

  credentials = ServiceAccountCredentials.from_p12_keyfile(
    service_account_email, key_file_location, scopes=scope)

  http = credentials.authorize(httplib2.Http())

  # Build the service object.
  service = build(api_name, api_version, http=http)

  return service

def get_first_profile_id(service):
  # Use the Analytics service object to get the first profile id.

  # Get a list of all Google Analytics accounts for this user
  accounts = service.management().accounts().list().execute()

  if accounts.get('items'):
    # Get the first Google Analytics account.
    account = accounts.get('items')[0].get('id')

    # Get a list of all the properties for the first account.
    properties = service.management().webproperties().list(
        accountId=account).execute()

    if properties.get('items'):
      # Get the first property id.
      property = properties.get('items')[0].get('id')

      # Get a list of all views (profiles) for the first property.
      profiles = service.management().profiles().list(
          accountId=account,
          webPropertyId=property).execute()

      if profiles.get('items'):
        # return the first view (profile) id.
        return profiles.get('items')[0].get('id')

  return None

def get_results(service, profile_id):
  # Use the Analytics Service Object to query the Core Reporting API
  # for the number of sessions within the past seven days.
  return service.data().ga().get(
      ids='ga:' + profile_id,
      start_date='7daysAgo',
      end_date='today',
      metrics='ga:sessions').execute()

def print_results(results):
  # Print data nicely for the user.
  if results:
    print 'View (Profile): %s' % results.get('profileInfo').get('profileName')
    print 'Total Sessions: %s' % results.get('rows')[0][0]

  else:
    print 'No results found'

def main():
  # Define the auth scopes to request.
  scope = ['https://www.googleapis.com/auth/analytics.readonly']

  # Use the developer console and replace the values with your
  # service account email and relative location of your key file.
  service_account_email = '<Replace with your service account email address.>'
  key_file_location = '<Replace with /path/to/generated/client_secrets.p12>'

  # Authenticate and construct service.
  service = get_service('analytics', 'v3', scope, key_file_location,
    service_account_email)
  profile = get_first_profile_id(service)
  print_results(get_results(service, profile))

if __name__ == '__main__':
  main()

Etapa 4: executar a amostra

Depois de você ter ativado a Google Analytics API, instalado a biblioteca cliente das Google APIs para Python e configurado o código-fonte da amostra, ela está pronta para ser executada.

Execute a amostra usando:

python HelloAnalytics.py

Quando você concluir essas etapas, a amostra gerará o nome da primeira vista da propriedade (perfil) do Google Analytics do usuário autorizado, além do número de sessões dos últimos sete dias.

Com o objeto de serviço autorizado do Google Analytics, agora você pode executar qualquer uma das amostras de código nos documentos de referência da API de gerenciamento. Por exemplo, você pode tentar alterar o código para usar o método accountSummaries.list.

Solução de problemas

AttributeError: 'Module_six_moves_urllib_parse' object has no attribute 'urlparse'

Esse erro pode ocorrer no Mac OSX em que a instalação padrão do módulo "six" (uma dependência dessa biblioteca) é carregada antes do módulo que o pip instalou. Para corrigir o problema, adicione o local de instalação do pip à variável de ambiente do sistema PYTHONPATH:

  1. Determine o local de instalação do pip com este comando:

    pip show six | grep "Location:" | cut -d " " -f2
    

  2. Adicione a linha a seguir ao seu arquivo ~/.bashrc, substituindo <pip_install_path> pelo valor determinado acima:

    export PYTHONPATH=$PYTHONPATH:<pip_install_path>
    
  3. Atualize seu arquivo ~/.bashrc nas janelas de qualquer terminal aberto usando este comando:

    source ~/.bashrc