Firebase ダイナミック リンク ショート リンク API リファレンス

この REST API を使用して、短いダイナミック リンクを生成できます。開始するには、開発者ガイドを参照してください。

HTTPリクエスト

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

request_body

リクエストボディ

リクエスト本文は、ダイナミック リンク パラメーターを長いダイナミック リンクとして指定するか、JSON オブジェクトとして指定するかに応じて、次のいずれかのようになります。

ダイナミック リンク パラメータを長いダイナミック リンクとして指定するには:

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

ダイナミック リンク パラメータを 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"
  }
}

パラメーター

特に指定がない限り、すべてのパラメータはオプションです。

一般パラメータ
ドメインUriプレフィックスlongDynamicLinkパラメータの値を設定しなかった場合は必須です。 Firebase プロジェクトのダイナミック リンク ドメイン。この値は、 Firebase コンソールの [ダイナミック リンク] セクションで確認できます。
リンクlongDynamicLinkパラメータの値を設定しなかった場合は必須です。

アプリが開くリンク。アプリが処理できる URL (通常はアプリのコンテンツまたはペイロード) を指定します。これにより、アプリ固有のロジック (ユーザーにクーポンを付与したり、ようこそ画面を表示したりするなど) が開始されます。このリンクは適切な形式の URL である必要があり、適切に URL エンコードされ、HTTP または HTTPS を使用する必要があります。別のダイナミック リンクを使用することはできません。

サフィックス

短いダイナミック リンクのパス コンポーネントを作成する方法を指定します。デフォルトでは、Firebase Dynamic Links は 17 文字の文字列サフィックスを生成します。

パラメータを{ "option": "SHORT" }に設定すると、一意であるために必要な長さのみ (最小長は 4 文字) のパス文字列が生成されます。短いダイナミック リンク URL が推測された場合に機密情報が公開されない場合は、この方法を使用します。

このパラメータを省略するか、パラメータを{ "option": "UNGUESSABLE" }に設定して、推測不可能な文字列へのパスを短縮します。このような文字列は、ランダムに生成された 96 ビット数値を Base62 エンコードすることによって作成され、17 文字の英数字で構成されます。推測不可能な文字列を使用して、機密情報が漏洩する可能性があるダイナミック リンクがクロールされるのを防ぎます。

Androidパラメータ
androidパッケージ名リンクを開くために使用する Android アプリのパッケージ名。アプリは、Firebase コンソールの [概要] ページからプロジェクトに接続する必要があります。ダイナミック リンクが Android アプリを開くために必要です。
androidフォールバックリンクアプリがインストールされていない場合に開くリンク。アプリがインストールされていないときに、Play ストアからアプリをインストールする以外の操作 (コンテンツのモバイル Web バージョンを開く、アプリのプロモーション ページを表示するなど) を行う場合にこれを指定します。
androidMinPackageVersionCodeリンクを開くことができるアプリの最小バージョンのversionCode 。インストールされているアプリが古いバージョンの場合、ユーザーは Play ストアに移動してアプリをアップグレードします。
iOSパラメータ
iosバンドルIDリンクを開くために使用する iOS アプリのバンドル ID。アプリは、Firebase コンソールの [概要] ページからプロジェクトに接続する必要があります。ダイナミック リンクが iOS アプリを開くために必要です。
iosフォールバックリンクアプリがインストールされていない場合に開くリンク。アプリがインストールされていないときに、App Store からアプリをインストールする以外の操作 (コンテンツのモバイル Web バージョンを開く、アプリのプロモーション ページを表示するなど) を行う場合にこれを指定します。
iosカスタムスキームアプリのカスタム URL スキーム (アプリのバンドル ID 以外のものとして定義されている場合)
iosIpadFallbackLinkアプリがインストールされていない場合に iPad で開くリンク。アプリがインストールされていないときに、App Store からアプリをインストールする以外の操作 (コンテンツの Web バージョンを開く、アプリのプロモーション ページを表示するなど) を行う場合にこれを指定します。
iosIpadバンドルID iPad でリンクを開くために使用する iOS アプリのバンドル ID。アプリは、Firebase コンソールの [概要] ページからプロジェクトに接続する必要があります。
iosAppStoreIdアプリの App Store ID。アプリがインストールされていないときにユーザーを App Store に送信するために使用されます。
ナビゲーションパラメータ
EnableForcedRedirect 「1」に設定すると、ダイナミック リンクを開いたときにアプリのプレビュー ページをスキップし、代わりにアプリまたはストアにリダイレクトします。アプリのプレビュー ページ (デフォルトで有効) は、ユーザーがアプリでダイナミック リンクを開いたときに、より確実に最も適切な宛先に送信できます。ただし、このページがなくてもダイナミック リンクを確実に開くことができるアプリでのみダイナミック リンクが開かれることが予想される場合は、このパラメーターを使用して無効にすることができます。このパラメータは、iOS でのみダイナミック リンクの動作に影響します。
ソーシャルメタタグパラメータ
ソーシャルタイトルダイナミック リンクがソーシャル投稿で共有されるときに使用するタイトル。
ソーシャル説明ダイナミック リンクがソーシャル投稿で共有されるときに使用する説明。
ソーシャルイメージリンクこのリンクに関連する画像の URL。
分析パラメータ
utmソース
utm中
utmキャンペーン
utmTerm
utmコンテンツ
Google Play 分析パラメータ。

ct

ポイント
iTunes Connect 分析パラメータ。

レスポンスボディ

リクエストに対するレスポンスは、次のような JSON オブジェクトです。

{
  "shortLink": string,
  "previewLink": string
}
応答フィールド
ショートリンク生成された短いダイナミック リンク。
プレビューリンクダイナミック リンクの動作のフローチャートへのリンク。