GoogleAnalyticsTracker 技术文档

1. 安装指南

GoogleAnalyticsTracker 是一个用于从 C# 跟踪 Google Analytics 的库。根据您的应用程序类型，您可以通过 NuGet 包来安装它。

对于不需要框架集成的任何应用程序类型（控制台、WPF、WinForms 等），请使用以下 NuGet 包：

GoogleAnalyticsTracker.Simple

对于 ASP.NET Core 应用程序，请使用以下 NuGet 包：

GoogleAnalyticsTracker.AspNetCore

您可以通过 NuGet 包管理器控制台或NuGet命令行工具来安装这些包。

2. 项目的使用说明

GoogleAnalyticsTracker 允许您直接从 C# 跟踪特定 URL。例如，当使用 ASP.NET MVC 框架创建 API 时，GoogleAnalyticsTracker 可以通过直接调用 Google Analytics 来跟踪 API 使用情况。

请注意，要使 GoogleAnalyticsTracker 正常工作，您应将 Google Analytics 配置为网站。如果 Google Analytics 帐户被配置为应用程序，这个库将无法工作。

Example usage - GoogleAnalyticsTracker.Simple

在代码中，无论您想跟踪哪些页面视图，都可以添加以下结构：

using (var tracker = new SimpleTracker("UA-XXXXXX-XX", simpleTrackerEnvironment))
{
    await tracker.TrackPageViewAsync("我的 API - 创建", "api/create");
    await tracker.TrackPageViewAsync("我的 API - 列表", "api/list");
}

或者，不使用 using 语句：

var tracker = new SimpleTracker("UA-XXXXXX-XX", simpleTrackerEnvironment);
await tracker.TrackPageViewAsync("我的 API - 创建", "api/create");

Example usage - GoogleAnalyticsTracker.AspNetCore

安装 GoogleAnalyticsTracker.AspNetCore 包，并在启动类中注册 GoogleAnalyticsTracker：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // ...

        services.AddGoogleAnalyticsTracker(options =>
        {
            options.TrackerId = "UA-XXXXXX-XX";
            options.ShouldTrackRequestInMiddleware = TrackRequests.Yes;
        });
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        app.UseGoogleAnalyticsTracker();
        
        // ...
    }
}

这将自动跟踪发送到您的应用程序的所有请求。

如果您想要控制跟踪请求：

• 设置 options.ShouldTrackRequestInMiddleware = TrackRequests.No; 选项以禁用自动跟踪。
• 将 [TrackPageView] 或 [TrackEvent] 属性添加到您的操作。

[TrackPageView] 将在 Google Analytics 中跟踪页面视图，而 [TrackEvent] 跟踪事件。

如果需要自定义跟踪，可以将 AspNetCoreTracker 注入到您的控制器中，并直接使用跟踪方法。

3. 项目API使用文档

GoogleAnalyticsTracker API 包含以下主要功能：

• TrackPageViewAsync：异步跟踪页面视图。
• TrackEventAsync：异步跟踪事件。

您可以通过创建 SimpleTracker 或 AspNetCoreTracker 实例并调用这些方法来使用它们。

4. 项目安装方式

项目的安装方式如安装指南部分所述，通过 NuGet 包管理器进行安装。具体命令取决于您的项目类型和需求：

对于不需要框架集成的应用程序：

Install-Package GoogleAnalyticsTracker.Simple

对于 ASP.NET Core 应用程序：

Install-Package GoogleAnalyticsTracker.AspNetCore

请确保您的项目已正确设置并能够使用 NuGet 包。