Содержание кампании (campaigns/get)

Метод позволяет получить содержание конкретной кампании: статус, тексты, ссылки — то, что определяет внешний вид оффера (скидки или бонуса) для пользователей.

Запрос

Адрес для отправки запроса

POST https://yoomoney.ru/api/offerwall/v1/campaigns/get

Параметры

Параметр	Тип	Описание
partnerCampaignId	int	Идентификатор кампании. Возвращается в ответе на запрос 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'

Ответ

Параметры

Параметр	Тип	Описание
ymCampaignId	int	Идентификатор кампании в сервисе ЮMoney. Возвращается в ответе на запрос campaigns/create. Обязательный параметр
campaignStatus	enum	Статус кампании. Обязательный параметр
campaignStart	datetime	Дата старта кампании. Необязательный параметр
campaignEnd	dateTime	Дата прекращения кампании. Необязательный параметр
campaignType	enum	Тип кампании. Возможные значения: `codeOnline` — c пин-кодом, который покупатель использует в онлайн-магазине (можно использовать `acceptUrl`, чтобы перенаправить покупателя на нужный сайт); `codeOffline` — c пин-кодом, который покупатель использует только в настоящем магазине (в офлайне); `promo` — без пин-кода (с использованием `acceptUrl`}). Обязательный параметр
pinType	enum	Тип пин-кода. Возможные значения: `one-off` — одноразовый; `reusable` — многоразовый. Если `campaignType=code`
pinEnd	datatime	Дата, после которой пин-код перестает действовать. Если `campaignType=promo`
merchantDomain	string	Адрес сайта магазина. Обязательный параметр
merchantLogoSvg	varchar (300)	Ссылка на логотип магазина в формате SVG. Обязательный параметр
merchantLogoPng	varchar (300)	Ссылка на логотип магазина в формате PNG. Обязательный параметр
merchantName	varchar (300)	Название магазина. Обязательный параметр
backgroundColor	varchar (30)	Цвет фона. Обязательный параметр
fontColor	varchar (30)	Цвет шрифта. Обязательный параметр
description	varchar (90)	Описание акции. Обязательный параметр
conditions	varchar (350)	Условия получения. Обязательный параметр
discountType	varchar (30)	Тип скидки или бонуса. Возможные значения: `text` — бонус, подарок или специальное предложение, передается текстовое значение; `fix` — фиксированная сумма; `percent` — скидка в процентах. Обязательный параметр
discountAmount	varchar (30)	Размер скидки или название бонуса. Обязательный параметр
campaignFee	varchar (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
  }
}