Содержание кампании (campaigns/get)
Метод позволяет получить содержание конкретной кампании: статус, тексты, ссылки — то, что определяет внешний вид оффера (скидки или бонуса) для пользователей.
 
Запрос
Адрес для отправки запроса
POST https://yoomoney.ru/api/offerwall/v1/campaigns/get
Параметры
ПараметрТипОписание
partnerCampaignIdintИдентификатор кампании. Возвращается в ответе на запрос campaigns/create.
Пример тела запроса
JSON
{
    "ymCampaignId": 34
}
Пример запроса
cURL
curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <авторизационный токен>'  -d '{
    "ymCampaignId": 34
    }' 'https://yoomoney.ru/api/offerwall/v1/campaigns/get'
 
Ответ
Параметры
ПараметрТипОписание
ymCampaignIdint
Идентификатор кампании в сервисе ЮMoney. Возвращается в ответе на запрос campaigns/create.
Обязательный параметр
campaignStatusenum
Обязательный параметр
campaignStartdatetime
Дата старта кампании.
Необязательный параметр
campaignEnddateTime
Дата прекращения кампании.
Необязательный параметр
campaignTypeenum
Тип кампании. Возможные значения:
  • codeOnline
     — c пин-кодом, который покупатель использует в онлайн-магазине (можно использовать
    acceptUrl
    , чтобы перенаправить покупателя на нужный сайт);
  • codeOffline
     — c пин-кодом, который покупатель использует только в настоящем магазине (в офлайне);
  • promo
     — без пин-кода (с использованием
    acceptUrl
    ).
Обязательный параметр
pinTypeenum
Тип пин-кода. Возможные значения:
  • one-off
     — одноразовый;
  • reusable
     — многоразовый.
Если
campaignType=code
pinEnddatatime
Дата, после которой пин-код перестает действовать.
Если
campaignType=promo
merchantDomainstring
Адрес сайта магазина.
Обязательный параметр
merchantLogoSvgvarchar (300)
Ссылка на логотип магазина в формате SVG.
Обязательный параметр
merchantLogoPngvarchar (300)
Ссылка на логотип магазина в формате PNG.
Обязательный параметр
merchantNamevarchar (300)
Название магазина.
Обязательный параметр
backgroundColorvarchar (30)
Цвет фона.
Обязательный параметр
fontColorvarchar (30)
Цвет шрифта.
Обязательный параметр
descriptionvarchar (90)
Описание акции.
Обязательный параметр
conditionsvarchar (350)
Условия получения.
Обязательный параметр
discountTypevarchar (30)
Тип скидки или бонуса. Возможные значения:
  • text
     — бонус, подарок или специальное предложение, передается текстовое значение;
  • fix
     — фиксированная сумма;
  • percent
     — скидка в процентах.
Обязательный параметр
discountAmountvarchar (30)
Размер скидки или название бонуса.
Обязательный параметр
campaignFeevarchar (30)
Размер вознаграждения ЮMoney по данной кампании.
Необязательный параметр
Ошибки
Код ошибкиЗначениеОписание
campaignNotFoundНе найденаКампания с таким
ymCampaignId
не существует.
Пример тела ответа
JSON
{
  "status": "success",
  "result": {
    "ymCampaignId": 34,
    "campaignStatus": "started",
    "categoryId": 39,
    "campaignEnd": "2017-12-31T20:29:59.000Z",
    "campaignType": "code",
    "pinType": "one-off",
    "merchantDomain": "example.com",
    "merchantLogoPng": "https://example.com/i/logo.png",
    "merchantLogoSvg": "https://example.com/i/logo.svg",
    "merchantName": "Магазин",
    "backgroundColor": "#ffffff",
    "fontColor": "#000000",
    "description": "Скидка на деньги на сайте ЮMoney",
    "conditions": "Бонус действует 10 дней при заказе от 4000 рублей на сайте example.com",
    "discountType": "text",
    "discountAmount": "100",
    "discountCurrency": 643
  }
}