Riferimento API Firebase Dynamic Links Short Link

Puoi utilizzare questa API REST per generare brevi collegamenti dinamici. Consulta la guida per sviluppatori per iniziare.

Richiesta HTTP

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

request_body

Richiedi corpo

Il corpo della richiesta è simile a uno dei seguenti, a seconda che si desideri specificare i parametri del collegamento dinamico come collegamento dinamico lungo o come oggetto JSON.

Per specificare i parametri del collegamento dinamico come collegamento dinamico lungo:

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

Per specificare i parametri di collegamento dinamico come oggetto 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"
  }
}

Parametri

Tutti i parametri sono facoltativi se non diversamente specificato.

Parametri generali
dominioUriPrefix Obbligatorio se non hai impostato un valore per il parametro longDynamicLink . Il dominio Dynamic Links del tuo progetto Firebase. Puoi trovare questo valore nella sezione Collegamenti dinamici della console Firebase .
collegamento Obbligatorio se non hai impostato un valore per il parametro longDynamicLink .

Il collegamento che verrà aperto dall'app. Specifica un URL che la tua app può gestire, in genere il contenuto o il payload dell'app, che avvia la logica specifica dell'app (ad esempio accreditare all'utente un coupon o visualizzare una schermata di benvenuto). Questo collegamento deve essere un URL ben formattato, essere codificato correttamente nell'URL, utilizzare HTTP o HTTPS e non può essere un altro collegamento dinamico.

suffisso

Specifica come creare il componente del percorso di un breve collegamento dinamico. Per impostazione predefinita, Firebase Dynamic Links genera suffissi di stringa di 17 caratteri.

Imposta il parametro su { "option": "SHORT" } per generare stringhe di percorso lunghe solo quanto necessario per essere univoche, con una lunghezza minima di 4 caratteri. Utilizzare questo metodo se le informazioni sensibili non verrebbero esposte se si indovinasse un breve URL di collegamento dinamico.

Ometti questo parametro o imposta il parametro su { "option": "UNGUESSABLE" } per abbreviare il percorso di una stringa non indovinabile. Tali stringhe vengono create mediante codifica base62 di numeri a 96 bit generati casualmente e sono costituite da 17 caratteri alfanumerici. Utilizza stringhe non riconoscibili per impedire la scansione dei tuoi collegamenti dinamici, che può potenzialmente esporre informazioni sensibili.

Parametri Android
androidPackageName Il nome del pacchetto dell'app Android da utilizzare per aprire il collegamento. L'app deve essere connessa al tuo progetto dalla pagina Panoramica della console Firebase. Necessario affinché Dynamic Link apra un'app Android.
androidFallbackLink Il collegamento da aprire quando l'app non è installata. Specifica questa opzione per eseguire operazioni diverse dall'installazione dell'app dal Play Store quando l'app non è installata, ad esempio aprire la versione Web mobile dei contenuti o visualizzare una pagina promozionale per la tua app.
androidMinPackageVersionCode Il versionCode della versione minima della tua app che può aprire il collegamento. Se l'app installata è una versione precedente, l'utente viene indirizzato al Play Store per aggiornare l'app.
parametri iOS
iosBundleId L'ID bundle dell'app iOS da utilizzare per aprire il collegamento. L'app deve essere connessa al tuo progetto dalla pagina Panoramica della console Firebase. Necessario affinché Dynamic Link apra un'app iOS.
iosFallbackLink Il collegamento da aprire quando l'app non è installata. Specifica questa opzione per eseguire operazioni diverse dall'installazione dell'app dall'App Store quando l'app non è installata, ad esempio aprire la versione Web mobile dei contenuti o visualizzare una pagina promozionale per la tua app.
iosCustomScheme Lo schema URL personalizzato della tua app, se definito come qualcosa di diverso dall'ID bundle della tua app
iosIpadFallbackLink Il collegamento da aprire sugli iPad quando l'app non è installata. Specificalo per fare qualcosa di diverso dall'installare la tua app dall'App Store quando l'app non è installata, ad esempio aprire la versione web del contenuto o visualizzare una pagina promozionale per la tua app.
iosIpadBundleId L'ID bundle dell'app iOS da utilizzare sugli iPad per aprire il collegamento. L'app deve essere connessa al tuo progetto dalla pagina Panoramica della console Firebase.
iosAppStoreId L'ID App Store della tua app, utilizzato per indirizzare gli utenti all'App Store quando l'app non è installata
Parametri di navigazione
abilitareReindirizzamentoForzato Se impostato su "1", salta la pagina di anteprima dell'app quando viene aperto il collegamento dinamico e reindirizza invece all'app o allo store. La pagina di anteprima dell'app (abilitata per impostazione predefinita) può inviare in modo più affidabile gli utenti alla destinazione più appropriata quando aprono i collegamenti dinamici nelle app; tuttavia, se prevedi che un collegamento dinamico venga aperto solo nelle app che possono aprire i collegamenti dinamici in modo affidabile senza questa pagina, puoi disabilitarlo con questo parametro. Questo parametro influenzerà il comportamento del Dynamic Link solo su iOS.
Parametri dei metatag sociali
socialTitolo Il titolo da utilizzare quando il collegamento dinamico viene condiviso in un post social.
socialDescrizione La descrizione da utilizzare quando il collegamento dinamico viene condiviso in un post social.
socialImageLink L'URL di un'immagine correlata a questo collegamento.
Parametri di analisi
utmSource
utmMedio
utmCampaign
utmTerm
utmContent		 Parametri di analisi di Google Play.
A
ct
mt
punto		 Parametri di analisi di iTunes Connect.

Corpo della risposta

La risposta a una richiesta è un oggetto JSON come il seguente:

{
  "shortLink": string,
  "previewLink": string
}
Campi di risposta
shortLink Il breve collegamento dinamico generato.
anteprimaLink Un collegamento a un diagramma di flusso del comportamento del collegamento dinamico.