Tworzenie linków dynamicznych za pomocą interfejsu API REST

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

https://example.page.link/WXYZ

Krótkie Dynamic Links utworzone za pomocą interfejsu API i pakietu SDK klienta (Android/Apple) nie są widoczne w Firebase konsoli. 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 page of the Firebase console.

Zanim zaczniesz

  1. Uzyskaj klucz interfejsu API. Do uwierzytelniania żądań do interfejsu API potrzebny jest klucz interfejsu API. Aby znaleźć klucz interfejsu API:
    1. Otwórz stronę Ustawienia konsoli Firebase. Jeśli pojawi się prośba o wybranie projektu, wybierz projekt w Firebase z menu.
    2. Zanotuj wartość pola Klucz interfejsu Web API.
  2. W konsoli Firebase otwórz sekcję Dynamic Links.

  3. Jeśli nie masz jeszcze zaakceptowanych warunków korzystania z usługi i nie masz ustawionej domeny dla Dynamic Links, zrób to, gdy pojawi się odpowiednia prośba.

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

Za pomocą interfejsu API Linków dynamicznych Firebase możesz skrócić długi Dynamic Link. Aby to zrobić, wyślij żądanie HTTP POST do punktu końcowego shortLinks, podając długi Dynamic Link w parametrze longDynamicLink. 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 Dynamic Links, przeczytaj artykuł Ręczne tworzenie adresu URL.

Możesz też utworzyć krótki Dynamic Link, podając bezpośrednio parametry Dynamic Link. Aby to zrobić, wyślij żądanie HTTP POST do punktu końcowego shortLinks, podając parametry Dynamic Link w parametrze dynamicLinkInfo. 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 krótkiego Dynamic Link

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

Domyślnie lub jeśli ustawisz parametr na "UNGUESSABLE", komponent ścieżki będzie ciągiem 17 znaków, 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ć odgadnięcie i indeksowanie adresów URL Dynamic Links, co może spowodować ujawnienie poufnych informacji nieuprawnionym odbiorcom.

Jeśli ustawisz parametr na "SHORT", komponent ścieżki będzie ciągiem o minimalnej długości 4 znaków, który będzie miał tylko tyle znaków, ile jest potrzebnych do zapewnienia unikalności.

https://example.page.link/WXYZ

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

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

Wartość precyzyjnego linku musi zaczynać się od schematu http:// lub https://. Musi też pasować do wszystkich wzorców adresów URL na liście dozwolonych wpisanych w konsoli. W przeciwnym razie interfejs API tworzenia zwróci kod błędu HTTP 400.

Dalsze kroki

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

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

Liczba żądań jest ograniczona do 5 żądań na adres IP na sekundę i 200 tys. żądań dziennie. Jeśli limit zostanie przekroczony, odpowiedź będzie zawierać kod błędu HTTP 429. Aby poprosić o zwiększenie limitu, wypełnij ten formularz.