Referencia de la API de vínculos cortos de Firebase Dynamic Links

Puedes usar esta API de REST para generar Dynamic Links cortos. Consulta 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 luce como una de las siguientes opciones, según lo que desees. para 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, haz lo siguiente:

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

Para especificar los parámetros Dynamic Link como un objeto JSON, haz lo siguiente:

{
  "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.

Parámetros generales
dominioUriPrefix Es obligatorio si no estableciste un valor para longDynamicLink. parámetro. El dominio Dynamic Links de tu proyecto de Firebase Puedes encontrar este valor en la sección Dynamic Links de la consola de Firebase.
link Es obligatorio si no estableciste un valor para longDynamicLink. parámetro.

El vínculo que abrirá tu app. Especifica una URL que tu app pueda manejar, como el contenido o la carga útil, que inicia una lógica específica de la app (como darle créditos al usuario con un cupón o mostrar una pantalla de bienvenida). Este vínculo debe ser una URL con un formato correcto y la codificación URL adecuada, debe usar HTTP o HTTPS y no puede ser otro Dynamic Link.

sufijo

Especifica cómo crear el componente de ruta de un Dynamic Link corto. De De forma predeterminada, Firebase Dynamic Links genera sufijos de cadena de 17 caracteres.

Establece el parámetro en { "option": "SHORT" } para generar de ruta de acceso que solo sean únicas y largas, con un con una longitud mínima de 4 caracteres. Usa este método si hay información sensible no se expondría si se adivinara una URL corta Dynamic Link.

Omite este parámetro o configúralo en { "option": "UNGUESSABLE" } para acortar la ruta a un una cadena indescifrable. Esas cadenas se crean mediante codificación en base62 de forma aleatoria de 96 bits generados y constan de 17 caracteres alfanuméricos. Usa cadenas indescifrables para evitar que se rastree tu Dynamic Links, lo que pueden exponer información sensible.

Parámetros de Android
NombreDelPaqueteAndroid El nombre del paquete de la app de Android que se usa para abrir el vínculo. La app debe estar conectada a tu proyecto desde la página Descripción general de la consola de Firebase. Es obligatorio para que Dynamic Link abra una app para Android.
Vínculo de androidFallback El vínculo que se debe abrir cuando la app no está instalada. Especifica el parámetro para hacer otra acción distinta de instalar tu app desde Play Store cuando no esté instalada, como abrir la versión web móvil del contenido o mostrar una página promocional de tu app.
androidMinPackageVersionCode El versionCode de la versión mínima de tu app que puede abrir el vínculo. Si la app instalada es una versión anterior, se dirige al usuario a Play Store para que la actualice.
Parámetros de iOS
ID del paquete de ios El ID de paquete de la app de iOS que se usa para abrir el vínculo. La app debe estar conectada a tu proyecto desde la página Descripción general de la consola de Firebase. Es obligatorio para que Dynamic Link abra una app para iOS.
Vínculo de iosFallback El vínculo que se debe abrir cuando la app no está instalada. Especifica este parámetro para hacer otra acción distinta de instalar la app desde App Store cuando no esté instalada, como abrir la versión web móvil del contenido o mostrar una página promocional de la app.
Esquema personalizado de ios El esquema de URL personalizada de la app, si se define con un valor diferente del ID de paquete.
iOSIpadFallbackVínculo El vínculo que se debe abrir en iPads cuando la app no está instalada. Especifica esto para que haga algo diferente de instalar tu app desde App Store cuando la app no esté instalada, como abrir la versión web del contenido o mostrar una página promocional de tu app.
ID de paquete de iOS Ipad El ID de paquete de la app para iOS que se usa en iPads para abrir el vínculo. La app debe estar conectada a tu proyecto desde la página Descripción general de la consola de Firebase.
ID de AppStore de ios El ID de la app en App Store, que se usa para enviar usuarios a App Store cuando la app no está instalada.
Parámetros de navegación
enableForcedRedirect Si se establece en "1", omite la página de vista previa de la app cuando se abre Dynamic Link y, en su lugar, redirecciona a la app o la tienda. La página de vista previa de la app (habilitada de forma predeterminada) puede enviar a los usuarios de manera más confiable al destino más apropiado cuando abren Dynamic Links en apps. Sin embargo, si esperas que una Dynamic Link se abra solo en apps que pueden abrir Dynamic Links de manera confiable sin esta página, puedes inhabilitarla con este parámetro. Este parámetro afectará el comportamiento de Dynamic Link solo en iOS.
Parámetros de metaetiquetas sociales
Título social Es el título que se debe usar cuando se comparte la Dynamic Link en una publicación de redes sociales.
Descripción social Es la descripción que se debe usar cuando se comparte el Dynamic Link en una publicación de redes sociales.
vínculo de imagen social La URL a una imagen relacionada con este vínculo.
Parámetros de Analytics
utmSource
utmMedium
utmCampaign
utmTerm
utmContent
Parámetros de análisis de Google Play.
at
ct
mt
pt
Parámetros de análisis de iTunes Connect.

Cuerpo de la respuesta

La respuesta a una solicitud es un objeto JSON como el siguiente:

{
  "shortLink": string,
  "previewLink": string
}
Campos de respuesta
vínculo corto El Dynamic Link corto generado.
vínculo de vista previa Un vínculo a un diagrama de flujo del comportamiento de Dynamic Link.