erlancarreira/laravel-analytics

一个用于获取 Google Analytics (GA4) 数据的 Laravel 扩展包。

dev-main 2023-02-06 19:50 UTC

This package is auto-updated.

Last update: 2024-09-05 15:19:45 UTC


README

使用此包,您可以轻松地从 Google Analytics (GA4) 获取数据。

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

$start = \Illuminate\Support\Carbon::now()->startOfDay();
$end = \Illuminate\Support\Carbon::now()->endOfDay();

$totalUsers = ErlanCarreira\Analytics\Facades\Analytics::setDateRanges($start, $end)
                               ->setDimensions(
                                   [
                                       'hostName',
                                   ]
                               )
                               ->setMetrics(
                                   [
                                       'totalUsers',
                                   ]
                               )
                               ->runReport()
                               ->toArray();

安装

此包可以通过 Composer 安装。

composer require erlancarreira/laravel-analytics

在 .env 文件中添加

GOOGLE_CLOUD_PROJECT=project_id_from_google_console
GOOGLE_APPLICATION_CREDENTIALS=full_path_to_google_credentials_json
ANALYTICS_PROPERTY_ID=analytics_property_id

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

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

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

return [

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

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

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

获取凭据

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

接下来,我们必须指定项目可能使用的 API。在可用的 API 列表中点击 "Google Analytics Data API"。在下一屏幕上点击 "启用"。

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

在下一屏幕上,您可以给服务帐户命名。您可以命名任何您想要的名字。在服务帐户 ID 中,您将看到一个电子邮件地址。我们将在本指南的后续步骤中使用此电子邮件地址。选择 "JSON" 作为密钥类型,然后点击 "创建" 以下载 JSON 文件。

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

为您的 Analytics 财产授予权限

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

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

获取财产 ID

最后,您需要在配置文件中填写 property_id。您可以在 Analytics 网站 上获取正确的值。转到财产管理部分的 "财产设置"。

您需要显示那里的 PROPERTY ID

用法

所有其他 Google Analytics 查询

要执行 Google Analytics 资源的所有其他查询,请使用 runReport。有关可能使用的指标和维度的更多信息,请参阅 Google Analytics Data API (GA4)

可用的 API 维度和指标

您可以获得对底层 BetaAnalyticsDataClient 对象的访问权限

ErlanCarreira\Analytics\Facades\Analytics::getAnalyticsService();

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关详细信息,请参阅 CONTRIBUTING

安全

如果您发现任何安全相关的问题,请通过电子邮件erlancarreira@hotmail.com与我们联系,而不是使用问题跟踪器。

致谢

许可证

MIT许可证(MIT)。请参阅许可证文件获取更多信息。