Отчет о лидах
Отчет — это документ, на основании которого вы перечисляете вознаграждение за лиды. Подробнее в правилах работы сервиса «ЮKassa»
Отчет нужно отправлять по адресу offer_clients@yoomoney.ru раз в месяц.
Вам необходимо заранее зафиксировать электронный адрес, с которого вы будете отправлять отчеты, в сервисе ЮMoney. Отчеты с других адресов приниматься не будут.
Формат отчета
Отчет формируется в виде файла в формате CSV (см. IETF RFC4180).
Разделитель полей — точка с запятой «;».
Кодировка символов — UTF‑8.
Вы можете сделать отчет в XLS (например, в Microsoft Excel) и выбрать сохранение в формате CSV (разделители — точка с запятой).
Формат имени файла:
redeem_file_partnerID_YYYY1-MM1-DD1_YYYY2-MM2-DD2.csv
где:
partnerID
— название магазина латиницей, выдается в сервисе ЮMoney;YYYY1-MM1-DD1
— начало отчетного периода (от, включительно);YYYY2-MM2-DD2
— конец отчетного периода (до, не включая).
Пример названия файла отчета компании «Магазин» за август 2017 года
report_file_magazin_2017-08-01_2017-08-31.csv
Структура отчета
В файле с отчетом передается заголовок, данные о лидах и итоговая сумма вознаграждения ЮMoney.
Поля в отчете
Поле | Тип | Описание |
---|---|---|
clickId | string | Уникальный идентификатор клика. Обязательное, если нет pinContent |
pinContent | string | Содержание пин-кода (буквенно-числовая строка) — нужен пользователю, чтобы получить скидку или бонус. Обязательное, если нет clickId |
campaignFee | varchar (30) | Вознаграждение ЮMoney за этот оффер. Обязательное |
ymCampaignId | string | Идентификатор кампании на стороне ЮMoney. Необязательное |
transactionId | string | Идентификатор заказа в системе магазина. Необязательное |
sceneRedeem | string | Место использования оффера (сайт, адрес конкретного магазина при использовании оффера в офлайне). Необязательное |
redeemTime | dateTime | Время погашения оффера в виде YYYY-MM-DDThh:mm:ss.fZZZZZ .Необязательное |
orderAmount | varchar (30) | Стоимость покупки в рублях. Необязательное |
Формирование отчета
Заголовок передается первой строкой, в нем содержатся все поля, которые есть в отчете. Набор полей фиксированный, но пустые поля заполнять не нужно.
Пример заголовка
clickId;campaignFee;ymCampaignId;transactionId;sceneRedeem;redeemTime;orderAmount
Для каждого лида, совершенного за отчетный период, формируется отдельная строка.
Пример строки с информацией по одному лиду
cc1ac215ca9305js26282363id1821s7;150;28014;638950-200;redcube.ru;2017-08-06T19:00:00.000+04:00;1554
Пример строки с пустыми полями
get300;80;34099;;;;
Если ваши клиенты используют оффер не на сайте, а в офлайновом магазине, обязательно нужно присылать использованный пин-код в параметре
pinContent
. Параметр clickId
для таких случаев не актуален.В последней строке отчета передается вся сумма вознаграждения ЮMoney за отчетный период: она должна совпадать с общей суммой значений поля
campaignFee
по всем лидам в отчете.Пример строки с суммой вознаграждения 3000
;3000;;;