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

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

авторизация

gapi.analytics.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

Идентификатор клиента вашего проекта в консоли разработчика .

container

Тип: string|HTMLElement

Идентификатор HTML-элемента в DOM, в котором будет размещена кнопка входа. Вы также можете передать ссылку на сам элемент.

userInfoLabel

Тип: string

Текст, отображаемый перед адресом электронной почты вошедшего в систему пользователя. По умолчанию: 'You are logged in as: ' .

scopes

Тип: Array

Список областей аутентификации Google API, которые запрашивает ваше приложение. Чтобы просмотреть все доступные области действия, посетите OAuth 2.0 Playground . Области аутентификации Google Analytics API см. в руководствах для разработчиков ресурсов по настройке и отчетности .

overwriteDefaultScopes

Тип: boolean

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

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

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

serverAuth.access_token

Тип: string

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

События

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) Компонент данных позволяет вам запрашивать API основных отчетов Google Analytics и получать результаты.

Параметры

query

Тип: Object

Объект, содержащий параметры запроса из Core Reporting API . Следующие значения по умолчанию используются в дополнение к обычным значениям по умолчанию, предоставляемым 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();

Диаграмма данных

gapi.analytics.googleCharts.DataChart
Конструктор
DataChart( options :Object) DataChart объединяет стандартную диаграмму Google и компонент данных , поэтому вы можете легко создать визуализацию на основе запроса без необходимости связывать ее вместе самостоятельно.

Параметры

query

Тип: Object

См. опцию запроса компонента данных .

chart

Тип: Object

Подробную информацию об отдельных опциях диаграммы смотрите ниже.

chart.container

Тип: string|HTMLElement

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

chart.type

Тип: string

Тип диаграммы. Возможные варианты: LINE , COLUMN , BAR , TABLE и GEO .

chart.options

Тип: Object

Любые параметры, которые можно передать соответствующему объекту Google Chart .

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

get
set
execute
on
once
off
emit

События

success

Аргументы: result

Вызывается, когда запрос успешно завершен и диаграмма полностью отрисована.

  • result.chart – экземпляр диаграммы Google.
  • result.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();

Селектор представления

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