"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.",
"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.",
"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.",
"type":"string",
"location":"query"
},
"access_token":{
"type":"string",
"location":"query",
"description":"OAuth access token."
},
"quotaUser":{
"type":"string",
"location":"query",
"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."
},
"pp":{
"description":"Pretty-print response.",
"type":"boolean",
"default":"true",
"location":"query"
},
"bearer_token":{
"location":"query",
"description":"OAuth bearer token.",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"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.",
"description":"iOS related attributes to the Dynamic Link..",
"type":"object"
},
"AnalyticsInfo":{
"description":"Tracking parameters supported by Dynamic Link.",
"type":"object",
"properties":{
"googlePlayAnalytics":{
"$ref":"GooglePlayAnalytics",
"description":"Google Play Campaign Measurements."
},
"itunesConnectAnalytics":{
"$ref":"ITunesConnectAnalytics",
"description":"iTunes Connect App Analytics."
}
},
"id":"AnalyticsInfo"
},
"CreateShortDynamicLinkRequest":{
"id":"CreateShortDynamicLinkRequest",
"description":"Request to create a short Dynamic Link.",
"type":"object",
"properties":{
"longDynamicLink":{
"description":"Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
"description":"Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
"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"
},
"appInstallationTime":{
"description":"App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.",
"description":"Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.",
"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."
"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."
"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":"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.",
"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.",
"description":"iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
"description":"Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
"description":"Information of navigation behavior of a Firebase Dynamic Links."
},
"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)."
"description":"Response for iSDK to execute strong match flow for post-install attribution.",
"type":"object",
"properties":{
"utmCampaign":{
"description":"Scion campaign value to be propagated by iSDK to Scion at post-install.",
"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"
},
"requestedLink":{
"description":"Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
"type":"string"
},
"utmMedium":{
"description":"Scion medium value to be propagated by iSDK to Scion at post-install.",
"type":"string"
},
"utmSource":{
"description":"Scion source value to be propagated by iSDK to Scion at post-install.",
"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"
},
"appMinimumVersion":{
"type":"string",
"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."
},
"invitationId":{
"description":"Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
"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"
},
"attributionConfidence":{
"enum":[
"UNKNOWN_ATTRIBUTION_CONFIDENCE",
"WEAK",
"DEFAULT",
"UNIQUE"
],
"description":"The confidence of the returned attribution.",
"type":"string",
"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"
]
},
"matchMessage":{
"description":"Describes why match failed, ie: \"discarded due to low confidence\".\nThis message will be publicly visible.",
"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"
}
},
"id":"GetIosPostInstallAttributionResponse"
},
"SocialMetaTagInfo":{
"description":"Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
"type":"object",
"properties":{
"socialTitle":{
"type":"string",
"description":"Title to be displayed. Optional."
},
"socialImageLink":{
"description":"An image url string. Optional.",
"type":"string"
},
"socialDescription":{
"description":"A short description of the link. Optional.",
"type":"string"
}
},
"id":"SocialMetaTagInfo"
},
"DynamicLinkStats":{
"properties":{
"linkEventStats":{
"description":"Dynamic Link event stats.",
"type":"array",
"items":{
"$ref":"DynamicLinkEventStat"
}
}
},
"id":"DynamicLinkStats",
"description":"Analytics stats of a Dynamic Link for a given timeframe.",
"type":"object"
},
"DynamicLinkWarning":{
"description":"Dynamic Links warning messages.",
"type":"object",
"properties":{
"warningMessage":{
"description":"The warning message to help developers improve their requests.",
"type":"string"
},
"warningDocumentLink":{
"type":"string",
"description":"The document describing the warning, and helps resolve."
},
"warningCode":{
"description":"The warning code.",
"type":"string",
"enumDescriptions":[
"Unknown code.",
"The Android package does not match any in developer's DevConsole project.",
"The Android minimum version code has to be a valid integer.",
"Android package min version param is not needed, e.g. when\n'apn' is missing.",
"Android link is not a valid URI.",
"Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
"Android fallback link is not a valid URI.",
"Android fallback link has an invalid (non http/https) URI scheme.",
"The iOS bundle ID does not match any in developer's DevConsole project.",
"The iPad bundle ID does not match any in developer's DevConsole project.",
"iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
"iOS app store ID format is incorrect, e.g. not numeric.",
"iOS app store ID is not needed.",
"iOS fallback link is not a valid URI.",
"iOS fallback link has an invalid (non http/https) URI scheme.",
"iPad fallback link is not a valid URI.",
"iPad fallback link has an invalid (non http/https) URI scheme.",
"Debug param format is incorrect.",
"isAd param format is incorrect.",
"Indicates a certain param is deprecated.",
"Indicates certain paramater is not recognized.",
"Indicates certain paramater is too long.",
"Social meta tag image link is not a valid URI.",
"Social meta tag image link has an invalid (non http/https) URI scheme.",
"",
"",
"Dynamic Link URL length is too long.",
"Dynamic Link URL contains fragments.",
"The iOS bundle ID does not match with the given iOS store ID."
],
"enum":[
"CODE_UNSPECIFIED",
"NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
"NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION",
"UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION",
"NOT_URI_ANDROID_LINK",
"UNNECESSARY_ANDROID_LINK",
"NOT_URI_ANDROID_FALLBACK_LINK",
"BAD_URI_SCHEME_ANDROID_FALLBACK_LINK",
"NOT_IN_PROJECT_IOS_BUNDLE_ID",
"NOT_IN_PROJECT_IPAD_BUNDLE_ID",
"UNNECESSARY_IOS_URL_SCHEME",
"NOT_NUMERIC_IOS_APP_STORE_ID",
"UNNECESSARY_IOS_APP_STORE_ID",
"NOT_URI_IOS_FALLBACK_LINK",
"BAD_URI_SCHEME_IOS_FALLBACK_LINK",
"NOT_URI_IPAD_FALLBACK_LINK",
"BAD_URI_SCHEME_IPAD_FALLBACK_LINK",
"BAD_DEBUG_PARAM",
"BAD_AD_PARAM",
"DEPRECATED_PARAM",
"UNRECOGNIZED_PARAM",
"TOO_LONG_PARAM",
"NOT_URI_SOCIAL_IMAGE_LINK",
"BAD_URI_SCHEME_SOCIAL_IMAGE_LINK",
"NOT_URI_SOCIAL_URL",
"BAD_URI_SCHEME_SOCIAL_URL",
"LINK_LENGTH_TOO_LONG",
"LINK_WITH_FRAGMENTS",
"NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID"
]
}
},
"id":"DynamicLinkWarning"
},
"AndroidInfo":{
"id":"AndroidInfo",
"description":"Android related attributes to the Dynamic Link.",
"type":"object",
"properties":{
"androidFallbackLink":{
"description":"Link to open on Android if the app is not installed.",
"type":"string"
},
"androidPackageName":{
"description":"Android package name of the app.",
"type":"string"
},
"androidMinPackageVersionCode":{
"description":"Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
"type":"string"
},
"androidLink":{
"type":"string",
"description":"If specified, this overrides the ‘link’ parameter on Android."
