Skip to content

В пакет ryandexdirect добавлена возможность работы с API Яндекс метрики совместимым с Google Analytics Core Reporting API (v3)

Choose a tag to compare

@selesnow selesnow released this 21 Sep 10:56
· 468 commits to master since this release

В пакет ryandexdirect добавлена функция yadirGetMetrikaGAData предназначенная для работы с API Яндекс Метрики совместимым с Google Analytics Core Reporting API (v3) и даёт возможность использовать привычные параметры запросов при сборе статистики, если ранее вы работали с Google Analytics Core Reporting API (v3).

Пример работы с функций

#Подключаем пакет
library(ryandexdirect)

#Получаем токен разработчика
myToken <- yadirGetToken()

#Запрашиваем данные из API Яндекс Метрики
metrikData6 <- yadirGetMetrikaGAData(start_date = "2017-08-01",
                                     end_date = "yesterday",
                                     counter_ids = "ga:11111",
                                     metrics = "ga:sessions,ga:bounces,ga:users",
                                     dimensions = "ga:date,ga:sourceMedium",
                                     token = myToken)

Аргументы:

  • start_date = Дата начала отчетного периода. Вы можете указывать дату в формате YYYY-MM-DD или использовать относительные временные значения: today, yesterday, NdaysAgo.
  • end_date = Дата окончания отчетного периода. Вы можете указывать даты в формате YYYY-MM-DD или использовать относительные временные значения: today, yesterday, NdaysAgo.
  • counter_ids = Номер счетчика, данные которого необходимо получить. Перед номером счетчика необходимо указать префикс ga:, пример: "ga:1111"
  • dimensions = Группировки объединяют данные по критериям. Например, используйте параметр dimensions=ga:browser,ga:city, чтобы:
    • Получить данные по количеству посещений.
    • Сгруппировать эти данные по браузеру, который использовал посетитель и городу, в котором находился посетитель в момент посещения.
      Если по указанной группировке данные не были получены, возвращается значение (not set).
      Обратите внимание на следующие ограничения:
    • В состав одного запроса может входить не более 7 группировок.
    • Запрос не может состоять только из группировок, но должен содержать хотя бы одну метрику.
    • Не все группировки можно сочетать друг с другом в составе одного запроса. Подробнее о сочетании группировок и метрик можно почитать тут
  • metrics = Метрики позволяют получать данные о статистике посещаемости и активности пользователей сайта. Если в запросе вы не укажете ни одной группировки, то API вернет общее значение метрики для выбранного временного интервала без разделения его на какие-либо группы.
    Обратите внимание на следующие особенности:
    • В состав одного запроса может входить не более 10 метрик.
    • Большинство метрик можно использовать в сочетании друг с другом при условии, что не выбрана ни одна группировка.
    • Не все метрики можно сочетать с другими метриками и группировками в составе одного запроса. Подробнее о сочетании группировок и метрик можно почитать тут
  • filters = Фильтр позволяет ограничить данные, возвращаемые в результате запроса. Более подробно о правилах фильтрации можно узнать тут
    Обратите внимание на следующие особенности:
    • Фильтрация по группировке производится до использования группировок. Таким образом результирующая метрика представляет собой итоговое значение только для данных, удовлетворяющих условию группировки.
    • Фильтрация по метрике производится после использования метрик.
    • Вы можете использовать для фильтрации те группировки и метрики, которые не входят в состав вашего запроса.
  • sort = В качестве сортировки собранных данных может быть использован список метрик и группировок. По умолчанию используется сортировка по возрастанию. Чтобы использовать сортировку по убыванию, укажите знак «-» в запросе перед списком метрик и группировок.В качестве значения параметра sort вы можете использовать только те значения группировок и метрик, по которым были получены данные.
  • samplingLevel = Используйте данный параметр для указания уровня семплирования (количества визитов, использованных при расчете итогового значения).
    • Значение по умолчанию: HIGHER_PRECISION
      Допустимые значения:
    • HIGHER_PRECISION — возвращает наиболее точное значение, используя наибольшую выборку данных. Этот режим может потребовать дополнительное время и замедлить обработку запроса.
    • FASTER — возвращает быстрый результат на основе сокращенной выборки данных.
    • DEFAULT — возвращает результат на основе выборки, сочетающей скорость и точность данных.
  • token = API токен полученный с помощью функции yadirGetToken