Blame - docs/dyn/firebasedynamiclinks_v1.v1.html - platform/external/python/google-api-python-client

blob: 77f91b65c3146a4d1ac121586f0dc04968fe3ffa [file] [log] [blame]

Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="firebasedynamiclinks_v1.html">Firebase Dynamic Links API</a> . <a href="firebasedynamiclinks_v1.v1.html">v1</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	81	<code><a href="#getLinkStats">getLinkStats(dynamicLink, durationDays=None, sdkVersion=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	84	<code><a href="#installAttribution">installAttribution(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">Get iOS strong/weak-match info for post-install attribution.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Get iOS reopen attribution for app universal link open deeplinking.</p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	89	<h3>Method Details</h3>
				90	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<code class="details" id="close">close()</code>
				92	<pre>Close httplib2 connections.</pre>
				93	</div>
				94
				95	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	96	<code class="details" id="getLinkStats">getLinkStats(dynamicLink, durationDays=None, sdkVersion=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<pre>Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	98
				99	Args:
				100	dynamicLink: string, Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	101	durationDays: string, The span of time requested in days.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	102	sdkVersion: string, Google SDK version. Version takes the form "$major.$minor.$patch"
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	103	x__xgafv: string, V1 error format.
				104	Allowed values
				105	1 - v1 error format
				106	2 - v2 error format
				107
				108	Returns:
				109	An object of the form:
				110
				111	{ # Analytics stats of a Dynamic Link for a given timeframe.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	112	"linkEventStats": [ # Dynamic Link event stats.
				113	{ # Dynamic Link event stat.
				114	"count": "A String", # The number of times this event occurred.
				115	"event": "A String", # Link event.
				116	"platform": "A String", # Requested platform.
				117	},
				118	],
				119	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	120	</div>
				121
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	123	<code class="details" id="installAttribution">installAttribution(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	<pre>Get iOS strong/weak-match info for post-install attribution.
				125
				126	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	127	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	128	The object takes the form of:
				129
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	130	{ # Request for iSDK to execute strong match flow for post-install attribution. This is meant for iOS requests only. Requests from other platforms will not be honored.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	"appInstallationTime": "A String", # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match.
				132	"bundleId": "A String", # APP bundle ID.
				133	"device": { # Signals associated with the device making the request. # Device information.
				134	"deviceModelName": "A String", # Device model name.
				135	"languageCode": "A String", # Device language code setting.
				136	"languageCodeFromWebview": "A String", # Device language code setting obtained by executing JavaScript code in WebView.
				137	"languageCodeRaw": "A String", # Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS.
				138	"screenResolutionHeight": "A String", # Device display resolution height.
				139	"screenResolutionWidth": "A String", # Device display resolution width.
				140	"timezone": "A String", # Device timezone setting.
				141	},
				142	"iosVersion": "A String", # iOS version, ie: 9.3.5. Consider adding "build".
				143	"retrievalMethod": "A String", # App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link.
				144	"sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
				145	"uniqueMatchLinkToCheck": "A String", # Possible unique matched link that server need to check before performing fingerprint match. If passed link is short server need to expand the link. If link is long server need to vslidate the link.
				146	"visualStyle": "A String", # Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie.
				147	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148
				149	x__xgafv: string, V1 error format.
				150	Allowed values
				151	1 - v1 error format
				152	2 - v2 error format
				153
				154	Returns:
				155	An object of the form:
				156
				157	{ # Response for iSDK to execute strong match flow for post-install attribution.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	158	"appMinimumVersion": "A String", # The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this.
				159	"attributionConfidence": "A String", # The confidence of the returned attribution.
				160	"deepLink": "A String", # The deep-link attributed post-install via one of several techniques (fingerprint, copy unique).
				161	"externalBrowserDestinationLink": "A String", # User-agent specific custom-scheme URIs for iSDK to open. This will be set according to the user-agent tha the click was originally made in. There is no Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com
				162	"fallbackLink": "A String", # The link to navigate to update the app if min version is not met. This is either (in order): 1) fallback link (from ?ifl= parameter, if specified by developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the payload link (from required link= parameter).
				163	"invitationId": "A String", # Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique).
				164	"isStrongMatchExecutable": True or False, # Instruction for iSDK to attemmpt to perform strong match. For instance, if browser does not support/allow cookie or outside of support browsers, this will be false.
				165	"matchMessage": "A String", # Describes why match failed, ie: "discarded due to low confidence". This message will be publicly visible.
				166	"requestIpVersion": "A String", # Which IP version the request was made from.
				167	"requestedLink": "A String", # Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique).
				168	"resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long. Parameters from this should not be used directly (ie: server can default utm_[campaign\|medium\|source] to a value when requested_link lack them, server determine the best fallback_link when requested_link specifies >1 fallback links).
				169	"utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at post-install.
				170	"utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
				171	"utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at post-install.
				172	"utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at post-install.
				173	"utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
				174	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	175	</div>
				176
				177	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	178	<code class="details" id="reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	179	<pre>Get iOS reopen attribution for app universal link open deeplinking.
				180
				181	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	182	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	183	The object takes the form of:
				184
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	185	{ # Request for iSDK to get reopen attribution for app universal link open deeplinking. This endpoint is meant for only iOS requests.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	"bundleId": "A String", # APP bundle ID.
				187	"requestedLink": "A String", # FDL link to be verified from an app universal link open. The FDL link can be one of: 1) short FDL. e.g. .page.link/, or 2) long FDL. e.g. .page.link/?{query params}, or 3) Invite FDL. e.g. .page.link/i/
				188	"sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
				189	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	190
				191	x__xgafv: string, V1 error format.
				192	Allowed values
				193	1 - v1 error format
				194	2 - v2 error format
				195
				196	Returns:
				197	An object of the form:
				198
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	{ # Response for iSDK to get reopen attribution for app universal link open deeplinking. This endpoint is meant for only iOS requests.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	200	"deepLink": "A String", # The deep-link attributed the app universal link open. For both regular FDL links and invite FDL links.
				201	"invitationId": "A String", # Optional invitation ID, for only invite typed requested FDL links.
				202	"iosMinAppVersion": "A String", # FDL input value of the "&imv=" parameter, minimum app version to be returned to Google Firebase SDK running on iOS-9.
				203	"resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long.
				204	"utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at app-reopen.
				205	"utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
				206	"utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at app-reopen.
				207	"utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at app-reopen.
				208	"utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
				209	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	210	</div>
				211
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	212	</body></html>