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 é carregada por completo. Os retornos de chamada são chamados na ordem em que foram adicionados.

A função ready é definida pelo snippet da API de incorporação, então ela pode ser usada imediatamente. Todas as outras funções devem ser inseridas no retorno de ready para garantir que a biblioteca seja carregada antes de elas serem chamadas.

Uso

gapi.analytics.ready(callback)

Parâmetros

Nome Tipo Descrição
callback Function Função a ser invocada quando a biblioteca da API de incorporação for totalmente carregada.

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

A função createCallback sempre deve ser chamada em um retorno de "ready" para garantir que a biblioteca cliente da API de incorporação seja carregada.

Uso

gapi.analytics.createComponent(name, prototypeMethods)

Parâmetros

Nome Tipo Descrição
name string Nome do componente.
prototypeMethods Object Um objeto cujas propriedades e métodos serão armazenados no protótipo do componente.

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

});