Référence de l'API des liens courts des liens dynamiques Firebase

Vous pouvez utiliser cette API REST pour générer des liens dynamiques courts. Consultez le guide du développeur pour commencer.

Requête HTTP

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

request_body

Corps de la demande

Le corps de la requête ressemble à l'un des éléments suivants, selon que vous souhaitez spécifier les paramètres Dynamic Link sous forme de lien dynamique long ou d'objet JSON.

Pour spécifier les paramètres Dynamic Link sous forme de Dynamic Link long :

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

Pour spécifier les paramètres Dynamic Link en tant qu'objet 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"
  }
}

Paramètres

Tous les paramètres sont facultatifs, sauf indication contraire.

Paramètres généraux

domainUriPrefix Obligatoire si vous n’avez pas défini de valeur pour le paramètre longDynamicLink . Le domaine Dynamic Links de votre projet Firebase. Vous pouvez trouver cette valeur dans la section Dynamic Links de la console Firebase .

lien

Paramètres généraux
domainUriPrefix	Obligatoire si vous n’avez pas défini de valeur pour le paramètre `longDynamicLink` . Le domaine Dynamic Links de votre projet Firebase. Vous pouvez trouver cette valeur dans la section Dynamic Links de la console Firebase .
lien	Obligatoire si vous n’avez pas défini de valeur pour le paramètre `longDynamicLink` . Le lien que votre application ouvrira. Spécifiez une URL que votre application peut gérer, généralement le contenu ou la charge utile de l'application, qui lance une logique spécifique à l'application (par exemple, créditer l'utilisateur d'un coupon ou afficher un écran de bienvenue). Ce lien doit être une URL bien formatée, être correctement codée en URL, utiliser HTTP ou HTTPS et ne peut pas être un autre lien dynamique. Lorsque les utilisateurs ouvrent un lien dynamique sur un navigateur Web de bureau, ils chargent cette URL (sauf si le paramètre `ofl` est spécifié). Si vous ne disposez pas d'un équivalent Web du contenu lié, l'URL n'a pas besoin de pointer vers une ressource Web valide. Dans cette situation, vous devez mettre en place une redirection depuis cette URL vers, par exemple, votre page d'accueil.
suffixe	Spécifie comment créer le composant de chemin d’un lien dynamique court. Par défaut, Firebase Dynamic Links génère des suffixes de chaîne de 17 caractères. Définissez le paramètre sur `{ "option": "SHORT" }` pour générer des chaînes de chemin aussi longues que nécessaire pour être uniques, avec une longueur minimale de 4 caractères. Utilisez cette méthode si les informations sensibles ne seraient pas exposées si une courte URL de lien dynamique était devinée. Omettez ce paramètre ou définissez le paramètre sur `{ "option": "UNGUESSABLE" }` pour raccourcir le chemin vers une chaîne impossible à deviner. Ces chaînes sont créées par des nombres de 96 bits générés aléatoirement encodés en base62 et se composent de 17 caractères alphanumériques. Utilisez des chaînes impossibles à deviner pour empêcher l'exploration de vos liens dynamiques, ce qui peut potentiellement exposer des informations sensibles.

Obligatoire si vous n’avez pas défini de valeur pour le paramètre longDynamicLink .

Le lien que votre application ouvrira. Spécifiez une URL que votre application peut gérer, généralement le contenu ou la charge utile de l'application, qui lance une logique spécifique à l'application (par exemple, créditer l'utilisateur d'un coupon ou afficher un écran de bienvenue). Ce lien doit être une URL bien formatée, être correctement codée en URL, utiliser HTTP ou HTTPS et ne peut pas être un autre lien dynamique.

Lorsque les utilisateurs ouvrent un lien dynamique sur un navigateur Web de bureau, ils chargent cette URL (sauf si le paramètre ofl est spécifié). Si vous ne disposez pas d'un équivalent Web du contenu lié, l'URL n'a pas besoin de pointer vers une ressource Web valide. Dans cette situation, vous devez mettre en place une redirection depuis cette URL vers, par exemple, votre page d'accueil.

suffixe

Spécifie comment créer le composant de chemin d’un lien dynamique court. Par défaut, Firebase Dynamic Links génère des suffixes de chaîne de 17 caractères.

Définissez le paramètre sur { "option": "SHORT" } pour générer des chaînes de chemin aussi longues que nécessaire pour être uniques, avec une longueur minimale de 4 caractères. Utilisez cette méthode si les informations sensibles ne seraient pas exposées si une courte URL de lien dynamique était devinée.

Omettez ce paramètre ou définissez le paramètre sur { "option": "UNGUESSABLE" } pour raccourcir le chemin vers une chaîne impossible à deviner. Ces chaînes sont créées par des nombres de 96 bits générés aléatoirement encodés en base62 et se composent de 17 caractères alphanumériques. Utilisez des chaînes impossibles à deviner pour empêcher l'exploration de vos liens dynamiques, ce qui peut potentiellement exposer des informations sensibles.

Paramètres Android
androidPackageName	Le nom du package de l’application Android à utiliser pour ouvrir le lien. L'application doit être connectée à votre projet depuis la page Présentation de la console Firebase. Requis pour que Dynamic Link ouvre une application Android.
androidFallbackLink	Le lien à ouvrir lorsque l'application n'est pas installée. Spécifiez cette option pour faire autre chose que d'installer votre application à partir du Play Store lorsque l'application n'est pas installée, comme ouvrir la version Web mobile du contenu ou afficher une page promotionnelle pour votre application.
androidMinPackageVersionCode	Le `versionCode` de la version minimale de votre application qui peut ouvrir le lien. Si l'application installée est une ancienne version, l'utilisateur est redirigé vers le Play Store pour mettre à niveau l'application.

Paramètres iOS
iosBundleId	L'ID du bundle de l'application iOS à utiliser pour ouvrir le lien. L'application doit être connectée à votre projet depuis la page Présentation de la console Firebase. Requis pour que Dynamic Link ouvre une application iOS.
iosFallbackLink	Le lien à ouvrir lorsque l'application n'est pas installée. Spécifiez cette option pour faire autre chose que d'installer votre application depuis l'App Store lorsque l'application n'est pas installée, comme ouvrir la version Web mobile du contenu ou afficher une page promotionnelle pour votre application.
iosCustomScheme	Le schéma d'URL personnalisé de votre application, s'il est défini comme étant autre chose que l'ID du bundle de votre application
iosIpadFallbackLink	Le lien à ouvrir sur les iPad lorsque l'application n'est pas installée. Spécifiez ceci pour faire autre chose que d'installer votre application depuis l'App Store lorsque l'application n'est pas installée, comme ouvrir la version Web du contenu ou afficher une page promotionnelle pour votre application.
iosIpadBundleId	L'ID du bundle de l'application iOS à utiliser sur les iPad pour ouvrir le lien. L'application doit être connectée à votre projet depuis la page Présentation de la console Firebase.
iosAppStoreId	L'identifiant App Store de votre application, utilisé pour envoyer les utilisateurs vers l'App Store lorsque l'application n'est pas installée

Paramètres de navigation
activerForcedRedirect	S'il est défini sur « 1 », ignorez la page d'aperçu de l'application lorsque le lien dynamique est ouvert et redirigez-le vers l'application ou la boutique. La page d'aperçu de l'application (activée par défaut) peut envoyer de manière plus fiable les utilisateurs vers la destination la plus appropriée lorsqu'ils ouvrent des liens dynamiques dans les applications ; cependant, si vous vous attendez à ce qu'un Dynamic Link soit ouvert uniquement dans les applications capables d'ouvrir des Dynamic Links de manière fiable sans cette page, vous pouvez le désactiver avec ce paramètre. Ce paramètre affectera le comportement du Dynamic Link uniquement sur iOS.

Paramètres de navigation

activerForcedRedirect

S'il est défini sur « 1 », ignorez la page d'aperçu de l'application lorsque le lien dynamique est ouvert et redirigez-le vers l'application ou la boutique. La page d'aperçu de l'application (activée par défaut) peut envoyer de manière plus fiable les utilisateurs vers la destination la plus appropriée lorsqu'ils ouvrent des liens dynamiques dans les applications ; cependant, si vous vous attendez à ce qu'un Dynamic Link soit ouvert uniquement dans les applications capables d'ouvrir des Dynamic Links de manière fiable sans cette page, vous pouvez le désactiver avec ce paramètre. Ce paramètre affectera le comportement du Dynamic Link uniquement sur iOS.

Paramètres des balises méta sociales
titresocial	Le titre à utiliser lorsque le lien dynamique est partagé dans une publication sociale.
socialDescription	Description à utiliser lorsque le lien dynamique est partagé dans une publication sociale.
socialImageLink	L'URL d'une image liée à ce lien.

Paramètres d'analyse
utmSource utmMoyen utmCampagne utmTerm utmContenu	Paramètres d'analyse de Google Play.
à côté mont pt	Paramètres d'analyse iTunes Connect.

Corps de réponse

La réponse à une requête est un objet JSON comme le suivant :

{
  "shortLink": string,
  "previewLink": string
}

Champs de réponse
lien court	Le lien dynamique court généré.
aperçuLien	Un lien vers un organigramme du comportement du Dynamic Link.