API OneLink

Краткий обзор: API OneLink позволяет вовлекать конечных пользователей и использовать собственные медиа, создавая персонализированные ссылки для крупномасштабных кампаний, СМС-рассылок и т. д. Для реализации требуется участие рекламодателя и разработчика.

API OneLink

API OneLink используется, чтобы:

  • Создаватьполучатьобновлять и удалять короткие адреса OneLink с настраиваемыми параметрами автоматически.
    Параметры могут быть:
    • Параметры, связанные с атрибуцией, такие как медиа-источник, кампания или ресурс, используемые для измерения и отслеживания маркетинговых инициатив. Примечание. Параметр медиа-источника (pid) является обязательным. 
    • Параметры для персонализации, которые позволяют настроить индивидуальный пользовательский интерфейс при открытии приложения по соответствующей ссылке. Эти параметры позволяют отправлять пользователей на настраиваемый контент в приложении, например на страницу определенного продукта, код купона или рекламную акцию.
  • Разрешить делиться контентом веб-сайта и приложения непосредственно с мобильными пользователями (тем самым увеличивая мобильные интеракции и количество установок).
  • Создавать большое количество настраиваемых ссылок OneLink мгновенно.
    Примечание: Про ссылки для приглашений см. статью Атрибуция приглашений пользователей

 Пример

Feed Me, служба доставки продуктов, хочет отправить имеющимся клиентам персонализированную ссылку по СМС, чтобы побудить их скачать приложение Feed Me и купить бананы. В зависимости от страны клиента, Feed Me использует REST API OneLink для создания настраиваемого URL-адреса OneLink, содержащего конкретные сведения о стране, личности пользователя и специальное предложение для продаваемых бананов.

Процедура

Чтобы настроить API OneLink:

  1. Создайте шаблон OneLink.
  2. Запишите идентификатор OneLink. 

  3. Запишите ключ API OneLink. Администратор аккаунта должен получить ключ API. У членов команды нет доступа к ключу API. 
    • На дэшборде AppsFlyer перейдите в раздел Integration (Интеграция) > API Access (Доступ к API) и прокрутите вниз до раздела API OneLink.
    • Если для администратора нет ключа API OneLink, это означает, что у вас нет необходимого пакета, и вам нужно связаться со своим менеджером.  

      OL_API_key.png

  4. Передайте разработчику идентификатор OneLink и ключ API OneLink.
  5. Сообщите ему о том, что необходимо следовать инструкциям для разработчиков.

Ограничения

Ограничения

Примечания

Запросы API

  • Ограничение по созданию ссылок атрибуции OneLink через API составляет 7,5 млн в месяц (по часовому поясу UTC) на каждый аккаунт.
  • Все запросы, сделанные после исчерпания лимита в 7,5 млн, не обслуживаются, и ссылки не создаются; при вызове API возвращается ошибка 429 с сообщением throttling limit exceeded (Превышен лимит по запросам).
  • Информация о том, сколько запросов использовано или осталось, пока не доступна.

Видимость настраиваемых ссылок

  • Ссылки, созданные через API, не отображаются в списке настраиваемых ссылок OneLink на дэшборде AppsFlyer.
  • Не существует API, в котором перечислены все настраиваемые ссылки OneLink, созданные с помощью этого API.
  • Рекомендация: Сохраните ссылки, созданные с помощью API, в таблицу на компьютере, чтобы иметь к ним доступ в будущем. 

Срок действия (TTL)

  • Каждая ссылка атрибуции OneLink, созданная API, по умолчанию действует 31 день. Через 31 день эта запись ссылки атрибуции удаляется из наших систем. Клик по такой ссылке после истечения срока действия по-прежнему соответствует поведению, определенному в базовой конфигурации OneLink, но атрибуция работать не будет.
  • Максимальный TTL составляет 31 день. Любое значение TTL, превышающее 31, заменяется значением TTL по умолчанию (т.е. на 31).
  • Значение TTL может быть указано в днях (по умолчанию), минутах или часах (например, 10 мин., 20 ч., 14 дн.).
  • Вы можете отправить запрос на обновление, чтобы указать значение TTL. Любой запрос на обновление сбрасывает TTL (для существующих ссылок) до значения, указанного в теле запроса.
    • Это означает, что TTL заменен. Например, если вы выполняете вызов обновления с TTL 2 дн. для ссылки, которая в настоящее время имеет TTL 29 дн., он изменится на TTL=2 дн. (не 31 день).
    • Вызов обновления потенциально может продлить срок действия ссылки атрибуции. Например, если вы выполняете вызов обновления с TTL 31 дн. для ссылки, которая в настоящее время имеет TTL 20 дн., из которых 5 дн. уже прошли, TTL будет составлять 31 день со дня обновления.

Специальные символы

Следующие символы должны быть закодированы, если они используются для ссылок, созданных API: ;, , !, @, #, ?, $, ^, :, &, ~, `, =, +, ’, >, <, /
Если вы не закодируете эти символы, они заменятся пробелом.

 

Была ли эта статья полезной?