Referência dos principais métodos

Este documento serve como uma referência dos principais métodos da API de incorporação, bem como uma visão geral de como esses métodos interagem com os componentes da API de incorporação e a biblioteca cliente subjacente do Google Analytics.

Principais métodos

Os principais métodos da API de incorporação estão no objeto gapi.analytics.

ready

Faz com que uma função de retorno seja chamada assim que a biblioteca da API de incorporação é totalmente carregada. Os retornos de chamada são chamados na ordem em que foram adicionados.

A função ready é definida pelo snippet da API Embed e pode ser usada imediatamente. Todas as outras funções precisam ser colocadas dentro do callback ready para garantir que a biblioteca seja carregada antes de serem invocadas.

Uso

gapi.analytics.ready(callback)

Parâmetros

Exemplo

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

createComponent

Cria um componente com o nome e os métodos de protótipo especificados. O componente criado será armazenado em gapi.analytics.ext com o nome transmitido.

A função createCallback precisa ser sempre invocada dentro de um callback "ready" para garantir que a biblioteca de cliente da API de incorporação seja carregada.

Uso

gapi.analytics.createComponent(name, prototypeMethods)

Parâmetros

Exemplo

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

});