ru.metrika4j
Interface ReportBuilder

All Known Implementing Classes:

ReportBuilderImpl

public interface ReportBuilder

Построитель отчетов.

Позволяет указать входные параметры отчетов. Набор возможных параметров указан в описании каждого отчета в документации на API Я.Метрики.
Для часто используемых параметров (временной интервал, сортировка и т.п.), существуют соответствующие именованные методы. Если требуется входной параметр отчета, для установки которого не существует специального метода, можно воспользоваться функцией (withParameter(String, String)), позволяющей установить параметр с произвольным именем.

Для построения отчета после задания параметров надо вызвать метод build()

Экземпляр построителя отчётов получается путём вызова MetrikaApi.makeReportBuilder(Reports, int)

Один и тот же построитель отчетов может использоваться несколько раз, с разными параметрами. Для установки нового значения параметра передайте значение в соответствующий метод withXXX(), для сброса параметра передайте в качестве значения null

Author:

Artur Suilin

Nested Class Summary

static class	ReportBuilder.Group Способ группировки данных по времени в отчёте
static class	ReportBuilder.TableMode Способ представления результатов отчёта

Method Summary

Report	build() Выполняет фактическое построение отчёта.
ReportBuilder	groupBy(ReportBuilder.Group group) Задаёт группировку данных по времени.
ReportBuilder	reverseSortBy(java.lang.String field) Задаёт сортировку по убыванию по произвольному полю отчёта
ReportBuilder	sortBy(java.lang.String field) Задаёт сортировку по возрастанию по произвольному полю отчёта
ReportBuilder	withDateFrom(MetrikaDate date) Задаёт нижнюю границу временного интервала, по которому будет построен отчёт.
ReportBuilder	withDateTo(MetrikaDate date) Задаёт верхнюю границу временного интервала, по которому будет построен отчёт.
ReportBuilder	withGoal(java.lang.Integer goalId) Задаёт идентификатор цели, для получения целевого отчёта.
ReportBuilder	withItemsPerPage(java.lang.Integer numberOfItems) Задаёт количество записей на одну "страницу" отчёта
ReportBuilder	withMirrorId(java.lang.Integer mirrorId) Задаёт фильтрацию по указанному зеркалу сайта.
ReportBuilder	withParameter(java.lang.String name, java.lang.String value) Задаёт входной параметр отчёта с произвольным именем.
ReportBuilder	withTableMode(ReportBuilder.TableMode tm) Задаёт представление результатов отчета - в виде таблиц или в виде дерева.

Method Detail

withDateFrom

ReportBuilder withDateFrom(MetrikaDate date)

Задаёт нижнюю границу временного интервала, по которому будет построен отчёт. Если границы не заданы, будет построен отчёт за последнюю неделю

See Also:

withDateTo(MetrikaDate)

withDateTo

ReportBuilder withDateTo(MetrikaDate date)

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

See Also:

withDateFrom(MetrikaDate)

withGoal

ReportBuilder withGoal(java.lang.Integer goalId)

Задаёт идентификатор цели, для получения целевого отчёта.

See Also:

Goal

groupBy

ReportBuilder groupBy(ReportBuilder.Group group)

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

sortBy

ReportBuilder sortBy(java.lang.String field)

Задаёт сортировку по возрастанию по произвольному полю отчёта

Parameters:

field - имя поля в отчете (имена полей перечислены в документации на каждый отчёт)

See Also:

reverseSortBy(String)

reverseSortBy

ReportBuilder reverseSortBy(java.lang.String field)

Задаёт сортировку по убыванию по произвольному полю отчёта

Parameters:

field - имя поля в отчете (имена полей перечислены в документации на каждый отчёт)

See Also:

sortBy(String)

withTableMode

ReportBuilder withTableMode(ReportBuilder.TableMode tm)

Задаёт представление результатов отчета - в виде таблиц или в виде дерева. По умолчанию результаты представляются в виде таблицы.

withMirrorId

ReportBuilder withMirrorId(java.lang.Integer mirrorId)

Задаёт фильтрацию по указанному зеркалу сайта. Применяется для отчетов по содержанию.

Parameters:

mirrorId - числовой идентификатор зеркала, 0 - основной сайт; 1 и более - порядковый номер из массива зеркал (см. параметр mirrors в описании счётчика); отрицательное число - будут выведены данные для сайтов и адресов, не указанных в настройках счётчика.

withParameter

ReportBuilder withParameter(java.lang.String name,
                            java.lang.String value)

Задаёт входной параметр отчёта с произвольным именем.

Parameters:

name - Имя параметра

value - Значение параметра

withItemsPerPage

ReportBuilder withItemsPerPage(java.lang.Integer numberOfItems)

Задаёт количество записей на одну "страницу" отчёта

build

Report build()

Выполняет фактическое построение отчёта. Функция в ходе работы обращается за данными к серверам Яндекс .Метрики.

Throws:

NoDataException