Справка по встроенным компонентам

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

В этой статье описываются параметры, методы, свойства и события всех встроенных компонентов Embed API.

auth

gapi.analytics.auth

Компонент auth представляет собой синглтон, реализующий авторизацию пользователя.

Методы

authorize(options:Object)

Возвращает: gapi.analytics.auth

Отображает кнопку входа в Google Analytics в указанном контейнере, с помощью которой пользователь может войти в систему, указав свой аккаунт Google.

isAuthorized()

Возвращает: boolean

Если авторизация прошла успешно, возвращает значение true, в противном случае – false.

signOut()

Возвращает: gapi.analytics.auth

Осуществляет выход пользователя из системы и вызывает событие signOut.

getAuthResponse()

Возвращает: Object

Передает данные для аутентификации по исходному запросу авторизации. Возвращаемый объект содержит токен доступа, обычно используемый для отправки запроса аутентификации вручную.

getUserProfile()

Возвращает: Object

Возвращает основные данные профиля текущего пользователя, выполнившего вход, такие как имя, адрес электронной почты и общедоступное фото (если есть).

Унаследованные методы

on
once
off

Параметры

clientId

Тип: string

Идентификатор клиента для проекта в Google Developers Console.

container

Тип: string|HTMLElement

Идентификатор HTML-элемента модели DOM, в котором размещается кнопка для входа в систему. Допускается передача ссылки на сам элемент.

userInfoLabel

Тип: string

Текст, который отображается перед электронным адресом пользователя, вошедшего в систему. Значение по умолчанию: Вы вошли как:.

scopes

Тип: Array

Список областей доступа к Google API, запрашиваемых приложением. Полный перечень вы найдете в этой статье. Подробнее об областях доступа к Google Analytics API читайте в руководствах по настройке и отчетности для разработчиков.

overwriteDefaultScopes

Тип: boolean

Указывает, будет ли параметр scopes замещать или дополнять стандартные области доступа Embed API. Значение по умолчанию: false (дополнение). Если задано значение true, параметр scopes замещает стандартные области доступа.

По умолчанию используется значение ['https://www.googleapis.com/auth/analytics.readonly'].

Примечание. для аутентификации через Embed API требуется доступ к основным данным профиля пользователя. Эти области доступа не переопределяются.

serverAuth.access_token

Тип: string

Если передать в метод authorize действительный токен доступа, пользователь сможет входить в систему без авторизации. Подробнее о получении токена доступа...

События

signIn

Аргументы: нет

Активируется после входа пользователя в систему.

signOut

Аргументы: нет

Активируется после выхода пользователя из системы.

needsAuthorization

Аргументы: нет

При вызове метода gapi.analytics.auth.authorize выполняется проверка, выполнен ли в настоящее время вход в систему. Если нет, это событие активируется, показывая, что необходимо выполнить вход.

error

Аргументы: response

Активируется при ошибке в процессе аутентификации. Сообщение об ошибке приводится в объекте response.error.message ответа.

Неподдерживаемые события
success

Аргументы: response

Это событие применяется в рамках обратной совместимости, оно может быть удалено в будущем. Рекомендуем перейти на использование события signIn.

Пример

// 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'
  }
});

Данные

gapi.analytics.report.Data
Конструктор
Data(options:Object) Компонент Data используется для запроса Google Analytics Core Reporting API и получения результатов.

Параметры

query

Тип: Object

Объект, содержащий параметры запроса от Core Reporting API. Кроме стандартных значений по умолчанию, используются следующие значения:

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

Унаследованные методы

get
set
execute
on
once
off
emit

События

success

Аргументы: response

Активируется после успешного выполнения запроса.

error

Аргументы: response

Активируется в случае ошибки при обработке запроса. Сообщение об ошибке приводится в объекте response.error.message ответа.

Пример

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
Конструктор
DataChart(options:Object) DataChart – это контейнер для стандартной диаграммы Google и компонента Data, который позволяет автоматически визуализировать результаты запроса.

Параметры

query

Тип: Object

Параметр query компонента Data.

chart

Тип: Object

Подробная информация о параметрах диаграммы приведена ниже.

chart.container

Тип: string|HTMLElement

Идентификатор HTML-элемента модели DOM, в котором размещается компонент DataChart. Допускается передача ссылки на сам элемент.

chart.type

Тип: string

Тип диаграммы. Допустимые значения: LINE, COLUMN, BAR, TABLE и GEO.

chart.options

Тип: Object

Параметры, передаваемые в соответствующий объект Google Диаграмм.

Унаследованные методы

get
set
execute
on
once
off
emit

События

success

Аргументы: result

Активируется после успешного выполнения запроса и полного отображения диаграммы.

  • result.chart – экземпляр диаграммы Google.
  • result.data – ответ отчета в формате параметра data.
  • result.dataTable – экземпляр DataTable, созданный из объекта result.data.
  • result.response – исходный объект ответа API.
error

Аргументы: response

Активируется в случае ошибки при обработке запроса или отображении. Сообщение об ошибке приводится в объекте response.error.message ответа.

Пример

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
Конструктор
ViewSelector(options:Object) Компонент ViewSelector реализует раскрывающееся меню для выбора аккаунта, ресурса или представления.

Параметры

container

Тип: string|HTMLElement

Идентификатор HTML-элемента модели DOM, в котором размещается компонент ViewSelector. Допускается передача ссылки на сам элемент.

Унаследованные методы

get
set
execute
on
once
off
emit

Свойства экземпляра

ids

Тип: string

Уникальный идентификатор таблицы в формате ga:XXXX, где XXXX – это идентификатор представления (профиля) Google Analytics.

События

change

Аргументы: ids

Активируется каждый раз при выборе нового представления в раскрывающемся меню, а также при первом отображении экземпляра ViewSelector и представления по умолчанию.

Пример

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

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

viewSelector.execute();

Общие методы компонентов

Методы
set(options)

Возвращает: this

Задает или обновляет параметры конфигурации компонента (также это можно сделать в конструкторе во время создания).

get()

Возвращает: Object

Возвращает текущие параметры конфигурации компонента.

execute()

Возвращает: this

Вызывает основное действие компонента, как правило, отображение данных или выполнение отчета (или и то, и другое).

on(event, handler)

Возвращает: this

Регистрирует функцию, которая будет вызвана при активации указанного события компонента.

once(event, handler)

Возвращает: this

Регистрирует функцию, которая будет вызвана только при следующей активации указанного события компонента. После выполнения обработчик автоматически отменяет собственную регистрацию.

off(opt_event, opt_handler)

Возвращает: undefined

Удаляет обработчик событий из компонента. Если конкретный обработчик не передан, удаляются все обработчики для указанного события. Если не задано событие, удаляются все обработчики для всех событий.

emit(event, ...opt_args)

Возвращает: undefined

Активирует событие. При необходимости вы можете задать аргументы, которые будут передаваться во все зарегистрированные обработчики.

set

Задает или обновляет параметры конфигурации компонента (также это можно сделать в конструкторе во время создания).

Использование

component.set(options);

Параметры

Название Тип Описание
options Object Параметры конфигурации компонента. Передаваемые параметры объединяются с существующими.

Что будет возвращено

this – экземпляр этого компонента.


get

Возвращает текущие параметры конфигурации компонента.

Что будет возвращено

Object – текущие параметры конфигурации компонента.


execute()

Вызывает основное действие компонента, как правило, отображение данных или выполнение отчета (или и то, и другое).

Что будет возвращено

this – экземпляр этого компонента.


on(event, handler)

Регистрирует функцию, которая будет вызвана при активации указанного события компонента.

Параметры

Название Тип Описание
event string Название события.
handler Function Функция, которая вызывается при возникновении события. Описание параметров вы найдете в справке по конкретным событиям.

Что будет возвращено

this – экземпляр этого компонента.


once(event, handler)

Регистрирует функцию, которая будет вызвана только при следующей активации указанного события компонента. После выполнения обработчик автоматически отменяет собственную регистрацию.

Параметры

Название Тип Описание
event string Название события.
handler Function Функция, которая вызывается при возникновении события. Описание параметров вы найдете в справке по конкретным событиям.

Что будет возвращено

this – экземпляр этого компонента.


off(opt_event, opt_handler)

Удаляет обработчик событий из компонента. Если конкретный обработчик не передан, удаляются все обработчики для указанного события. Если не задано событие, удаляются все обработчики для всех событий.

Параметры

Название Тип Описание
opt_event string Название события. Если не задано событие, удаляются все обработчики для всех событий. Необязательный параметр.
opt_handler Function Ссылка на обработчик функции, который требуется удалить. Если функция не передана, удаляются все обработчики. Необязательный параметр.

Что будет возвращено

undefined


emit(event, ...opt_args)

Активирует событие. При необходимости вы можете задать аргументы, которые будут передаваться во все зарегистрированные обработчики.

Параметры

Название Тип Описание
event string Название события.
...opt_args * Необязательные аргументы, которые будут передаваться во все зарегистрированные обработчики события.

Что будет возвращено

undefined