Firebase Dynamic Links Short Links API Referansı

Kısa bir Dynamic Links oluşturmak için bu REST API'yi kullanabilirsiniz. Geliştirici kılavuzuna bakın seçerek başlayın.

HTTP isteği

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

request_body

İstek içeriği

İsteğinize bağlı olarak, istek gövdesi aşağıdaki gibi görünür: kullanın.Dynamic LinkDynamic Link

Dynamic Link parametrelerini uzun bir Dynamic Link olarak belirtmek için:

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

Dynamic Link 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
alan adıUri Öneki longDynamicLink için bir değer ayarlamadıysanız gereklidir parametresinden sonra bir değer girin. Firebase projenizin Dynamic Links alanı. Bu değeri, Firebase konsolunun Dynamic Links bölümünde bulabilirsiniz.
bağlantı longDynamicLink için bir değer ayarlamadıysanız gereklidir parametresinden sonra bir değer girin.

Uygulamanızın açacağı bağlantı. Uygulamanızın işleyebileceği bir URL belirtin (genellikle uygulamanın içeriği) uygulamaya özel mantığı (kullanıcıya kupon veya kredi vermek gibi) başlatan bir karşılama ekranı görüntülenir). Bu bağlantı iyi biçimlendirilmiş bir URL olmalı, doğru şekilde URL kodlamalı olmalıdır. ve başka bir Dinamik Bağlantı olamaz.

sonek

Kısa bir Dynamic Link yol bileşeninin nasıl oluşturulacağını belirtir. Ölçüt varsayılan olarak Firebase Dynamic Links, 17 karakterlik dize son ekleri oluşturur.

Oluşturmak için parametreyi { "option": "SHORT" } olarak ayarlayın olması gereken kadar uzun olan path dizeleri en az 4 karakter uzunluğunda olmalıdır. Hassas bilgileriniz varsa bu yöntemi kullanın kısa bir Dynamic Link URL'si tahmin edilirse gösterilmez.

Bu parametreyi atlayın veya parametreyi Bir hedefe giden yolu kısaltmak için { "option": "UNGUESSABLE" } tahmin edilemez dize. Bu dizeler rastgele base62 kodlamasıyla oluşturulur 96 bit sayılar halinde üretilmiştir ve 17 alfanümerik karakterden oluşur. Tekliflerinizi otomatikleştirmek ve optimize etmek için taranamaz. Bu nedenle, Dynamic Links öğesinin taranmasını önlemek için hassas bilgileri açığa çıkarma potansiyeli vardır.

Android parametreleri
androidPackageName Bağlantıyı açmak için kullanılacak Android uygulamasının paket adı. Uygulama, Firebase konsolunun Genel bakış sayfasından projenize bağlanmalıdır. Dynamic Link cihazının bir Android uygulamasını açması için gereklidir.
androidFallbackLink Uygulama yüklenmediğinde açılacak bağlantı. Uygulama yüklü değilken Play Store'dan uygulamanızı yüklemek dışında bir işlem yapmak (ör. içeriğin mobil web sürümünü açmak veya uygulamanızın tanıtım sayfasını görüntülemek) için bunu belirtin.
androidMinPackageVersionCode Uygulamanızın bağlantıyı açabilen minimum sürümünün versionCode değeri. Yüklü uygulama daha eski bir sürümse kullanıcı, uygulamayı yeni sürüme geçirmesi 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. Uygulama, Firebase konsolunun Genel bakış sayfasından projenize bağlanmalıdır. Dynamic Link, iOS uygulamasını açmak için gereklidir.
iosFallbackBağlantısı Uygulama yüklenmediğinde açılacak bağlantı. Uygulama yüklü değilken uygulamanızı App Store'dan yüklemek dışında bir işlem yapmak (ör. içeriğin mobil web sürümünü açmak veya uygulamanızın tanıtım sayfasını görüntülemek) için bunu belirtin.
iOSÖzelŞema Uygulamanızın özel URL şeması (uygulamanızın paket kimliğinden farklı bir şekilde tanımlanırsa)
iosIpadFallbackLink Uygulama yüklü olmadığında iPad'lerde açılacak bağlantı. Uygulama yüklü değilken uygulamanızı App Store'dan yüklemek dışında bir işlem yapmak (ör. içeriğin web sürümünü açmak veya uygulamanızın tanıtım sayfasını görüntülemek) için bu seçeneği belirtin.
iOSIpadBundleId Bağlantıyı açmak için iPad'lerde kullanılacak iOS uygulamasının paket kimliği. Uygulama, Firebase konsolunun Genel bakış sayfasından projenize bağlanmalıdır.
iosAppStoreNo Uygulamanızın App Store kimliği (uygulama yüklü olmadığında kullanıcıları App Store'a göndermek için kullanılır)
Gezinme parametreleri
allowForcedRedirect Politika "1" olarak ayarlanırsa Dynamic Link açıldığında uygulama önizleme sayfasını atlayıp bunun yerine uygulamaya veya mağazaya yönlendirin. Uygulama önizleme sayfası (varsayılan olarak etkindir), Dynamic Links uygulamasını uygulamalarda açtıklarında kullanıcıları en uygun hedefe daha güvenilir bir şekilde gönderebilir; ancak bir Dynamic Link öğesinin, yalnızca bu sayfa olmadan Dynamic Links uygulamasını güvenilir bir şekilde açabilen uygulamalarda açılmasını bekliyorsanız bu parametreyle devre dışı bırakabilirsiniz. Bu parametre, Dynamic Link işlevinin yalnızca iOS'teki davranışını etkiler.
Sosyal Meta Etiket parametreleri
sosyalBaşlık Dynamic Link bir sosyal medya yayınında paylaşıldığında kullanılacak başlık.
sosyalAçıklama Dynamic Link bir sosyal medya yayınında paylaşıldığında kullanılacak açıklama.
SocialImageLink Bu bağlantıyla ilgili bir resmin URL'si.
Analytics parametreleri
utmSource
utmMedium
utmCampaign
utmTerm
utmContent
Google Play Analytics parametreleri.

ct
mt
pt
iTunes Connect analiz parametreleri.

Yanıt gövdesi

Bir isteğin yanıtı, aşağıdakine benzer bir JSON nesnesidir:

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