Справочник API коротких ссылок динамических ссылок Firebase

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

HTTP-запрос

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

request_body

Тело запроса

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

Чтобы указать параметры динамической ссылки как длинную динамическую ссылку:

{
  "longDynamicLink": string,
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

Чтобы указать параметры Dynamic Link как объект JSON:

{
  "dynamicLinkInfo": {
    "domainUriPrefix": string,
    "link": string,
    "androidInfo": {
      "androidPackageName": string,
      "androidFallbackLink": string,
      "androidMinPackageVersionCode": string
    },
    "iosInfo": {
      "iosBundleId": string,
      "iosFallbackLink": string,
      "iosCustomScheme": string,
      "iosIpadFallbackLink": string,
      "iosIpadBundleId": string,
      "iosAppStoreId": string
    },
    "navigationInfo": {
      "enableForcedRedirect": boolean,
    },
    "analyticsInfo": {
      "googlePlayAnalytics": {
        "utmSource": string,
        "utmMedium": string,
        "utmCampaign": string,
        "utmTerm": string,
        "utmContent": string
      },
      "itunesConnectAnalytics": {
        "at": string,
        "ct": string,
        "mt": string,
        "pt": string
      }
    },
    "socialMetaTagInfo": {
      "socialTitle": string,
      "socialDescription": string,
      "socialImageLink": string
    }
  },
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

Параметры

Все параметры являются необязательными, если не указано иное.

Общие параметры
доменUriPrefix Требуется, если вы не задали значение для параметра longDynamicLink . Домен динамических ссылок вашего проекта Firebase. Это значение можно найти в разделе «Динамические ссылки» консоли Firebase .
связь Требуется, если вы не задали значение для параметра longDynamicLink .

Ссылка, которую откроется ваше приложение. Укажите URL-адрес, который может обрабатывать ваше приложение (обычно это контент или полезная нагрузка приложения), который инициирует логику, специфичную для приложения (например, зачисление пользователю купона или отображение экрана приветствия). Эта ссылка должна представлять собой правильно отформатированный URL-адрес, иметь правильную URL-кодировку, использовать HTTP или HTTPS и не может быть другой динамической ссылкой.

суффикс

Указывает, как создать компонент пути короткой динамической ссылки. По умолчанию динамические ссылки Firebase генерируют суффиксы строк из 17 символов.

Установите для параметра значение { "option": "SHORT" } , чтобы генерировать строки пути, длина которых должна быть уникальной, с минимальной длиной 4 символа. Используйте этот метод, если конфиденциальная информация не будет раскрыта, если будет угадан короткий URL-адрес динамической ссылки.

Опустите этот параметр или установите для него значение { "option": "UNGUESSABLE" } , чтобы сократить путь к неугадываемой строке. Такие строки создаются путем кодирования base62 случайно сгенерированных 96-битных чисел и состоят из 17 буквенно-цифровых символов. Используйте неугадываемые строки, чтобы предотвратить сканирование ваших динамических ссылок, которое потенциально может раскрыть конфиденциальную информацию.

Параметры Android
androidPackageName Имя пакета приложения Android, которое будет использоваться для открытия ссылки. Приложение должно быть подключено к вашему проекту на странице «Обзор» консоли Firebase. Требуется для динамической ссылки для открытия приложения Android.
AndroidFallbackLink Ссылка для открытия, когда приложение не установлено. Укажите это, чтобы сделать что-то кроме установки приложения из Play Store, когда оно не установлено, например открыть мобильную веб-версию контента или отобразить рекламную страницу вашего приложения.
androidMinPackageVersionCode versionCode минимальной версии вашего приложения, которая может открыть ссылку. Если установлено приложение более старой версии, пользователь перенаправляется в Play Store для обновления приложения.
Параметры iOS
iosBundleId Идентификатор пакета приложения iOS, который будет использоваться для открытия ссылки. Приложение должно быть подключено к вашему проекту на странице «Обзор» консоли Firebase. Требуется для динамической ссылки для открытия приложения iOS.
iosFallbackLink Ссылка для открытия, когда приложение не установлено. Укажите это, чтобы сделать что-то кроме установки приложения из App Store, когда оно не установлено, например открыть мобильную веб-версию контента или отобразить рекламную страницу вашего приложения.
iosCustomScheme Пользовательская схема URL-адресов вашего приложения, если она определена как нечто отличное от идентификатора пакета вашего приложения.
iosIpadFallbackLink Ссылка, которую можно открыть на iPad, когда приложение не установлено. Укажите это, чтобы сделать что-то кроме установки приложения из App Store, когда оно не установлено, например открыть веб-версию контента или отобразить рекламную страницу вашего приложения.
iosIpadBundleId Идентификатор пакета приложения iOS, который можно использовать на iPad, чтобы открыть ссылку. Приложение должно быть подключено к вашему проекту на странице «Обзор» консоли Firebase.
iosAppStoreId Идентификатор вашего приложения в App Store, используемый для отправки пользователей в App Store, когда приложение не установлено.
Параметры навигации
EnableForcedRedirect Если установлено значение «1», пропустите страницу предварительного просмотра приложения при открытии динамической ссылки и вместо этого перенаправьте в приложение или магазин. Страница предварительного просмотра приложения (включена по умолчанию) может более надежно направлять пользователей в наиболее подходящее место назначения, когда они открывают динамические ссылки в приложениях; однако, если вы ожидаете, что динамическая ссылка будет открываться только в приложениях, которые могут надежно открывать динамические ссылки без этой страницы, вы можете отключить ее с помощью этого параметра. Этот параметр повлияет на поведение Dynamic Link только на iOS.
Параметры социальных метатегов
СоциальноеНазвание Заголовок, который будет использоваться, когда динамическая ссылка публикуется в публикации в социальной сети.
СоциальноеОписание Описание, которое будет использоваться при публикации динамической ссылки в публикации в социальной сети.
SocialImageLink URL-адрес изображения, связанного с этой ссылкой.
Параметры аналитики
utmИсточник
утммедиум
utmКампания
утмтерм
utmContent		 Параметры аналитики Google Play.
в
КТ
тонна
пт		 Параметры аналитики iTunes Connect.

Тело ответа

Ответом на запрос является объект JSON, подобный следующему:

{
  "shortLink": string,
  "previewLink": string
}
Поля ответа
короткая ссылка Сгенерированная короткая динамическая ссылка.
предварительный просмотрСсылка Ссылка на блок-схему поведения динамической ссылки.