Изменения

Перейти к: навигация, поиск

R:Google Analytics

14 379 байтов добавлено, 08:27, 6 августа 2014
м
Общее описание
== Общее описание ==
Пакетов На данный момент, несмотря на все многообразие, в официальном репозитории CRAN нет пакетов для работы с API Google Analytics несколько. Однако на сторонних ресурсах, наиболее часто упоминающиеся тем не менее, можно обнаружить три рабочих решения: [https://code.google.com/p/r- google-analytics/ <code>RGoogleAnalytics</code>], [http://skardhamar.github.io/rga/ <code>rga</code>] и , [https://code.googlegithub.com/p/r-google-analyticsjdeboer/ ganalytics <code>RGoogleAnalyticsganalytics</code>]. В принципе, они различаются незначительно - в процедуре аутентификации и организации доступа к API[https://bitbucket. Пакет org/unikum/rga RGA]. <ref>Пакеты <code>rga</code> выглядит более удобным для работы, так как ключ для аутентификации создается один раз, и потом только загружается, в то время как при работе с пакетом <code>RGoogleAnalyticsganalytics</code> приходится в начале каждой сессии проходить аутентификацию в браузереи <refcode>В текущей версии 1.4.RGA</refcode>. К тому жев ближайшее время могут появиться и в CRAN, пакет <code>rgaработы в этом направлении уже ведутся.</coderef> обладает более прозрачной логикой запросов к API.
Менее известным является пакет [https://github.com/jdeboer/ganalytics <code>ganalytics</code>], который был опубликован на github в мае 2013. Он обладает довольно хорошей документацией и довольно удобным в работе Сравнительная таблица пактов для работы с помощью S4-методов. Аутентификация осуществляется с помощью Client ID и Client secret, полученных через [httpsAPI Google Analytics://code.google.com/apis/console/ Google API Console].
{| class="wikitable sortable" width= Установка необходимых пакетов "800px"! width="40%" | Параметры сравнения! width="20%" | [https://code.google.com/p/r-google-analytics/ RGoogleAnalytics]! 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=5 | Общая информация|-| Размещение| style="text-align:center" | [https://code.google.com/p/r-google-analytics/ Google Code]| 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" | 29.09.2010| 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" | 1.06.2014<ref>Дата последней правки на данный момент, т.к. релизы данного пакета отсутствуют.</ref>| style="text-align:center" | 4.08.2014<ref>Дата последней правки на данный момент, т.к. релизы данного пакета отсутствуют.</ref>| style="text-align:center" | 5.08.2014<ref>Дата последней правки на данный момент, т.к. релизы данного пакета отсутствуют.</ref>|-| Лицензия| style="text-align:center" | Apache 2.0| style="text-align:center" | GPL2| 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>httr</code>, <code>jsonlite</code>, <code>lubridate</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=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=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" | +|-| Доступ к [https://developers.google.com/analytics/devguides/reporting/mcf/v3/ API отчётов<br />многоканальных последовательностей]| 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" | -| style="text-align:center" | +|-| Пакетная обработка запросов<ref>Pagination - получение данных, превышающих ограничения Google (1000 на один запрос) путем организации нескольких запросов.</ref>| style="text-align:center" | +| style="text-align:center" | +| style="text-align:center" | +| style="text-align:center" | +|}
Устанавливаем и подключаем пакет {{r-package|devtools}}Помимо технических различий пакеты различаются еще рядом параметров, для доступа к [https://github.com/ github] (требуется только в первый разчастности методологией организации кода, для установки документированностью функций, общей дружелюбностью и простотой в использовании пакета {{r-package|rga}}):.
{{rТак, пакет <code>RGoogleAnalytics</code> основан на использовании простых функции и S3-методов, но по внутренней организации похож на RC (Reference classes). Пакет <code|>rga</code=> целиком основан на использовании RC. Пакет <nowikicode>ganalytics</code> installоснован на использовании S4 классов и методов, что обеспечивает более точный контроль над вводимыми аргументами <ref>Получить обобщённое представление об принципах и реализации ООП в R можно [http://adv-r.packages("devtools")had.co.nz/OO-essentials.html#rc здесь]</ref> library(devtools). При определенных различиях в реализации доступа к GA API, все пакеты, тем не менее, основываются на функционале пакета <code>httr</nowikicode>}}.
Устанавливаем В плане подробности документации, бесспорно, выигрывает пакет <code>rgaganalytics</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>, в котором пошагово описан процесс работы с пакетом, включающим весь функционал.
{{r-В плане простоты использования, в свою очередь. лидирует пакет <code|>rga</code=>. В отличие от <nowikicode>ganalytics</code>, пакет <code> install_github("rga"</code> позволяет указывать метрики, "skardhamar"измерения, узкие сегменты и фильтры в виде аргументов сразу, в одной функции, что упрощает понимание структуры запроса и сегмента, и позволяет обрабатывать множество однотипных сегментов (например, страниц сайта)в цикле или <code>[a-z]pply</nowikicode>}}-функциях. Также <code>ganalytics</code> не имеет внутренних инструментов получения ID профилей, а их получение из web-интерфейса Google Analytics с последующей вставкой в запросы <code>ganalytics</code> трудоемко и, самое главное, неинтуитивно. <code>RGoogleAnalytics</code>, несмотря на достаточно подробную документацию и достаточный для полноценной работы функционал, обладает несколько непрозрачной и неочевидной структурой запросов к GA API.
== Организация Получение ключей для доступа к API Google Analytics ==
Загрузка пакета доступа Прежде чем приступить к GA (требуется только в начале работе с пакетами, предназначенными для работы при запуске новой R-сессии)с Google Analytics API, необходимо создать новое приложение в [https://console.developers.google.com Google Developers Console] и получить '''Client ID''' (идентификатор клиента) и '''Client secret''' (секретный ключ клиента) для доступа к API Google Analytics. Не смотря на то, что некоторые пакеты, например <code>rga</code>, предоставляют ключи доступа, сгенерированные автором пакета, мы всё же рекомендуем получить собственные ключи, т.к. сторонние ключи могут быть в любой момент отозваны автором.
{{r-code|code=<nowiki>> library(rga)</nowiki>}}Пошаговая инструкция приведена ниже:
Запрет верификации SSL-соединения # Создание нового проекта (требуется только для ОС Windowsможно пропустить, чтобы избежать ошибок при аутентификацииесли проект уже создан):#* Откройте страницу 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` (убедитесь, что вместо надписи `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://console.developers.google.com/project;#* В боковой панели слева выберите пункт '''APIs & auth''', подпункт '''Credentials''';#* В таблице с названием '''Client ID for native application''' скопируйте значения полей '''Client ID''' и '''Client secret'''.
{{r-code|code=<nowiki>> options(RCurlOptions = list(capath = systemТеперь вы в любой момент можете вернуться на страницу '''Credentials''' и узнать '''Client ID''' и '''Client secret'''.file("CurlSSL", "cacert.pem", package = "RCurl"), ssl.verifypeer = FALSE))</nowiki>}}
Для создания ключа аутентификации потребуется переход в браузер, подтверждение доступа и копирование ключа в консоль. Опционально команда создает отдельный файл, который потом можно использовать для аутентификации без перехода в браузер<ref>Аргумент == Пакет <code>whererga</code> с указанием пути и имени файла.</ref>.==
{{r-code|code=<nowiki>> rga.open(instance = "ga", where = "ga.rga")</nowiki>}}Установка пакета ===
Видим, что в директории проекта появился файл Исходный код пакета <code>ga.rga</code><ref>Можно указать любой удобный путь и имя файла.<располагается на [https://ref>github. Теперь при повторном использовании этой команды будет осуществляться проверка наличия файла com github], поэтому установить его можно с помощью функции <code>ga.rgainstall_github</code> в рабочей директории и, если такой файл будет найден, то данные для аутентификации будут взяты из данного файла.пакета {{r-package|devtools}}:
Второй вариант аутентификации с созданием собственного клиента API и ключей доступа{{r-code|code=<nowiki>> devtools::install_github("rga", "skardhamar")</nowiki>}}
# Необходимо создать проект на странице https://console.developers.google.com/project;# Во вкладке APIs & auth выбрать Analytics API (нажать на <code>ON</code>);# Во вкладке APIs & auth перейти во вкладку Credentials, где выбрать Create new Client ID;# При создании Client ID выбрать APPLICATION TYPE: Installed application, INSTALLED APPLICATION TYPE: other, и нажать create;# В результате будет Client ID = и Client secret = ;# На вкладке Consent screen необходимо выбрать рабочий email и дать название приложению (Product name), сохранить;# На общей вкладке APIs & auth/Analytics API/APIs надо активировать API, нажав на кнопку, где написано <code>OFF</code>.= Авторизация ===
Создаем постоянный ключ Перед началом работы необходимо загрузить пакет <code>rga</code> (откроется браузертребуется только в начале работы при запуске новой R-сессии): {{r-code|code=<nowiki>> library(rga)</nowiki>}} Для предоставления доступа к данным Google Analytics API из пакета <code>rga</code> неободимо пройти процедуру авторизации. Для этого используется функция <code>rga.open</code>, которая принимает следующие аргументы: * <code>instance</code> - имя переменной, где надо которая будет выбрать свой почтовый аккаунт содержать информацию о доступе к APi Google Analytics;* <code>where</code> - путь и подтвердить вход /или имя файла, который будет использоваться для кэширования информации;* <code>client.id</code> - ID клиента;* <code>client.secret</code> - секретный ключ. Для получения токена доступа потребуется переход в APIбраузер, тогда выдадут подтверждение доступа и копирование коддоступа в консоль. Опционально команда создает отдельный файл, который надо будет вставить потом можно использовать для аутентификации без перехода в консольбраузер<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> в рабочей директории и, если такой файл будет найден, то данные для аутентификации будут взяты из данного файла.
{{r-code|code=<nowiki>> rga.open(instance = "ga", client.id = "", client.secret = "", where = "api.rga")</nowiki>}}Второй вариант аутентификации с использованием собственных ключей доступа:
Пояснения по значениям аргументов:{{r-code|code=<nowiki>> rga.open(instance = "ga", client.id = "XXXXXX", client.secret = "XXXXXXX", where = "ga.rga")</nowiki>}}
* <code>clientПосле выполнения данной команды будет открыт интернет браузер со страницей запроса подтверждения разрешения на доступ к данным Google Analytics.id</code> необходимо вставить сюда Client ID;* <code>clientНеобходимо авторизоваться под своей учётной записью Google и подтвердить разрешение на доступ к данным Google Analytics.secret</code> необходимо вставить сюда Client secretОтметим, что пакет `RGA` запрашивает доступ '''только для чтения''' данных.
После успешной аутентификации информацию о установленном подключении можно получить с помощью команды <code>ga$status()</code> или более подробную информацию <code>ga$show()</code>.
=== Получение данных ===
Получить информацию о всех доступных методахПакет <code>rga</code> позволяет получить доступ к различным API Google Analytics. Поскольку объекты, доступных для класса формируемые пакетом <code>rga</code> можно с помощью команды , относятся к классу <code>ga$explore()refClass</code>:, что не является широко распространённой системой в данный момент, то ниже мы проведём небольшой обзор доступных функций и методов.
Получить общую информацию о классе <code>rga</code> можно с помощью функции <code>getRefClass()</code>: {{r-code|code=<nowiki>> ga$exploregetRefClass(Class = "rga")
Generator for class "rga":
</nowiki>}}
Получить информацию о всех методах, доступных для класса <code>rga</code> можно с помощью команды <code>rga$methods()</code>: {{r-code|code=<nowiki>> rga$methods() [1] "callSuper" "copy" "explore" "export" "field" "getAccounts" [7] "getClass" "getData" "getDataInBatches" "getDataInWalks" "getFirstDate" "getGoals" [13] "getMCFData" "getMCFDataInBatches" "getMCFDataInWalks" "getMGMTData" "getProfiles" "getRefClass" [19] "getSegments" "getToken" "getWebProperties" "import" "initFields" "initialize" [25] "isToken" "isTokenExpired" "isWhere" "prepare" "refreshToken" "setToken" [31] "show" "status" "tokenExpiresIn" "trace" "untrace" "usingMethods" </nowiki>}} Наиболее полезными являются:
* <code>explore</code> - получение информации о о классе <code>rga</code>;
* <code>getAccounts</code> - получение списка аккаунтов в, к которым пользователь имеет доступ;
* <code>getData</code> - получение данных из GA API базового отчёта;
* <code>show</code> - получение подробной информации о данных подключения к GA;
* <code>status</code> - получение краткой информации о статусе подключения к GA;
 
Получить справку по тому или иному методу можно с помощью команды <code>rga$help(topic)</code>, где вместо <code>topic</code> нужно подставить название интересующего метода:
 
{{r-code|code=<nowiki>> rga$help("getWebProperties")
Call:
$getWebProperties(accountId = , start = , max = )
</nowiki>}}
Вызов метода осуществляется аналогично доступу к элементам списка посредством оператора <code>$</code>. После создания объекта с помощью функции <code>rga.open()</code> к методам можно обратиться с помощью конструкции <code>object$methodName()</code>, где <code>object</code> - имя, которое было указано в качестве аргумента <code>instance</code> при вызове функции <code>rga.open()</code>, а <code>methodName()</code> - один из вышеперечисленных методов.
Узнать какие аргументы, а также их значения по умолчанию, можно передать тому или иному методу можно узнать с помощью функции <code>args</code>. Например:
output.raw, output.formats, return.url = FALSE, rbr = FALSE,
envir = .GlobalEnv)
NULL</nowiki>}}
Пакет <code>rga</code> поддерживает работу как с [https://developers.google.com/analytics/devguides/reporting/core/v3/ API отчётов], так и с [https://developers.google.com/analytics/devguides/reporting/mcf/v3/ API многоканальных последовательностей].
Пояснения по значениям аргументов для метода <code>getData</code>:
* <code>ids</code> - номер ID профиля, из которого нужно выгрузить данные;* <code>start.date</code> - задает символьная строка, которая задаёт стартовое время в формате, указанном с помощью аргумента <code>date.formatYYYY-MM-DD</code><ref>Получить начальную дату сбора статистики в GA можно с помощью команды <code> ga$getFirstDate(id)</code>.</ref>. Допускаются также значения "today", "yesterday", "ndaysAgo", где <code>n</code> - это количество дней;* <code>end.date</code> - задает символьная строка, которая задаёт конечное время в формате, указанном с помощью аргумента <code>date.formatYYYY-MM-DD</code><ref>В данном случае используется функция <code>Sys.Date()</code>, которая выводит текущую дату.</ref>. Допускаются также значения "today", "yesterday", "ndaysAgo", где <code>n</code> - это количество дней;* <code>date.format</code> - символьная строка, которая задаёт формат даты, который используется по умолчанию для <code>start.date</code> и <code>end.date</code> преобразования дат, полученных в результате запроса (по умолчанию <code>format(Sys.time(), "%Y-%m-%d")</code>);* <code>metrics</code> - символьная строка, которая определяет показатели (столбцы), которые будут входить в таблицу с данными (по умолчанию <code>"ga:visits"</code>)<ref>Можно использовать не больше 10 метрик одновременно.</ref>;* <code>dimensions</code> - символьная строка, которая определяет параметры (строки) таблицы, которые будут входить в таблицу с данными (по умолчанию <code>"ga:date"</code>)<ref>Можно использовать не больше 7 измерений одновременно.</ref>;* <code>segment</code> - символьная строка, которая определяет сегмент данных (как правило, страницы/разделы сайта);* <code>sort</code> - символьная строка, которая определяет, по какому из столбцов будет производиться сортировка данных в таблице<ref>Поддерживается как прямая, так и обратная сортировка</ref>;* <code>filters</code> - символьная строка, которая определяет фильтры, которые накладываются применяемые при отборе данных на данные стороне сервера (в определенной мере аналог сегментов);* <code>batch = TRUE</code> собирает все данные, а не только первые 10000 - позволяет преодолеть ограничение на количество возвращаемых строк при ответе сервера (необходимо, если предполагается, что строк может быть многобольше, чем 10000).* <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 ...
* Google Analytics Query Explorer 2 - https://ga-dev-tools.appspot.com/explorer/?csw=1
* Google Analytics: Core Reporting API - Segments - https://developers.google.com/analytics/devguides/reporting/core/v3/segments
* Google Analytics Core Reporting API Changelog: https://developers.google.com/analytics/devguides/reporting/core/v3/changelog
== См. также ==
* [[R:Google Analytics/Параметры и измерения|Google Analytics - Параметры и измерения]]
* [[R:Google Analytics/Примеры|Примеры анализа данных Google Analytics в R]]
 
[[Категория:R]]
[[Категория:Веб-аналитика]]

Навигация