Method: projects.addGoogleAnalytics

指定された FirebaseProject を既存の Google アナリティクス アカウントにリンクします。

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

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

projects.addGoogleAnalytics を呼び出すと、次のことに注意してください。

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

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

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

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

FirebaseProject で Google アナリティクスがすでに有効になっている場合に、現在関連付けられているプロパティとは異なる analyticsPropertyId を使用して projects.addGoogleAnalytics を呼び出すと、呼び出しが失敗します。アナリティクスが Firebase コンソールですでに有効になっている可能性があります。または、projects.addFirebase の呼び出しで timeZone と regionCode を指定します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

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


analytics_resource は次のいずれかになります。
analyticsAccountId

string

FirebaseProject とリンクする既存の Google アナリティクス アカウントの ID。

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

string

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

レスポンスの本文

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

認証スコープ

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

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

詳細については、認証の概要をご覧ください。