ru.metrika4j
Interface MetrikaApi

All Known Implementing Classes:

MetrikaApiImpl

public interface MetrikaApi

API Яндекс.Метрики.
Непосредственно в этом интерфейсе есть методы для работы со счетчиками (создание, удаление, etc) и отчетами. Для работы с другими сущностями (фильтры, цели, etc), надо получить интерфейс для работы с этим видом сущностей, с помощью метода getXxxApi, например для целей - метод getGoalApi() .

Экземпляр API для использования в приложении создаётся с помощью ApiFactory

Author:

Artur Suilin

Method Summary

Counter	createCounter(Counter newCounter) Создаёт новый счетчик в аккаунте текущего пользователя
void	deleteCounter(int counterId) Удаляет счетчик с заданным идентификатором
AccountApi	getAccountApi()
Counter	getCounter(int id, CounterDetails... details) Возвращает счетчик по его идентификатору
Counter[]	getCounters(CounterDetails... details) Возвращает список всех счетчиков, доступных в текущем аккаунте Я.Метрики
DelegateApi	getDelegateApi()
FilterApi	getFilterApi()
GoalApi	getGoalApi()
GrantApi	getGrantApi()
OperationApi	getOperationApi()
ReportBuilder	makeReportBuilder(Reports report, int counterId) Возвращает построитель для заданного отчёта
Counter	updateCounter(Counter counter) Изменяет счетчик в аккаунте текущего пользователя

Method Detail

getCounters

Counter[] getCounters(CounterDetails... details)

Возвращает список всех счетчиков, доступных в текущем аккаунте Я.Метрики

Parameters:

details - Требуемая детализация данных каждого счетчика

See Also:

Справочник API

getCounter

Counter getCounter(int id,
                   CounterDetails... details)

Возвращает счетчик по его идентификатору

Parameters:

details - Требуемая детализация данных счетчика

See Also:

Справочник API

makeReportBuilder

ReportBuilder makeReportBuilder(Reports report,
                                int counterId)

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

Parameters:

report - Отчёт

counterId - идентификатор счетчика

createCounter

Counter createCounter(Counter newCounter)

Создаёт новый счетчик в аккаунте текущего пользователя

Parameters:

newCounter - Объект с заполненными полями, представляющий новый счетчик

Returns:

Созданный счетчик. Это объект с теми же полями, что у входного newCounter, плюс поля, автоматически выставленные Метрикой (например id).

See Also:

Справочник API

updateCounter

Counter updateCounter(Counter counter)

Изменяет счетчик в аккаунте текущего пользователя

Parameters:

counter - Объект с заполненными полями, представляющий счетчик, который должен быть изменён

Returns:

Измененный счетчик. Это объект с теми же полями, что у входного счетчика, плюс Метрика может сама выставить значения некоторых полей по умолчанию.

See Also:

Справочник API

deleteCounter

void deleteCounter(int counterId)

Удаляет счетчик с заданным идентификатором

See Also:

Справочник API

getGoalApi

GoalApi getGoalApi()

getFilterApi

FilterApi getFilterApi()

getOperationApi

OperationApi getOperationApi()

getGrantApi

GrantApi getGrantApi()

getDelegateApi

DelegateApi getDelegateApi()

getAccountApi

AccountApi getAccountApi()