README

使用此包，您可以轻松地从 Google 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 对象。

Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到所有开源项目的概述在这里。

如果您正在使用此包的 v1 版本，请参阅旧版本的 README 以获取安装和用法指南。

Postcardware

您可以使用此包（它是 MIT 许可的），但如果它进入您的生产环境，您需要向我们发送一张来自您家乡的明信片，说明您正在使用我们的哪些包。

我们的地址是：Spatie，Samberstraat 69D，2060 安特卫普，比利时。

所有明信片都会发布在我们的网站上这里。

安装

此包可以通过 Composer 安装。

composer require spatie/laravel-analytics

您必须安装此服务提供者。

// config/app.php
'providers' => [
    ...
    Spatie\Analytics\AnalyticsServiceProvider::class,
    ...
];

此包还提供了一个外观，它提供了一个轻松调用类的方法。

// config/app.php
'aliases' => [
    ...
    'Analytics' => Spatie\Analytics\AnalyticsFacade::class,
    ...
];

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

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.
     */
    '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',
    ],
];

如何获取与 Google Analytics 通信的凭据

获取凭据

您首先需要获取一些用于使用 Google API 的凭据。我假设您已经创建了一个 Google 账户并已登录。转到 Google API 网站并在标题中点击 "选择项目"。

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

现在，您已经创建了一个可以访问 Analytics API 的项目，现在是时候下载一个包含这些凭据的文件了。在侧边栏中点击 "凭据"。您希望创建一个 "服务帐户密钥"。

在下一个屏幕上，您可以给服务帐户起一个名字。您可以给它起任何名字。在服务帐户 id 中，您将看到一个电子邮件地址。我们将在本指南的稍后部分使用此电子邮件地址。选择 "JSON" 作为密钥类型，然后点击 "创建" 下载 JSON 文件。

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

授予您的 Analytics 属性权限

我假设您已经在 Analytics 网站上创建了一个 Analytics 账户。转到属性的 Admin 部分的 "用户管理"。

在此屏幕上，您可以授予对前一步中下载的 json 文件中找到的 client_email 键中的电子邮件地址的访问权限。只读访问权限就足够了。

获取视图 id

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

您需要显示的视图 ID。

用法

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

以下是一个示例，用于检索当前日和前七天的访问者和页面浏览数据。

$analyticsData = Analytics::fetchVisitorsAndPageViews(Period::days(7));

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

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

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

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

提供的方法

访问者和页面浏览量

public function fetchVisitorsAndPageViews(Period $period): Collection

该函数返回一个包含键date、visitors、pageTitle和pageViews的Collection。

总访问者和页面浏览量

public function fetchTotalVisitorsAndPageViews(Period $period): Collection

该函数返回一个包含键date、visitors和pageViews的Collection。

最常访问的页面

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

该函数返回一个包含键url、pageTitle和pageViews的Collection。

顶级引用者

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

该函数返回一个包含键url和pageViews的Collection。

顶级浏览器

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

该函数返回一个包含键browser和sessions的Collection。

所有其他Google Analytics查询

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

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

您可以访问底层的Google_Service_Analytics对象

Analytics::getAnalyticsService();

测试

使用以下命令运行测试

vendor/bin/phpunit

贡献

有关详细信息，请参阅CONTRIBUTING。

安全性

如果您发现任何与安全相关的问题，请通过电子邮件freek@spatie.be联系，而不是使用问题跟踪器。

鸣谢

关于Spatie