API Hello Analytics: краткое руководство по Python для учетных записей служб, API API Hello Analytics: краткое руководство по Python для учетных записей служб

В этом руководстве описаны шаги, необходимые для доступа к учетной записи Google Analytics, запроса API-интерфейсов Analytics, обработки ответов API и вывода результатов. В этом руководстве используются Core Reporting API v3.0 , Management API v3.0 и OAuth2.0 .

Шаг 1. Включите Analytics API

Чтобы начать использовать Google Analytics API, вам необходимо сначала использовать инструмент настройки , который поможет вам создать проект в консоли Google API, включить API и создать учетные данные.

Создайте идентификатор клиента

  1. Откройте страницу учетных записей службы . При появлении запроса выберите проект.
  2. Нажмите учетную запись службы» , введите имя и описание учетной записи службы. Вы можете использовать идентификатор учетной записи службы по умолчанию или выбрать другой, уникальный. Когда закончите, нажмите «Создать» .
  3. Следующий раздел «Разрешения учетной записи службы (необязательно)» не является обязательным. Нажмите Продолжить .
  4. На экране «Предоставить пользователям доступ к этой учетной записи службы» прокрутите вниз до раздела «Создать ключ» . Нажмите Создать ключ» .
  5. На появившейся боковой панели выберите формат вашего ключа: рекомендуется JSON .
  6. Нажмите Создать . Ваша новая пара открытого/закрытого ключей генерируется и загружается на ваш компьютер; он служит единственной копией этого ключа. Информацию о том, как безопасно хранить данные, см. в разделе Управление ключами сервисных учетных записей .
  7. Нажмите «Закрыть» в диалоговом окне «Закрытый ключ, сохраненный на вашем компьютере» , затем нажмите « Готово», чтобы вернуться к таблице ваших учетных записей служб.

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

Вновь созданная учетная запись службы будет иметь адрес электронной почты <projectId>-<uniqueId>@developer.gserviceaccount.com ; Используйте этот адрес электронной почты, чтобы добавить пользователя в учетную запись Google Analytics, к которой вы хотите получить доступ через API. Для этого руководства необходимы только разрешения на чтение и анализ .

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

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

пункт

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

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

Инструменты настройки

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

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

Ручная установка

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

sudo python setup.py install

Возможно, вам придется вызвать команду с правами суперпользователя ( sudo ) для установки в систему Python.

Шаг 3. Настройте образец

Вам нужно будет создать один файл с именем HelloAnalytics.py , который будет содержать данный пример кода.

  1. Скопируйте или загрузите следующий исходный код в HelloAnalytics.py .
  2. Переместите ранее загруженный client_secrets.json в тот же каталог, что и пример кода.
  3. Замените значения key_file_location соответствующими значениями из консоли разработчика.
"""A simple example of how to access the Google Analytics API."""

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


def get_service(api_name, api_version, scopes, key_file_location):
    """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.
        scopes: A list auth scopes to authorize for the application.
        key_file_location: The path to a valid service account JSON key file.

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

    credentials = ServiceAccountCredentials.from_json_keyfile_name(
            key_file_location, scopes=scopes)

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

    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):', results.get('profileInfo').get('profileName')
        print 'Total Sessions:', 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'
    key_file_location = '<REPLACE_WITH_JSON_FILE>'

    # Authenticate and construct service.
    service = get_service(
            api_name='analytics',
            api_version='v3',
            scopes=[scope],
            key_file_location=key_file_location)

    profile_id = get_first_profile_id(service)
    print_results(get_results(service, profile_id))


if __name__ == '__main__':
    main()

Шаг 4. Запустите образец

После того как вы включили Analytics API, установили клиентскую библиотеку Google API для Python и настроили пример исходного кода, образец готов к запуску.

Запустите образец, используя:

python HelloAnalytics.py

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

С помощью авторизованного объекта службы Analytics теперь можно запускать любые примеры кода, приведенные в справочной документации по Management API . Например, вы можете попробовать изменить код, чтобы использовать метод accountSummaries.list .

Поиск неисправностей

AttributeError: объект «Module_six_moves_urllib_parse» не имеет атрибута «urlparse».

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

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

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

  2. Добавьте следующую строку в файл ~/.bashrc , заменив <pip_install_path> значением, определенным выше:

    export PYTHONPATH=$PYTHONPATH:<pip_install_path>

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

    source ~/.bashrc

,

В этом руководстве описаны шаги, необходимые для доступа к учетной записи Google Analytics, запроса API-интерфейсов Analytics, обработки ответов API и вывода результатов. В этом руководстве используются Core Reporting API v3.0 , Management API v3.0 и OAuth2.0 .

Шаг 1. Включите Analytics API

Чтобы начать использовать Google Analytics API, вам необходимо сначала использовать инструмент настройки , который поможет вам создать проект в консоли Google API, включить API и создать учетные данные.

Создайте идентификатор клиента

  1. Откройте страницу учетных записей службы . При появлении запроса выберите проект.
  2. Нажмите учетную запись службы» , введите имя и описание учетной записи службы. Вы можете использовать идентификатор учетной записи службы по умолчанию или выбрать другой, уникальный. Когда закончите, нажмите «Создать» .
  3. Следующий раздел «Разрешения учетной записи службы (необязательно)» не является обязательным. Нажмите Продолжить .
  4. На экране «Предоставить пользователям доступ к этой учетной записи службы» прокрутите вниз до раздела «Создать ключ» . Нажмите Создать ключ» .
  5. На появившейся боковой панели выберите формат вашего ключа: рекомендуется JSON .
  6. Нажмите Создать . Ваша новая пара открытого/закрытого ключей генерируется и загружается на ваш компьютер; он служит единственной копией этого ключа. Информацию о том, как безопасно хранить данные, см. в разделе Управление ключами сервисных учетных записей .
  7. Нажмите «Закрыть» в диалоговом окне «Закрытый ключ, сохраненный на вашем компьютере» , затем нажмите « Готово», чтобы вернуться к таблице ваших учетных записей служб.

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

Вновь созданная учетная запись службы будет иметь адрес электронной почты <projectId>-<uniqueId>@developer.gserviceaccount.com ; Используйте этот адрес электронной почты, чтобы добавить пользователя в учетную запись Google Analytics, к которой вы хотите получить доступ через API. Для этого руководства необходимы только разрешения на чтение и анализ .

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

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

пункт

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

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

Инструменты настройки

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

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

Ручная установка

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

sudo python setup.py install

Возможно, вам придется вызвать команду с правами суперпользователя ( sudo ) для установки в систему Python.

Шаг 3. Настройте образец

Вам нужно будет создать один файл с именем HelloAnalytics.py , который будет содержать данный пример кода.

  1. Скопируйте или загрузите следующий исходный код в HelloAnalytics.py .
  2. Переместите ранее загруженный client_secrets.json в тот же каталог, что и пример кода.
  3. Замените значения key_file_location соответствующими значениями из консоли разработчика.
"""A simple example of how to access the Google Analytics API."""

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


def get_service(api_name, api_version, scopes, key_file_location):
    """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.
        scopes: A list auth scopes to authorize for the application.
        key_file_location: The path to a valid service account JSON key file.

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

    credentials = ServiceAccountCredentials.from_json_keyfile_name(
            key_file_location, scopes=scopes)

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

    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):', results.get('profileInfo').get('profileName')
        print 'Total Sessions:', 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'
    key_file_location = '<REPLACE_WITH_JSON_FILE>'

    # Authenticate and construct service.
    service = get_service(
            api_name='analytics',
            api_version='v3',
            scopes=[scope],
            key_file_location=key_file_location)

    profile_id = get_first_profile_id(service)
    print_results(get_results(service, profile_id))


if __name__ == '__main__':
    main()

Шаг 4. Запустите образец

После того как вы включили Analytics API, установили клиентскую библиотеку Google API для Python и настроили пример исходного кода, образец готов к запуску.

Запустите образец, используя:

python HelloAnalytics.py

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

С помощью авторизованного объекта службы Analytics теперь можно запускать любые примеры кода, приведенные в справочной документации по Management API . Например, вы можете попробовать изменить код, чтобы использовать метод accountSummaries.list .

Поиск неисправностей

AttributeError: объект «Module_six_moves_urllib_parse» не имеет атрибута «urlparse».

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

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

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

  2. Добавьте следующую строку в файл ~/.bashrc , заменив <pip_install_path> значением, определенным выше:

    export PYTHONPATH=$PYTHONPATH:<pip_install_path>

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

    source ~/.bashrc