---
title: "Типы TypeScript для AdsGram"
description: "Объявления типов TypeScript для SDK AdsGram: AdController, ShowPromiseResult, типы событий и типизация для компонента adsgram-task."
---

# Работа с TypeScript: Создание объявления типов AdsGram

Для интеграции AdsGram с использованием TypeScript создайте файл `adsgram.d.ts` и добавьте его в папку `types` или существующую папку с объявлениями типов.

::: info Информация
Если вы используете наши специализированные npm-пакеты для [React](https://www.npmjs.com/package/@adsgram/react) или [Vue](https://www.npmjs.com/package/@adsgram/vue), поддержка TypeScript уже встроена и вам не нужно вручную объявлять типы.
:::

## Типизация API AdsGram
::: code-group
```ts [adsgram.d.ts]
export interface ShowPromiseResult {
  done: boolean; // true, если реклама досмотрена до конца, иначе false
  description: string; // описание события
  state: 'load' | 'render' | 'playing' | 'destroy'; // текущее состояние баннера
  error: boolean; // true, если произошло событие ошибки, иначе false
}

type BannerType = 'RewardedVideo' | 'FullscreenMedia';

interface AdsgramInitParams {
  blockId: string; // уникальный идентификатор рекламного блока
  debug?: boolean; // debug режим (опционально)
  debugConsole?: boolean; // логи в консоли в debug режиме (опционально)
  debugBannerType?: BannerType; // тип тестового баннера (опционально)
}

type EventType =
  | 'onReward' // пользователь получил награду за просмотр рекламы
  | 'onComplete' // пользователь досмотрел Interstitial баннер или закрыл его
  | 'onStart' // первый кадр баннера отображён
  | 'onSkip' // пользователь пропустил рекламу
  | 'onBannerNotFound'  // баннер для показа отсутствует
  | 'onNonStopShow' // пользователь пытается посмотреть несколько реклам подряд
  | 'onTooLongSession' // слишком долгая сессия, необходимо перезапустить приложение чтобы получать рекламу
  | 'onError'; // ошибка при рендере или воспроизведении рекламы
type HandlerType = () => void; // функция обратного вызова для событий

export interface AdController {
  show(): Promise<ShowPromiseResult>; // показывает рекламу
  addEventListener(event: EventType, handler: HandlerType): void; // подписывает на событие
  removeEventListener(event: EventType, handler: HandlerType): void; // отписывает от события
  destroy(): void; // прекращает показ рекламы и очищает ресурсы
}

declare global {
    interface Window {
      Adsgram?: {
        init(params: AdsgramInitParams): AdController; // инициализация AdsGram
      };
    }
}
```
:::

## Типизация веб-компонента `<adsgram-task>` для проектов на react/preact{#task-types}
Добавьте следующий код в `adsgram.d.ts`, чтобы описать типы для использования веб-компонента `<adsgram-task>`:
::: code-group
```ts [adsgram.d.ts (react)]
import type { DetailedHTMLProps, HTMLAttributes } from "react";

type AdsgramTaskAttributes = DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement> & {
  "data-block-id": string;
  "data-debug"?: boolean | "true" | "false";
  "data-debug-console"?: boolean | "true" | "false";
  classname?: string;
};

declare module "react" {
  namespace JSX {
    interface IntrinsicElements {
      "adsgram-task": AdsgramTaskAttributes;
    }
  }
}
```
```ts [adsgram.d.ts (preact)]
import type { JSX } from "preact";

type AdsgramTaskAttributes = JSX.HTMLAttributes<HTMLElement> & {
  "data-block-id": string;
  "data-debug"?: boolean | "true" | "false";
  "data-debug-console"?: boolean | "true" | "false";
  classname?: string;
};

declare module "preact" {
  namespace JSX {
    interface IntrinsicElements {
      "adsgram-task": AdsgramTaskAttributes;
    }
  }
}
```
:::

**Примечания**
- **Типы событий (EventType):**\
Эти типы описывают события, на которые можно подписаться с помощью метода addEventListener.
- **Глобальное объявление (global):**\
Указывает, что Adsgram доступен в глобальном объекте window.
- **Типизация веб-компонента:**\
Позволяет использовать `<adsgram-task>` с корректными типами.
