Za pomocą tego interfejsu API typu REST możesz wygenerować krótki format Dynamic Links. Zobacz przewodnik dla programistów. aby rozpocząć.
Żądanie HTTP
POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key Content-Type: application/json request_body
Treść żądania
Treść żądania wygląda tak: aby określić parametry Dynamic Link w postaci długiej Dynamic Link lub obiektu JSON.
Aby określić parametry Dynamic Link za pomocą długiego elementu Dynamic Link:
{
"longDynamicLink": string,
"suffix": {
"option": "SHORT" or "UNGUESSABLE"
}
}
Aby określić parametry Dynamic Link 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 | |
|---|---|
| Prefiks URI domeny | Wymagany, jeśli nie ustawiono wartości pola longDynamicLink
. Domena Dynamic Links Twojego projektu Firebase. Tę wartość znajdziesz w sekcji Dynamic Links w konsoli Firebase. |
| link | Wymagany, jeśli nie ustawiono wartości pola longDynamicLink
.
Link, który otworzy się Twoja aplikacja. Określ adres URL, który może obsługiwać aplikacja (zwykle jest to zawartość aplikacji) lub ładunku, które inicjują logikę związaną z daną aplikacją (np. przypisanie użytkownikowi kuponu lub wyświetlając ekran powitalny). Link ten musi być dobrze sformatowanym adresem URL, prawidłowo zakodowanym adresem URL oraz musi to być protokół HTTP lub HTTPS i nie może być kolejnym linkiem dynamicznym. |
| przyrostek |
Określa, jak utworzyć komponent ścieżki w krótkim formacie Dynamic Link. Według domyślnie Firebase Dynamic Links generuje 17-znakowe sufiksy ciągu znaków. Ustaw parametr na Pomiń ten parametr lub ustaw wartość na
|
| Parametry Androida | |
|---|---|
| NazwaPakietu na Androida | Nazwa pakietu aplikacji na Androida, której chcesz użyć do otwarcia linku. Musisz połączyć aplikację z projektem na stronie Przegląd w konsoli Firebase. Wymagane do otwierania aplikacji na Androida przez aplikację Dynamic Link. |
| Link zastępczy androida | Link do otwarcia, gdy aplikacja nie jest zainstalowana. Wybierz tę opcję, jeśli chcesz, by aplikacja nie była zainstalowana ze Sklepu Play. Może to być na przykład otwarcie mobilnej wersji treści lub wyświetlenie strony promocyjnej aplikacji. |
| Kod wersji pakietu androidMin | versionCode minimalnej wersji aplikacji, w której można otworzyć link. Jeśli zainstalowana jest starsza wersja aplikacji, użytkownik zostanie przekierowany do Sklepu Play, aby ją uaktualnić. |
| Parametry iOS | |
|---|---|
| Identyfikator pakietu iOS | Identyfikator pakietu aplikacji na iOS, która ma zostać użyta do otwarcia linku. Musisz połączyć aplikację z projektem na stronie Przegląd w konsoli Firebase. Wymagane, aby aplikacja Dynamic Link mogła otwierać aplikację na iOS. |
| Link iosFallbackLink | Link do otwarcia, gdy aplikacja nie jest zainstalowana. Wybierz to ustawienie, jeśli chcesz, by aplikacja nie była zainstalowana z App Store. Może to być na przykład otwarcie mobilnej wersji treści lub wyświetlanie strony promocyjnej aplikacji. |
| Niestandardowy schemat ios | Schemat niestandardowego adresu URL aplikacji, jeśli został zdefiniowany jako inny niż identyfikator pakietu aplikacji |
| Link zastępczy iOSIpad | Link do otwierania się na iPadzie, gdy aplikacja nie jest zainstalowana. Wybierz to ustawienie, jeśli aplikacja nie jest zainstalowana z App Store. Może to być na przykład otwarcie internetowej wersji treści lub wyświetlanie strony promocyjnej aplikacji. |
| Identyfikator pakietu iOSIpad | Identyfikator pakietu aplikacji na iOS, którego chcesz użyć na iPadzie do otwarcia linku. Musisz połączyć aplikację z projektem na stronie Przegląd w konsoli Firebase. |
| Identyfikator iOSAppStore | Identyfikator App Store Twojej aplikacji używany do kierowania użytkowników do App Store, gdy aplikacja nie jest zainstalowana |
| Parametry nawigacji | |
|---|---|
| allowForcedRedirect | Jeśli ma wartość „1”, pomiń stronę podglądu aplikacji po otwarciu Dynamic Link i przekieruj ją do aplikacji lub sklepu. Strona podglądu aplikacji (domyślnie włączona) może bardziej niezawodnie odsyłać użytkowników do najbardziej odpowiednich miejsc docelowych, gdy otwierają Dynamic Links w aplikacjach. Jeśli jednak oczekujesz, że element Dynamic Link będzie otwierany tylko w aplikacjach, które mogą niezawodnie otwierać Dynamic Links bez tej strony, możesz go wyłączyć za pomocą tego parametru. Ten parametr będzie miał wpływ na działanie funkcji Dynamic Link tylko w systemie iOS. |
| Parametry metatagów społecznościowych | |
|---|---|
| Sieć społecznościowaTytuł | Tytuł używany, gdy Dynamic Link jest udostępniany w poście w mediach społecznościowych. |
| opis społecznościowy | Opis używany, gdy Dynamic Link jest udostępniany w poście w mediach społecznościowych. |
| link do obrazu społecznościowego | Adres URL obrazu powiązanego z tym linkiem. |
| Parametry Analytics | |
|---|---|
| utmSource utmMedium utmCampaign utmTerm utmContent |
Parametry analityczne Google Play. |
| przy szt. mt pkt. |
Parametry analityczne iTunes Connect. |
Treść odpowiedzi
Odpowiedź na żądanie to obiekt JSON podobny do tego:
{
"shortLink": string,
"previewLink": string
}
| Pola odpowiedzi | |
|---|---|
| ShortLink | Wygenerowany krótki Dynamic Link. |
| link do podglądu | Link do schematu blokowego przedstawiającego działanie elementu Dynamic Link. |