Referencia de componentes integrados

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

autenticación

gapi.analytics.auth

El componente auth es un singleton que se puede usar para autorizar a un usuario.

Métodos
authorize(options:Object)

Devuelve:  gapi.analytics.auth

Renderiza un botón de acceso de Google Analytics dentro del contenedor especificado, lo que le permite al usuario acceder con su Cuenta de Google.
isAuthorized()

Devuelve:  boolean

Muestra true si el usuario lo autorizó correctamente; de lo contrario, muestra false.
signOut()

Devuelve:  gapi.analytics.auth

Cierra la sesión del usuario actual. También activa el evento signOut.
getAuthResponse()

Devuelve:  Object

Obtiene los datos de autenticación que muestra la solicitud de autorización original. El objeto devuelto incluye el token de acceso, que generalmente se puede usar para realizar solicitudes autenticadas de forma manual.
getUserProfile()

Devuelve:  Object

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

Métodos heredados
on
once
off

Opciones
clientId

Tipo:  string

El ID de cliente de tu proyecto en la consola para desarrolladores
container

Tipo:  string|HTMLElement

El ID de un elemento HTML en el DOM que alojará el botón de acceso. También puedes pasar una referencia al elemento en sí.
userInfoLabel

Tipo:  string

El texto que se mostrará antes de la dirección de correo electrónico de un usuario que haya accedido. La configuración predeterminada es 'You are logged in as: '.
scopes

Tipo:  Array

Una lista de los permisos de autenticación de la API de Google que solicita tu aplicación. Para ver todos los permisos disponibles, visita OAuth 2.0 Playground. Para conocer los permisos de autenticación de la API de Google Analytics, consulta las guías para desarrolladores sobre los recursos de configuración e informes.
overwriteDefaultScopes

Tipo:  boolean

Indica si la opción scopes reemplaza los permisos predeterminados de la API de Embed o agrega a ellos. Si especificas false (la opción predeterminada), se agregarán los permisos predeterminados y, si especificas true, se reemplazarán con los que se especifican en la opción scopes.

El valor predeterminado de los permisos es ['https://www.googleapis.com/auth/analytics.readonly'].

Nota: La autenticación a través de la API de Embed requiere acceso al perfil básico del usuario. Estos permisos no se pueden reemplazar.
serverAuth.access_token

Tipo:  string

Si ya tienes un token de acceso válido, puedes pasarlo directamente al método autorizado y no se le solicitará al usuario que lo autorice. Para obtener información detallada 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 accede correctamente.
signOut

Argumentos: Ninguno

Se activa cuando el usuario sale de la cuenta correctamente.
needsAuthorization

Argumentos: Ninguno

Cuando se invoca el método gapi.analytics.auth.authorize, se realiza una verificación inicial para ver si el usuario ya accedió. Si el usuario no accedió, este evento se activa para indicar que se requiere más autorización.
error

Argumentos:  response

Se activa cuando se produce un error durante el proceso de autenticación. Si deseas recibir el mensaje de error del objeto de respuesta, lo encontrarás en response.error.message.
Eventos obsoletos
success

Argumentos:  response

Este evento existe para brindar retrocompatibilidad y es posible que se quite en una versión futura. En su lugar, usa el 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
Constructor
Data(options:Object) El componente de datos te permite consultar la API de Core Reporting de Google Analytics y obtener resultados.

Opciones
query

Tipo:  Object

Un objeto que contiene parámetros de consulta de la API de Core Reporting. Los siguientes valores predeterminados se usan además de los valores predeterminados regulares que proporciona la API:

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

Métodos heredados
get
set
execute
on
once
off
emit

Eventos
success

Argumentos:  response

Se activa cuando la consulta se completa correctamente.
error

Argumentos:  response

Se activa cuando se produce un error durante el proceso de consulta. Si deseas recibir el mensaje de error del objeto de respuesta, lo encontrarás 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
Constructor
DataChart(options:Object) DataChart une un gráfico estándar de Google y un componente de datos para que puedas crear fácilmente una visualización a partir de una consulta sin tener que conectarla.

Opciones
query

Tipo:  Object

Consulta la opción de consulta del componente de datos.
chart

Tipo:  Object

A continuación, puedes ver los detalles de las opciones de gráficos individuales.
chart.container

Tipo:  string|HTMLElement

El ID de un elemento HTML en el DOM que alojará el DataChart. También puedes pasar una referencia al elemento en sí.
chart.type

Tipo:  string

El tipo de gráfico. Las opciones posibles son LINE, COLUMN, BAR, TABLE y GEO.
chart.options

Tipo:  Object

Cualquier opción que se puede pasar al objeto Gráfico de Google correspondiente.

Métodos heredados
get
set
execute
on
once
off
emit

Eventos
success

Argumentos:  result

Se activa cuando la consulta se completa correctamente y el gráfico se renderiza por completo.

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

Argumentos:  response

Se activa cuando se produce un error durante la consulta o el proceso de renderización. Si deseas recibir el mensaje de error del objeto de respuesta, lo encontrarás 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
Constructor
ViewSelector(options:Object) El componente ViewSelector te permite elegir tu cuenta, propiedad y vista a través de menús desplegables.

Opciones
container

Tipo:  string|HTMLElement

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

Métodos heredados
get
set
execute
on
once
off
emit

Propiedades de la instancia
ids

Tipo:  string

El ID de tabla único con el formato ga:XXXX, en el que XXXX es el ID de vista (perfil) de Analytics.

Eventos
change

Argumentos:  ids

Se activa cada vez que el usuario selecciona una vista nueva en los menús desplegables. También se activa cuando la instancia ViewSelector se renderiza 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 (esto también se puede hacer al momento de la creación en el constructor).

get()

devuelve: Object

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

execute()

devuelve: this

Invoca la acción principal del componente. Por lo general, para renderizar un elemento en la página o ejecutar un informe (o ambos).

on(event, handler)

devuelve: this

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

once(event, handler)

devuelve: this

Registra una función para que se invoque solo la próxima vez que ocurra el evento especificado. Después de que el controlador se ejecuta una vez que se cancela el registro automáticamente.

off(opt_event, opt_handler)

devuelve: undefined

Elimina un controlador de eventos de un componente. Si no se pasa ningún controlador, se quitan todos los controladores para el evento que se pasó. Si no se pasa ningún evento, se quitan todos los controladores de todos los eventos.

emit(event, ...opt_args)

devuelve: undefined

Emite un evento. De manera opcional, puedes especificar los argumentos que se pasarán a cualquier controlador registrado.

set

Establece o actualiza las opciones de configuración del componente (esto también se puede hacer al momento de la creación en el constructor).

Uso

component.set(options);

Parámetros

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

Devuelve

this: es la instancia del componente.

get

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

Devuelve

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

execute()

Invoca la acción principal del componente. Por lo general, para renderizar un elemento en la página o ejecutar un informe (o ambos).

Devuelve

this: es la instancia del componente.

on(event, handler)

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

Parámetros

Nombre Tipo Descripción
event string El nombre del evento
handler Function La función que se invocará cuando se produzca el evento. (Consulta las referencias de eventos individuales para obtener detalles de los parámetros).

Devuelve

this: es la instancia del componente.

once(event, handler)

Registra una función para que se invoque solo la próxima vez que ocurra el evento especificado. Después de que el controlador se ejecuta una vez que se cancela el registro automáticamente.

Parámetros

Nombre Tipo Descripción
event string El nombre del evento
handler Function La función que se invocará cuando se produzca el evento. (Consulta las referencias de eventos individuales para obtener detalles de los parámetros).

Devuelve

this: es la instancia del componente.

off(opt_event, opt_handler)

Elimina un controlador de eventos de un componente. Si no se pasa ningún controlador, se quitan todos los controladores para el evento que se pasó. Si no se pasa ningún evento, se quitan todos los controladores de todos los eventos.

Parámetros

Nombre Tipo Descripción
opt_event string El nombre del evento Si no se especifica ningún evento, se quitan todos los controladores de todos los eventos. Opcional.
opt_handler Function Una referencia al controlador de la función que se quitará. Si no se pasa ninguna función, se quitan todos los controladores. Opcional.

Devuelve

undefined

emit(event, ...opt_args)

Emite un evento. De manera opcional, puedes especificar los argumentos que se pasarán a cualquier controlador registrado.

Parámetros

Nombre Tipo Descripción
event string El nombre del evento
...opt_args * Argumentos opcionales que se deben pasar a cualquier controlador de eventos registrado.

Devuelve

undefined