En este documento se proporciona una referencia de los métodos principales de la API de inserción, así como una descripción general del modo en que estos métodos interactúan con los componentes de la API de inserción y la biblioteca de cliente de Analytics subyacente.
Métodos principales
Los métodos principales de las API de inserción son aquellos que se encuentran en el objeto gapi.analytics.
ready
Pone en cola una función de retrollamada que se invocará tan pronto como se haya cargado por completo la biblioteca de la API de inserción. Las devoluciones de llamada se invocan en el orden en que se han agregado.
El fragmento de la API de inserción define la función ready, por lo que esta se puede utilizar inmediatamente. Las demás funciones deben colocarse en la devolución de llamada de proceso ready para garantizar que la biblioteca se carga antes de que se invoquen.
Uso
gapi.analytics.ready(callback)
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
callback |
Function |
Función que se invocará tan pronto como se haya cargado por completo la biblioteca de la API de inserción. |
Ejemplo
gapi.analytics.ready(function() {
// Code in here will be invoked once the library fully loads.
});
createComponent
Crea un componente con el nombre y los métodos de prototipo especificados. El componente creado se almacenará en gapi.analytics.ext con el nombre enviado.
La función createCallback siempre debe invocarse dentro de una devolución de llamada de proceso preparado para garantizar que se carga la biblioteca cliente de la API de inserción.
Uso
gapi.analytics.createComponent(name, prototypeMethods)
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
name |
string |
Nombre del componente. |
prototypeMethods |
Object |
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'.
});