Описание объектной модели - wm-russia-software/Segmento.Api.Connector GitHub Wiki

Segmento.Api.Connector

Authentication BaseApiHandler
BaseTokenApiHandler Campaigns
Clients Campaign
Client DataContainer<T>
StatisticsItem SubCampaign
Token Statistics

Authentication

Класс для работы с аутентификацией

Constructor

Конструктор

Constructor(apiUrl)

Конструктор

Name Description
apiUrl System.String
Url для доступа к Api

GetToken(login, password)

Получение токена

Name Description
login System.String
Логин
password System.String
Пароль

Returns

BaseApiHandler

Базовый обработчик API

Constructor

Конструктор

Constructor(apiUrl)

Конструктор

Name Description
apiUrl System.String
Url для доступа к Api

AddDefaultHeaders(request)

Добавление заголовков запроса по умолчанию

Name Description
request RestSharp.RestRequest
Запроса

ApiUrl

Url для доступа к Api

CommonApiUrl

Url для доступа к Api

DefaultRequestTimeout

Таймаут между запросами

RequestTimeout

Таймаут между запросами

Wait

Ожидание

BaseTokenApiHandler

Базовый обработчик API

Constructor(apiUrl, token)

Конструктор

Name Description
apiUrl System.String
Url для доступа к Api
token System.String
Токен

Constructor(token)

Конструктор

Name Description
token System.String
Токен

AddDefaultHeaders(request)

Добавление заголовков запроса по умолчанию

Name Description
request RestSharp.RestRequest
Запрос

Token

Токен

Campaigns

Класс для работы с кампаниями

See also

Constructor(apiUrl, token)

Конструктор

Name Description
apiUrl System.String
Url для доступа к Api
token System.String
Токен

Constructor(token)

Конструктор

Name Description
token System.String
Токен

GetCampaigns(clientId)

Получение списка кампаний

Name Description
clientId System.Int32
Идентификатор клиента

Returns

Clients

Класс для работы с клиентами

See also

Constructor(apiUrl, token)

Конструктор

Name Description
apiUrl System.String
Url для доступа к Api
token System.String
Токен

Constructor(token)

Конструктор

Name Description
token System.String
Токен

GetClients

Получение списка клиентов

Returns

Campaign

Кампания

Id

Идентификатор

Name

Название

SubCampaigns

Подкампании

Client

Клиент

Id

Идентификатор

Name

Название

DataContainer<T>

Контейнер данных

Values

Элементы

StatisticsItem

Элемент статистики

BounceRate

Время на сайте

Clicks

Количество кликов

ClientCost

Стоимость для клиента

Date

Дата

Impressions

Количество показов

LastClicks

Количество last-click конверсий

MeanDuration

Время на сайте

PageDepth

Глубина просмотра

PostClicks

Количество post-click конверсий

PostViews30Days

Количество post-view конверсий совершенных после просмотра рекламы до 30 дней до совершения конверсии

PostViews3Days

Количество post-view конверсий совершенных после просмотра рекламы до 3 дней до совершения конверсии

PostViewSessions

Количество сессий после просмотра рекламы

PostViewVisitors

Количество уникальных пользователей после просмотра рекламы

Sessions

Количество сессий

VideoComplete

Количество досмотров видео

ViewableImpressions

Количество видимых показов

SubCampaign

Подкампания

EndDate

Конечная дата

Id

Идентификатор

Name

Название

StartDate

Начальная дата

Token

Токен

AccessToken

Токен доступа

ExpiringTime

Время жизни

TokenType

Тип токена

Statistics

Класс для получения статистических отчетов

See also

Constructor(apiUrl, token)

Конструктор

Name Description
apiUrl System.String
Url для доступа к Api
token System.String
Токен

Constructor(token)

Конструктор

Name Description
token System.String
Токен

GetStatisticsReport(campaignId, startDate, endDate)

Получение основного статистического отчета

Name Description
campaignId System.Int32
Идентификатор кампании
startDate System.DateTime
Начальная дата
endDate System.DateTime
Конечная дата

Returns

⚠️ **GitHub.com Fallback** ⚠️