Python client for Firebase Dynamic Links API
Project description
firebase-dynamic-link-generator
Simple python client to generate Firebase Dynamic Links. It allows to use a custom domain and fields for generate links for android and ios.
Requirements
- Python >= 3.8
- PIP
- API Key from Firebase console Settings page.
Installation
pip3 install firebase-dynamic-links-generator
Usage
from firebase_dynamic_link_generator import GenerateFirebaseDynamicLink
SERVICE_FILE = 'YOUR_SERVICE_ACCOUNT_JSON_FILE_PATH'
DOMAIN = 'example.page.link' ## need to setup in firebase dynamic link
NAME = "NAME_OF_LINK" ## name of the link
fdl = GenerateFirebaseDynamicLink(DOMAIN, SERVICE_FILE, NAME)
linkinfo_params = {
"androidInfo": {
"androidPackageName": 'PACKAGE_NAME',
"androidFallbackLink": 'FALL_BACK_LINK',
"androidMinPackageVersionCode": '1'
},
}
## for short link
short_link = fdl.generate_dynamic_link('http://google.com', linkinfo_params) #https://example.page.link/h77c
## custom short link
suffix_params = {
"option": "CUSTOM", ## SHORT or UNGUESSABLE
"customSuffix": "CT2213" ## for custom suffix valye
}
short_link = fdl.generate_dynamic_link('http://google.com', linkinfo_params, suffix_params) #https://example.page.link/CT2213
api_key
: Key from firebase consoledomain
: Domain uri prefix created in firebase console - Dynamic Link. For exampleexample.page.link
or your custom domain.linkinfo_params
: Dictionary of optional params. For example:
{
"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_params
: Dictionary of optional params. For example:
{
"option": "SHORT" or "UNGUESSABLE" or "CUSTOM",
"customSuffix": string,
}
Reference
https://firebase.google.com/docs/dynamic-links/rest
https://firebase.google.com/docs/reference/dynamic-links/link-shortener
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for firebase_dynamic_links_generator-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e72f25aa0a61be54afcc46d1a7f6750955574209dcc17847a3ae5fe611193c0 |
|
MD5 | 1e91e64a94dd32970f6462dfa9069057 |
|
BLAKE2b-256 | 2fee025a870d7a379d958c3221bfc968c653b11a89cc41c5e38bf56929b02cf7 |