article
README
🚀 Google Analytics 4 MCP 服务器
本项目是基于 Model Context Protocol (MCP) 的实现,借助 TypeScript SDK 来访问 Google Analytics 4 (GA4) 数据,为用户提供了便捷且强大的 GA4 数据访问能力。
🚀 快速开始
本服务器基于 Model Context Protocol (MCP) 实现,可通过 TypeScript SDK 访问 Google Analytics 4 (GA4) 数据。以下是使用该服务器的基本步骤:
先决条件
- Node.js 20 或更高版本
- Google Analytics 4 账户属性
- 启用了 Analytics Data API 的 Google Cloud 项目
- 具备相应权限的服务账户凭据
安装
pnpm install mcp-server-google-analytics
启动服务器
pnpm start
在 Claude Desktop 中的配置
在你的 Claude Desktop 配置中添加以下内容:
{
"mcpServers": {
"google-analytics": {
"command": "npx",
"args": ["-y", "mcp-server-google-analytics"],
"env": {
"GOOGLE_CLIENT_EMAIL": "your-service-account@project.iam.gserviceaccount.com",
"GOOGLE_PRIVATE_KEY": "your-private-key",
"GA_PROPERTY_ID": "your-ga4-property-id"
}
}
}
}
✨ 主要特性
- 获取可自定义维度的页面视图指标:能够根据需求自定义维度,精准获取页面视图指标。
- 跟踪一段时间内的活跃用户和新用户:方便了解用户增长和留存情况。
- 分析特定事件及其指标:深入分析特定事件,掌握事件相关数据。
- 监控用户行为指标(会话时长、跳出率):全面了解用户行为,优化用户体验。
- 所有查询支持灵活的时间范围选择:可根据不同需求选择合适的时间范围进行查询。
💻 使用示例
基础用法
本服务器提供了多个可用功能,以下是部分功能的使用示例:
getPageViews
获取特定时间段内的页面视图指标:
{
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"dimensions": ["page", "country"] // 可选
}
getActiveUsers
获取活跃用户指标:
{
"startDate": "2024-01-01",
"endDate": "2024-01-31"
}
getEvents
获取事件指标:
{
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"eventName": "purchase" // 可选
}
getUserBehavior
获取用户行为指标:
{
"startDate": "2024-01-01",
"endDate": "2024-01-31"
}
🔧 技术细节
安全注意事项
为确保服务器的安全性,使用时请遵循以下安全注意事项:
- 始终使用环境变量存储敏感凭证:避免敏感信息泄露。
- 实施适当的 CORS 设置:防止跨域请求带来的安全风险。
- 遵循最小权限原则设置服务账户权限:减少不必要的权限,降低安全风险。
- 定期轮换服务账户凭证:保证凭证的安全性。
- 监控 API 使用情况并根据需要实施速率限制:防止恶意请求。
🤝 为项目做贡献
欢迎贡献!请阅读我们的 Contributing Guide 了解代码规范和提交 Pull Request 的流程。
📄 许可证
本项目在 MIT License 下开源,具体信息请查看 LICENSE 文件。
微信扫一扫