Method: projects.addGoogleAnalytics

指定されたFirebaseProject既存のGoogle Analytics アカウントにリンクします。

この呼び出しを使用すると、次のいずれかを行うことができます。

  • analyticsAccountIdを指定して、指定したアカウント内に新しい Google アナリティクス プロパティをプロビジョニングし、新しいプロパティをFirebaseProjectに関連付けます。
  • 既存のanalyticsPropertyIdを指定して、プロパティをFirebaseProjectに関連付けます。

projects.addGoogleAnalytics呼び出すときは次の点に注意してください。

  1. 最初のチェックでは、Google アナリティクス プロパティ内の既存のデータ ストリームがFirebaseProject内の既存の Firebase アプリに対応するかどうかを判断します(データ ストリームに関連付けられたpackageNameまたはbundleIdに基づいて)。次に、必要に応じて、データ ストリームとアプリがリンクされます。この自動リンクはAndroidAppsIosAppsにのみ適用されることに注意してください。
  2. Firebase アプリに対応するデータ ストリームが見つからない場合は、各 Firebase アプリの Google アナリティクス プロパティに新しいデータ ストリームがプロビジョニングされます。新しいデータ ストリームは、以前に Analytics プロパティのデータ ストリームに関連付けられていた場合でも、常に Web アプリ用にプロビジョニングされることに注意してください。

Google Analytics アカウントの階層と構造について詳しくは、 Analytics のドキュメントをご覧ください。

この呼び出しの結果はOperationです。 Operationをポーリングし、 done trueになるまでoperations.getを呼び出してプロビジョニング プロセスを追跡します。 donetrueの場合、 Operation成功したか失敗したかのいずれかです。 Operation成功した場合、そのresponse AnalyticsDetailsに設定されます。 Operation失敗した場合、そのerror google.rpc.Statusに設定されます。

projects.addGoogleAnalyticsを呼び出すには、プロジェクト メンバーが既存のFirebaseProjectの所有者であり、Google Analytics アカウントのEdit権限を持っている必要があります。

FirebaseProjectですでに Google Analytics が有効になっており、現在関連付けられているプロパティとは異なるanalyticsPropertyIdを使用してprojects.addGoogleAnalyticsを呼び出すと、呼び出しは失敗します。分析は、Firebase コンソールで、またはprojects.addFirebaseの呼び出しでtimeZoneregionCodeを指定することによって、すでに有効になっている可能性があります。

HTTPリクエスト

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

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

既存の Google Analytics アカウントにリンクするFirebaseProjectのリソース名。次の形式です。

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER値の詳細については、 FirebaseProject nameフィールドを参照してください。

リクエストボディ

リクエスト本文には、次の構造のデータが含まれます。

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 リソースは 1 つだけです。
  • 新しい Google アナリティクス プロパティをプロビジョニングしてFirebaseProjectに関連付けるには、 analyticsAccountIdを指定します。
  • 既存の Google アナリティクス プロパティをFirebaseProjectに関連付けるには、 analyticsPropertyIdを指定します。


analytics_resource次のいずれか 1 つだけです。
analyticsAccountId

string

FirebaseProjectにリンクする既存のGoogle Analytics アカウントの ID。

このフィールドを指定すると、Google アナリティクス アカウントに新しい Google アナリティクス プロパティがプロビジョニングされ、新しいプロパティがFirebaseProjectに関連付けられます。

analyticsPropertyId

string

FirebaseProjectに関連付ける既存の Google アナリティクス プロパティの ID。

レスポンスボディ

成功した場合、応答本文にはOperationのインスタンスが含まれます。

認可の範囲

次の OAuth スコープのいずれかが必要です。

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

詳細については、 「認証の概要」を参照してください。