Как создавать динамические ссылки с помощью REST API

Вы можете создавать короткие Dynamic Links с помощью Firebase Dynamic Links REST API. Этот API принимает либо длинный параметр Dynamic Link, либо объект, содержащий параметры Dynamic Link, и возвращает URL, как в примере ниже.

https://example.page.link/WXYZ

Короткие ссылки Dynamic Links, созданные с помощью API и SDK клиента (Android/Apple), не отображаются в консоли Firebase. Такие Dynamic Links предназначены для обмена между пользователями. Для маркетинговых целей продолжайте создавать ссылки на странице Dynamic Links в консоли Firebase.

Подготовка

  1. Получите ключ API. Для аутентификации запросов к API вам потребуется ключ API. Чтобы найти ключ API:
    1. Откройте страницу настроек в консоли Firebase. Если вам будет предложено выбрать проект, выберите проект Firebase в меню.
    2. Запишите значение поля Web API Key (Ключ веб-API).
  2. В консоли Firebase откройте раздел Dynamic Links.

  3. Если вы ещё не приняли условия использования и не настроили домен для Dynamic Links, сделайте это, когда появится запрос.

    Если у вас уже есть домен Dynamic Links, запишите его. При программном создании Dynamic Links необходимо указать домен Dynamic Links.

Вы можете использовать Firebase Dynamic Links API, чтобы сократить длинную ссылку Dynamic Link. Для этого отправьте HTTP-запрос POST к конечной точке shortLinks, указав длинный Dynamic Link в параметре longDynamicLink. Пример:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

Подробнее о том, как вручную создать URL для длинных тегов Dynamic Links…

Вы также можете создать короткий URL Dynamic Link, указав параметры Dynamic Link напрямую. Для этого отправьте HTTP-запрос POST конечной точке shortLinks, указав параметры Dynamic Link в параметре dynamicLinkInfo. Пример:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

Полная спецификация объекта dynamicLinkInfo приведена в документации по API.

Как задать продолжительность Shorts Dynamic Link

Вы также можете задать параметр suffix, чтобы указать, как генерируется компонент пути короткой ссылки Dynamic Link.

По умолчанию или если вы зададите для параметра значение "UNGUESSABLE", компонент пути будет представлять собой строку из 17 символов, как в следующем примере:

https://example.page.link/UVWXYZuvwxyz12345

Такие строки создаются путем кодирования в base62 случайно сгенерированных 96-битных чисел. Используйте эту настройку, чтобы предотвратить угадывание и сканирование URL-адресов Dynamic Links, которые могут раскрыть конфиденциальную информацию нежелательным получателям.

Если вы зададите для параметра значение "SHORT", то компонент пути будет строкой, длина которой будет достаточной для обеспечения уникальности, но не менее четырех символов.

https://example.page.link/WXYZ

Используйте этот метод, если конфиденциальная информация не будет раскрыта, если короткий URL-адрес Dynamic Link будет угадан.

Ниже показано, как задать параметр suffix.

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

Значение ссылки на контент должно начинаться с http:// или https://. Он также должен соответствовать любому белому списку шаблонов URL, введенному в консоли. В противном случае API создания вернет ошибку HTTP с кодом 400.

Дальнейшие действия

Теперь, когда вы создали Dynamic Links, вам нужно настроить приложение так, чтобы оно получало Dynamic Links и направляло пользователей в нужный раздел приложения после того, как они открывают их.

Чтобы получать Dynamic Links в приложении, ознакомьтесь с документацией для iOS, Android, C++ и Unity.

Ограничения: 5 запросов на IP-адрес в секунду и 200 000 запросов в день. Если лимит превышен, будет возвращен код ошибки HTTP 429.