返回 MCP 目录
public公开dns本地运行

GoogleAnalytics-mcp-server

一个基于MCP协议的Google Analytics数据API服务,提供报表查询、受众管理、元数据访问等功能。

article

README

🚀 Google Analytics 数据 API MCP 服务器

这是一个用于与 Google Analytics 数据 API v1 进行交互的模型上下文协议(MCP)服务器。该服务器提供了丰富的工具和资源,可用于查询 Google Analytics 数据、管理受众以及访问元数据,为用户提供了便捷的数据处理和分析途径。

✨ 主要特性

  • 运行标准报告和透视表报告,满足多样化的数据展示需求。
  • 具备批量处理报告功能,提高数据处理效率。
  • 可访问维度和指标的元数据,深入了解数据结构。
  • 支持创建、列出、更新和删除受众,方便进行受众管理。
  • 能够检查维度和指标之间的兼容性,确保数据查询的准确性。
  • 提供全面的资源端点以探索 GA 数据,便于用户挖掘数据价值。

📦 安装指南

先决条件

  • Node.js 14 或更高版本
  • Google Analytics 4 账号属性
  • 具备适当权限的 Google Cloud 服务账户

安装步骤

  1. 克隆此仓库。
  2. 安装依赖项:
    npm install
    
  3. 根据 .env.example 创建一个 .env 文件,并填写您的 Google Analytics 凭证:
    GOOGLE_CLIENT_EMAIL=your-service-account-email@project-id.iam.gserviceaccount.com
    GOOGLE_PRIVATE_KEY=your-private-key
    DEFAULT_PROPERTY_ID=properties/123456789
    

💻 使用示例

运行服务器

npm start

使用 MCP 检查工具进行测试

npm run inspect

基础用法

// 运行基本报告
{
  "propertyId": "properties/123456789",
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "yesterday"
    }
  ],
  "dimensions": [
    {
      "name": "country"
    },
    {
      "name": "deviceCategory"
    }
  ],
  "metrics": [
    {
      "name": "activeUsers"
    },
    {
      "name": "sessions"
    }
  ]
}

高级用法

// 创建受众群体
{
  "propertyId": "properties/123456789",
  "displayName": "High Value Users",
  "description": "Users who have completed a purchase",
  "membershipDurationDays": 30,
  "filterClauses": [
    {
      "filterExpression": {
        "andGroup": {
          "expressions": [
            {
              "filter": {
                "fieldName": "eventName",
                "stringFilter": {
                  "value": "purchase",
                  "matchType": "EXACT"
                }
              }
            }
          ]
        }
      }
    }
  ]
}

📚 详细文档

可用工具

  • runReport:运行 Google Analytics 数据的标准报告。
  • batchRunReports:批量运行多个报告。
  • runPivotReport:运行带有透视表的报告。
  • batchRunPivotReports:批量运行带有透视表的报告。
  • getMetadata:获取维度和指标的元数据。
  • checkCompatibility:检查维度和指标之间的兼容性。
  • createAudience:创建新的受众群体。
  • listAudiences:列出某个属性下的所有受众群体。
  • getAudience:获取特定受众群体的详细信息。
  • deleteAudience:删除某个受众群体。
  • updateAudience:更新现有的受众群体。

可用资源

  • ga://property/{propertyId}:获取属性信息。
  • ga://report/{propertyId}/{reportType}/{dimensions}/{metrics}/{startDate}/{endDate}:生成报告。
  • ga://metadata:获取 API 元数据。
  • ga://dimensions:按类别浏览维度。
  • ga://dimensions/{category}:获取特定类别的所有维度。
  • ga://metrics:按类别浏览指标。
  • ga://metrics/{category}:获取特定类别的所有指标。
  • ga://audiences/{propertyId}:列出某个属性下的所有受众群体。
  • ga://audiences/{propertyId}/{audienceId}:获取特定受众群体的详细信息。

📄 许可证

[在此处填写许可证信息]

贡献者

[在此处列出贡献者]

版本历史

[在此处添加版本历史]

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端