README

此瓷砖可用于Laravel Dashboard以显示 Google Analytics 实时信息。

安装

您可以通过 composer 安装此包

composer require vdvcoder/laravel-dashboard-google-analytics-realtime-tile-v2

Google Analytics 凭据

在您使用此瓷砖之前，请确保您系统中已正确设置了凭据。按照实时报告 API 概述中的说明注册以访问 API。当访问被允许时

1. 启用 Google Analytics API。
2. 创建一个具有适当权限的服务帐户。
3. 导航到服务帐户并添加一个新的 JSON 私钥。将下载一个 JSON 文件 - 将其重命名为 'analytics-credentials.json' 并将其移动到您的 Laravel 根目录。

注意生成的 '服务帐户 ID'。它将遵循 "<service_account_name>@.iam.gserviceaccount.com" 的格式。

Google Analytics 视图

访问Google Analytics并导航到所需的视图（例如，帐户 > 属性 & 应用 > 视图）。注意显示在视图名称下面的 '视图 ID'。单击 '视图用户管理' 并添加新用户。电子邮件地址是在 Google Analytics 凭据步骤中使用的服务帐户 ID。

有关更多信息，请参阅实时报告 API 开发者指南。还要考虑您的API 请求配额和限制。

用法

在 dashboard 配置文件中，您必须在 tiles 键中添加此配置。

1. 输入您希望收集信息的视图 ID，例如 123456789。
2. 如果您更改了以下建议的名称和/或位置的分析凭据 JSON，请更新该字段。
3. 通过修改 urls_displayed 字段，可以限制在 URLs 瓦片上显示的 URL 数量，默认值为 10。
4. 根据您设置的活跃用户数量阈值，active users 瓦片的背景可以更改。如果 active_users_warning_threshold 字段不在设置中，则没有阈值，背景不会更改。将值设置为 0 将在存在 0 个活跃用户时使用警告背景。将值设置为 10 将在存在 10 个或更少的活跃用户时使用警告背景。

// in config/dashboard.php

return [
    // ...
    'tiles' => [
        'google_analytics_realtime' => [
            'view_id' => '123456789',
            'key_file_location' => __DIR__ . '/../analytics-credentials.json',
            'urls_displayed' => 4,
            'active_users_warning_threshold' => 0,
        ]
    ],
];

在 app\Console\Kernel.php 中，您应该安排 \vdvcoder\GoogleAnalyticsRealtimeTile\Commands\FetchGoogleAnalyticsRealtimeCommand 每分钟运行一次，具体取决于您的 Google API 配额和限制。

// in app/console/Kernel.php

protected function schedule(Schedule $schedule)
{
    // ...
    $schedule->command(\vdvcoder\GoogleAnalyticsRealtimeTile\Commands\FetchGoogleAnalyticsRealtimeCommand::class)->everyMinute();
}

在您的仪表板视图中，您可以使用三个不同的瓦片

• livewire:google-analytics-realtime-active-users-tile
• livewire:google-analytics-realtime-devices-tile
• livewire:google-analytics-realtime-urls-tile

<x-dashboard>
    <livewire:google-analytics-realtime-active-users-tile position="a1:a4" />
    <livewire:google-analytics-realtime-devices-tile position="b1:b4" />
    <livewire:google-analytics-realtime-urls-tile position="a5:b8" />
</x-dashboard>

上面的布局将生成类似的内容

测试

composer test

变更日志

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

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现任何安全相关的问题，请通过电子邮件而不是使用问题跟踪器来报告。

支持Spatie

我从Spatie的各个包中学到了很多，包括Mailcoach，如果您想了解更多，建议您查看它们。

通过观看Spatie的付费视频课程学习如何创建类似此的包

Spatie在创建顶级开源包上投入了大量资源。您可以通过购买他们的付费产品来支持他们。

鸣谢

• Ingoldsby
• vdvcoder
• 所有贡献者

许可证

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