Riferimento ai metodi principali

Questo documento fornisce un riferimento per i metodi principali dell'API Embed, nonché una panoramica di come questi metodi interagiscono con i componenti dell'API Embed e la libreria client Analytics sottostante.

Metodi principali

I metodi principali dell'API Embed sono quelli trovati nell'oggetto gapi.analytics.

ready

Mette in coda una funzione di callback da richiamare non appena la libreria API Embed viene completamente caricata. I callback vengono richiamati nell'ordine in cui sono stati aggiunti.

La funzione ready è definita dallo snippet dell'API Embed, quindi può essere utilizzata immediatamente. Tutte le altre funzioni devono essere inserite all'interno del callback ready per garantire che la libreria venga caricata prima di essere richiamate.

Utilizzo

gapi.analytics.ready(callback)

Parametri

Esempio

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

createComponent

Crea un componente con i metodi del nome e del prototipo specificati. Il componente creato verrà archiviato su gapi.analytics.ext con il nome passato.

La funzione createCallback deve essere sempre richiamata all'interno di un callback pronto per garantire che la libreria client dell'API Embed sia caricata.

Utilizzo

gapi.analytics.createComponent(name, prototypeMethods)

Parametri

Esempio

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

});