Method: projects.addGoogleAnalytics

将指定的 FirebaseProject 与现有 Google Analytics 账号相关联。

使用此调用,您可以:

  • 指定 analyticsAccountId,以便在指定账号中配置新的 Google Analytics 媒体资源,并将新媒体资源与 FirebaseProject 相关联。
  • 指定现有的 analyticsPropertyId 以将该属性与 FirebaseProject 相关联。

请注意,当您调用 projects.addGoogleAnalytics 时:

  1. 第一个检查会确定 Google Analytics 媒体资源中的任何现有数据流是否与 FirebaseProject 中的任何现有 Firebase 应用相对应(基于与数据流关联的 packageNamebundleId)。然后,关联数据流和应用(如适用)。请注意,此自动关联仅适用于 AndroidAppsIosApps
  2. 如果没有为 Firebase 应用找到相应的数据流,则系统会在 Google Analytics 媒体资源中为每个 Firebase 应用预配新的数据流。请注意,即使 Web 应用之前已与 Google Analytics 媒体资源中的数据流相关联,系统也始终会为其预配新的数据流。

如需详细了解 Google Analytics 账号的层次结构和结构,请参阅 Google Analytics 文档

此调用的结果是 Operation。通过调用 operations.getOperation 进行轮询来跟踪配置过程,直到 donetrue。当 donetrue 时,Operation 会成功或失败。如果 Operation 成功,其 response 会设置为 AnalyticsDetails;如果 Operation 失败,其 error 会设置为 google.rpc.Status

要调用 projects.addGoogleAnalytics,项目成员必须是现有 FirebaseProject 的所有者,并且拥有 Google Analytics 账号的 Edit 权限

如果 FirebaseProject 已启用 Google Analytics,并且您使用不同于当前关联媒体资源的 analyticsPropertyId 调用 projects.addGoogleAnalytics,则调用将失败。可能已经在 Firebase 控制台中启用了 Analytics,或者通过在对 projects.addFirebase 的调用中指定 timeZoneregionCode 而启用了 Analytics。

HTTP 请求

POST https://firebase.googleapis.com/v1beta1/{parent=projects/*}:addGoogleAnalytics

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

要关联到现有 Google Analytics 账号的 FirebaseProject 的资源名称,格式为:

projects/PROJECT_IDENTIFIER

请参阅 FirebaseProject name 字段,详细了解 PROJECT_IDENTIFIER 值。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{

  // Union field analytics_resource can be only one of the following:
  "analyticsAccountId": string,
  "analyticsPropertyId": string
  // End of list of possible types for union field analytics_resource.
}
字段
联合字段 analytics_resource

只能在请求正文中指定一项 Google Analytics 资源。
  • 如需配置新的 Google Analytics 媒体资源并将其与 FirebaseProject 相关联,请提供 analyticsAccountId
  • 如需将现有的 Google Analytics 媒体资源与 FirebaseProject 相关联,请提供 analyticsPropertyId


analytics_resource 只能是下列其中一项:
analyticsAccountId

string

您希望与 FirebaseProject 相关联的现有 Google Analytics 账号的 ID。

指定此字段会在您的 Google Analytics 账号中配置新的 Google Analytics 媒体资源,并将新媒体资源与 FirebaseProject 关联。

analyticsPropertyId

string

要与 FirebaseProject 相关联的现有 Google Analytics 媒体资源的 ID。

响应正文

如果成功,则响应正文包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

如需了解详情,请参阅身份验证概览