Введение в Analytics Reporting API версии 4: краткое руководство по Python для сервисных аккаунтов

Из этой статьи вы узнаете, как выполнить авторизацию в Analytics Reporting API версии 4.

1. Включите API

Перед началом работы с Analytics Reporting API версии 4 используйте инструмент настройки, чтобы создать проект в Google API Console, включить API и зарегистрировать учетные данные.

Создание учетных данных

  1. Откройте страницу Сервисные аккаунты. При необходимости выберите проект.
  2. Нажмите Создать сервисный аккаунт.
  3. Укажите название аккаунта и выберите Создать новый закрытый ключ. Затем нажмите кнопку Сохранить.

Система создаст новую пару ключей (открытый и закрытый), которая будет сохранена на ваш компьютер. Эта копия является единственной, и вы должны самостоятельно обеспечивать ее сохранность.

Добавьте в Google Аналитику сервисный аккаунт

У нового сервисного аккаунта будет адрес электронной почты такого типа:

quickstart@PROJECT-ID.iam.gserviceaccount.com

Используйте этот адрес, чтобы добавить пользователя в представление Google Аналитики, к которому вам нужен доступ через API. Для выполнения задач, описанных в этом руководстве, потребуется только разрешение на чтение и анализ.

2. Установите клиентскую библиотеку

Вы можете воспользоваться менеджером пакетов или скачать и установить клиентскую библиотеку для Python вручную:

pip

Примените pip, специальный инструмент для установки пакетов Python:

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

Setuptools

Можно также использовать инструмент easy_install, входящий в пакет setuptools:

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

Установка вручную

Загрузите последнюю версию клиентской библиотеки Google API, распакуйте код и выполните его:

sudo python setup.py install

3. Настройте пример

Теперь нужно создать файл HelloAnalytics.py с кодом этого примера.

  1. Скопируйте или скачайте приведенный ниже код для HelloAnalytics.py.
  2. Переместите ранее скачанный файл client_secrets.json в каталог с исходным кодом.
  3. Замените значения SERVICE_ACCOUNT_EMAIL и KEY_FILE_LOCATION значениями из Developer Console.
  4. Измените значение VIEW_ID. Чтобы найти этот параметр, воспользуйтесь инструментом Account Explorer.
"""Hello Analytics Reporting API V4."""

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

SCOPES = ['https://www.googleapis.com/auth/analytics.readonly']
KEY_FILE_LOCATION = '<REPLACE_WITH_JSON_FILE>'
VIEW_ID = '<REPLACE_WITH_VIEW_ID>'

def initialize_analyticsreporting():
  """Initializes an Analytics Reporting API V4 service object.

  Returns:
    An authorized Analytics Reporting API V4 service object.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      KEY_FILE_LOCATION, SCOPES)

  # Build the service object.
  analytics = build('analyticsreporting', 'v4', credentials=credentials)

  return analytics

def get_report(analytics):
  """Queries the Analytics Reporting API V4.

  Args:
    analytics: An authorized Analytics Reporting API V4 service object.
  Returns:
    The Analytics Reporting API V4 response.
  """
  return analytics.reports().batchGet(
      body={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'startDate': '7daysAgo', 'endDate': 'today'}],
          'metrics': [{'expression': 'ga:sessions'}],
          'dimensions': [{'name': 'ga:country'}]
        }]
      }
  ).execute()

def print_response(response):
  """Parses and prints the Analytics Reporting API V4 response.

  Args:
    response: An Analytics Reporting API V4 response.
  """
  for report in response.get('reports', []):
    columnHeader = report.get('columnHeader', {})
    dimensionHeaders = columnHeader.get('dimensions', [])
    metricHeaders = columnHeader.get('metricHeader', {}).get('metricHeaderEntries', [])

    for row in report.get('data', {}).get('rows', []):
      dimensions = row.get('dimensions', [])
      dateRangeValues = row.get('metrics', [])

      for header, dimension in zip(dimensionHeaders, dimensions):
        print header + ': ' + dimension

      for i, values in enumerate(dateRangeValues):
        print 'Date range: ' + str(i)
        for metricHeader, value in zip(metricHeaders, values.get('values')):
          print metricHeader.get('name') + ': ' + value

def main():
  analytics = initialize_analyticsreporting()
  response = get_report(analytics)
  print_response(response)

if __name__ == '__main__':
  main()

4. Запустите пример

Запустите пример, используя следующий код:

python HelloAnalytics.py

Когда вы выполните все шаги, на экране появится количество сеансов в выбранном представлении за последние семь дней.

Устранение неполадок

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

Эта ошибка может возникнуть в Mac OS X, когда установка по умолчанию модуля six (зависимого компонента этой библиотеки) завершается до того, как установлен инструмент pip. Чтобы устранить проблему, добавьте место установки инструмента pip в системную переменную среды PYTHONPATH:

  • Определите место установки инструмента pip с помощью следующей команды:

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

  • Замените строку &lt;pip_install_path&gt; в файле ~/.bashrc значением, указанным выше:

    export PYTHONPATH=$PYTHONPATH:<pip_install_path>

  • Перезагрузите файл ~/.bashrc в окне терминала с помощью следующей команды:

    source ~/.bashrc