3482
правки
Изменения
м
=== Установка необходимых пакетов ===Прежде чем приступить к работе с пакетами, предназначенными для работы с Google Analytics API, необходимо создать новое приложение в [https://console.developers.google.com Google Developers Console] и получить '''Client ID''' (идентификатор клиента) и '''Client secret''' (секретный ключ клиента) для доступа к API Google Analytics. Не смотря на то, что некоторые пакеты, например <code>rga</code>, предоставляют ключи доступа, сгенерированные автором пакета, мы всё же рекомендуем получить собственные ключи, т.к. сторонние ключи могут быть в любой момент отозваны автором.
Устанавливаем и подключаем пакет {{r-package|devtools}}, для доступа к [https://github.com/ github] (требуется только в первый раз, для установки пакета {{r-package|rga}})Пошаговая инструкция приведена ниже:
{{r-code|code=<nowiki>> install.packages# Создание нового проекта ("devtools"можно пропустить, если проект уже создан):> library#* Откройте страницу https://console.developers.google.com/project;#* В левой верхней части страницы нажмите на красную кнопку с надписью '''Create Project''';#* Во всплывающем окне в поле '''PROJECT NAME''' введите название проекта;#* Подтвердите создание проекта, нажав на кнопку '''Create'''.# Активация доступа к API Google Analytics:#* Выберите проект в списке проектов на странице https://console.developers.google.com/project;#* На боковой панели слева выберите пункт '''APIs & auth''';#* на вкладке '''APIs''' активируйте '''Analytics API''', нажав на кнопку с надписью `OFF` (devtoolsубедитесь, что вместо надписи `OFF` появилось `ON`)<.# Создание нового приложения:#* В боковой панели слева выберите пункт '''APIs & auth''', подпункт '''Credentials''';#* В левой части страницы нажмите на кнопку с надписью '''Create new Client ID''';#* Во всплывающем окне выберите пункт '''Installed application''' в списке '''APPLICATION TYPE''' и пункт '''Other''' в списке '''INSTALLED APPLICATION TYPE'''.#* Подтвердите создание приложения, нажав на кнопку с надписью '''Create Client ID'''.# Получение Client ID и Client secret:#* Выберите проект в списке проектов на странице https:/nowiki>}}/console.developers.google.com/project;#* В боковой панели слева выберите пункт '''APIs & auth''', подпункт '''Credentials''';#* В таблице с названием '''Client ID for native application''' скопируйте значения полей '''Client ID''' и '''Client secret'''.
Устанавливаем пакет <code>rga</code>:Теперь вы в любой момент можете вернуться на страницу '''Credentials''' и узнать '''Client ID''' и '''Client secret'''.
Загрузка пакета доступа к GA Перед началом работы необходимо загрузить пакет <code>rga</code> (требуется только в начале работы при запуске новой R-сессии):
Запрет верификации SSL-соединения (требуется только для ОС WindowsДля предоставления доступа к данным Google Analytics API из пакета <code>rga</code> неободимо пройти процедуру авторизации. Для этого используется функция <code>rga.open</code>, чтобы избежать ошибок при аутентификации)которая принимает следующие аргументы:
{{r-* <code|>instance</code=> - имя переменной, которая будет содержать информацию о доступе к APi Google Analytics;* <nowikicode>where</code> options(RCurlOptions = list(capath = system.file("CurlSSL"- путь и/или имя файла, "cacertкоторый будет использоваться для кэширования информации;* <code>client.pem", package = "RCurl"), sslid</code> - ID клиента;* <code>client.verifypeer = FALSE))secret</nowikicode>}}- секретный ключ.
# Необходимо создать проект на странице https://console.developers.google.com/project;# На вкладке APIs & auth на вкладке APIs надо активировать Analytics API, нажав на кнопку, где написано <{{r-code|code=<nowiki>OFF</code>rga.# Во вкладке APIs & auth перейти во вкладку Credentialsopen(instance = "ga", где выбрать Create new Client ID;# При создании Client ID выбрать APPLICATION TYPE: Installed applicationclient.id = "XXXXXX", INSTALLED APPLICATION TYPE: otherclient.secret = "XXXXXXX", и нажать create;# В результате будет Client ID where = и Client secret = ;# На вкладке Consent screen необходимо выбрать рабочий email и дать название приложению (Product name"ga.rga"), сохранить;</nowiki>}}
Получаем токен доступа (откроется После выполнения данной команды будет открыт интернет браузер, где надо будет выбрать свой почтовый аккаунт со страницей запроса подтверждения разрешения на доступ к данным Google Analytics. Необходимо авторизоваться под своей учётной записью Google и подтвердить вход в API, тогда выдадут код, который надо будет вставить в консоль): {{r-code|code=<nowiki>> rgaразрешение на доступ к данным Google Analytics.open(instance = "ga"Отметим, client.id = "", client.secret = "", where = "api.rga")</nowiki>}} Пояснения по значениям аргументов: * <code>client.id</code> необходимо вставить сюда Client ID;* <code>client.secret</code> необходимо вставить сюда Client secretчто пакет `RGA` запрашивает доступ '''только для чтения''' данных.
→Общее описание
== Общее описание ==
На данный момент, несмотря на все многообразие, в официальном репозитории CRAN нет пакетов для работы с API Google Analytics. Однако на сторонних ресурсах, тем не менее, можно обнаружить три рабочих решения: [https://code.google.com/p/r-google-analytics/ <code>RGoogleAnalytics</code>], [http://skardhamar.github.io/rga/ <code>rga</code>] и , [https://github.com/jdeboer/ganalytics <code>ganalytics</code>] и [https://bitbucket.org/unikum/rga RGA]. <ref>Пакеты <code>rga</code> и , <code>ganalytics</code> и <code>RGA</code> в ближайшее время могут появиться и в CRAN, работы в этом направлении уже ведутся.</ref>
Сравнительная таблица пактов для работы с GA APIGoogle Analytics:
{| class="wikitable sortable" width="800px"
! width="20%" | [https://github.com/skardhamar/rga rga]
! width="20%" | [https://github.com/jdeboer/ganalytics ganalytics]
! width="20%" | [https://bitbucket.org/unikum/rga RGA]
|-
! colspan=4 5 | Общая информация
|-
| Размещение
| style="text-align:center" | [https://github.com/skardhamar/rga GitHub]
| style="text-align:center" | [https://github.com/jdeboer/ganalytics GitHub]
| style="text-align:center" | [https://bitbucket.org/unikum/rga Bitbucket]
|-
| Дата публикации
| style="text-align:center" | 27.11.2012
| style="text-align:center" | 25.05.2013
| style="text-align:center" | 3.06.2014
|-
| Дата последней стабильной версии
| style="text-align:center" | 9.09.2013<ref>В апреле 2014 были внесены значительные изменения в код проекта, но после их внесения стабильного выпуска пока нет.</ref>
| style="text-align:center" | 251.0506.2014<ref>Дата последней правки на данный момент, т.к. релизы данного пакета отсутствуют.</ref>| style="text-align:center" | 244.0508.2014<ref>Дата последней правки на данный момент, т.к. релизы данного пакета отсутствуют.</ref>| style="text-align:center" | 5.08.2014<ref>Дата последней правки на данный момент, т.к. релизы данного пакета отсутствуют.</ref>
|-
| Лицензия
| style="text-align:center" | Apache 2.0
| style="text-align:center" | GPLGPL2
| style="text-align:center" | MIT
| style="text-align:center" | GPL2
|-
| Зависимости
| style="text-align:center" | <code>RCurl</code>, <code>rjson</code>, <code>lubridate</code>
| style="text-align:center" | <code>RCurl</code>, <code>jsonlitehttr</code>, <code>lubridatejsonlite</code>, <code>httrlubridate</code>| style="text-align:center" | <code>httr</code>, <code>plyr</code>, <code>stringr</code>, <code>jsonlite</code>, <code>httpuv</code>| style="text-align:center" | <code>RCurl</code>, <code>httr</code>, <code>jsonlite</code>
|-
! colspan=4 5 | Авторизация
|-
| Авторизация по логину и паролю
| style="text-align:center" | +
| style="text-align:center" | -
| style="text-align:center" | -
| style="text-align:center" | -
|-
| Авторизация [https://developers.google.com/accounts/docs/OAuth2 OAuth2]<ref>Авторизация по Client ID и Client secret, полученным в [https://console.developers.google.com API Console].</ref>
| style="text-align:center" | +
| style="text-align:center" | +
| style="text-align:center" | +
| style="text-align:center" | +
|-
! colspan=4 5 | Доступ к API
|-
| Доступ к [https://developers.google.com/analytics/devguides/reporting/core/v3/ API базовых отчётов]
| style="text-align:center" | +
| style="text-align:center" | +
| style="text-align:center" | +
| style="text-align:center" | +
| style="text-align:center" | -
| style="text-align:center" | +
|-
| Доступ к [https://developers.google.com/analytics/devguides/config/mgmt/v3/ API конфигурации]<ref>Информация по аккаунтам, профилям, представлениям, сегментам и целям.</ref>
| style="text-align:center" | +
| style="text-align:center" | -
| style="text-align:center" | +
|-
| Пакетная обработка запросов<ref>Pagination - получение данных, превышающих ограничения Google (1000 на один запрос) путем организации нескольких запросов.</ref>
| style="text-align:center" | +
| style="text-align:center" | +
| style="text-align:center" | +
Помимо технических различий пакеты различаются еще рядом параметров, в частности методологией организации кода, документированностью функций, общей дружелюбностью и простотой в использовании пакета.
Так, пакет <code>RGoogleAnalytics</code> основан на использовании простых функции и S3-методов, но по внутренней организации похож на RC (Reference classes). Пакет <code>rga</code> целиком основан на использовании RC. Пакет <code>ganalytics</code> основан на использовании S4 классов и методов, что обеспечивает более точный контроль над вводимыми аргументами. <ref>Получить обобщённое представление об принципах и реализации ООП в R можно [http://adv-r.had.co.nz/OO-essentials.html#rc здесь]</ref>. При определенных различиях в реализации доступа к GA API, все пакеты, тем не менее, основываются на функционале пакета <code>httr</code>.
В плане подробности документации, бесспорно, выигрывает пакет <code>ganalytics</code>. Он обладает довольно подробным <code>README</code> файлом, расположенном на странице проекта [https://github.com/jdeboer/ganalytics ganalytics], и описывающим практически весь функционал пакета. Помимо этого, пакет также содержит полную документацию всех функций, которая поставляется вместе с пакетом. Пакет <code>rga</code> обладает <code>README</code> файлом, описывающем лишь основы работы с пакетом и не включает в себя описание ряда возможностей пакета. Справка по функциям, доступная при установке пакета, содержит только краткое описание процедуры получения доступа к GA API и описание структуры запроса к API. Другие полезные функции, в частности, получение списка доступных профилей GA-аккаунта, приходится искать вслепую. Документация пакета <code>RGoogleAnalytics</code> также имеет файл <code>README</code>, в котором пошагово описан процесс работы с пакетом, включающим весь функционал.
В плане простоты использования лидирует, несомненно, в свою очередь. лидирует пакет <code>rga</code>. В отличие от <code>ganalytics</code>, пакет <code>rga</code> позволяет указывать метрики, измерения, узкие сегменты и фильтры в виде аргументов сразу, в одной функции, что упрощает понимание структуры запроса и сегмента, и позволяет обрабатывать множество однотипных сегментов (например, страниц сайта) в цикле или <code>[a-z]pply</code>-функциях. Также <code>ganalytics</code> не имеет внутренних инструментов получения ID-профилей, а их получение из web-интерфейса Google Analytics с последующей вставкой в запросы <code>ganalytics</code> трудоемко и, самое главное, неинтуитивно. <code>RGoogleAnalytics</code>, несмотря на достаточно подробную документацию и достаточный для полноценный полноценной работы функционал, обладает несколько непрозрачной и неочевидной структурой запросов к GA API.
== Пакет <code>rga</code> Получение ключей для доступа к API Google Analytics ==
== Пакет <code>rga</code> == === Установка пакета === Исходный код пакета <code>rga</code> располагается на [https://github.com github], поэтому установить его можно с помощью функции <code>install_github</code> из пакета {{r-package|devtools}}: {{r-code|code=<nowiki>> devtools::install_github("rga", "skardhamar")</nowiki>}}
=== Организация доступа к API Авторизация ===
{{r-code|code=<nowiki>> library(rga)</nowiki>}}
Для создания тоекна получения токена доступа потребуется переход в браузер, подтверждение доступа и копирование ключа код доступа в консоль. Опционально команда создает отдельный файл, который потом можно использовать для аутентификации без перехода в браузер<ref>Аргумент <code>where</code> с указанием пути и имени файла.</ref>.
{{r-code|code=<nowiki>> rga.open(instance = "ga", where = "ga.rga")</nowiki>}}
Видим, что в директории проекта появился файл <code>ga.rga</code><ref>Можно указать любой удобный путь и имя файла.</ref>. Теперь при повторном использовании этой команды будет осуществляться проверка наличия файла <code>ga.rga</code> в рабочей директории и, если такой файл будет найден, то данные для аутентификации будут взяты из данного файла.
Второй вариант аутентификации с созданием собственного клиента API и использованием собственных ключей доступа:
После успешной аутентификации информацию о установленном подключении можно получить с помощью команды <code>ga$status()</code> или более подробную информацию <code>ga$show()</code>.
=== Получение данных ===
Пакет <code>rga</code> позволяет получить доступ к различным API Google Analytics. Поскольку объекты, формируемые пакетом <code>rga</code>, относятся к классу <code>refClass</code>, что не является широко распространённой системой в данный момент, то ниже мы проведём небольшой обзор доступных функций и методов. Получить общую информацию о классе <code>rga</code> можно с помощью функции <code>getRefClass()</code>:
{{r-code|code=<nowiki>> getRefClass(Class = "rga")
Пояснения по значениям аргументов для метода <code>getData</code>:
* <code>ids</code> - номер ID профиля, из которого нужно выгрузить данные;* <code>start.date</code> - символьная строка, которая задаёт стартовое время в формате <code>%YYYYY-%mMM-%dDD</code><ref>Получить начальную дату сбора статистики в GA можно с помощью команды <code> ga$getFirstDate(id)</code>.</ref>. Допускаются также значения "today", "yesterday", "ndaysAgo", где <code>n</code> - это количество дней;* <code>end.date</code> - символьная строка, которая задаёт конечное время в формате <code>%YYYYY-%mMM-%dDD</code><ref>В данном случае используется функция <code>Sys.Date()</code>, которая выводит текущую дату.</ref>. Допускаются также значения "today", "yesterday", "ndaysAgo", где <code>n</code> - это количество дней;
* <code>date.format</code> - символьная строка, которая задаёт формат даты, который используется для преобразования дат, полученных в результате запроса (по умолчанию <code>%Y-%m-%d</code>);
* <code>metrics</code> - символьная строка, которая определяет показатели (столбцы), которые будут входить в таблицу с данными (по умолчанию <code>"ga:visits"</code>)<ref>Можно использовать не больше 10 метрик одновременно.</ref>;
* <code>walk = TRUE</code> - позволяет получить исходные, а не агрегированные данные.
Аргументы <code>ids</code>, <code>start.date</code>, <code>end.date</code> и <code>metrics</code> являются обязательными для запроса к GA Google Analytics API. Прм этом функция <code>getData()</code> требует только <code>id</code> профиля, т.к. остальные аргументы имеют значения по умолчанию. Все аргументы метода <code>getData</code>, а также значения по умолчанию , можно посмотреть с помощью команды <code>args(ga$getData)</code>.
Детальную информацию можно найти на соответствующих страницах справочного руководства по GA API:
* по сегментам: https://developers.google.com/analytics/devguides/reporting/core/v3/segments
Получить доступ к API GA Google Analytics можно также с помощью веб-сервисов Google по следующей ссылке: https://developers.google.com/apis-explorer/?hl=ru#p/analytics/v3/. Для получения данных необходимо авторизоваться и задать требуемые параметры для запроса к API.
Пример сбора данных по выбранным метрикам и измерениям приведён ниже.
{{r-code|code=<nowiki>> ga.data <- ga$getData(ids = id,
{{r-code|code=<nowiki>> str(ga.data)
'data.frame': 34 obs. of 4 variables:
$ date : Date, format: "2014-03-19" "2014-03-20" "2014-03-21" "2014-03-22" ...
$ pageviews: num 9032 11914 10494 7173 8561 ...
