ru.metrika4j
Interface Report

All Known Implementing Classes:

ReportImpl

public interface Report

Отчёт системы Яндекс.Метрика. Генерируется при вызове метода ReportBuilder.build(). Табличный отчёт содержит массив основных результатов (getData()}), а также может содержать дополнительные результаты, для извлечения которых используется функция getArray(String).
Содержимое записей в массиве результатов описано в документации на каждый отчёт

Если в отчете много данных, он может состоять из нескольких "страниц". При создании отчёта загружается его первая страница, для получения следующих страниц необходимо пользоваться методами hasNextPage() и getNextPage()

Author:

Artur Suilin

Method Summary

ReportItem[]	getArray(java.lang.String name) Возвращает массив с дополнительными результатами отчёта
int	getCounterId() Возвращает идентификатор счётчика, для которого построен отчёт
ReportItem[]	getData() Возвращает массив основных результатов отчёта (соответствует параметру data в выходных данных отчёта)
MetrikaDate	getDateFrom() Возвращает начало интервала времени, за который построен отчёт
MetrikaDate	getDateTo() Возвращает конец интервала времени, за который построен отчёт
java.lang.Integer	getGoalId() Возвращает идентификатор цели для целевого отчёта, или null для нецелевого отчёта
Report	getNextPage() Возвращает "следующую страницу" отчёта, если она существует, или null
ReportItem	getTotals() Итоговые данные отчёта
boolean	hasNextPage() Возвращает true, если есть следующая "страница" данных отчёта.

Method Detail

hasNextPage

boolean hasNextPage()

Возвращает true, если есть следующая "страница" данных отчёта. Для перехода к следующей странице используется метод getNextPage()

getCounterId

int getCounterId()

Возвращает идентификатор счётчика, для которого построен отчёт

getGoalId

java.lang.Integer getGoalId()

Возвращает идентификатор цели для целевого отчёта, или null для нецелевого отчёта

See Also:

ReportBuilder.withGoal(Integer)

getDateFrom

MetrikaDate getDateFrom()

Возвращает начало интервала времени, за который построен отчёт

See Also:

ReportBuilder.withDateFrom(MetrikaDate)

getDateTo

MetrikaDate getDateTo()

Возвращает конец интервала времени, за который построен отчёт

See Also:

ReportBuilder.withDateTo(MetrikaDate)

getData

ReportItem[] getData()

Возвращает массив основных результатов отчёта (соответствует параметру data в выходных данных отчёта)

getArray

ReportItem[] getArray(java.lang.String name)

Возвращает массив с дополнительными результатами отчёта

Parameters:

name - имя параметра, содержащего дополнительные результаты

getTotals

ReportItem getTotals()

Итоговые данные отчёта

Returns:

Структура с итоговыми данными (обычно она повторяет структуру строки отчёта) или null, если в отчёте нет итоговых данных

getNextPage

Report getNextPage()

Возвращает "следующую страницу" отчёта, если она существует, или null