Формат меченой ссылки
Меченая ссылка используется в кампаниях с описанием оффера (
promo), баннером (banner) с пин-кодом для сайта (codeOnline). По ней пользователь может получить бонус (она используется вместо пин-кода или вместе с ним).Шаблон меченой ссылки
Шаблон меченой ссылки задается в параметре
acceptUrl при создании кампании (см. campaigns/create).К ссылке можно добавить ваши параметры — они вернутся без изменений. В параметрах вы можете указать переменные. Они передаются в двойных фигурных скобках:
{{variable}}. Вместо них сервис ЮMoney подставит в ссылку значения соответствующих параметров (в url-encoded виде).Можно использовать такие переменные:
campaignId— идентификатор кампании на стороне магазина или агрегатора;ymCampaignId— идентификатор кампании в сервисе ЮMoney;couponCode— пин-код (здесь передается пин-код, который использует пользователь, он может быть и одноразовый, и многоразовый);currentDate— текущее время в форматеYYYY-MM-DDThh:mm:ss[.sss]по ISO-8601.
В результате должен получиться корректный URL. Если этот адрес не откроется, пользователь не сможет получить купон и увидит ошибку, кампания будет приостановлена.
Пример шаблона ссылки с параметрами и переменными
http://shop.example.com/target/?promo={{campaignId}}&pin={{couponCode}}&discount=15
Параметры при выдаче оффера
В момент выдачи оффера в сервисе ЮMoney к ссылке добавляются параметры
clickId и viewId. Их необходимо сохранять и позднее передавать в уведомлении об использовании оффера (см. campaigns/redeem).| Параметр | Тип | Описание |
|---|---|---|
clickId | string | Уникальный идентификатор клика. Обязательный параметр |
viewId | string | Уникальный идентификатор показа оффера. Обязательный параметр для кампаний с баннерами ( campaignType=banner в запросе на создание кампании, см. campaigns/create) |
Пример ссылки без ваших параметров
http://shop.example.com/target/?clickId=019d653d-31e0-7fd5-b752-40e0e270ab7f&viewId=4f97b7d3-0677-4f60-b1af-9f2c0f233500
Пример ссылки с вашими параметрами
http://shop.example.com/target/?promo=1&pin=happynewyear&discount=15&clickId=019d653d-31e0-7fd5-b752-40e0e270ab7f&viewId=4f97b7d3-0677-4f60-b1af-9f2c0f233500