主要なメソッド リファレンス

このドキュメントでは、基本的な Embed API メソッドのリファレンスに加え、これらのメソッドが Embed API コンポーネントと対話する方法や基になるアナリティクス クライアント ライブラリの概要について説明します。

主要なメソッド

Embed API の主要なメソッドは gapi.analytics オブジェクトにあります。

ready

Embed API ライブラリが完全に読み込まれるとすぐに呼び出されるコールバック関数をキューに入れます。コールバックは、追加された順に呼び出されます。

ready 関数は Embed API スニペットにより定義されるため、直ちに使用が可能です。その他すべての関数は、ライブラリが読み込まれた後で呼び出されるように、ready コールバック内に挿入する必要があります。

使用方法

gapi.analytics.ready(callback)

パラメータ

名前 説明
callback 関数 Embed API ライブラリが完全に読み込まれるとすぐに呼び出される関数。

gapi.analytics.ready(function() {
  // Code in here will be invoked once the library fully loads.
});

createComponent

指定された名前とプロトタイプのメソッドを使用してコンポーネントを作成します。作成されたコンポーネントは、渡された名前で gapi.analytics.ext に格納されます。

Embed API クライアント ライブラリが読み込まれた後で実行されるように、createCallback 関数は、常に ready コールバック内部で呼び出される必要があります。

使用方法

gapi.analytics.createComponent(name, prototypeMethods)

パラメータ

名前 説明
name 文字列 コンポーネントの名前。
prototypeMethods オブジェクト プロパティとメソッドがコンポーネントのプロトタイプに格納されるオブジェクト。

gapi.analytics.ready(function() {

  gapi.analytics.createComponent('MyComponent', {
    foo: function() {
      alert('foo');
    },
    bar: function() {
      alert('bar');
    }
  });

  var myComponentInstance = new gapi.analytics.ext.MyComponent();
  myComponentInstance.foo(); // Alerts 'foo'.

});