README

从谷歌分析中检索数据

使用此包可以轻松从谷歌分析中检索数据。

以下是一些提供的方法示例

use Analytics;
use Spatie\Analytics\Period;

//fetch the most visited pages for today and the past week
Analytics::fetchMostVisitedPages(Period::days(7));

//fetch visitors and page views for the past week
Analytics::fetchVisitorsAndPageViews(Period::days(7));

大多数方法将返回一个包含结果的 \Illuminate\Support\Collection 对象。

支持我们

我们投入了大量资源来创建 一流的开放源代码包。您可以通过 购买我们的付费产品之一 来支持我们。

我们非常感谢您从家乡寄给我们明信片，并提及您正在使用我们哪个包。您可以在 我们的联系页面 上找到我们的地址。我们在 我们的虚拟明信片墙 上发布所有收到的明信片。

安装

此包可以通过Composer安装。

composer require spatie/laravel-analytics

可选地，您可以使用以下命令发布此包的配置文件

php artisan vendor:publish --provider="Spatie\Analytics\AnalyticsServiceProvider"

以下配置文件将发布到 config/analytics.php

return [

    /*
     * The view id of which you want to display data.
     */
    'view_id' => env('ANALYTICS_VIEW_ID'),

    /*
     * Path to the client secret json file. Take a look at the README of this package
     * to learn how to get this file. You can also pass the credentials as an array
     * instead of a file path.
     */
    'service_account_credentials_json' => storage_path('app/analytics/service-account-credentials.json'),

    /*
     * The amount of minutes the Google API responses will be cached.
     * If you set this to zero, the responses won't be cached at all.
     */
    'cache_lifetime_in_minutes' => 60 * 24,

    /*
     * Here you may configure the "store" that the underlying Google_Client will
     * use to store it's data.  You may also add extra parameters that will
     * be passed on setCacheConfig (see docs for google-api-php-client).
     *
     * Optional parameters: "lifetime", "prefix"
     */
    'cache' => [
        'store' => 'file',
    ],
];

如何获取与谷歌分析通信的凭据

获取凭据

您首先需要做的是获取一些凭据来使用谷歌API。我假设您已经创建了一个谷歌账户并已登录。转到 谷歌API网站 并在页眉中点击 "选择项目"。

接下来，我们必须指定项目可以消耗哪些API。在 API Library 列表中点击 "Google Analytics API"。在下一屏幕上点击 "启用"。

现在，您已经创建了一个可以访问分析API的项目，现在是时候下载一个包含这些凭据的文件了。在侧边栏中点击 "Credentials"。您需要创建一个 "Service account key"。

在下一屏幕上，您可以给服务账户命名。您可以取任何名字。在服务账户id中您会看到一个电子邮件地址。我们将在本指南的稍后部分使用这个电子邮件地址。

选择 "JSON" 作为密钥类型，然后点击 "Create" 下载JSON文件。

将json保存到您的Laravel项目中，位置在包的配置文件中的 service_account_credentials_json 键指定的位置。由于json文件可能包含敏感信息，我建议不要将其提交到您的git仓库。

授予您的分析属性权限

我假设您已经在 分析网站 上创建了一个分析账户。在设置属性时，点击 "高级选项" 并确保您已启用 Universal Analytics。

转到属性的 "Admin" 部分的 "用户管理"。

在此屏幕上，您可以为之前步骤中下载的json文件中找到的 client_email 键中的电子邮件地址授予访问权限。分析师角色就足够了。

获取视图ID

您需要做的最后一件事是在配置文件中填写 view_id。您可以在 分析网站 上获取正确的值。请访问属性管理部分的“视图设置”。

您需要显示在这里的 View ID。

使用方法

安装完成后，您可以轻松检索分析数据。几乎所有方法都会返回一个 Illuminate\Support\Collection 实例。

以下是使用时期的几个示例

//retrieve visitors and pageview data for the current day and the last seven days
$analyticsData = Analytics::fetchVisitorsAndPageViews(Period::days(7));

//retrieve visitors and pageviews since the 6 months ago
$analyticsData = Analytics::fetchVisitorsAndPageViews(Period::months(6));

//retrieve sessions and pageviews with yearMonth dimension since 1 year ago
$analyticsData = Analytics::performQuery(
    Period::years(1),
    'ga:sessions',
    [
        'metrics' => 'ga:sessions, ga:pageviews',
        'dimensions' => 'ga:yearMonth'
    ]
);

$analyticsData 是一个 Collection，其中每个项目都是一个包含 date、visitors 和 pageViews 键的数组。

如果您想对要获取数据的时期有更多的控制，可以向时期对象传递一个 startDate 和一个 endDate。

$startDate = Carbon::now()->subYear();
$endDate = Carbon::now();

Period::create($startDate, $endDate);

提供的方法

访客和页面浏览量

public function fetchVisitorsAndPageViews(Period $period): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 date、visitors、pageTitle 和 pageViews 键的数组。

总访客和页面浏览量

public function fetchTotalVisitorsAndPageViews(Period $period): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 date、visitors 和 pageViews 键的数组。

最常访问的页面

public function fetchMostVisitedPages(Period $period, int $maxResults = 20): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 url、pageTitle 和 pageViews 键的数组。

顶级引用者

public function fetchTopReferrers(Period $period, int $maxResults = 20): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 url 和 pageViews 键的数组。

用户类型

public function fetchUserTypes(Period $period): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 type 和 sessions 键的数组。

顶级浏览器

public function fetchTopBrowsers(Period $period, int $maxResults = 10): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 browser 和 sessions 键的数组。

所有其他 Google Analytics 查询

要执行 Google Analytics 资源上的所有其他查询，请使用 performQuery。有关可能使用的指标和维度的更多信息，请参阅 Google 的核心报告 API。

public function performQuery(Period $period, string $metrics, array $others = [])

您可以访问底层的 Google_Service_Analytics 对象

Analytics::getAnalyticsService();

测试

使用以下命令运行测试

vendor/bin/phpunit

更改日志

请参阅 更改日志 了解最近更改的更多信息。

贡献

有关详细信息，请参阅 贡献指南。

安全

如果您发现有关安全性的错误，请通过 security@spatie.be 发送邮件，而不是使用问题跟踪器。

鸣谢

• Freek Van der Herten
• 所有贡献者

特别感谢 Caneco 为标志做出的贡献 ✨

许可

MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。