コンポーネントの扱い

Embed API では、開発者の方にレポートデータのクエリや表示用の組み込みコンポーネントをいくつか提供します。コンポーネントはすべて共通の基盤で作成されているため、同じメソッドの多くを共有します。このセクションでは、このような共有メソッドの使用方法の概要を説明します。個々のコンポーネントの詳細については、コンポーネント リファレンスをご覧ください。

コンポーネントのオプション

コンポーネントのオプションは、インスタンスで set メソッドを呼び出すことで、作成時にコンストラクタ関数を使って設定されます。特定の時点のコンポーネント インスタンスのステータスを取得する場合 get を呼び出します。これにより、インスタンスの現在のオプションが返されます。

コンポーネントの相互作用

コンポーネントは、重要な操作が行われるときにイベントを発生させます。他のコンポーネントはこれらのイベントの発生時に応答することができます。特定のイベントにハンドラを登録するには、on メソッドを呼び出します。また、once メソッドを使用することもできます。このメソッドは on に似ていますが、そのハンドラは初回のみ呼び出され、その後自動的に削除されます。ハンドラを削除するには、off メソッドを使用します。

通常は、コンポーネントによって発生したデフォルト イベントをリッスンするだけですが、独自のイベントを発生させる必要がある場合は、emit を使用して実行できます。

アナリティクスのクライアント ライブラリ

Embed API は Google アナリティクスのクライアント ライブラリも読み込みます。これにより、必要な場合に Google アナリティクスの他の多くの API にもアクセスできます。

次の API は、これらの名前空間で使用できます。

gapi.client.analytics.data.ga
gapi.client.analytics.data.mcf
gapi.client.analytics.data.realtime
gapi.client.analytics.management
gapi.client.analytics.metadata