Referencia de los componentes integrados

En este documento se describen las opciones, los métodos, las propiedades y los eventos de todos los componentes integrados de la API de inserción.

auth

gapi.analytics.auth

El componente auth es un elemento único que se puede usar para autorizar a un usuario.

Métodos

authorize(options:Object)

Devuelve: gapi.analytics.auth

Procesa un botón de inicio de sesión de Google Analytics en el contenedor especificado que permite al usuario iniciar sesión con su cuenta de Google.

isAuthorized()

Devuelve: boolean

Devuelve true si el usuario se ha autorizado correctamente, de lo contrario devuelve false.

signOut()

Devuelve: gapi.analytics.auth

Cierra la sesión del usuario actual. Además, activa el evento signOut.

getAuthResponse()

Devuelve: Object

Obtiene los datos de autenticación devueltos por la solicitud de autorización inicial. El objeto devuelto incluye el token de acceso, que puede utilizarse para realizar manualmente solicitudes autenticadas.

getUserProfile()

Devuelve: Object

Obtiene información básica del perfil sobre el usuario con sesión iniciada actualmente. Esto incluye el nombre, la dirección de correo electrónico y la imagen del perfil público (si está establecida) del usuario.

Métodos heredados

on
once
off

Opciones

clientId

Tipo: string

ID de cliente de tu proyecto en Developers Console.

container

Tipo: string|HTMLElement

ID de un elemento HTML en DOM que alojará el botón de inicio de sesión. También puedes pasar una referencia al propio elemento.

userInfoLabel

Tipo: string

Texto que se mostrará delante de la dirección de correo electrónico del usuario que ha iniciado sesión. El valor predeterminado es 'You are logged in as: '.

scopes

Tipo: Array

Lista de ámbitos de autorización de la API de Google que solicita tu aplicación. Para ver todos los ámbitos disponibles, consulta Espacio de OAuth 2.0. En el caso de los ámbitos de autorización de la API de Google Analytics, consulta las guías para desarrolladores de los recursos Configuración e Informes.

overwriteDefaultScopes

Tipo: boolean

Indica si la opción scopes reemplaza a los ámbitos predeterminados de la API de inserción o se agrega a ellos. Si se especifica false (el valor predeterminado), se agregarán a los ámbitos predeterminados y, si se especifica true, se reemplazarán por los especificados mediante la opción scopes.

El valor de los ámbitos predeterminados es:['https://www.googleapis.com/auth/analytics.readonly'].

Nota: La autenticación a través de la API de inserción requiere el acceso al perfil básico del usuario. Estos ámbitos no se pueden sobrescribir.

serverAuth.access_token

Tipo: string

Si ya tienes un token de acceso válido, puedes pasarlo al método authorize directamente y al usuario no se le pedirá que realice el proceso de autorización. Para obtener información sobre cómo recuperar un token de acceso, consulta la documentación de OAuth 2.0.

Eventos

signIn

Argumentos: ninguno

Se activa cuando el usuario ha iniciado sesión correctamente.

signOut

Argumentos: ninguno

Se activa cuando el usuario ha cerrado sesión correctamente.

needsAuthorization

Argumentos: ninguno

Cuando se invoca el método gapi.analytics.auth.authorize, se realiza una comprobación inicial para ver si el usuario ha iniciado la sesión actualmente. Si el usuario no ha iniciado sesión, el evento se activa para indicar que se requiere una nueva autorización.

error

Argumentos: response

Se activa cuando se produce un error durante el proceso de autenticación. Si quieres obtener el mensaje de error a partir del objeto de respuesta, se encuentra en response.error.message.

Eventos obsoletos
success

Argumentos: response

Este evento se usa para la compatibilidad con versiones anteriores y podría eliminarse en una versión futura. En su lugar, utiliza e evento signIn.

Ejemplo

// Standard client-side authorization.

gapi.analytics.auth.authorize({
  clientId: 'XXXXXX',
  container: 'auth-button'
});

gapi.analytics.auth.on('signIn', function() {
  console.log(gapi.analytics.auth.getUserProfile());
});
// Authorization using an access token obtained server-side.
// You do not need to register an event handler because
// authorization happens immediately.

gapi.analytics.auth.authorize({
  serverAuth: {
    access_token: 'XXXXXX'
  }
});

Datos

gapi.analytics.report.Data
Creador
Data(options:Object) El componente "Data" te permite consultar la API de informes centrales de Google Analytics y recuperar los resultados.

Opciones

query

Tipo: Object

Objeto que contiene los parámetros de consulta de la API de informes centrales. Además de los valores predeterminados habituales de la API, se usan los valores predeterminados siguientes:

{
  'start-date': '7daysAgo',
  'end-date': 'yesterday
}

Métodos heredados

get
set
execute
on
once
off
emit

Eventos

success

Argumentosresponse

Se activa cuando la consulta se ha completado correctamente.

error

Argumentosresponse

Se activa cuando se produce un error durante el proceso de consulta. Si quieres obtener el mensaje de error a partir del objeto de respuesta, se encuentra en response.error.message.

Ejemplo

var report = new gapi.analytics.report.Data({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:city'
  }
});

report.on('success', function(response) {
  console.log(response);
});

report.execute();

DataChart

gapi.analytics.googleCharts.DataChart
Creador
DataChart(options:Object) DataChart incluye un gráfico de Google estándar y un componente Data para que puedas crear una visualización a partir de una consulta sin que tengas que realizar las conexiones.

Opciones

query

Tipo: Object

Consulta la opción de consulta de componentes de datos.

chart

Tipo: Object

Consulta más abajo la información de la opción de gráfico individual.

chart.container

Tipo: string|HTMLElement

ID de un elemento HTML en DOM que alojará el objeto DataChart. También puedes pasar una referencia al propio elemento.

chart.type

Tipo: string

Tipo de gráfico. Las opciones posibles son: LINE, COLUMN, BAR, TABLE y GEO.

chart.options

Tipo: Object

Se puede pasar cualquier opción al objeto de gráfico de Google.

Métodos heredados

get
set
execute
on
once
off
emit

Eventos

success

Argumentosresult

Se activa cuando la consulta se ha completado correctamente y el gráfico se ha procesado por completo.

  • result.chart: instancia del gráfico de Google.
  • result.data: respuesta del informe con el formato de parámetro de datos.
  • result.dataTable: instancia de DataTable creada a partir del objeto result.data.
  • result.response: objeto de respuesta de la API sin procesar.
error

Argumentosresponse

Se activa cuando se produce un error durante la consulta o el procesamiento. Si quieres obtener el mensaje de error a partir del objeto de respuesta, se encuentra en response.error.message.

Ejemplo

var chart = new gapi.analytics.googleCharts.DataChart({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:date'
  },
  chart: {
    type: 'LINE',
    container: 'line-chart',
    options: {
      title: 'Sessions over the past week.',
      fontSize: 12
    }
  }
});
chart.on('success', function(response) {
  // response.chart : the Google Chart instance.
  // response.data : the Google Chart data object.
});

chart.execute();

ViewSelector

gapi.analytics.ViewSelector
Creador
ViewSelector(options:Object) El componente ViewSelector te permite elegir la cuenta, la propiedad y la vista mediante menús desplegables.

Opciones

container

Tipo: string|HTMLElement

ID de un elemento HTML en DOM que alojará el objeto ViewSelector. También puedes pasar una referencia al propio elemento.

Métodos heredados

get
set
execute
on
once
off
emit

Propiedades de instancia

ids

Tipo: string

ID de tabla único con el formato ga:XXXX, donde XXXX es el ID de vista (perfil).

Eventos

change

Argumentosids

Se activa siempre que el usuario selecciona una nueva vista en los menús desplegables. También se activa cuando la instancia de ViewSelector se procesa por primera vez y se muestra la vista predeterminada.

Ejemplo

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

Métodos de componentes compartidos

Métodos
set(options)

Devuelve: this

Establece o actualiza las opciones de configuración del componente (también se puede realizar en el momento de crearlo en el creador).

get()

Devuelve: Object

Devuelve las opciones de configuración actuales de un componente.

execute()

Devuelve: this

Invoca a la acción principal del componente, normalmente procesar algo en la página o ejecutar un informe (o ambas acciones).

on(event, handler)

Devuelve: this

Registra una función que se invocará cuando el componente emite el evento especificado.

once(event, handler)

Devuelve: this

Registra una función que se invocará solo en la próxima repetición del evento especificado (después de que el controlador se ejecute una vez que cancele el registro automáticamente).

off(opt_event, opt_handler)

Devuelve: undefined

Elimina un controlador de evento de un componente. Si no se pasa ningún controlador, elimina todos los controladores del evento pasado. Si no se pasa ningún evento, elimina todos los controladores de todos los eventos.

emit(event, ...opt_args)

Devuelve: undefined

Emite un evento. También puedes especificar los argumentos que se pasarán a cualquier controlador registrado.

set

Establece o actualiza las opciones de configuración del componente (también se puede realizar en el momento de crearlo en el creador).

Uso

component.set(options);

Parámetros

Nombre Tipo Descripción
options Object Opciones de configuración de este componente. Las opciones que se pasen se combinarán con las opciones existentes.

Devuelve

this: instancia del componente.


get

Devuelve las opciones de configuración actuales de un componente.

Devuelve

Object: las opciones de configuración actuales del componente.


execute()

Invoca a la acción principal del componente, normalmente procesar algo en la página o ejecutar un informe (o ambas acciones).

Devuelve

this: instancia del componente.


on(event, handler)

Registra una función que se invocará cuando el componente emite el evento especificado.

Parámetros

Nombre Tipo Descripción
event string Nombre del evento.
handler Function Función que se invocará cuando se produzca el evento. Consulta las referencias de eventos individuales para obtener la información de parámetros.

Devuelve

this: instancia del componente.


once(event, handler)

Registra una función que se invocará solo en la próxima repetición del evento especificado (después de que el controlador se ejecute una vez que cancele el registro automáticamente).

Parámetros

Nombre Tipo Descripción
event string Nombre del evento.
handler Function Función que se invocará cuando se produzca el evento. Consulta las referencias de eventos individuales para obtener la información de parámetros.

Devuelve

this: instancia del componente.


off(opt_event, opt_handler)

Elimina un controlador de evento de un componente. Si no se pasa ningún controlador, elimina todos los controladores del evento pasado. Si no se pasa ningún evento, elimina todos los controladores de todos los eventos.

Parámetros

Nombre Tipo Descripción
opt_event string Nombre del evento. Si no se especifica ningún evento, se eliminan todos los controladores de todos los eventos. Opcional.
opt_handler Function Referencia al controlador de función que se eliminará. Si no se pasa ninguna función, se eliminan todos los controladores. Opcional.

Devuelve

undefined


emit(event, ...opt_args)

Emite un evento. También puedes especificar los argumentos que se pasarán a cualquier controlador registrado.

Parámetros

Nombre Tipo Descripción
event string Nombre del evento.
...opt_args * Argumentos opcionales que se pasarán a los controladores de eventos registrados.

Devuelve

undefined