Руководство по модулю Promotion (Реклама)

⚠️ v3.0.0: Это руководство обновлено для SDK v3.0.0. Если вы используете v2.x, см. руководство по миграции.

Это руководство описывает модуль Promotion (Реклама) SDK Wildberries, включая управление кампаниями, контроль ставок, бюджетные операции и аналитику.

Обзор

Модуль Promotion предоставляет полный доступ к рекламным возможностям Wildberries:

Управление кампаниями: Создание, запуск, пауза, остановка и удаление рекламных кампаний
Бюджетные операции: Пополнение средств и отслеживание расходов кампании
Управление ставками: Установка и управление ставками для поиска и рекомендаций
Управление фразами: Управление фиксированными и минус-фразами
Аналитика: Получение статистики кампании по ключевым словам и метрикам эффективности

Быстрый старт

typescript

import { WildberriesSDK } from 'daytona-wildberries-typescript-sdk';

const sdk = new WildberriesSDK({
  apiKey: process.env.WB_API_KEY!
});

// Получить баланс рекламного кабинета
const balance = await sdk.promotion.getAdvBalance();
console.log(`Баланс: ${balance.net}₽`);

// Получить обзор всех кампаний
const campaigns = await sdk.promotion.getCampaigns();
console.log(`Всего кампаний: ${campaigns.all}`);

Жизненный цикл кампании

Статусы кампаний

Статус	Код	Описание
Готова	`4`	Кампания создана, готова к запуску
Завершена	`7`	Кампания завершена
Отменена	`8`	Кампания отменена
Активна	`9`	Кампания работает
На паузе	`11`	Кампания приостановлена
Удаляется	`-1`	Кампания удаляется (3-10 мин)

Типы кампаний

Тип	Описание	Статус
`4`	В каталоге	Устарел
`5`	В карточке товара	Устарел
`6`	В поиске	Устарел
`7`	В рекомендациях	Устарел
`8`	Единая ставка	Устарел
`9`	Единая или ручная ставка	Текущий

v3.0.0: Унифицированный метод

В SDK v3.0.0 используется единый метод getCampaigns() для получения всех типов кампаний. Метод возвращает массив кампаний с полной информацией.

Типы ставок

Тип ставки	Описание
`manual`	Ручная ставка - управление ставками по местам размещения
`unified`	Единая ставка - одна ставка для всех мест

Места размещения

Место	Описание
`search`	Реклама в поиске
`recommendations`	Реклама в рекомендациях
`combined`	И поиск, и рекомендации

Управление кампаниями

Создание кампании

typescript

// Создать кампанию с ручной ставкой для поиска
const campaign = await sdk.promotion.createSeacatSaveAd({
  name: 'Зимняя коллекция 2024',
  nms: [168120815, 173574852], // Артикулы WB (макс. 50)
  bid_type: 'manual',
  placement_types: ['search']
});

console.log(`Кампания создана: ID ${campaign}`);

Получение информации о кампаниях

Список всех кампаний

typescript

// Получить все кампании, сгруппированные по типу и статусу
const overview = await sdk.promotion.getCampaigns();

overview.adverts?.forEach(group => {
  console.log(`Тип ${group.type}, Статус ${group.status}: ${group.count} кампаний`);

  // Список ID кампаний
  group.advert_list?.forEach(ad => {
    console.log(`  ID кампании: ${ad.advertId}`);
  });
});

Детали кампаний типа 9 (современные)

typescript

// Получить аукционные кампании (тип 9)
const auctionCampaigns = await sdk.promotion.getCampaigns({});
auctionCampaigns.adverts?.forEach(campaign => {
  console.log(`Кампания ${campaign.id}: статус=${campaign.status}, тип_ставки=${campaign.bid_type}`);
});

// Фильтрация по статусу или типу оплаты
const activeCampaigns = await sdk.promotion.getCampaigns({
  statuses: '9',        // Только активные
  payment_type: 'cpm'   // Кампании CPM
});

// Получить конкретные кампании по ID
const specificCampaigns = await sdk.promotion.getCampaigns({
  ids: '12345,67890'    // Макс. 50 ID
});

Детали устаревших кампаний (типы 4-8)

Путаница с названием метода

getCampaigns() НЕ создаёт кампании - он ПОЛУЧАЕТ информацию об устаревших кампаниях. Название сгенерировано из Swagger-спецификации и может вводить в заблуждение.

typescript

// Получить детали устаревших кампаний (типы 4-8)
const legacyDetails = await sdk.promotion.getCampaigns(
  [12345, 67890],     // Массив ID кампаний (макс. 50)
  {
    status: 9,        // Фильтр по статусу (необязательно)
    type: 8,          // Фильтр по типу (необязательно)
    order: 'change',  // Сортировка: 'create', 'change', 'id'
    direction: 'desc' // Направление: 'asc' или 'desc'
  }
);

console.log('Детали устаревших кампаний:', legacyDetails);

Полный воркфлоу: получение ВСЕХ деталей кампаний

typescript

async function getAllCampaignDetails(sdk: WildberriesSDK) {
  // Шаг 1: Получить список ВСЕХ кампаний
  const allCampaigns = await sdk.promotion.getCampaigns();

  // Шаг 2: Разделить по типам
  const type9Ids: number[] = [];
  const legacyIds: number[] = [];

  allCampaigns.adverts?.forEach(group => {
    group.advert_list?.forEach(advert => {
      if (group.type === 9) {
        type9Ids.push(advert.advertId!);
      } else if (group.type && group.type >= 4 && group.type <= 8) {
        legacyIds.push(advert.advertId!);
      }
    });
  });

  console.log(`Найдено ${type9Ids.length} кампаний типа 9 (современные)`);
  console.log(`Найдено ${legacyIds.length} устаревших кампаний (типы 4-8)`);

  // Шаг 3: Получить детали кампаний типа 9
  if (type9Ids.length > 0) {
    const type9Details = await sdk.promotion.getCampaigns({
      ids: type9Ids.slice(0, 50).join(',')  // Макс. 50 ID за запрос
    });
    console.log('Детали кампаний типа 9:', type9Details);
  }

  // Шаг 4: Получить детали устаревших кампаний
  if (legacyIds.length > 0) {
    const legacyDetails = await sdk.promotion.getCampaigns(
      legacyIds.slice(0, 50)  // Макс. 50 ID за запрос
    );
    console.log('Детали устаревших кампаний:', legacyDetails);
  }
}

Методы управления кампаниями

typescript

// Запустить кампанию (требуется статус 4 или 11 + бюджет)
await sdk.promotion.startCampaign({ id: campaignId });

// Поставить на паузу (только для статуса 9 - активна)
await sdk.promotion.pauseCampaign({ id: campaignId });

// Остановить/завершить кампанию (для статусов 4, 9, 11)
await sdk.promotion.stopCampaign({ id: campaignId });

// Удаление кампании недоступно через SDK в v3.0.0
// Используйте личный кабинет Wildberries для удаления кампаний

// Переименовать кампанию
await sdk.promotion.createAdvRename({
  advertId: campaignId,
  name: 'Новое название кампании'
});

Допустимые переходы статусов

┌─────────┐     запуск     ┌─────────┐
│ Готова  │ ──────────────>│ Активна │
│   (4)   │                │   (9)   │
└────┬────┘                └────┬────┘
     │                          │
     │ удаление                 │ пауза
     ▼                          ▼
┌───────────┐            ┌──────────┐
│ Удаляется │            │ На паузе │
│   (-1)    │            │   (11)   │
└───────────┘            └────┬─────┘
                              │
     ┌────────────────────────┤ запуск
     │                        │
     │      остановка         ▼
     │    ◄───────────────────┘
     ▼
┌───────────┐
│ Завершена │
│    (7)    │
└───────────┘

Бюджетные операции

Проверка баланса

typescript

const balance = await sdk.promotion.getAdvBalance();
console.log(`Баланс (счёт): ${balance.balance}₽`);
console.log(`Баланс (кабинет): ${balance.net}₽`);
console.log(`Бонусы: ${balance.bonus}₽`);

// Информация о кэшбэке
if (balance.cashbacks?.length) {
  balance.cashbacks.forEach(cb => {
    console.log(`Кэшбэк: ${cb.percent}% (макс ${cb.sum}₽)`);
  });
}

Пополнение бюджета кампании

Важно: Согласно документации API, для пополнения бюджета кампания должна быть в статусе 11 (на паузе). Однако тестирование показало, что это может работать и для статуса 4 (готова).

typescript

// Сначала поставьте кампанию на паузу, если она активна
await sdk.promotion.pauseCampaign({ id: campaignId });

// Пополнить на 1000₽ с баланса кабинета
await sdk.promotion.createBudgetDeposit(
  {
    sum: 1000,
    type: 1  // 0=счёт, 1=баланс (кабинет), 3=бонусы
  },
  { id: campaignId }
);

// Проверить бюджет
const budget = await sdk.promotion.getAdvBudget({ id: campaignId });
console.log(`Бюджет кампании: ${budget.total}₽`);

Получение бюджета кампании

typescript

const budget = await sdk.promotion.getAdvBudget({ id: campaignId });
console.log(`Наличные: ${budget.cash}₽`);
console.log(`Взаимозачёт: ${budget.netting}₽`);
console.log(`Всего: ${budget.total}₽`);

История расходов

typescript

const to = new Date();
const from = new Date();
from.setDate(from.getDate() - 30);

const expenses = await sdk.promotion.getAdvUpd({
  from: from.toISOString().split('T')[0],
  to: to.toISOString().split('T')[0]
});

let totalSpent = 0;
expenses.forEach(record => {
  console.log(`${record.campName}: ${record.updSum}₽`);
  totalSpent += record.updSum || 0;
});
console.log(`Всего потрачено за 30 дней: ${totalSpent}₽`);

Управление ставками

Получение минимальных ставок

typescript

// Получить минимальные ставки для товаров в кампании
const minBids = await sdk.promotion.createBidsMin({
  advert_id: campaignId,
  nm_ids: [168120815, 173574852],
  payment_type: 'cpm',  // 'cpm' (за 1000 показов) или 'cpc' (за клик)
  placement_types: ['search']
});

minBids.forEach(bid => {
  console.log(`Артикул ${bid.nm_id}: мин. ставка = ${bid.bid}₽`);
});

Обновление ставок для кампаний с единой ставкой

typescript

// Для кампаний с единой ставкой (bid_type: 'unified')
await sdk.promotion.updateAdvBid({
  bids: [{
    advert_id: campaignId,
    bid: 280  // CPM ставка в рублях
  }]
});

Обновление ставок для кампаний с ручной ставкой

typescript

// Для кампаний с ручной ставкой (bid_type: 'manual')
await sdk.promotion.updateAuctionBid({
  bids: [{
    advert_id: campaignId,
    nm_bids: [{
      nm_id: 168120815,
      bid: 280,
      placement: 'search'  // или 'recommendations', 'combined'
    }]
  }]
});

Управление ключевыми фразами

Минус-фразы для ручной ставки

Важно: Эти методы требуют, чтобы кампания была активной (статус 9).

typescript

// Установить минус-фразы
await sdk.promotion.createSearchSetExcluded(
  { excluded: ['дёшево', 'скидка', 'б/у'] },
  { id: campaignId }
);

// Очистить все минус-фразы
await sdk.promotion.createSearchSetExcluded(
  { excluded: [] },
  { id: campaignId }
);

Минус-фразы для единой ставки

typescript

// Установить минус-фразы для кампании с единой ставкой
await sdk.promotion.createAutoSetExcluded(
  { excluded: ['дёшево', 'скидка'] },
  { id: campaignId }
);

Фиксированные фразы (для ручной ставки)

Фиксированные фразы гарантируют, что ваш товар будет показываться только по определённым поисковым запросам.

typescript

// Получить статус активности фиксированных фраз
const activity = await sdk.promotion.getSearchSetPlus({ id: campaignId });

// Установить фиксированные фразы (фразы должны быть в списке ключевых слов кампании)
await sdk.promotion.createSearchSetPlu(
  { pluse: ['зимняя куртка', 'тёплое пальто'] },
  { id: campaignId }
);

// Удалить все фиксированные фразы
await sdk.promotion.createSearchSetPlu(
  { pluse: [] },
  { id: campaignId }
);

// Переключить активность фиксированных фраз (true = активны, false = неактивны)
await sdk.promotion.getSearchSetPlus({
  id: campaignId,
  fixed: true
});

Статистика кампаний

Статистика по ключевым словам (последние 7 дней)

typescript

const to = new Date();
const from = new Date();
from.setDate(from.getDate() - 7);

const stats = await sdk.promotion.getStatsKeywords({
  advert_id: campaignId,
  from: from.toISOString().split('T')[0],
  to: to.toISOString().split('T')[0]
});

stats.keywords?.forEach(day => {
  console.log(`\nДата: ${day.date}`);
  day.stats?.forEach(kw => {
    console.log(`  "${kw.keyword}": показы=${kw.views}, клики=${kw.clicks}, расход=${kw.sum}₽`);
  });
});

Статистика ключевых слов для кампаний с ручной ставкой

typescript

const manualStats = await sdk.promotion.getStatWords({ id: campaignId });

if (manualStats.stat) {
  manualStats.stat.forEach(s => {
    console.log(`"${s.keyword}": показы=${s.views}, клики=${s.clicks}, ctr=${s.ctr}%`);
  });
}

Статистика кластеров для кампаний с единой ставкой

typescript

const unifiedStats = await sdk.promotion.getAutoStatWords({ id: campaignId });

if (unifiedStats.clusters) {
  unifiedStats.clusters.forEach(c => {
    console.log(`Кластер "${c.cluster}": ${c.count} ключевых слов`);
  });
}

if (unifiedStats.excluded) {
  console.log(`Минус-фразы: ${unifiedStats.excluded.length}`);
}

Полная статистика кампании (getAdvFullstats)

Строгий лимит запросов

У этого эндпоинта очень строгие лимиты: 3 запроса в минуту с интервалом 20 секунд. При более частых вызовах получите ошибку 429.

typescript

const end = new Date();
const begin = new Date();
begin.setDate(begin.getDate() - 7);

const fullStats = await sdk.promotion.getAdvFullstats({
  ids: String(campaignId),  // Можно передать несколько: "123,456,789" (макс 100)
  beginDate: begin.toISOString().split('T')[0],
  endDate: end.toISOString().split('T')[0]  // Макс 31 день от beginDate
});

fullStats.forEach(stat => {
  console.log(`Кампания ${stat.advertId}:`);
  console.log(`  Показы: ${stat.views}`);
  console.log(`  Клики: ${stat.clicks}`);
  console.log(`  CTR: ${stat.ctr}%`);
  console.log(`  CPC: ${stat.cpc}₽`);
  console.log(`  Заказы: ${stat.orders}`);
  console.log(`  Расход: ${stat.sum}₽`);

  // Детализация по дням и платформам
  stat.days.forEach(day => {
    console.log(`  ${day.date}:`);
    day.apps?.forEach(app => {
      console.log(`    Платформа ${app.appType}: ${app.clicks} кликов, ${app.orders} заказов`);
    });
  });
});

Пакетный запрос (несколько кампаний)

Можно запросить статистику до 100 кампаний за один вызов:

typescript

// Получить статистику по нескольким кампаниям сразу
const stats = await sdk.promotion.getAdvFullstats({
  ids: '24483511,23332267,27052565',  // ID через запятую
  beginDate: '2025-12-16',
  endDate: '2025-12-22'
});

// Возвращает массив с данными по каждой кампании
stats.forEach(s => {
  console.log(`Кампания ${s.advertId}: ${s.clicks} кликов, ${s.sum}₽ потрачено`);
});

С обработкой rate limit

typescript

import { RateLimitError } from 'daytona-wildberries-typescript-sdk';

const RATE_LIMIT_DELAY = 21000; // 21 секунда между запросами

async function getStatsForCampaigns(campaignIds: number[]) {
  const results = [];

  for (const id of campaignIds) {
    try {
      const stats = await sdk.promotion.getAdvFullstats({
        ids: String(id),
        beginDate: '2025-12-16',
        endDate: '2025-12-22'
      });
      results.push(...stats);

      // Ждём перед следующим запросом
      await new Promise(r => setTimeout(r, RATE_LIMIT_DELAY));

    } catch (error) {
      if (error instanceof RateLimitError) {
        console.log(`Превышен лимит, ждём ${error.retryAfter}мс`);
        await new Promise(r => setTimeout(r, error.retryAfter));
        // Повторяем для этой кампании
        campaignIds.push(id);
      } else {
        throw error;
      }
    }
  }

  return results;
}

Структура ответа

typescript

interface FullStatsResponse {
  advertId: number;      // ID кампании
  clicks: number;        // Всего кликов
  views: number;         // Всего показов
  ctr: number;           // Click-through rate %
  cpc: number;           // Цена за клик ₽
  orders: number;        // Всего заказов
  sum: number;           // Всего потрачено ₽
  atbs: number;          // Добавлений в корзину
  cr: number;            // Конверсия
  days: Array<{
    date: string;        // "2025-12-17T00:00:00Z"
    clicks: number;
    views: number;
    orders: number;
    sum: number;
    apps: Array<{        // Разбивка по платформам
      appType: number;   // 1=сайт, 32=android, 64=ios
      clicks: number;
      views: number;
      orders: number;
      sum: number;
      nms: Array<{       // Разбивка по товарам
        nmId: number;
        name: string;
        clicks: number;
        views: number;
        orders: number;
        sum: number;
      }>;
    }>;
  }>;
}

Извлечение статистики по SKU (nmId)

Данные nmId находятся во вложенной структуре days → apps → nms. Вот как их извлечь:

typescript

import type {
  FullStatsNmItem,
  FullStatsAppItem
} from 'daytona-wildberries-typescript-sdk';

// Получаем полную статистику
const stats = await sdk.promotion.getAdvFullstats({
  ids: String(campaignId),
  beginDate: '2025-12-16',
  endDate: '2025-12-22'
});

// Извлекаем статистику по SKU за все дни и платформы
interface SkuStats {
  nmId: number;
  name: string;
  totalClicks: number;
  totalViews: number;
  totalOrders: number;
  totalSpent: number;
}

const skuMap = new Map<number, SkuStats>();

for (const campaign of stats) {
  for (const day of campaign.days) {
    for (const app of day.apps) {
      for (const nm of app.nms) {
        const existing = skuMap.get(nm.nmId) || {
          nmId: nm.nmId,
          name: nm.name,
          totalClicks: 0,
          totalViews: 0,
          totalOrders: 0,
          totalSpent: 0
        };

        existing.totalClicks += nm.clicks;
        existing.totalViews += nm.views;
        existing.totalOrders += nm.orders;
        existing.totalSpent += nm.sum;

        skuMap.set(nm.nmId, existing);
      }
    }
  }
}

// Выводим разбивку по SKU
for (const [nmId, stats] of skuMap) {
  console.log(`Артикул ${nmId} (${stats.name}):`);
  console.log(`  Клики: ${stats.totalClicks}`);
  console.log(`  Показы: ${stats.totalViews}`);
  console.log(`  Заказы: ${stats.totalOrders}`);
  console.log(`  Потрачено: ${stats.totalSpent}₽`);
}

Статистика по платформам и SKU

typescript

// Названия платформ для отображения
const PLATFORMS: Record<number, string> = {
  1: 'Сайт',
  32: 'Android',
  64: 'iOS'
};

const stats = await sdk.promotion.getAdvFullstats({
  ids: String(campaignId),
  beginDate: '2025-12-16',
  endDate: '2025-12-22'
});

for (const campaign of stats) {
  console.log(`\n=== Кампания ${campaign.advertId} ===`);

  for (const day of campaign.days) {
    console.log(`\nДата: ${day.date}`);

    for (const app of day.apps) {
      console.log(`  ${PLATFORMS[app.appType] || app.appType}:`);

      for (const nm of app.nms) {
        console.log(`    Арт. ${nm.nmId}: ${nm.clicks} кликов, ${nm.orders} заказов, ${nm.sum}₽`);
      }
    }
  }
}

Типы TypeScript

SDK экспортирует полностью типизированные интерфейсы для данных по SKU:

FullStatsNmItem - статистика по артикулу (nmId, name, clicks и т.д.)
FullStatsAppItem - статистика по платформе с массивом nms
FullStatsDayItem - статистика за день с массивом apps

Полный пример рабочего процесса

typescript

import { WildberriesSDK } from 'daytona-wildberries-typescript-sdk';

async function runAdvertisingCampaign() {
  const sdk = new WildberriesSDK({ apiKey: process.env.WB_API_KEY! });

  const delay = (ms: number) => new Promise(r => setTimeout(r, ms));
  const RATE_LIMIT_DELAY = 5000;

  let campaignId: number | null = null;

  try {
    // 1. Проверить баланс
    const balance = await sdk.promotion.getAdvBalance();
    console.log(`Доступный баланс: ${balance.net}₽`);
    await delay(RATE_LIMIT_DELAY);

    if (balance.net < 1000) {
      throw new Error('Недостаточный баланс');
    }

    // 2. Создать кампанию
    campaignId = await sdk.promotion.createSeacatSaveAd({
      name: 'Тестовая кампания SDK',
      nms: [168120815],
      bid_type: 'manual',
      placement_types: ['search']
    }) as number;
    console.log(`Создана кампания: ${campaignId}`);
    await delay(RATE_LIMIT_DELAY);

    // 3. Пополнить бюджет
    await sdk.promotion.createBudgetDeposit(
      { sum: 1000, type: 1 },
      { id: campaignId }
    );
    console.log('Бюджет пополнен: 1000₽');
    await delay(RATE_LIMIT_DELAY);

    // 4. Получить минимальные ставки
    const minBids = await sdk.promotion.createBidsMin({
      advert_id: campaignId,
      nm_ids: [168120815],
      payment_type: 'cpm',
      placement_types: ['search']
    });
    console.log(`Минимальная ставка: ${minBids[0]?.bid || 'Н/Д'}₽`);
    await delay(RATE_LIMIT_DELAY);

    // 5. Запустить кампанию
    await sdk.promotion.startCampaign({ id: campaignId });
    console.log('Кампания запущена!');

    // 6. Мониторинг (в реальном сценарии - периодический опрос)
    // ... кампания работает ...

  } finally {
    // Очистка: Удалить тестовую кампанию
    if (campaignId) {
      try {
        await sdk.promotion.pauseCampaign({ id: campaignId });
        await delay(2000);
        await sdk.promotion.deleteCampaign({ id: campaignId });
        console.log('Кампания удалена');
      } catch (e) {
        // Попробовать остановить, если удаление не удалось (кампания может быть не в статусе 4)
        await sdk.promotion.stopCampaign({ id: campaignId });
        console.log('Кампания остановлена');
      }
    }
  }
}

Лимиты запросов

Операция	Лимит
Большинство операций	5 запр/сек (интервал 200мс)
Создание кампании	5 запр/мин (интервал 12сек)
Пополнение бюджета	1 запр/сек
Статистика	1 запр/мин
Минимальные ставки	20 запр/мин (интервал 3сек)

Всегда реализуйте правильные задержки между вызовами API:

typescript

const delay = (ms: number) => new Promise(r => setTimeout(r, ms));

// Между большинством операций
await delay(5000); // 5 секунд

// Между запросами статистики
await delay(60000); // 1 минута

Обработка ошибок

typescript

import {
  ValidationError,
  AuthenticationError,
  RateLimitError
} from 'daytona-wildberries-typescript-sdk';

try {
  await sdk.promotion.startCampaign({ id: campaignId });
} catch (error) {
  if (error instanceof ValidationError) {
    // Неверный ID кампании или неправильный статус
    console.error('Ошибка валидации:', error.message);
  } else if (error instanceof AuthenticationError) {
    // У API ключа нет прав на запись
    console.error('Ошибка авторизации: Проверьте права API ключа');
  } else if (error instanceof RateLimitError) {
    // Слишком много запросов
    console.error('Превышен лимит запросов, повторить через:', error.retryAfter);
  }
}

Справочник методов

Список и детали кампаний

v3.0.0: Унифицированный API

В SDK v3.0.0 используется единый метод getCampaigns() для получения всех типов кампаний.

Метод	Описание
`getCampaigns()`	Получить все кампании (возвращает массив с count)

Управление кампаниями

Метод	Описание	Требуемый статус
`createCampaign()`	Создать кампанию	-
`startCampaign()`	Запустить кампанию	4 или 11
`pauseCampaign()`	Поставить на паузу	9
`stopCampaign()`	Остановить/завершить	4, 9 или 11
~~`deleteCampaign()`~~	Удалено в v3.0.0, используйте личный кабинет WB	-
`createAdvRename()`	Переименовать	любой

Бюджет и финансы

Метод	Описание
`getAdvBalance()`	Баланс аккаунта
`createBudgetDeposit()`	Пополнить кампанию (статус 11)
`getAdvBudget()`	Бюджет кампании
`getAdvUpd()`	История расходов

Ставки

Метод	Описание
`createBidsMin()`	Минимальные ставки
`updateAdvBid()`	Обновить единую ставку
`updateAuctionBid()`	Обновить ручные ставки

Ключевые фразы

Метод	Описание	Тип ставки
`createSearchSetExcluded()`	Установить минус-фразы	ручная
`createAutoSetExcluded()`	Установить минус-фразы	единая
`getSearchSetPlus()`	Получить/переключить фикс. фразы	ручная
`createSearchSetPlu()`	Установить фикс. фразы	ручная

Статистика

Метод	Описание
`getStatsKeywords()`	Стат. по ключевым (7 дней)
`getStatWords()`	Стат. по ключевым (ручная)
`getAutoStatWords()`	Стат. по кластерам (единая)
`getAdvFullstats()`	Полная статистика

Устранение неполадок

Частые проблемы

"Validation failed" при пополнении бюджета
- Кампания должна быть в статусе 11 (на паузе)
- Сначала поставьте на паузу: pauseCampaign({ id })
"Validation failed" для минус/фиксированных фраз
- Кампания должна быть активной (статус 9)
- Сначала запустите кампанию
"Authentication failed" при операциях записи
- Проверьте, есть ли у API ключа права на рекламу
- Запросите расширенные права в личном кабинете WB
Кампания создаётся со статусом 7 (завершена)
- Товар может не подходить для рекламы
- Проверьте наличие и остатки товара
Не удаётся удалить кампанию
- В SDK v3.0.0 удаление кампаний через API недоступно
- Используйте личный кабинет Wildberries для удаления кампаний
- Используйте stopCampaign() для завершения кампаний

getAdvFullstats возвращает null/undefined или зависает

Частая ошибка

Использование optional chaining с nullish coalescing скрывает ошибки:

typescript

// ❌ НЕПРАВИЛЬНО - Это поглощает ошибки и возвращает null
const response = await (sdk.promotion as any).getAdvFullstats?.({...})
  ?? Promise.resolve(null);

Почему это не работает:

Optional chaining ?. возвращает undefined если метод не существует (но он существует!)
Nullish coalescing ?? перехватывает ошибки и возвращает null
Ошибки rate limit (429) проглатываются
Нет видимости реальных ошибок

Решение:

typescript

// ✅ ПРАВИЛЬНО - Прямой вызов с обработкой ошибок
try {
  const stats = await sdk.promotion.getAdvFullstats({
    ids: String(campaignId),
    beginDate: '2025-12-16',
    endDate: '2025-12-22'
  });
  console.log('Статистика:', stats);
} catch (error) {
  if (error instanceof RateLimitError) {
    console.log('Превышен лимит, ожидание...');
    await new Promise(r => setTimeout(r, error.retryAfter));
    // Повторить запрос
  } else {
    console.error('Ошибка:', error.message);
    throw error;
  }
}

Помните: У getAdvFullstats очень строгий лимит: 3 запроса в минуту с интервалом 20 секунд.

Акции маркетплейса WB (Calendar API)

Акции ≠ Рекламные кампании

Акции маркетплейса WB — это распродажи, организованные Wildberries (например, "Чёрная пятница", "Экспресс-скидки"). Они отличаются от рекламных кампаний, которые вы создаёте и управляете сами.

Аспект	Акции	Рекламные кампании
Создатель	Wildberries	Продавец
API домен	`dp-calendar-api.wildberries.ru`	`advert-api.wildberries.ru`
Цель	Маркетплейс-распродажи	Платная реклама товаров
Стоимость	Обычно бесплатное участие	Оплата за клики/показы

Получение доступных акций

typescript

// Получить акции за период
const promotions = await sdk.promotion.getCalendarPromotions({
  startDateTime: '2024-01-01T00:00:00Z',  // Обязательно - формат ISO 8601
  endDateTime: '2024-12-31T23:59:59Z',    // Обязательно - формат ISO 8601
  allPromo: true,                          // Обязательно - включить все типы
  limit: 100,                              // Опционально - макс. результатов
  offset: 0                                // Опционально - смещение пагинации
});

promotions.data?.promotions?.forEach(promo => {
  console.log(`Акция: ${promo.name}`);
  console.log(`  Тип: ${promo.type}`);
  console.log(`  Период: ${promo.startDateTime} - ${promo.endDateTime}`);
});

Получение деталей акции

typescript

// Получить подробную информацию об акциях
const details = await sdk.promotion.getPromotionsDetails({
  promotionIDs: '1854,1852,1851'  // Обязательно - ID через запятую
});

details.data?.promotions?.forEach(promo => {
  console.log(`${promo.name}:`);
  console.log(`  Описание: ${promo.description}`);
  console.log(`  В акции: ${promo.inPromoActionTotal} товаров`);
  console.log(`  Не в акции: ${promo.notInPromoActionTotal} товаров`);
});

Получение товаров для акции

typescript

// Получить товары, подходящие для акции
const products = await sdk.promotion.getPromotionsNomenclatures({
  promotionID: 1854,     // Обязательно - ID акции
  inAction: false,       // Обязательно - true=уже добавлены, false=можно добавить
  limit: 100,            // Опционально
  offset: 0              // Опционально
});

products.data?.nomenclatures?.forEach(nm => {
  console.log(`Арт. ${nm.nmID}: ${nm.vendorCode}, в акции: ${nm.inAction}`);
});

Добавление товаров в акцию

typescript

// Загрузить товары в акцию
const result = await sdk.promotion.createPromotionsUpload({
  data: {
    promotionID: 1854,           // Обязательно - ID акции
    uploadNow: true,             // Обязательно - true=применить сейчас, false=при старте акции
    nomenclatures: [123456, 789012]  // Обязательно - артикулы WB для добавления
  }
});

console.log(`ID задачи загрузки: ${result.data?.uploadID}`);

Типы ответов Calendar API

typescript

// Ответ getCalendarPromotions
interface CalendarPromotionsResponse {
  data?: {
    promotions?: Array<{
      id?: number;
      name?: string;
      type?: string;           // 'regular' | 'auto' | 'express'
      startDateTime?: string;  // ISO 8601
      endDateTime?: string;    // ISO 8601
    }>;
  };
}

// Ответ getPromotionsDetails
interface PromotionsDetailsResponse {
  data?: {
    promotions?: Array<{
      id?: number;
      name?: string;
      description?: string;
      startDateTime?: string;
      endDateTime?: string;
      inPromoActionLeftovers?: number;     // Товары в акции с остатками
      inPromoActionTotal?: number;          // Всего товаров в акции
      notInPromoActionLeftovers?: number;   // Товары не в акции с остатками
      notInPromoActionTotal?: number;       // Всего товаров не в акции
    }>;
  };
}

// Ответ getPromotionsNomenclatures
interface PromotionsNomenclaturesResponse {
  data?: {
    nomenclatures?: Array<{
      nmID?: number;
      vendorCode?: string;
      inAction?: boolean;
    }>;
  };
}

Полный справочник API

Методы жизненного цикла кампаний

Метод	Сигнатура	Описание
`getCampaigns`	`() => Promise<Campaign[]>`	Получить все кампании
`createCampaign`	`(data: CreateCampaignData) => Promise<Campaign>`	Создать кампанию
`startCampaign`	`(campaignId: number) => Promise<void>`	Запустить кампанию
`pauseCampaign`	`(campaignId: number) => Promise<void>`	Поставить на паузу
`stopCampaign`	`(campaignId: number) => Promise<void>`	Остановить кампанию
`createAdvRename`	`(data: { advertId: number; name: string }) => Promise<unknown>`	Переименовать

⚠️ v3.0.0: Метод deleteCampaign() удалён. Используйте личный кабинет Wildberries для удаления кампаний.

Методы работы с бюджетом

Метод	Сигнатура	Описание
`getAdvBalance`	`() => Promise<AdvBalanceResponse>`	Баланс аккаунта
`getAdvBudget`	`(options: { id: number }) => Promise<BudgetResponse>`	Бюджет кампании
`createBudgetDeposit`	`(data: BudgetDepositData, options: { id: number }) => Promise<ResponseWithReturn>`	Пополнить кампанию
`getAdvUpd`	`(options: { from: string; to: string }) => Promise<AdvUpdRecord[]>`	История расходов

Методы работы с фразами

Метод	Сигнатура	Описание
`getSearchSetPlus`	`(options: { id: number; fixed?: boolean }) => Promise<unknown>`	Получить/переключить фикс. фразы
`createSearchSetPlu`	`(data: { pluse?: string[] }, options: { id: number }) => Promise<string[]>`	Установить фикс. фразы
`createSearchSetExcluded`	`(data: { excluded?: string[] }, options: { id: number }) => Promise<unknown>`	Минус-фразы (ручная)
`createAutoSetExcluded`	`(data: { excluded?: string[] }, options: { id: number }) => Promise<unknown>`	Минус-фразы (единая)
`getAutoGetnmtoadd`	`(options: { id: number }) => Promise<number[]>`	Доступные товары
`createAutoUpdatenm`	`(data: { add?: number[]; delete?: number[] }, options: { id: number }) => Promise<unknown>`	Обновить товары кампании

Методы Calendar API

Метод	Сигнатура	Описание
`getCalendarPromotions`	`(options: { startDateTime: string; endDateTime: string; allPromo: boolean; limit?: number; offset?: number }) => Promise<CalendarPromotionsResponse>`	Получить акции WB
`getPromotionsDetails`	`(options: { promotionIDs: string }) => Promise<PromotionsDetailsResponse>`	Детали акций
`getPromotionsNomenclatures`	`(options: { promotionID: number; inAction: boolean; limit?: number; offset?: number }) => Promise<PromotionsNomenclaturesResponse>`	Товары для акции
`createPromotionsUpload`	`(data: { data: { promotionID: number; uploadNow: boolean; nomenclatures: number[] }}) => Promise<{ data?: { uploadID?: number }}>`	Добавить товары в акцию

Критические изменения (v2.2.3)

Обновление обязательных параметров

В v2.2.3 многие параметры методов изменились с опциональных на обязательные в соответствии с контрактом API WB. Это может вызвать ошибки компиляции TypeScript в существующем коде.

Методы с изменёнными сигнатурами

Метод	До (v2.2.2)	После (v2.2.3)
`startCampaign`	`options?: { id }`	`options: { id }`
`pauseCampaign`	`options?: { id }`	`options: { id }`
`stopCampaign`	`options?: { id }`	`options: { id }`
`deleteCampaign`	`options?: { id }`	`options: { id }`
`getAdvBudget`	`options?: { id }`	`options: { id }`
`getSearchSetPlus`	`options?: { id; fixed? }`	`options: { id; fixed? }`
`getAutoGetnmtoadd`	`options?: { id }`	`options: { id }`
`createBudgetDeposit`	`options?: { id }`	`options: { id }`
`createSearchSetPlu`	`options?: { id }`	`options: { id }`
`createSearchSetExcluded`	`options?: { id }`	`options: { id }`
`createAutoSetExcluded`	`options?: { id }`	`options: { id }`
`createAutoUpdatenm`	`options?: { id }`	`options: { id }`
`getAdvUpd`	`options?: { from; to }`	`options: { from; to }`
`createAdvRename`	`data?: { advertId; name }`	`data: { advertId; name }`
`getCalendarPromotions`	`options?: { ... }`	`options: { startDateTime; endDateTime; allPromo; limit?; offset? }`
`getPromotionsDetails`	`options?: { promotionIDs }`	`options: { promotionIDs }`
`getPromotionsNomenclatures`	`options?: { ... }`	`options: { promotionID; inAction; limit?; offset? }`

Руководство по миграции

typescript

// До (v2.2.2) - Компилировалось, но падало при выполнении
await sdk.promotion.getAdvBudget();  // ❌ Без ошибки, но API вернёт 400

// После (v2.2.3) - TypeScript ловит ошибку
await sdk.promotion.getAdvBudget();  // ❌ Ошибка TypeScript: 'options' обязателен
await sdk.promotion.getAdvBudget({ id: 12345 });  // ✅ Правильно

Calendar API - Типизированные ответы

Методы Calendar API теперь возвращают типизированные ответы вместо Promise<unknown>:

typescript

// До (v2.2.2)
const promotions = await sdk.promotion.getCalendarPromotions({...});
// promotions: unknown - нет автодополнения

// После (v2.2.3)
const promotions = await sdk.promotion.getCalendarPromotions({
  startDateTime: '2024-01-01',
  endDateTime: '2024-12-31',
  allPromo: true
});
// promotions.data?.promotions?.forEach(p => p.name) - полное автодополнение!

История версий

v2.2.3 (Декабрь 2024):
- 18 параметров методов стали обязательными (соответствие контракту API WB)
- Добавлены типизированные ответы для методов Calendar API
- Исправлены примеры JSDoc с sdk.general.* на sdk.promotion.*
- Добавлена полная документация Calendar API
v2.2.2 (Декабрь 2024): Параметры getStatsKeywords() стали обязательными; исправлены типы массивов для placement_types
v2.2.1 (Декабрь 2024): Исправлен URL getStatsKeywords() и документация типов кампаний

См. также

Модуль тарифов - Для расчёта ROI
Лучшие практики - Общие рекомендации по SDK
Устранение неполадок - Типичные проблемы
PromotionModule API (English) - Актуальные методы и типы
Миграция v4.0.0 - Удалённые методы и поддерживаемые замены

Руководство по модулю Promotion (Реклама) ​

Обзор ​

Быстрый старт ​

Жизненный цикл кампании ​

Статусы кампаний ​

Типы кампаний ​

Типы ставок ​

Места размещения ​

Управление кампаниями ​

Создание кампании ​

Получение информации о кампаниях ​

Список всех кампаний ​

Детали кампаний типа 9 (современные) ​

Детали устаревших кампаний (типы 4-8) ​

Полный воркфлоу: получение ВСЕХ деталей кампаний ​

Методы управления кампаниями ​

Допустимые переходы статусов ​

Бюджетные операции ​

Проверка баланса ​

Пополнение бюджета кампании ​

Получение бюджета кампании ​

История расходов ​

Управление ставками ​

Получение минимальных ставок ​

Обновление ставок для кампаний с единой ставкой ​

Обновление ставок для кампаний с ручной ставкой ​

Управление ключевыми фразами ​

Минус-фразы для ручной ставки ​

Минус-фразы для единой ставки ​

Фиксированные фразы (для ручной ставки) ​

Статистика кампаний ​

Статистика по ключевым словам (последние 7 дней) ​

Статистика ключевых слов для кампаний с ручной ставкой ​

Статистика кластеров для кампаний с единой ставкой ​

Полная статистика кампании (getAdvFullstats) ​

Пакетный запрос (несколько кампаний) ​

С обработкой rate limit ​

Структура ответа ​

Извлечение статистики по SKU (nmId) ​

Статистика по платформам и SKU ​

Полный пример рабочего процесса ​

Лимиты запросов ​

Обработка ошибок ​

Справочник методов ​

Список и детали кампаний ​

Управление кампаниями ​

Бюджет и финансы ​

Ставки ​

Ключевые фразы ​

Статистика ​

Устранение неполадок ​

Частые проблемы ​

Акции маркетплейса WB (Calendar API) ​

Получение доступных акций ​

Получение деталей акции ​

Получение товаров для акции ​

Добавление товаров в акцию ​

Типы ответов Calendar API ​

Полный справочник API ​

Методы жизненного цикла кампаний ​

Методы работы с бюджетом ​

Методы работы с фразами ​

Методы Calendar API ​

Критические изменения (v2.2.3) ​

Методы с изменёнными сигнатурами ​

Руководство по миграции ​

Calendar API - Типизированные ответы ​

История версий ​

См. также ​

Руководство по модулю Promotion (Реклама)

Обзор

Быстрый старт

Жизненный цикл кампании

Статусы кампаний

Типы кампаний

Типы ставок

Места размещения

Управление кампаниями

Создание кампании

Получение информации о кампаниях

Список всех кампаний

Детали кампаний типа 9 (современные)

Детали устаревших кампаний (типы 4-8)

Полный воркфлоу: получение ВСЕХ деталей кампаний

Методы управления кампаниями

Допустимые переходы статусов

Бюджетные операции

Проверка баланса

Пополнение бюджета кампании

Получение бюджета кампании

История расходов

Управление ставками

Получение минимальных ставок

Обновление ставок для кампаний с единой ставкой

Обновление ставок для кампаний с ручной ставкой

Управление ключевыми фразами

Минус-фразы для ручной ставки

Минус-фразы для единой ставки

Фиксированные фразы (для ручной ставки)

Статистика кампаний

Статистика по ключевым словам (последние 7 дней)

Статистика ключевых слов для кампаний с ручной ставкой

Статистика кластеров для кампаний с единой ставкой

Полная статистика кампании (getAdvFullstats)

Пакетный запрос (несколько кампаний)

С обработкой rate limit

Структура ответа

Извлечение статистики по SKU (nmId)

Статистика по платформам и SKU

Полный пример рабочего процесса

Лимиты запросов

Обработка ошибок

Справочник методов

Список и детали кампаний

Управление кампаниями

Бюджет и финансы

Ставки

Ключевые фразы

Статистика

Устранение неполадок

Частые проблемы

Акции маркетплейса WB (Calendar API)

Получение доступных акций

Получение деталей акции

Получение товаров для акции

Добавление товаров в акцию

Типы ответов Calendar API

Полный справочник API

Методы жизненного цикла кампаний

Методы работы с бюджетом

Методы работы с фразами

Методы Calendar API

Критические изменения (v2.2.3)

Методы с изменёнными сигнатурами

Руководство по миграции

Calendar API - Типизированные ответы

История версий

См. также