Справка по основным методам

В этой статье описываются основные методы Embed API, а также порядок их взаимодействия с компонентами Embed API и базовой клиентской библиотекой Google Analytics.

Основные методы

Основные методы 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.

Функция createCallback всегда должна вызываться в рамках обратного вызова ready, чтобы было выполнено условие полной загрузки клиентской библиотеки Embed API.

Использование

gapi.analytics.createComponent(name, prototypeMethods)

Параметры

Название Тип Описание
name string Название компонента.
prototypeMethods оbject Объект, свойства и методы которого будут храниться в прототипе компонента.

Пример

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

});