Firebase Dynamic Links Short Links API リファレンス

この REST API を使用して、短い Dynamic Links を生成できます。デベロッパー ガイドをご覧ください。 ご覧ください。

HTTP リクエスト

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

request_body

リクエストの本文

リクエスト本文は、使用するかどうかに応じて、次のいずれかになります。 Dynamic Link パラメータを long Dynamic Link または JSON オブジェクトとして指定します。

Dynamic Link パラメータを long Dynamic Link として指定するには:

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

Dynamic Link パラメータを 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"
  }
}

パラメータ

特に指定しない限り、すべてのパラメータは省略可能です。

一般的なパラメータ
domainUriPrefix longDynamicLink に値を設定しなかった場合は必須です。 パラメータを指定します。Firebase プロジェクトの Dynamic Links ドメイン。この値は、Firebase コンソールDynamic Links セクションで確認できます。
リンク longDynamicLink に値を設定しなかった場合は必須です。 パラメータを指定します。

アプリで開くリンク。アプリで処理可能な URL を指定します。通常、この URL はアプリ固有のロジック(ユーザーへのクーポン付与や特定の開始画面の表示など)を起動するアプリのコンテンツやペイロードへのリンクです。このリンクは適切な形式の URL で、正しく URL エンコードされている必要があります。HTTP または HTTPS のいずれかを使用してください。他のダイナミック リンクは使用できません。

接尾辞

短い Dynamic Link のパス コンポーネントを作成する方法を指定します。方法 デフォルトでは、Firebase Dynamic Links は 17 文字の文字列接尾辞を生成します。

生成するには、パラメータを { "option": "SHORT" } に設定します。 長くして一意のパス文字列を指定します。 4 文字以上にする必要があります。この方法は、機密情報が Dynamic Link の短縮 URL が推測された場合には公開されません。

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

Android 向けパラメータ
androidPackageName リンクを開くために使う Android アプリのパッケージ名。Firebase コンソールの [Overview] ページで、アプリがプロジェクトに接続されている必要があります。Dynamic Link が Android アプリを開くために必要です。
Android のフォールバック リンク アプリがインストールされていない場合に開くリンク。モバイルウェブ バージョンのコンテンツを開いたり、アプリの宣伝ページを開いたりするなど、アプリがインストールされていないときに Play ストアからアプリをインストールする以外の動作をさせる場合に指定します。
androidMinPackageVersionCode リンクを開くことができるアプリの最小バージョンの versionCode。インストールされているアプリのバージョンがそれよりも古い場合、ユーザーは Play ストアにリダイレクトされ、アプリのアップグレードを促されます。
iOS 向けパラメータ
iosBundleId リンクを開くために使う iOS アプリのバンドル ID。Firebase コンソールの [Overview] ページで、アプリがプロジェクトに接続されている必要があります。Dynamic Link が iOS アプリを開くために必要です。
iOS の代替リンク アプリがインストールされていない場合に開くリンク。モバイルウェブ バージョンのコンテンツを開いたり、アプリの宣伝ページを開いたりするなど、アプリがインストールされていないときに App Store からアプリをインストールする以外の動作をさせる場合に指定します。
iosCustomScheme アプリのカスタム URL スキーム(アプリのバンドル ID とは異なるものを定義している場合)。
iOSIpadFallbackLink アプリがインストールされていない場合に iPad で開くリンク。ウェブ バージョンのコンテンツを開いたり、アプリの宣伝ページを開いたりするなど、アプリがインストールされていないときに App Store からアプリをインストールする以外の動作をさせる場合に指定します。
iosIpadBundleId iPad でリンクを開くために使う iOS アプリのバンドル ID。Firebase コンソールの [Overview] ページで、アプリがプロジェクトに接続されている必要があります。
iosAppStoreId アプリの App Store ID。アプリがインストールされていない場合にユーザーを App Store に転送するために使用します。
ナビゲーション パラメータ
enableForcedRedirect 「1」に設定した場合、Dynamic Link を開いたときにアプリのプレビュー ページをスキップし、代わりにアプリまたはストアにリダイレクトします。アプリのプレビュー ページ(デフォルトで有効)により、ユーザーがアプリ内で Dynamic Links を開いたときに、最も確実なリンク先に確実に誘導できるようになります。ただし、このページがなくても Dynamic Links を確実に開くことができるアプリでのみ Dynamic Link を開くことを想定する場合は、このパラメータを使用して無効にできます。このパラメータは、iOS の Dynamic Link の動作にのみ影響します。
ソーシャル メタタグのパラメータ
ソーシャルのタイトル ソーシャル投稿で Dynamic Link が共有されたときに使用するタイトル。
ソーシャルの説明 ソーシャル投稿で Dynamic Link が共有されたときに使用する説明。
SocialImageLink このリンクに関連する画像への URL。
解析パラメータ
utmSource
utmMedium
utmCampaign
utmTerm
utmContent
Google Play の解析パラメータ。
at
ct
mt
pt
iTunes Connect の解析パラメータ。

レスポンスの本文

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

{
  "shortLink": string,
  "previewLink": string
}
レスポンスのフィールド
ショートリンク 生成された短い Dynamic Link
previewLink Dynamic Link の動作のフローチャートへのリンク。