Tworzenie linków dynamicznych za pomocą interfejsu API REST

Możesz tworzyć krótkie Dynamic Links za pomocą interfejsu REST API Linków dynamicznych Firebase. Ten interfejs API akceptuje długi parametr Dynamic Link lub obiekt zawierający parametry Dynamic Link i zwraca adres URL podobny do tego:

https://example.page.link/WXYZ

Skróty Dynamic Links utworzone za pomocą interfejsu API i pakietu SDK klienta (Android/Apple) nie są widoczne w konsoli Firebase. Takie Dynamic Links są przeznaczone do udostępniania między użytkownikami. W przypadku zastosowań marketingowych nadal twórz linki bezpośrednio na stronie Dynamic Links w konsoli Firebase.

Zanim zaczniesz

  1. Uzyskaj klucz interfejsu API. Aby uwierzytelniać żądania do interfejsu API, potrzebujesz klucza interfejsu API. Aby znaleźć klucz interfejsu API:
    1. Otwórz stronę Ustawienia w konsoli Firebase. Jeśli pojawi się prośba o wybranie projektu, wybierz z menu projekt w Firebase.
    2. Zapisz wartość pola Web API Key (Klucz interfejsu Web API).
  2. W konsoli Firebase otwórz sekcję Dynamic Links.

  3. Jeśli nie zaakceptowano jeszcze warunków korzystania z usługi i nie ustawiono domeny dla Dynamic Links, zrób to, gdy pojawi się odpowiedni komunikat.

    Jeśli masz już domenę Dynamic Links, zapisz ją. Podczas automatycznego tworzenia Dynamic Links musisz podać domenę Dynamic Links.

Możesz użyć interfejsu Linki dynamiczne Firebase API, aby skrócić długi Dynamic Link. W tym celu wyślij żądanie POST HTTP do punktu końcowego shortLinks, podając długi Dynamic Link w parametrze longDynamicLink. Na przykład:

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

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

Aby dowiedzieć się, jak tworzyć długie adresy URL Dynamic Links, przeczytaj artykuł Ręczne tworzenie adresu URL.

Możesz też utworzyć krótki link Dynamic Link, bezpośrednio podając parametry Dynamic Link. W tym celu wyślij żądanie POST HTTP do punktu końcowego shortLinks, podając parametry Dynamic Link w parametrze dynamicLinkInfo. Na przykład:

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

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

Pełną specyfikację obiektu dynamicLinkInfo znajdziesz w dokumentacji API.

Ustawianie długości filmu Short Dynamic Link

Możesz też ustawić parametr suffix, aby określić, jak ma być generowany komponent ścieżki krótkiego adresu Dynamic Link.

Domyślnie lub jeśli ustawisz parametr na "UNGUESSABLE", komponent ścieżki będzie 17-znakowym ciągiem, jak w tym przykładzie:

https://example.page.link/UVWXYZuvwxyz12345

Takie ciągi są tworzone przez kodowanie base62 losowo wygenerowanych 96-bitowych liczb. Użyj tego ustawienia, aby uniemożliwić odgadywanie i indeksowanie adresów URL Dynamic Links, co może potencjalnie ujawnić informacje poufne niezamierzonym odbiorcom.

Jeśli ustawisz parametr na "SHORT", komponent ścieżki będzie ciągiem znaków o minimalnej długości 4 znaków, który będzie tylko tak długi, jak to konieczne, aby był unikalny.

https://example.page.link/WXYZ

Użyj tej metody, jeśli odgadnięcie krótkiego adresu URL Dynamic Link nie spowoduje ujawnienia informacji poufnych.

Poniższy przykład pokazuje, jak ustawić parametr suffix:

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

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

Podana wartość precyzyjnego linku musi zaczynać się od schematu http:// lub https://. Musi też pasować do listy dozwolonych wzorców adresów URL wpisanej w konsoli. W przeciwnym razie interfejs API do tworzenia zwróci błąd HTTP 400.

Dalsze kroki

Po utworzeniu Dynamic Links musisz skonfigurować aplikację tak, aby odbierała Dynamic Links i kierowała użytkowników do odpowiedniego miejsca w aplikacji po ich otwarciu.

Aby otrzymywać Dynamic Links w aplikacji, zapoznaj się z dokumentacją dotyczącą iOS, Androida, C++ i Unity.

Liczba żądań jest ograniczona do 5 żądań na adres IP na sekundę i 200 000 żądań dziennie. Jeśli zostanie przekroczony, odpowiedź zwróci kod błędu HTTP 429.