Informacje o interfejsie API krótkich linków Firebase Dynamic Links

Możesz użyć tego interfejsu API REST do wygenerowania krótkich łączy dynamicznych. Aby rozpocząć, zapoznaj się z przewodnikiem dla programistów .

Żądanie HTTP

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

request_body

Treść żądania

Treść żądania wygląda następująco, w zależności od tego, czy chcesz określić parametry łącza dynamicznego jako długie łącze dynamiczne, czy jako obiekt JSON.

Aby określić parametry łącza dynamicznego jako długie łącze dynamiczne:

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

Aby określić parametry łącza dynamicznego jako obiekt 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"
  }
}

Parametry

Wszystkie parametry są opcjonalne, chyba że określono inaczej.

Parametry ogólne
domenaUriPrefix Wymagane, jeśli nie ustawiono wartości parametru longDynamicLink . Domena Linków dynamicznych Twojego projektu Firebase. Tę wartość można znaleźć w sekcji Linki dynamiczne w konsoli Firebase .
połączyć Wymagane, jeśli nie ustawiono wartości parametru longDynamicLink .

Link, który otworzy Twoja aplikacja. Określ adres URL, który może obsłużyć Twoja aplikacja, zazwyczaj zawartość aplikacji lub ładunek, który inicjuje logikę specyficzną dla aplikacji (taką jak przyznanie użytkownikowi kuponu lub wyświetlenie ekranu powitalnego). Ten link musi być dobrze sformatowanym adresem URL, odpowiednio zakodowanym adresem URL, używać protokołu HTTP lub HTTPS i nie może być innym łączem dynamicznym.

przyrostek

Określa sposób tworzenia składnika ścieżki krótkiego łącza dynamicznego. Domyślnie Firebase Dynamic Links generuje 17-znakowe sufiksy w postaci ciągów.

Ustaw parametr na { "option": "SHORT" } , aby wygenerować ciągi ścieżek o długości tylko tyle, ile jest to konieczne, aby były unikalne, o minimalnej długości 4 znaków. Użyj tej metody, jeśli poufne informacje nie zostaną ujawnione w przypadku odgadnięcia krótkiego adresu URL łącza dynamicznego.

Pomiń ten parametr lub ustaw parametr na { "option": "UNGUESSABLE" } , aby skrócić ścieżkę do niemożliwego do odgadnięcia ciągu. Takie ciągi są tworzone przez losowo generowane 96-bitowe liczby w kodowaniu base62 i składają się z 17 znaków alfanumerycznych. Używaj niemożliwych do odgadnięcia ciągów znaków, aby uniemożliwić indeksowanie łączy dynamicznych, co może potencjalnie ujawnić poufne informacje.

Parametry Androida
AndroidNazwaPakietu Nazwa pakietu aplikacji na Androida, która ma zostać użyta do otwarcia łącza. Aplikacja musi być połączona z projektem na stronie Przegląd konsoli Firebase. Wymagane, aby łącze dynamiczne otwierało aplikację na Androida.
AndroidFallbackLink Link otwierany, gdy aplikacja nie jest zainstalowana. Określ tę opcję, aby zrobić coś innego niż instalowanie aplikacji ze Sklepu Play, gdy aplikacja nie jest zainstalowana, na przykład otworzyć mobilną wersję internetową treści lub wyświetlić stronę promocyjną aplikacji.
AndroidMinPackageVersionCode versionCode minimalnej wersji aplikacji, która może otworzyć łącze. Jeśli zainstalowana aplikacja jest starszą wersją, użytkownik zostanie przeniesiony do Sklepu Play w celu aktualizacji aplikacji.
Parametry iOS
iosBundleId Identyfikator pakietu aplikacji na iOS, którego chcesz użyć do otwarcia łącza. Aplikacja musi być połączona z projektem na stronie Przegląd konsoli Firebase. Wymagane, aby łącze dynamiczne otwierało aplikację na iOS.
iOSFallbackLink Link otwierany, gdy aplikacja nie jest zainstalowana. Określ tę opcję, aby zrobić coś innego niż instalowanie aplikacji ze sklepu App Store, gdy aplikacja nie jest zainstalowana, na przykład otworzyć mobilną wersję internetową zawartości lub wyświetlić stronę promocyjną aplikacji.
iosSchemat niestandardowy Niestandardowy schemat adresu URL Twojej aplikacji, jeśli zdefiniowany jako inny niż identyfikator pakietu aplikacji
iosIpadFallbackLink Link do otwarcia na iPadzie, gdy aplikacja nie jest zainstalowana. Określ tę opcję, aby zrobić coś innego niż instalowanie aplikacji ze sklepu App Store, gdy aplikacja nie jest zainstalowana, na przykład otworzyć internetową wersję zawartości lub wyświetlić stronę promocyjną aplikacji.
iosIpadPakietId Identyfikator pakietu aplikacji na iOS, którego można używać na iPadach do otwierania łącza. Aplikacja musi być połączona z projektem na stronie Przegląd konsoli Firebase.
iosAppStoreId Identyfikator Twojej aplikacji w App Store, używany do odsyłania użytkowników do App Store, gdy aplikacja nie jest zainstalowana
Parametry nawigacji
włącz wymuszone przekierowanie Jeśli ustawione na „1”, pomiń stronę podglądu aplikacji po otwarciu łącza dynamicznego i zamiast tego przekieruj do aplikacji lub sklepu. Strona podglądu aplikacji (domyślnie włączona) może w bardziej niezawodny sposób odsyłać użytkowników do najbardziej odpowiedniego miejsca docelowego, gdy otwierają łącza dynamiczne w aplikacjach; jeśli jednak oczekujesz, że łącze dynamiczne będzie otwierane tylko w aplikacjach, które potrafią niezawodnie otwierać łącza dynamiczne bez tej strony, możesz je wyłączyć za pomocą tego parametru. Ten parametr będzie miał wpływ na zachowanie łącza dynamicznego tylko w systemie iOS.
Parametry metatagu społecznościowego
tytuł społecznościowy Tytuł używany podczas udostępniania łącza dynamicznego w poście społecznościowym.
opis społecznościowy Opis używany w przypadku udostępniania łącza dynamicznego w poście społecznościowym.
socialImageLink Adres URL obrazu powiązanego z tym linkiem.
Parametry analityczne
utmŹródło
utmŚredni
utmKampania
utmTerm
utmTreść
Parametry analityczne Google Play.
Na
ct
mt
pkt
Parametry analityczne iTunes Connect.

Treść odpowiedzi

Odpowiedzią na żądanie jest obiekt JSON podobny do poniższego:

{
  "shortLink": string,
  "previewLink": string
}
Pola odpowiedzi
krótki link Wygenerowany krótki link dynamiczny.
podglądLink Link do schematu blokowego zachowania łącza dynamicznego.