この 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 文字の文字列サフィックスを生成します。 パラメータを このパラメータを省略するか、パラメータを |
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
}
応答フィールド | |
---|---|
ショートリンク | 生成された短いダイナミック リンク。 |
プレビューリンク | ダイナミック リンクの動作のフローチャートへのリンク。 |