Firebase Dynamic Links Short Links API-Referenz

Mit dieser REST-API können Sie kurze dynamische Links generieren. Weitere Informationen finden Sie im Entwicklerhandbuch .

HTTP-Anfrage

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

request_body

Anforderungstext

Der Anforderungstext sieht wie folgt aus, je nachdem, ob Sie die Dynamic Link-Parameter als langen Dynamic Link oder als JSON-Objekt angeben möchten.

So geben Sie die Dynamic Link-Parameter als langen Dynamic Link an:

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

So geben Sie die Dynamic Link-Parameter als JSON-Objekt an:

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

Parameter

Alle Parameter sind optional, sofern nicht anders angegeben.

Allgemeine Parameter
domainUriPrefix Erforderlich, wenn Sie keinen Wert für den longDynamicLink Parameter festgelegt haben. Die Dynamic Links-Domäne Ihres Firebase-Projekts. Sie finden diesen Wert im Abschnitt „Dynamische Links“ der Firebase-Konsole .
Verknüpfung Erforderlich, wenn Sie keinen Wert für den longDynamicLink Parameter festgelegt haben.

Der Link, über den Ihre App geöffnet wird. Geben Sie eine URL an, die Ihre App verarbeiten kann, normalerweise der Inhalt oder die Nutzlast der App, die app-spezifische Logik initiiert (z. B. die Gutschrift eines Gutscheins an den Benutzer oder die Anzeige eines Begrüßungsbildschirms). Dieser Link muss eine gut formatierte URL sein, ordnungsgemäß URL-codiert sein, entweder HTTP oder HTTPS verwenden und darf kein anderer dynamischer Link sein.

Suffix

Gibt an, wie die Pfadkomponente eines kurzen dynamischen Links erstellt wird. Standardmäßig generiert Firebase Dynamic Links 17-stellige Zeichenfolgensuffixe.

Setzen Sie den Parameter auf { "option": "SHORT" } , um Pfadzeichenfolgen zu generieren, die nur so lang sind, wie es für die Eindeutigkeit erforderlich ist, mit einer Mindestlänge von 4 Zeichen. Verwenden Sie diese Methode, wenn vertrauliche Informationen nicht offengelegt würden, wenn eine kurze dynamische Link-URL erraten würde.

Lassen Sie diesen Parameter weg oder setzen Sie den Parameter auf { "option": "UNGUESSABLE" } , um den Pfad auf eine nicht erratene Zeichenfolge zu verkürzen. Solche Zeichenfolgen werden durch Base62-Kodierung zufällig generierter 96-Bit-Zahlen erstellt und bestehen aus 17 alphanumerischen Zeichen. Verwenden Sie unvorhersehbare Zeichenfolgen, um zu verhindern, dass Ihre dynamischen Links gecrawlt werden, wodurch möglicherweise vertrauliche Informationen preisgegeben werden.

Android-Parameter
androidPackageName Der Paketname der Android-App, die zum Öffnen des Links verwendet werden soll. Die App muss über die Übersichtsseite der Firebase-Konsole mit Ihrem Projekt verbunden sein. Erforderlich für den Dynamic Link zum Öffnen einer Android-App.
androidFallbackLink Der Link, der geöffnet wird, wenn die App nicht installiert ist. Geben Sie dies an, um etwas anderes zu tun, als Ihre App aus dem Play Store zu installieren, wenn die App nicht installiert ist, z. B. die mobile Webversion des Inhalts zu öffnen oder eine Werbeseite für Ihre App anzuzeigen.
androidMinPackageVersionCode Der versionCode der Mindestversion Ihrer App, die den Link öffnen kann. Wenn es sich bei der installierten App um eine ältere Version handelt, wird der Benutzer zum Play Store weitergeleitet, um die App zu aktualisieren.
iOS-Parameter
iosBundleId Die Bundle-ID der iOS-App, die zum Öffnen des Links verwendet werden soll. Die App muss über die Übersichtsseite der Firebase-Konsole mit Ihrem Projekt verbunden sein. Erforderlich für den Dynamic Link zum Öffnen einer iOS-App.
iosFallbackLink Der Link, der geöffnet wird, wenn die App nicht installiert ist. Geben Sie dies an, um etwas anderes zu tun, als Ihre App aus dem App Store zu installieren, wenn die App nicht installiert ist, z. B. die mobile Webversion des Inhalts zu öffnen oder eine Werbeseite für Ihre App anzuzeigen.
iosCustomScheme Das benutzerdefinierte URL-Schema Ihrer App, sofern es als etwas anderes als die Bundle-ID Ihrer App definiert ist
iosIpadFallbackLink Der Link wird auf iPads geöffnet, wenn die App nicht installiert ist. Geben Sie dies an, um etwas anderes zu tun, als Ihre App aus dem App Store zu installieren, wenn die App nicht installiert ist, z. B. die Webversion des Inhalts zu öffnen oder eine Werbeseite für Ihre App anzuzeigen.
iosIpadBundleId Die Bundle-ID der iOS-App, die auf iPads zum Öffnen des Links verwendet werden soll. Die App muss über die Übersichtsseite der Firebase-Konsole mit Ihrem Projekt verbunden sein.
iosAppStoreId Die App Store-ID Ihrer App, mit der Benutzer zum App Store weitergeleitet werden, wenn die App nicht installiert ist
Navigationsparameter
enableForcedRedirect Bei Einstellung auf „1“ wird die App-Vorschauseite übersprungen, wenn der Dynamic Link geöffnet wird, und stattdessen zur App oder zum Store weitergeleitet. Die App-Vorschauseite (standardmäßig aktiviert) kann Benutzer zuverlässiger zum am besten geeigneten Ziel weiterleiten, wenn sie dynamische Links in Apps öffnen. Wenn Sie jedoch erwarten, dass ein dynamischer Link nur in Apps geöffnet wird, die dynamische Links ohne diese Seite zuverlässig öffnen können, können Sie ihn mit diesem Parameter deaktivieren. Dieser Parameter wirkt sich nur auf iOS auf das Verhalten von Dynamic Link aus.
Parameter für soziale Meta-Tags
socialTitle Der Titel, der verwendet werden soll, wenn der dynamische Link in einem sozialen Beitrag geteilt wird.
sozialeBeschreibung Die Beschreibung, die verwendet werden soll, wenn der dynamische Link in einem Social-Media-Beitrag geteilt wird.
socialImageLink Die URL zu einem Bild, das sich auf diesen Link bezieht.
Analyseparameter
utmSource
utmMedium
utmCampaign
utmTerm
utmContent		 Analyseparameter von Google Play.
bei
ct
mt
pt		 Analyseparameter von iTunes Connect.

Antwortkörper

Die Antwort auf eine Anfrage ist ein JSON-Objekt wie das folgende:

{
  "shortLink": string,
  "previewLink": string
}
Antwortfelder
Kurzlink Der generierte kurze dynamische Link.
VorschauLink Ein Link zu einem Flussdiagramm des Verhaltens des dynamischen Links.