Вы можете использовать этот REST API для создания коротких Dynamic Links . Чтобы начать работу, ознакомьтесь с руководством разработчика .
HTTP-запрос
POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key Content-Type: application/json request_body
Тело запроса
Текст запроса выглядит следующим образом, в зависимости от того, хотите ли вы указать параметры Dynamic Link как длинную Dynamic Link или как объект JSON.
Чтобы указать параметры Dynamic Link как длинную Dynamic Link :
{
"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 . Домен Dynamic Links вашего проекта Firebase. Это значение можно найти в разделе Dynamic Links консоли Firebase . |
| связь | Требуется, если вы не задали значение для параметра longDynamicLink .Ссылка, которую откроется ваше приложение. Укажите URL-адрес, который может обрабатывать ваше приложение (обычно это контент или полезная нагрузка приложения), который инициирует логику, специфичную для приложения (например, зачисление пользователю купона или отображение экрана приветствия). Эта ссылка должна представлять собой правильно отформатированный URL-адрес, иметь правильную URL-кодировку, использовать HTTP или HTTPS и не может быть другой динамической ссылкой. |
| суффикс | Указывает, как создать компонент пути короткой Dynamic Link . По умолчанию Firebase Dynamic Links генерирует суффиксы строк из 17 символов. Установите для параметра значение Опустите этот параметр или установите для него значение |
| Параметры Android | |
|---|---|
| androidPackageName | Имя пакета приложения Android, которое будет использоваться для открытия ссылки. Приложение должно быть подключено к вашему проекту на странице «Обзор» консоли Firebase . Требуется для Dynamic Link для открытия приложения Android. |
| AndroidFallbackLink | Ссылка для открытия, когда приложение не установлено. Укажите это, чтобы сделать что-то кроме установки приложения из Play Store, когда оно не установлено, например открыть мобильную веб-версию контента или отобразить рекламную страницу вашего приложения. |
| androidMinPackageVersionCode | versionCode минимальной версии вашего приложения, которая может открыть ссылку. Если установленное приложение имеет более старую версию, пользователь перенаправляется в Play Store для обновления приложения. |
| Параметры iOS | |
|---|---|
| iosBundleId | Идентификатор пакета приложения iOS, который будет использоваться для открытия ссылки. Приложение должно быть подключено к вашему проекту на странице «Обзор» консоли Firebase . Требуется для Dynamic Link для открытия приложения iOS. |
| iosFallbackLink | Ссылка для открытия, когда приложение не установлено. Укажите это, чтобы сделать что-то кроме установки приложения из App Store, когда оно не установлено, например открыть мобильную веб-версию контента или отобразить рекламную страницу вашего приложения. |
| iosCustomScheme | Пользовательская схема URL-адресов вашего приложения, если она определена как нечто иное, чем идентификатор пакета вашего приложения. |
| iosIpadFallbackLink | Ссылка, которую можно открыть на iPad, когда приложение не установлено. Укажите это, чтобы сделать что-то кроме установки приложения из App Store, когда оно не установлено, например открыть веб-версию контента или отобразить рекламную страницу вашего приложения. |
| iosIpadBundleId | Идентификатор пакета приложения iOS, который можно использовать на iPad, чтобы открыть ссылку. Приложение должно быть подключено к вашему проекту на странице «Обзор» консоли Firebase . |
| iosAppStoreId | Идентификатор вашего приложения в App Store, используемый для отправки пользователей в App Store, когда приложение не установлено. |
| Параметры навигации | |
|---|---|
| EnableForcedRedirect | Если установлено значение «1», пропустите страницу предварительного просмотра приложения при открытии Dynamic Link и вместо этого перенаправьте в приложение или магазин. Страница предварительного просмотра приложения (включена по умолчанию) может более надежно направлять пользователей в наиболее подходящее место назначения, когда они открывают Dynamic Links в приложениях; однако, если вы ожидаете, что Dynamic Link будет открываться только в приложениях, которые могут надежно открывать Dynamic Links без этой страницы, вы можете отключить ее с помощью этого параметра. Этот параметр повлияет на поведение Dynamic Link только на iOS. |
| Параметры социальных метатегов | |
|---|---|
| СоциальноеНазвание | Заголовок, который будет использоваться, когда Dynamic Link публикуется в публикации в социальной сети. |
| СоциальноеОписание | Описание, которое будет использоваться при публикации Dynamic Link в публикации в социальной сети. |
| SocialImageLink | URL-адрес изображения, связанного с этой ссылкой. |
| Параметры аналитики | |
|---|---|
| utmИсточник утммедиум utmКампания утмтерм utmContent | Параметры аналитики Google Play. |
| в КТ тонна пт | Параметры аналитики iTunes Connect. |
Тело ответа
Ответом на запрос является объект JSON, подобный следующему:
{
"shortLink": string,
"previewLink": string
}
| Поля ответа | |
|---|---|
| короткая ссылка | Сгенерированная короткая Dynamic Link . |
| предварительный просмотрСсылка | Ссылка на блок-схему поведения Dynamic Link . |