Referencia de API de enlaces cortos de Firebase Dynamic Links

Puede utilizar 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 del vínculo dinámico como un vínculo dinámico largo o como un objeto JSON.

Para especificar los parámetros del vínculo dinámico como un vínculo dinámico largo:

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

Para especificar los parámetros del vínculo dinámico 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 tu proyecto de Firebase. Puede encontrar este valor en la sección Enlaces dinámicos de Firebase console .
enlace Obligatorio si no estableció un valor para el parámetro longDynamicLink .

El enlace que se abrirá su aplicación. Especifique una URL que su aplicación pueda manejar, generalmente el contenido o la carga útil de la aplicación, lo que inicia la lógica específica de la aplicación (como acreditar al usuario un cupón o mostrar una pantalla de bienvenida). Este enlace debe ser una URL con buen formato, estar codificada correctamente, usar HTTP o HTTPS y no puede ser otro enlace 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 { "option": "SHORT" } para generar cadenas de ruta que sean tan largas como sea necesario para ser únicas, con una longitud mínima de 4 caracteres. Utilice este método si la información confidencial no quedaría expuesta si se adivinara una URL corta de enlace dinámico.

Omita este parámetro o establezca el parámetro en { "option": "UNGUESSABLE" } para acortar la ruta a una cadena imposible de adivinar. Estas cadenas se crean mediante codificación base62, números de 96 bits generados aleatoriamente y constan de 17 caracteres alfanuméricos. Utilice cadenas imposibles de adivinar para evitar que se rastreen sus vínculos dinámicos, lo que potencialmente puede exponer información confidencial.

Parámetros de Android
nombredelpaqueteandroid El nombre del paquete de la aplicación de Android que se utilizará 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.
androidFallbackEnlace 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 la versión mínima de su aplicación que puede abrir el enlace. Si la aplicación instalada es una versión anterior, el usuario es llevado 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 utilizará 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.
iosEnlace alternativo 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 distinto al ID del paquete de su aplicación
iosIpadEnlace alternativo 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 App Store de tu aplicación, que se utiliza para enviar a los usuarios a la App Store 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 el enlace dinámico 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 de manera más confiable al destino más apropiado cuando abren Dynamic Links en las aplicaciones; sin embargo, si espera que un vínculo dinámico se abra solo en aplicaciones que pueden abrir vínculos dinámicos de manera confiable sin esta página, puede desactivarlo con este parámetro. Este parámetro afectará el comportamiento del Dynamic Link solo en iOS.
Parámetros de metaetiquetas sociales
título social El título que se utilizará cuando el enlace dinámico se comparte en una publicación social.
descripción social La descripción que se utilizará cuando el enlace dinámico se comparte en una publicación social.
enlace de imagen social La URL de una imagen relacionada con este enlace.
Parámetros analíticos
utmFuente
utmMedio
utmCampaña
utmTérmino
utmContenido		 Parámetros de análisis de Google Play.
en
Connecticut
monte
pt		 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 vínculo a un diagrama de flujo del comportamiento del vínculo dinámico.