itd-api / TelemetryResource

Interface: TelemetryResource

Defined in: resources/telemetry.ts:436

Телеметрия просмотров и взаимодействий.

Ничего не отправляет автоматически: каждый запрос, tracker или накопитель создаётся явным вызовом пользователя. Доступна как itd.telemetry.

Extends

• BaseResource

Accessors

sessionId

Get Signature

get sessionId(): string;

Defined in: resources/telemetry.ts:451

Идентификатор сессии телеметрии, общий для всех событий этого ресурса.

Returns

string

Methods

batch()

batch(options?, requestOptions?): TelemetryBatch;

Defined in: resources/telemetry.ts:566

Создаёт накопитель с явными flush() и close().

Создание и добавление записей не выполняют сетевых запросов.

Parameters

options?

TelemetryBatchOptions = {}

requestOptions?

RequestOptions = {}

Returns

TelemetryBatch

---

close()

close(): Promise<void>;

Defined in: resources/telemetry.ts:584

Закрывает все созданные накопители, отправляя оставшиеся записи.

Returns

Promise<void>

---

dwell()

dwell(
   entries, 
   telemetryOptions?, 
requestOptions?): Promise<unknown>;

Defined in: resources/telemetry.ts:457

Отправляет события просмотра постов (POST /api/v1/i).

Parameters

entries

readonly DwellEntry[]

telemetryOptions?

TelemetryOptions = {}

requestOptions?

RequestOptions = {}

Returns

Promise<unknown>

---

interaction()

interaction(
   entries, 
   telemetryOptions?, 
requestOptions?): Promise<unknown>;

Defined in: resources/telemetry.ts:495

Отправляет события взаимодействия с контентом (POST /api/v1/x).

Parameters

entries

readonly InteractionEntry[]

telemetryOptions?

TelemetryOptions = {}

requestOptions?

RequestOptions = {}

Returns

Promise<unknown>

---

photoOpen()

photoOpen(
   input, 
   telemetryOptions?, 
requestOptions?): Promise<unknown>;

Defined in: resources/telemetry.ts:544

Отправляет событие открытия фотографии.

Parameters

input

PhotoOpenInput

telemetryOptions?

TelemetryOptions = {}

requestOptions?

RequestOptions = {}

Returns

Promise<unknown>

---

startView()

startView(
   input, 
   options?, 
   requestOptions?): ViewTracker;

Defined in: resources/telemetry.ts:532

Начинает измерять время просмотра и отправляет результат после finish().

Parameters

input

ViewTrackerInput

options?

ViewTrackerOptions = {}

requestOptions?

RequestOptions = {}

Returns

ViewTracker

---

videoProgress()

videoProgress(
   input, 
   telemetryOptions?, 
requestOptions?): Promise<unknown>;

Defined in: resources/telemetry.ts:553

Отправляет событие прогресса просмотра видео.

Parameters

input

VideoProgressInput

telemetryOptions?

TelemetryOptions = {}

requestOptions?

RequestOptions = {}

Returns

Promise<unknown>