Create
|
|||||
|
|
||||
Creates a managed short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire.
This differs from CreateShortDynamicLink in the following ways:
- The request will also contain a name for the link (non unique name for the front end).
- The response must be authenticated with an auth token (generated with the admin service account).
- The link will appear in the FDL list of links in the console front end.
The Dynamic Link domain in the request must be owned by requester's Firebase project
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and administer all your Firebase data and settings
Input
This building block consumes 44 input parameters
| Name | Format | Description |
|---|---|---|
dynamicLinkInfo |
OBJECT |
Information about a Dynamic Link |
dynamicLinkInfo.navigationInfo |
OBJECT |
Information of navigation behavior |
dynamicLinkInfo.navigationInfo.enableForcedRedirect |
BOOLEAN |
If this option is on, FDL click will be forced to redirect rather than show an interstitial page |
dynamicLinkInfo.analyticsInfo |
OBJECT |
Tracking parameters supported by Dynamic Link |
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics |
OBJECT |
Parameters for iTunes Connect App Analytics |
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.at |
STRING |
Affiliate token used to create affiliate-coded links |
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.ct |
STRING |
Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign |
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.mt |
STRING |
iTune media types, including music, podcasts, audiobooks and so on |
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.pt |
STRING |
Provider token that enables analytics for Dynamic Links from within iTunes Connect |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics |
OBJECT |
Parameters for Google Play Campaign Measurements. Learn more |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmContent |
STRING |
Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmMedium |
STRING |
Campaign medium; used to identify a medium such as email or cost-per-click |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmTerm |
STRING |
Campaign term; used with paid search to supply the keywords for ads |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmSource |
STRING |
Campaign source; used to identify a search engine, newsletter, or other source |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.gclid |
STRING |
AdWords autotagging parameter; used to measure Google AdWords ads. This value is generated dynamically and should never be modified |
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmCampaign |
STRING |
Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign |
dynamicLinkInfo.dynamicLinkDomain |
STRING |
Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix |
dynamicLinkInfo.desktopInfo |
OBJECT |
Desktop related attributes to the Dynamic Link |
dynamicLinkInfo.desktopInfo.desktopFallbackLink |
STRING |
Link to open on desktop |
dynamicLinkInfo.link |
STRING |
The link your app will open, You can specify any URL your app can handle. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or HTTPS scheme. See 'link' parameters in the documentation. Required |
dynamicLinkInfo.iosInfo |
OBJECT |
iOS related attributes to the Dynamic Link. |
dynamicLinkInfo.iosInfo.iosIpadBundleId |
STRING |
iPad bundle ID of the app |
dynamicLinkInfo.iosInfo.iosCustomScheme |
STRING |
Custom (destination) scheme to use for iOS. By default, we’ll use the bundle ID as the custom scheme. Developer can override this behavior using this param |
dynamicLinkInfo.iosInfo.iosBundleId |
STRING |
iOS bundle ID of the app |
dynamicLinkInfo.iosInfo.iosFallbackLink |
STRING |
Link to open on iOS if the app is not installed |
dynamicLinkInfo.iosInfo.iosAppStoreId |
STRING |
iOS App Store ID |
dynamicLinkInfo.iosInfo.iosIpadFallbackLink |
STRING |
If specified, this overrides the ios_fallback_link value on iPads |
dynamicLinkInfo.iosInfo.iosMinimumVersion |
STRING |
iOS minimum version |
dynamicLinkInfo.socialMetaTagInfo |
OBJECT |
Parameters for social meta tag params. Used to set meta tag data for link previews on social sites |
dynamicLinkInfo.socialMetaTagInfo.socialTitle |
STRING |
Title to be displayed. Optional |
dynamicLinkInfo.socialMetaTagInfo.socialImageLink |
STRING |
An image url string. Optional |
dynamicLinkInfo.socialMetaTagInfo.socialDescription |
STRING |
A short description of the link. Optional |
dynamicLinkInfo.domainUriPrefix |
STRING |
E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing |
dynamicLinkInfo.androidInfo |
OBJECT |
Android related attributes to the Dynamic Link |
dynamicLinkInfo.androidInfo.androidMinPackageVersionCode |
STRING |
Minimum version code for the Android app. If the installed app’s version code is lower, then the user is taken to the Play Store |
dynamicLinkInfo.androidInfo.androidLink |
STRING |
If specified, this overrides the ‘link’ parameter on Android |
dynamicLinkInfo.androidInfo.androidFallbackLink |
STRING |
Link to open on Android if the app is not installed |
dynamicLinkInfo.androidInfo.androidPackageName |
STRING |
Android package name of the app |
sdkVersion |
STRING |
Google SDK version. Version takes the form "$major.$minor.$patch" |
longDynamicLink |
STRING |
Full long Dynamic Link URL with desired query parameters specified. For example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", Learn more |
name |
STRING |
Link name to associate with the link. It's used for marketer to identify manually-created links in the Firebase console (https://console.firebase.google.com/). Links must be named to be tracked |
suffix |
OBJECT |
Short Dynamic Link suffix |
suffix.customSuffix |
STRING |
Only applies to Option.CUSTOM |
suffix.option |
ENUMERATION |
Suffix option |
= Parameter name
= Format
|
dynamicLinkInfo OBJECT Information about a Dynamic Link |
|
dynamicLinkInfo.navigationInfo OBJECT Information of navigation behavior |
|
dynamicLinkInfo.navigationInfo.enableForcedRedirect BOOLEAN If this option is on, FDL click will be forced to redirect rather than show an interstitial page |
|
dynamicLinkInfo.analyticsInfo OBJECT Tracking parameters supported by Dynamic Link |
|
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics OBJECT Parameters for iTunes Connect App Analytics |
|
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.at STRING Affiliate token used to create affiliate-coded links |
|
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.ct STRING Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign |
|
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.mt STRING iTune media types, including music, podcasts, audiobooks and so on |
|
dynamicLinkInfo.analyticsInfo.itunesConnectAnalytics.pt STRING Provider token that enables analytics for Dynamic Links from within iTunes Connect |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics OBJECT Parameters for Google Play Campaign Measurements. Learn more |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmContent STRING Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmMedium STRING Campaign medium; used to identify a medium such as email or cost-per-click |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmTerm STRING Campaign term; used with paid search to supply the keywords for ads |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmSource STRING Campaign source; used to identify a search engine, newsletter, or other source |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.gclid STRING AdWords autotagging parameter; used to measure Google AdWords ads. This value is generated dynamically and should never be modified |
|
dynamicLinkInfo.analyticsInfo.googlePlayAnalytics.utmCampaign STRING Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign |
|
dynamicLinkInfo.dynamicLinkDomain STRING Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix |
|
dynamicLinkInfo.desktopInfo OBJECT Desktop related attributes to the Dynamic Link |
|
dynamicLinkInfo.desktopInfo.desktopFallbackLink STRING Link to open on desktop |
|
dynamicLinkInfo.link STRING The link your app will open, You can specify any URL your app can handle. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or HTTPS scheme. See 'link' parameters in the documentation. Required |
|
dynamicLinkInfo.iosInfo OBJECT iOS related attributes to the Dynamic Link. |
|
dynamicLinkInfo.iosInfo.iosIpadBundleId STRING iPad bundle ID of the app |
|
dynamicLinkInfo.iosInfo.iosCustomScheme STRING Custom (destination) scheme to use for iOS. By default, we’ll use the bundle ID as the custom scheme. Developer can override this behavior using this param |
|
dynamicLinkInfo.iosInfo.iosBundleId STRING iOS bundle ID of the app |
|
dynamicLinkInfo.iosInfo.iosFallbackLink STRING Link to open on iOS if the app is not installed |
|
dynamicLinkInfo.iosInfo.iosAppStoreId STRING iOS App Store ID |
|
dynamicLinkInfo.iosInfo.iosIpadFallbackLink STRING If specified, this overrides the ios_fallback_link value on iPads |
|
dynamicLinkInfo.iosInfo.iosMinimumVersion STRING iOS minimum version |
|
dynamicLinkInfo.socialMetaTagInfo OBJECT Parameters for social meta tag params. Used to set meta tag data for link previews on social sites |
|
dynamicLinkInfo.socialMetaTagInfo.socialTitle STRING Title to be displayed. Optional |
|
dynamicLinkInfo.socialMetaTagInfo.socialImageLink STRING An image url string. Optional |
|
dynamicLinkInfo.socialMetaTagInfo.socialDescription STRING A short description of the link. Optional |
|
dynamicLinkInfo.domainUriPrefix STRING E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing |
|
dynamicLinkInfo.androidInfo OBJECT Android related attributes to the Dynamic Link |
|
dynamicLinkInfo.androidInfo.androidMinPackageVersionCode STRING Minimum version code for the Android app. If the installed app’s version code is lower, then the user is taken to the Play Store |
|
dynamicLinkInfo.androidInfo.androidLink STRING If specified, this overrides the ‘link’ parameter on Android |
|
dynamicLinkInfo.androidInfo.androidFallbackLink STRING Link to open on Android if the app is not installed |
|
dynamicLinkInfo.androidInfo.androidPackageName STRING Android package name of the app |
|
sdkVersion STRING Google SDK version. Version takes the form "$major.$minor.$patch" |
|
longDynamicLink STRING Full long Dynamic Link URL with desired query parameters specified. For example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", Learn more |
|
name STRING Link name to associate with the link. It's used for marketer to identify manually-created links in the Firebase console (https://console.firebase.google.com/). Links must be named to be tracked |
|
suffix OBJECT Short Dynamic Link suffix |
|
suffix.customSuffix STRING Only applies to Option.CUSTOM |
|
suffix.option ENUMERATION Suffix option |
Output
This building block provides 39 output parameters
| Name | Format | Description |
|---|---|---|
previewLink |
STRING |
Preview link to show the link flow chart. (debug info.) |
managedShortLink |
OBJECT |
Managed Short Link |
managedShortLink.link |
STRING |
Short durable link url, for example, "https://sample.app.goo.gl/xyz123". Required |
managedShortLink.creationTime |
ANY |
Creation timestamp of the short link |
managedShortLink.visibility |
ENUMERATION |
Visibility status of link |
managedShortLink.linkName |
STRING |
Link name defined by the creator. Required |
managedShortLink.flaggedAttribute[] |
ENUMERATION |
|
managedShortLink.info |
OBJECT |
Information about a Dynamic Link |
managedShortLink.info.navigationInfo |
OBJECT |
Information of navigation behavior |
managedShortLink.info.navigationInfo.enableForcedRedirect |
BOOLEAN |
If this option is on, FDL click will be forced to redirect rather than show an interstitial page |
managedShortLink.info.analyticsInfo |
OBJECT |
Tracking parameters supported by Dynamic Link |
managedShortLink.info.analyticsInfo.itunesConnectAnalytics |
OBJECT |
Parameters for iTunes Connect App Analytics |
managedShortLink.info.analyticsInfo.googlePlayAnalytics |
OBJECT |
Parameters for Google Play Campaign Measurements. Learn more |
managedShortLink.info.dynamicLinkDomain |
STRING |
Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix |
managedShortLink.info.desktopInfo |
OBJECT |
Desktop related attributes to the Dynamic Link |
managedShortLink.info.desktopInfo.desktopFallbackLink |
STRING |
Link to open on desktop |
managedShortLink.info.link |
STRING |
The link your app will open, You can specify any URL your app can handle. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or HTTPS scheme. See 'link' parameters in the documentation. Required |
managedShortLink.info.iosInfo |
OBJECT |
iOS related attributes to the Dynamic Link. |
managedShortLink.info.iosInfo.iosIpadBundleId |
STRING |
iPad bundle ID of the app |
managedShortLink.info.iosInfo.iosCustomScheme |
STRING |
Custom (destination) scheme to use for iOS. By default, we’ll use the bundle ID as the custom scheme. Developer can override this behavior using this param |
managedShortLink.info.iosInfo.iosBundleId |
STRING |
iOS bundle ID of the app |
managedShortLink.info.iosInfo.iosFallbackLink |
STRING |
Link to open on iOS if the app is not installed |
managedShortLink.info.iosInfo.iosAppStoreId |
STRING |
iOS App Store ID |
managedShortLink.info.iosInfo.iosIpadFallbackLink |
STRING |
If specified, this overrides the ios_fallback_link value on iPads |
managedShortLink.info.iosInfo.iosMinimumVersion |
STRING |
iOS minimum version |
managedShortLink.info.socialMetaTagInfo |
OBJECT |
Parameters for social meta tag params. Used to set meta tag data for link previews on social sites |
managedShortLink.info.socialMetaTagInfo.socialTitle |
STRING |
Title to be displayed. Optional |
managedShortLink.info.socialMetaTagInfo.socialImageLink |
STRING |
An image url string. Optional |
managedShortLink.info.socialMetaTagInfo.socialDescription |
STRING |
A short description of the link. Optional |
managedShortLink.info.domainUriPrefix |
STRING |
E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing |
managedShortLink.info.androidInfo |
OBJECT |
Android related attributes to the Dynamic Link |
managedShortLink.info.androidInfo.androidMinPackageVersionCode |
STRING |
Minimum version code for the Android app. If the installed app’s version code is lower, then the user is taken to the Play Store |
managedShortLink.info.androidInfo.androidLink |
STRING |
If specified, this overrides the ‘link’ parameter on Android |
managedShortLink.info.androidInfo.androidFallbackLink |
STRING |
Link to open on Android if the app is not installed |
managedShortLink.info.androidInfo.androidPackageName |
STRING |
Android package name of the app |
warning[] |
OBJECT |
Dynamic Links warning messages |
warning[].warningCode |
ENUMERATION |
The warning code |
warning[].warningMessage |
STRING |
The warning message to help developers improve their requests |
warning[].warningDocumentLink |
STRING |
The document describing the warning, and helps resolve |
= Parameter name
= Format
|
previewLink STRING Preview link to show the link flow chart. (debug info.) |
|
managedShortLink OBJECT Managed Short Link |
|
managedShortLink.link STRING Short durable link url, for example, "https://sample.app.goo.gl/xyz123". Required |
|
managedShortLink.creationTime ANY Creation timestamp of the short link |
|
managedShortLink.visibility ENUMERATION Visibility status of link |
|
managedShortLink.linkName STRING Link name defined by the creator. Required |
|
managedShortLink.flaggedAttribute[] ENUMERATION |
|
managedShortLink.info OBJECT Information about a Dynamic Link |
|
managedShortLink.info.navigationInfo OBJECT Information of navigation behavior |
|
managedShortLink.info.navigationInfo.enableForcedRedirect BOOLEAN If this option is on, FDL click will be forced to redirect rather than show an interstitial page |
|
managedShortLink.info.analyticsInfo OBJECT Tracking parameters supported by Dynamic Link |
|
managedShortLink.info.analyticsInfo.itunesConnectAnalytics OBJECT Parameters for iTunes Connect App Analytics |
|
managedShortLink.info.analyticsInfo.googlePlayAnalytics OBJECT Parameters for Google Play Campaign Measurements. Learn more |
|
managedShortLink.info.dynamicLinkDomain STRING Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix |
|
managedShortLink.info.desktopInfo OBJECT Desktop related attributes to the Dynamic Link |
|
managedShortLink.info.desktopInfo.desktopFallbackLink STRING Link to open on desktop |
|
managedShortLink.info.link STRING The link your app will open, You can specify any URL your app can handle. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or HTTPS scheme. See 'link' parameters in the documentation. Required |
|
managedShortLink.info.iosInfo OBJECT iOS related attributes to the Dynamic Link. |
|
managedShortLink.info.iosInfo.iosIpadBundleId STRING iPad bundle ID of the app |
|
managedShortLink.info.iosInfo.iosCustomScheme STRING Custom (destination) scheme to use for iOS. By default, we’ll use the bundle ID as the custom scheme. Developer can override this behavior using this param |
|
managedShortLink.info.iosInfo.iosBundleId STRING iOS bundle ID of the app |
|
managedShortLink.info.iosInfo.iosFallbackLink STRING Link to open on iOS if the app is not installed |
|
managedShortLink.info.iosInfo.iosAppStoreId STRING iOS App Store ID |
|
managedShortLink.info.iosInfo.iosIpadFallbackLink STRING If specified, this overrides the ios_fallback_link value on iPads |
|
managedShortLink.info.iosInfo.iosMinimumVersion STRING iOS minimum version |
|
managedShortLink.info.socialMetaTagInfo OBJECT Parameters for social meta tag params. Used to set meta tag data for link previews on social sites |
|
managedShortLink.info.socialMetaTagInfo.socialTitle STRING Title to be displayed. Optional |
|
managedShortLink.info.socialMetaTagInfo.socialImageLink STRING An image url string. Optional |
|
managedShortLink.info.socialMetaTagInfo.socialDescription STRING A short description of the link. Optional |
|
managedShortLink.info.domainUriPrefix STRING E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing |
|
managedShortLink.info.androidInfo OBJECT Android related attributes to the Dynamic Link |
|
managedShortLink.info.androidInfo.androidMinPackageVersionCode STRING Minimum version code for the Android app. If the installed app’s version code is lower, then the user is taken to the Play Store |
|
managedShortLink.info.androidInfo.androidLink STRING If specified, this overrides the ‘link’ parameter on Android |
|
managedShortLink.info.androidInfo.androidFallbackLink STRING Link to open on Android if the app is not installed |
|
managedShortLink.info.androidInfo.androidPackageName STRING Android package name of the app |
|
warning[] OBJECT Dynamic Links warning messages |
|
warning[].warningCode ENUMERATION The warning code |
|
warning[].warningMessage STRING The warning message to help developers improve their requests |
|
warning[].warningDocumentLink STRING The document describing the warning, and helps resolve |