API OneLink

Премиум
Для:
Последнее обновление:

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

API OneLink

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

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

Пример

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

Объем запросов к API OneLink ограничен и зависит от типа аккаунта. Вы можете видеть, сколько запросов уже сделано и сколько осталось, на дэшборде API OneLink. 

Чтобы увеличить лимит запросов к API, свяжитесь со своим менеджером.  

Настройка

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

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

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

Дэшборд

Дэшборд API OneLink отображаетежедневное, ежемесячное и квартальное использование API.

Чтобы открыть дэшборд API OneLink: 

В AppsFlyer в боковом меню выберите Engage > OneLink API.

Характеристики и ограничения

Особенность

Примечания

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

Ограничение скорости
  • Ограничение скорости передачи данных по API для одного аккаунта составляет 500 запросов в секунду (30000 в минуту).
  • Все запросы, превышающие 500 запросов в секунду (30000 в минуту) не обслуживаются, и ссылки не создаются; вызов API получает ошибку 429 с сообщением “Превышен лимит”.

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

TTL 
  • Срок действия (TTL) по умолчанию для коротких URL-адресов OneLink, созданных с помощью массовой загрузки, составляет 31 день. Он продлевается на 31 день каждый раз, когда кто-то нажимает на ссылку. Клик по ссылке после истечения срока действия по-прежнему соответствует поведению, определенному в базовой конфигурации OneLink, но атрибуция работать не будет.
    • Для удаления короткого URL-адреса OneLink после истечения срока действия ссылки может потребоваться до 48 часов.
  • Максимальный TTL составляет 31 день. Любое значение TTL, превышающее 31, заменяется значением TTL по умолчанию (т.е. на 31).
  • Вы можете изменить TTL по умолчанию, добавив параметр ttl={value} и указав количество дней, часов или минут. Например,  ttl=7d, ttl=12h, или ttl=10m.
  • Вы можете отправить запрос на обновление, чтобы указать TTL. Любой запрос на обновление сбрасывает TTL (для существующих ссылок) до значения, указанного в теле запроса.
    • Это означает, что TTL заменен. Например, если вы выполняете вызов обновления с TTL 2 дн. для ссылки, которая в настоящее время имеет TTL 29 дн., он изменится на TTL=2 дн. (не 31 день).
    • Вызов обновления потенциально может продлить срок действия ссылки атрибуции. Например, если вы выполняете вызов обновления с TTL 31 дн. для ссылки, которая в настоящее время имеет TTL 20 дн., из которых 5 дн. уже прошли, TTL будет составлять 31 день со дня обновления.
  • Если вы не хотите, чтобы TTL ссылок автоматически увеличивался, добавьте renew_ttl=false к ссылкам. Значение этого параметра - булево, либо true (по умолчанию), либо false.
  • Параметр renew_ttl не отображается на фактическом URL.

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

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


Примечание: Следующие 3 параметра не будут декодированы при нажатии на ссылку и останутся закодированными:

  • af_dp
  • deep_link_value
  • deep_link_sub1

Полезная нагрузка

Строка запроса из полезной нагрузки не может превышать 2048 символов.

ИДЕНТИФИКАТОР URL

Идентификатор URL (или идентификатор короткой ссылки) можно изменить, чтобы выделить предложение вашей кампании. Пример: https://myapp.onelink.me/abc123/apples. Идентификатор URL может иметь до 50 символов и содержать буквы и цифры. По умолчанию он состоит из 8 символов.

Примечание.

  • Вы можете изменить идентификатор URL, только если текущий идентификатор еще не используется.
  • Если идентификатор URL уже используется, создание ссылки не удается и возвращается ответ об ошибке (400). Вы и ваш разработчик должны решить и настроить, что произойдет в таком случае.
  • Неудачный вызов по-прежнему засчитывается в вашу месячную квоту вызовов API.