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 是一家位于比利时的安特卫普的网页设计公司。您可以在我们的网站上找到所有开源项目的概述在此。

明信片软件

您可以使用此包（它有 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/laravel-analytics.php

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

    /*
     * Path to the json file with service account credentials. Take a look at the README of this package
     * to learn how to get this file.
     */
    'service_account_credentials_json' => storage_path('app/laravel-google-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,
    
    /*
     * The directory where the underlying Google_Client will store it's cache files.
     */
    'cache_location' => storage_path('app/laravel-google-analytics/google-cache/'),
];

如何获取与 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。您可以在 Analytics 网站上获取正确的值。转到属性的 Admin 部分的 "视图设置"。

您需要显示那里的 View ID。

使用方法

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

以下是一个示例，演示如何检索当前日和最近七天的访问者和页面浏览数据。

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

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

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

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

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

提供的方法

访问者和页面浏览量

public function fetchVisitorsAndPageViews(Period $period): Collection

该函数返回一个 Collection，其中每个项目都是一个包含 date、visitors、pageTitle 和 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 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

贡献

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

安全性

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

致谢

关于 Spatie