En este documento, se proporciona una referencia para los métodos principales de la API de Embed, así como una descripción general de cómo esos métodos interactúan con los componentes de la API de Embed y la biblioteca cliente de Analytics subyacente.
Métodos principales
Los métodos principales de la API de Embed son los que se encuentran en el objeto gapi.analytics.
ready
Pone en cola una función de devolución de llamada para que se invoque en cuanto la biblioteca de la API de Embed se cargue por completo. Las devoluciones de llamada se invocan en el orden en que se agregaron.
El fragmento de la API de Embed define la función ready, por lo que se puede usar de inmediato. Todas las demás funciones deben colocarse dentro de la devolución de llamada de ready para garantizar que la biblioteca se cargue antes de que se invoquen.
Uso
gapi.analytics.ready(callback)
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
callback |
Function |
La función que se invocará en cuanto la biblioteca de Embed API esté completamente cargada. |
Ejemplo
gapi.analytics.ready(function() {
// Code in here will be invoked once the library fully loads.
});
createComponent
Crea un componente con el nombre especificado y los métodos del prototipo. El componente creado se almacenará en gapi.analytics.ext con el nombre que se pasó.
La función createCallback siempre se debe invocar dentro de una devolución de llamada lista para garantizar que se cargue la biblioteca cliente de la API de Embed.
Uso
gapi.analytics.createComponent(name, prototypeMethods)
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
name |
string |
Es el nombre del componente. |
prototypeMethods |
Object |
Es un objeto cuyas propiedades y métodos se almacenarán en el prototipo del componente. |
Ejemplo
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'.
});