Grundlegende Methodenmethoden

Dieses Dokument bietet eine Referenz für die wichtigsten Embed API-Methoden sowie eine Übersicht über die Interaktion dieser Methoden mit den Embed API-Komponenten und der zugrunde liegenden Analytics-Clientbibliothek.

Kernmethoden

Die Hauptmethoden der Embed API sind die Methoden, die im gapi.analytics-Objekt enthalten sind.

ready

Reiht eine Callback-Funktion in die Warteschlange ein, die aufgerufen werden soll, sobald die Embed API-Bibliothek vollständig geladen ist. Callbacks werden in der Reihenfolge aufgerufen, in der sie hinzugefügt wurden.

Die Funktion ready wird durch das Embed API-Snippet definiert und kann daher sofort verwendet werden. Alle anderen Funktionen sollten im ready-Callback platziert werden, damit die Bibliothek geladen wird, bevor sie aufgerufen werden.

Nutzung

gapi.analytics.ready(callback)

Parameter

Name Typ Beschreibung
callback Function Die Funktion, die aufgerufen werden soll, sobald die Embed API-Bibliothek vollständig geladen ist

Beispiel

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

createComponent

Erstellt eine Komponente mit den angegebenen Namen und Prototyp-Methoden. Die erstellte Komponente wird unter gapi.analytics.ext mit dem übergebenen Namen gespeichert.

Die createCallback-Funktion sollte immer innerhalb eines bereiten Callbacks aufgerufen werden, damit die Embed API-Clientbibliothek geladen wird.

Nutzung

gapi.analytics.createComponent(name, prototypeMethods)

Parameter

Name Typ Beschreibung
name string Der Name der Komponente.
prototypeMethods Object Ein Objekt, dessen Eigenschaften und Methoden im Prototyp der Komponente gespeichert werden.

Beispiel

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

});