Puede usar esta API REST para generar enlaces dinámicos cortos. Consulte la guía para desarrolladores para comenzar.
Solicitud HTTP
POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key Content-Type: application/json request_body
cuerpo de la solicitud
El cuerpo de la solicitud se parece a uno de los siguientes, dependiendo de si desea especificar los parámetros de Dynamic Link como un Dynamic Link largo o como un objeto JSON.
Para especificar los parámetros de Dynamic Link como un Dynamic Link largo:
{
"longDynamicLink": string,
"suffix": {
"option": "SHORT" or "UNGUESSABLE"
}
}
Para especificar los parámetros de Dynamic Link como un objeto 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"
}
}
Parámetros
Todos los parámetros son opcionales a menos que se especifique lo contrario.
Parametros generales | |
---|---|
dominioUriPrefix | Obligatorio si no estableció un valor para el parámetro longDynamicLink . El dominio de Dynamic Links de su proyecto de Firebase. Puede encontrar este valor en la sección Dynamic Links de Firebase console . |
Enlace | Obligatorio si no estableció un valor para el parámetro longDynamicLink .El enlace que abrirá su aplicación. Especifique una URL que su aplicación pueda manejar, normalmente el contenido de la aplicación o la carga útil, que inicia la lógica específica de la aplicación (como acreditar al usuario con un cupón o mostrar una pantalla de bienvenida). Este vínculo debe ser una URL bien formateada, estar correctamente codificado como URL, usar HTTP o HTTPS y no puede ser otro vínculo dinámico. |
sufijo | Especifica cómo crear el componente de ruta de un enlace dinámico corto. De forma predeterminada, Firebase Dynamic Links genera sufijos de cadena de 17 caracteres. Establezca el parámetro en Omita este parámetro o establezca el parámetro en |
Parámetros de Android | |
---|---|
androidPackageName | El nombre del paquete de la aplicación de Android que se usará para abrir el enlace. La aplicación debe estar conectada a su proyecto desde la página Descripción general de Firebase console. Requerido para que Dynamic Link abra una aplicación de Android. |
AndroidFallbackLink | El enlace para abrir cuando la aplicación no está instalada. Especifique esto para hacer algo más que instalar su aplicación desde Play Store cuando la aplicación no está instalada, como abrir la versión web móvil del contenido o mostrar una página promocional para su aplicación. |
androidMinPackageVersionCode | El versionCode de versión de la versión mínima de su aplicación que puede abrir el enlace. Si la aplicación instalada es una versión anterior, se lleva al usuario a Play Store para actualizar la aplicación. |
Parámetros de iOS | |
---|---|
iosBundleId | El ID del paquete de la aplicación de iOS que se usará para abrir el enlace. La aplicación debe estar conectada a su proyecto desde la página Descripción general de Firebase console. Requerido para que Dynamic Link abra una aplicación de iOS. |
iosFallbackLink | El enlace para abrir cuando la aplicación no está instalada. Especifique esto para hacer algo más que instalar su aplicación desde App Store cuando la aplicación no está instalada, como abrir la versión web móvil del contenido o mostrar una página promocional para su aplicación. |
iosCustomScheme | El esquema de URL personalizado de su aplicación, si se define como algo diferente al ID del paquete de su aplicación |
iosIpadFallbackLink | El enlace para abrir en iPads cuando la aplicación no está instalada. Especifique esto para hacer algo más que instalar su aplicación desde App Store cuando la aplicación no está instalada, como abrir la versión web del contenido o mostrar una página promocional para su aplicación. |
iosIpadBundleId | El ID del paquete de la aplicación de iOS que se usará en iPads para abrir el enlace. La aplicación debe estar conectada a su proyecto desde la página Descripción general de Firebase console. |
iosAppStoreId | El ID de la tienda de aplicaciones de su aplicación, que se usa para enviar a los usuarios a la tienda de aplicaciones cuando la aplicación no está instalada |
Parámetros de navegación | |
---|---|
habilitarForcedRedirect | Si se establece en '1', omita la página de vista previa de la aplicación cuando se abra Dynamic Link y, en su lugar, redirija a la aplicación o tienda. La página de vista previa de la aplicación (habilitada de forma predeterminada) puede enviar a los usuarios al destino más apropiado de manera más confiable cuando abren Dynamic Links en las aplicaciones; sin embargo, si espera que un Dynamic Link se abra solo en aplicaciones que pueden abrir Dynamic Links de manera confiable sin esta página, puede deshabilitarlo con este parámetro. Este parámetro afectará el comportamiento de Dynamic Link solo en iOS. |
Parámetros de etiquetas meta sociales | |
---|---|
título social | El título que se usará cuando el vínculo dinámico se comparta en una publicación social. |
Descripción social | La descripción que se usará cuando el vínculo dinámico se comparta en una publicación social. |
socialImageLink | La URL de una imagen relacionada con este enlace. |
Parámetros de análisis | |
---|---|
Fuente utm utmMedio Campaña utm utmTerm utmContent | Parámetros de análisis de Google Play. |
en Connecticut monte punto | Parámetros de análisis de iTunes Connect. |
Cuerpo de respuesta
La respuesta a una solicitud es un objeto JSON como el siguiente:
{
"shortLink": string,
"previewLink": string
}
Campos de respuesta | |
---|---|
enlace corto | El enlace dinámico corto generado. |
vista previaEnlace | Un enlace a un diagrama de flujo del comportamiento de Dynamic Link. |