Эта страница переведена с помощью Cloud Translation API.

Создание динамических ссылок с помощью REST API

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

https://example.page.link/WXYZ

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

Прежде чем начать

Получите свой API-ключ. Вам понадобится API-ключ для аутентификации ваших запросов к API. Чтобы найти свой API-ключ:
1. Откройте страницу настроек консоли Firebase . Если вам будет предложено выбрать проект, выберите свой проект Firebase из меню.
2. Обратите внимание на значение поля «Ключ веб-API» .
В консоли Firebase откройте раздел Dynamic Links .
Если вы еще не приняли условия обслуживания и не указали домен для своих Dynamic Links , сделайте это, когда появится соответствующий запрос.
Если у вас уже есть домен Dynamic Links , запишите его. Вам необходимо указать домен Dynamic Links при программном создании Dynamic Links .

Создание короткой Dynamic Link

Преобразовать длинную ссылку в короткую.

Вы можете использовать API динамических ссылок Firebase для сокращения длинных 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 .

Создайте короткую ссылку на основе параметров.

Вы также можете создать короткую 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 .

Задайте длину короткой Dynamic Link

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

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

https://example.page.link/UVWXYZuvwxyz12345

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

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

https://example.page.link/WXYZ

Используйте этот метод, если в случае угадывания короткой 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. Для запроса увеличения квоты заполните эту форму .