"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"description":"Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
"flatPath":"v1/shortLinks",
"httpMethod":"POST",
"id":"firebasedynamiclinks.shortLinks.create",
"parameterOrder":[],
"parameters":{},
"path":"v1/shortLinks",
"request":{
"$ref":"CreateShortDynamicLinkRequest"
},
"response":{
"$ref":"CreateShortDynamicLinkResponse"
},
"scopes":[
"https://www.googleapis.com/auth/firebase"
]
}
}
},
"v1":{
"methods":{
"getLinkStats":{
"description":"Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
"flatPath":"v1/{dynamicLink}/linkStats",
"httpMethod":"GET",
"id":"firebasedynamiclinks.getLinkStats",
"parameterOrder":[
"dynamicLink"
],
"parameters":{
"durationDays":{
"description":"The span of time requested in days.",
"format":"int64",
"location":"query",
"type":"string"
},
"dynamicLink":{
"description":"Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"v1/{dynamicLink}/linkStats",
"response":{
"$ref":"DynamicLinkStats"
},
"scopes":[
"https://www.googleapis.com/auth/firebase"
]
},
"installAttribution":{
"description":"Get iOS strong/weak-match info for post-install attribution.",
"description":"Request to create a short Dynamic Link.",
"id":"CreateShortDynamicLinkRequest",
"properties":{
"dynamicLinkInfo":{
"$ref":"DynamicLinkInfo",
"description":"Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener)."
"description":"Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com\u0026apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener).",
"type":"string"
},
"suffix":{
"$ref":"Suffix",
"description":"Short Dynamic Link suffix. Optional."
}
},
"type":"object"
},
"CreateShortDynamicLinkResponse":{
"description":"Response to create a short Dynamic Link.",
"id":"CreateShortDynamicLinkResponse",
"properties":{
"previewLink":{
"description":"Preivew link to show the link flow chart.",
"type":"string"
},
"shortLink":{
"description":"Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
"type":"string"
},
"warning":{
"description":"Information about potential warnings on link creation.",
"items":{
"$ref":"DynamicLinkWarning"
},
"type":"array"
}
},
"type":"object"
},
"DesktopInfo":{
"description":"Desktop related attributes to the Dynamic Link.",
"id":"DesktopInfo",
"properties":{
"desktopFallbackLink":{
"description":"Link to open on desktop.",
"type":"string"
}
},
"type":"object"
},
"DeviceInfo":{
"description":"Signals associated with the device making the request.",
"id":"DeviceInfo",
"properties":{
"deviceModelName":{
"description":"Device model name.",
"type":"string"
},
"languageCode":{
"description":"Device language code setting.",
"type":"string"
},
"languageCodeFromWebview":{
"description":"Device language code setting obtained by executing JavaScript code in\nWebView.",
"type":"string"
},
"languageCodeRaw":{
"description":"Device language code raw setting.\niOS does returns language code in different format than iOS WebView.\nFor example WebView returns en_US, but iOS returns en-US.\nField below will return raw value returned by iOS.",
"Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
"Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.",
"Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory."
],
"type":"string"
}
},
"type":"object"
},
"DynamicLinkInfo":{
"description":"Information about a Dynamic Link.",
"id":"DynamicLinkInfo",
"properties":{
"analyticsInfo":{
"$ref":"AnalyticsInfo",
"description":"Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
},
"androidInfo":{
"$ref":"AndroidInfo",
"description":"Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
},
"desktopInfo":{
"$ref":"DesktopInfo",
"description":"Desktop related information. See desktop related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
},
"dynamicLinkDomain":{
"description":"Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android/receive)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
"type":"string"
},
"iosInfo":{
"$ref":"IosInfo",
"description":"iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
},
"link":{
"description":"The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).\n\nRequired.",
"type":"string"
},
"navigationInfo":{
"$ref":"NavigationInfo",
"description":"Information of navigation behavior of a Firebase Dynamic Links."
},
"socialMetaTagInfo":{
"$ref":"SocialMetaTagInfo",
"description":"Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites."
"description":"Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
"description":"Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.",
"type":"string"
},
"visualStyle":{
"description":"Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.",
"enum":[
"UNKNOWN_VISUAL_STYLE",
"DEFAULT_STYLE",
"CUSTOM_STYLE"
],
"enumDescriptions":[
"Unknown style.",
"Default style.",
"Custom style."
],
"type":"string"
}
},
"type":"object"
},
"GetIosPostInstallAttributionResponse":{
"description":"Response for iSDK to execute strong match flow for post-install attribution.",
"id":"GetIosPostInstallAttributionResponse",
"properties":{
"appMinimumVersion":{
"description":"The minimum version for app, specified by dev through ?imv= parameter.\nReturn to iSDK to allow app to evaluate if current version meets this.",
"type":"string"
},
"attributionConfidence":{
"description":"The confidence of the returned attribution.",
"enum":[
"UNKNOWN_ATTRIBUTION_CONFIDENCE",
"WEAK",
"DEFAULT",
"UNIQUE"
],
"enumDescriptions":[
"Unset.",
"Weak confidence, more than one matching link found or link suspected to\nbe false positive",
"Default confidence, match based on fingerprint",
"Unique confidence, match based on \"unique match link to check\" or other\nmeans"
],
"type":"string"
},
"deepLink":{
"description":"The deep-link attributed post-install via one of several techniques\n(fingerprint, copy unique).",
"type":"string"
},
"externalBrowserDestinationLink":{
"description":"User-agent specific custom-scheme URIs for iSDK to open. This will be set\naccording to the user-agent tha the click was originally made in. There is\nno Safari-equivalent custom-scheme open URLs.\nie: googlechrome://www.example.com\nie: firefox://open-url?url=http://www.example.com\nie: opera-http://example.com",
"type":"string"
},
"fallbackLink":{
"description":"The link to navigate to update the app if min version is not met.\nThis is either (in order): 1) fallback link (from ?ifl= parameter, if\nspecified by developer) or 2) AppStore URL (from ?isi= parameter, if\nspecified), or 3) the payload link (from required link= parameter).",
"type":"string"
},
"invitationId":{
"description":"Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
"type":"string"
},
"isStrongMatchExecutable":{
"description":"Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false.",
"type":"boolean"
},
"matchMessage":{
"description":"Describes why match failed, ie: \"discarded due to low confidence\".\nThis message will be publicly visible.",
"type":"string"
},
"requestedLink":{
"description":"Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
"type":"string"
},
"resolvedLink":{
"description":"The entire FDL, expanded from a short link. It is the same as the\nrequested_link, if it is long. Parameters from this should not be\nused directly (ie: server can default utm_[campaign|medium|source]\nto a value when requested_link lack them, server determine the best\nfallback_link when requested_link specifies \u003e1 fallback links).",
"type":"string"
},
"utmCampaign":{
"description":"Scion campaign value to be propagated by iSDK to Scion at post-install.",
"description":"Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
"description":"[AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords ads. This value is generated dynamically\nand should never be modified.",
"description":"Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
"The suffix option is not specified, performs as NOT_GUESSABLE .",
"Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
"Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
