Firebase Dinamik Bağlantılar Kısa Bağlantılar API Referansı

Kısa Dinamik Bağlantılar oluşturmak için bu REST API'yi kullanabilirsiniz. Başlamak için geliştirici kılavuzuna bakın.

HTTP isteği

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

request_body

Talep gövdesi

İstek gövdesi, Dinamik Bağlantı parametrelerini uzun bir Dinamik Bağlantı olarak mı yoksa bir JSON nesnesi olarak mı belirtmek istediğinize bağlı olarak aşağıdakilerden birine benzer.

Dinamik Bağlantı parametrelerini uzun bir Dinamik Bağlantı olarak belirtmek için:

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

Dinamik Bağlantı parametrelerini JSON nesnesi olarak belirtmek için:

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

Parametreler

Aksi belirtilmedikçe tüm parametreler isteğe bağlıdır.

Genel parametreler
etki alanıUriPrefix longDynamicLink parametresi için bir değer ayarlamadıysanız gereklidir. Firebase projenizin Dinamik Bağlantılar alanı. Bu değeri Firebase konsolunun Dinamik Bağlantılar bölümünde bulabilirsiniz.
bağlantı longDynamicLink parametresi için bir değer ayarlamadıysanız gereklidir.

Uygulamanızın açılacağı bağlantı. Uygulamanızın işleyebileceği, uygulamaya özel mantığı (kullanıcıya bir kuponla kredi vermek veya bir karşılama ekranı görüntülemek gibi) başlatan, genellikle uygulamanın içeriği veya yükü gibi bir URL belirtin. Bu bağlantı iyi biçimlendirilmiş bir URL olmalı, URL'si düzgün şekilde kodlanmış olmalı, HTTP veya HTTPS kullanmalı ve başka bir Dinamik Bağlantı olamaz.

sonek

Kısa Dinamik Bağlantının yol bileşeninin nasıl oluşturulacağını belirtir. Firebase Dynamic Links varsayılan olarak 17 karakterlik dize son ekleri oluşturur.

Yalnızca benzersiz olması gereken uzunlukta ve minimum 4 karakter uzunluğunda yol dizeleri oluşturmak için parametreyi { "option": "SHORT" } olarak ayarlayın. Kısa bir Dinamik Bağlantı URL'si tahmin edildiğinde hassas bilgilerin açığa çıkmayacağı durumlarda bu yöntemi kullanın.

Tahmin edilemeyen bir dizeye giden yolu kısaltmak için bu parametreyi atlayın veya parametreyi { "option": "UNGUESSABLE" } olarak ayarlayın. Bu tür dizeler, rastgele oluşturulmuş 96 bitlik sayıların base62 kodlamasıyla oluşturulur ve 17 alfasayısal karakterden oluşur. Dinamik Bağlantılarınızın hassas bilgilerin açığa çıkmasına neden olabilecek şekilde taranmasını önlemek için tahmin edilemeyen dizeler kullanın.

Android parametreleri
androidPaketAdı Bağlantıyı açmak için kullanılacak Android uygulamasının paket adı. Uygulamanın, Firebase konsolunun Genel Bakış sayfasından projenize bağlanması gerekir. Dinamik Bağlantının bir Android uygulamasını açması için gereklidir.
androidFallbackLink Uygulama yüklenmediğinde açılacak bağlantı. Uygulama yüklenmediğinde Play Store'dan uygulamanızı yüklemek dışında bir şey yapmak (örneğin, içeriğin mobil web sürümünü açmak veya uygulamanız için bir tanıtım sayfası görüntülemek) için bunu belirtin.
androidMinPackageVersionCode Uygulamanızın bağlantıyı açabilecek minimum sürümünün versionCode . Yüklenen uygulama daha eski bir sürümse kullanıcı, uygulamayı yükseltmesi için Play Store'a yönlendirilir.
iOS parametreleri
iosBundleId Bağlantıyı açmak için kullanılacak iOS uygulamasının paket kimliği. Uygulamanın, Firebase konsolunun Genel Bakış sayfasından projenize bağlanması gerekir. Dinamik Bağlantının bir iOS uygulamasını açması için gereklidir.
iosFallbackLink Uygulama yüklenmediğinde açılacak bağlantı. Uygulama yüklenmediğinde App Store'dan uygulamanızı yüklemek dışında bir şey yapmak için (örneğin, içeriğin mobil web sürümünü açmak veya uygulamanız için bir tanıtım sayfası görüntülemek) bunu belirtin.
iosÖzel Şema Uygulamanızın paket kimliğinden farklı bir şey olarak tanımlanmışsa, uygulamanızın özel URL şeması
iosIpadFallbackLink Uygulama yüklü olmadığında iPad'lerde açılacak bağlantı. Uygulama yüklenmediğinde App Store'dan uygulamanızı yüklemek dışında, içeriğin web sürümünü açmak veya uygulamanız için bir tanıtım sayfası görüntülemek gibi başka bir işlem yapmak için bunu belirtin.
iosIpadBundleId Bağlantıyı açmak için iPad'lerde kullanılacak iOS uygulamasının paket kimliği. Uygulamanın, Firebase konsolunun Genel Bakış sayfasından projenize bağlanması gerekir.
iosAppStoreKimliği Uygulamanız yüklü olmadığında kullanıcıları App Store'a göndermek için kullanılan uygulamanızın App Store Kimliği
Gezinme parametreleri
ForcedRedirect'i etkinleştir '1' olarak ayarlanırsa Dinamik Bağlantı açıldığında uygulama önizleme sayfasını atlayın ve bunun yerine uygulamaya veya mağazaya yönlendirin. Uygulama önizleme sayfası (varsayılan olarak etkindir), uygulamalarda Dinamik Bağlantıları açtıklarında kullanıcıları en uygun hedefe daha güvenilir şekilde gönderebilir; ancak bu sayfa olmadan yalnızca Dinamik Bağlantıları güvenilir bir şekilde açabilen uygulamalarda Dinamik Bağlantının açılmasını bekliyorsanız bu parametreyle devre dışı bırakabilirsiniz. Bu parametre Dinamik Bağlantının davranışını yalnızca iOS'ta etkileyecektir.
Sosyal Meta Etiketi parametreleri
sosyalBaşlık Dinamik Bağlantı bir sosyal gönderide paylaşıldığında kullanılacak başlık.
sosyal Açıklama Dinamik Bağlantı bir sosyal gönderide paylaşıldığında kullanılacak açıklama.
sosyal İmaj Bağlantısı Bu bağlantıyla ilgili bir görselin URL'si.
Analiz parametreleri
utmKaynak
utmMedium
utmKampanyası
utmTerm
utmİçerik
Google Play analiz parametreleri.
en
CT
mt
puan
iTunes Connect analiz parametreleri.

Yanıt gövdesi

Bir isteğe verilen yanıt aşağıdakine benzer bir JSON nesnesidir:

{
  "shortLink": string,
  "previewLink": string
}
Yanıt alanları
kısa bağlantı Oluşturulan kısa Dinamik Bağlantı.
önizlemeBağlantı Dinamik Bağlantı davranışının akış şemasına bağlantı.