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

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

主要なメソッド

Embed API のコアメソッドは、gapi.analytics オブジェクトにあるメソッドです。

`ready`

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

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

使用量

gapi.analytics.ready(callback)

パラメータ

名前	型	説明
`callback`	`Function`	Embed API ライブラリが完全に読み込まれ次第呼び出される関数。

例

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

`createComponent`

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

Embed API クライアントライブラリが確実に読み込まれるように、createCallback 関数は常に準備完了のコールバック内で呼び出す必要があります。

使用量

gapi.analytics.createComponent(name, prototypeMethods)

パラメータ

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

例

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'.

});

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