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