alexusmai/ yandex-metrika
Laravel - Yandex Metrika
v1.7
2020-10-30 17:43 UTC
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ^7.2
- illuminate/support: ^5.0|^6.0|^7.0|^8.0
README
该包用于获取Yandex Metrika的统计数据。
由于最近的变化,token已移至HTTP头中 - 安装v1.0
Передача авторизационного токена в параметрах URL перестанет работать
13 февраля 2019 года. Чтобы продолжить работу с API Метрики,
настройте авторизацию по токену в HTTP-заголовке.
安装
使用Composer
composer require alexusmai/yandex-metrika
如果您安装了Laravel 5.4或更早版本,则在app/config/app.php中需要添加提供者,
Alexusmai\YandexMetrika\YandexMetrikaServiceProvider::class,
并添加别名。
'YandexMetrika' => Alexusmai\YandexMetrika\YandexMetrikaFacade::class,
发布配置文件
php artisan vendor:publish --provider="Alexusmai\YandexMetrika\YandexMetrikaServiceProvider" --tag="yandex-metrika"
配置
Metrika使用OAuth协议,该协议允许通过在Yandex上注册的应用程序代表用户操作Yandex数据。首先需要注册新应用并获取token
- 进入页面
https://oauth.yandex.ru/
- 点击“注册新应用”
- 填写“名称”字段
- 在权限部分选择“Yandex.Метрика”,并在“获取统计信息、读取自己及受信任账户的参数”旁边勾选
- 在“回调URL”字段下选择“开发URL”
- 保存
- 复制应用ID,并使用将作为应用程序运行的用户名登录到Yandex
- 进入URL
https://oauth.yandex.ru/authorize?response_type=token&client_id=подставим сюда идентификатор приложения
- 应用程序将请求访问权限,点击“允许”
- 将获得的token输入到包配置文件中。
使用方法
大部分请求取自Yandex Metrika API文档https://tech.yandex.ru/metrika/
请求结果为对象。
YandexMetrika {#464 ▼
#url: "https://api-metrika.yandex.net/stat/v1/data"
#counter_id: "12345678"
#getMethodName: "getVisitsViewsUsers"
#adaptMethodName: "adaptVisitsViewsUsers"
+data: array:12 [▼
"query" => array:14 [▶]
"data" => array:31 [▶]
"total_rows" => 31
"total_rows_rounded" => false
"sampled" => false
"sample_share" => 1.0
"sample_size" => 350
"sample_space" => 350
"data_lag" => 100
"totals" => array:3 [▶]
"min" => array:3 [▶]
"max" => array:3 [▶]
]
+adaptData: null
}
如果未获取数据 - null。在请求数据时出现的错误将写入以Yandex Metrika命名的日志中
所有请求都被缓存,缓存时间由配置文件指定。
对于处理获取的数据,有额外的处理方法,使数据更易于应用。使用adapt()方法使用这些方法。并非所有获取数据的方法都有处理方法。getRequestToApi()没有
使用多个计数器。
如果您需要从不同的计数器获取数据
YandexMetrika::setCounter($token, $counterId, $cache)->тут имя метода; // Например YandexMetrika::setCounter($token, $counterId, $cache)->getVisitsViewsUsers(); // $token и $counterId - нужно передавать обязательно, параметр $cache - необязательно(если не передан то будет использоваться из настроек)
获取每天的访问量、页面浏览量和独立访客数量
YandexMetrika::getVisitsViewsUsers(); //По умолчанию - за последние 30 дней //Пример YandexMetrika::getVisitsViewsUsers(10); //За последние 10 дней //За период YandexMetrika::getVisitsViewsUsersForPeriod(DateTime $startDate, DateTime $endDate) //За указанный период //Обработка полученных данных для построения графика Highcharts › Basic line YandexMetrika::getVisitsViewsUsers()->adapt();
最常查看的页面
YandexMetrika::getTopPageViews(); //По умолчанию за последние 30 дней, количество результатов - 10 //Пример YandexMetrika::getTopPageViews(10, 50); //За последние 10 дней, максимум 50 результатов //За период YandexMetrika::getTopPageViewsForPeriod(DateTime $startDate, DateTime $endDate, $maxResults = 10) //По умолчанию максимум 10 результатов //Обработка полученных данных YandexMetrika::getTopPageViews()->adapt();
“来源 - 摘要”报告
YandexMetrika::getSourceSummary(); //По умолчанию за последние 30 дней //Пример YandexMetrika::getSourceSummary(7); //За последние 10 дней //За период YandexMetrika::getSourcesSummaryForPeriod(DateTime $startDate, DateTime $endDate) //Обработка полученных данных YandexMetrika::getSourcesSummary()->adapt();
“来源 - 搜索词”报告
YandexMetrika::getSourcesSearchPhrases(); //По умолчанию за последние 30 дней, количество результатов - 10 //Пример YandexMetrika::getSourcesSearchPhrases(15, 20); //За последние 15 дней, максимум 20 результатов //За период YandexMetrika::getSourcesSearchPhrasesForPeriod(DateTime $startDate, DateTime $endDate, $maxResult = 10) //По максимум - 10 результатов //Обработка полученных данных YandexMetrika::getSourcesSearchPhrases()->adapt();
“技术 - 浏览器”报告
YandexMetrika::getTechPlatforms(); //По умолчанию за последние 30 дней, макс количество результатов - 10 //Пример YandexMetrika::getTechPlatforms(12, 5); //За последние 12 дней, максимум 5 результатов //За период YandexMetrika::getTechPlatformsForPeriod(DateTime $startDate, DateTime $endDate, $maxResult = 10) //По умолчанию максимум 10 результатов //Обработка полученных данных YandexMetrika::getTechPlatforms()->adapt();
考虑到搜索引擎的访问量和访客数量
YandexMetrika::getVisitsUsersSearchEngine(); //По умолчанию за последние 30 дней, макс количество результатов - 10 //Пример YandexMetrika::getVisitsUsersSearchEngine(24, 60); //За последние 24 дня, максимум 60 результатов //За период YandexMetrika::getVisitsUsersSearchEngineForPeriod(DateTime $startDate, DateTime $endDate, $maxResult = 10) //По умолчанию максимум 10 результатов //Обработка полученных данных YandexMetrika::getVisitsUsersSearchEngine()->adapt();
具有特定查看深度的访问量
YandexMetrika::getVisitsViewsPageDepth(); //По умолчанию за последние 30 дней, количество просмотренных страниц - 5 //Пример YandexMetrika::getVisitsViewsPageDepth(14, 30); //За последние 14 дней, макс количество результатов - 30 //За период YandexMetrika::getVisitsViewsPageDepthForPeriod(DateTime $startDate, DateTime $endDate, $pages = 5) //По умолчанию - 5 страниц //Обработка полученных данных YandexMetrika::getVisitsViewsPageDepth()->adapt();
按国家和地区的网站访问量报告
YandexMetrika::getGeoCountry(); //По умолчанию за последние 7 дней, макс количество результатов - 100 //Пример YandexMetrika::getGeoCountry(12, 30); //За последние 12 дней, макс количество результатов - 30 //За период YandexMetrika::getGeoCountryForPeriod(DateTime $startDate, DateTime $endDate, $maxResult = 100) //По умолчанию максимум 100 результатов //Обработка полученных данных для построения графика Highcharts.js > Pie with drilldown YandexMetrika::getGeoCountry()->adapt()();
按区域和城市的网站访问量报告
YandexMetrika::getGeoArea(); //По умолчанию за последние 7 дней, макс количество результатов - 100, Страна - Россия (id-225) //Пример YandexMetrika::getGeoArea(12, 30, 187); //За последние 12 дней, макс количество результатов - 30, страна - Украина //За период YandexMetrika::getGeoAreaForPeriod(DateTime $startDate, DateTime $endDate, $maxResult = 100, $countryId = 225) //Обработка полученных данных для построения графика Highcharts.js > Pie with drilldown YandexMetrika::getGeoArea()->adapt()();
对于getGeoCountry()和getGeoArea()方法,数据处理方法是通用的 - adaptGeoPie()
对Yandex Metrika API的任意查询
//Параметры запроса $urlParams = [ 'ids' => '123456', //id счетчика 'date1' => Carbon::today()->subDays(10), //Начальная дата 'date2' => Carbon::today(), //Конечная дата 'metrics' => 'ym:s:visits', 'filters' => 'ym:s:pageViews>5' ]; //Запрос YandexMetrika::getRequestToApi($urlParams);