Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / firebasedynamiclinks_v1.v1.html
blob: df601a1343723411f7405d35344cf4b1c3a608da [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Frenkel3e17f892020-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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]81 <code><a href="#getLinkStats">getLinkStats(dynamicLink, sdkVersion=None, durationDays=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#installAttribution">installAttribution(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-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'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Get iOS reopen attribution for app universal link open deeplinking.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]96 <code class="details" id="getLinkStats">getLinkStats(dynamicLink, sdkVersion=None, durationDays=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-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 Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]98
99Args:
100 dynamicLink: string, Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 sdkVersion: string, Google SDK version. Version takes the form &quot;$major.$minor.$patch&quot;
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]102 durationDays: string, The span of time requested in days.
Sai Cheemalapati4ba8c232017-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
108Returns:
109 An object of the form:
110
111 { # Analytics stats of a Dynamic Link for a given timeframe.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;linkEventStats&quot;: [ # Dynamic Link event stats.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]113 { # Dynamic Link event stat.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;count&quot;: &quot;A String&quot;, # The number of times this event occurred.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]115 &quot;platform&quot;: &quot;A String&quot;, # Requested platform.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]116 &quot;event&quot;: &quot;A String&quot;, # Link event.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]117 },
118 ],
119 }</pre>
120</div>
121
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 <code class="details" id="installAttribution">installAttribution(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 <pre>Get iOS strong/weak-match info for post-install attribution.
125
126Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]127 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 The object takes the form of:
129
Dmitry Frenkel3e17f892020-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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]131 &quot;visualStyle&quot;: &quot;A String&quot;, # Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 &quot;bundleId&quot;: &quot;A String&quot;, # APP bundle ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]133 &quot;sdkVersion&quot;: &quot;A String&quot;, # Google SDK version. Version takes the form &quot;$major.$minor.$patch&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]134 &quot;uniqueMatchLinkToCheck&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]135 &quot;device&quot;: { # Signals associated with the device making the request. # Device information.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 &quot;languageCodeRaw&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 &quot;deviceModelName&quot;: &quot;A String&quot;, # Device model name.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]138 &quot;screenResolutionHeight&quot;: &quot;A String&quot;, # Device display resolution height.
139 &quot;languageCode&quot;: &quot;A String&quot;, # Device language code setting.
140 &quot;timezone&quot;: &quot;A String&quot;, # Device timezone setting.
141 &quot;languageCodeFromWebview&quot;: &quot;A String&quot;, # Device language code setting obtained by executing JavaScript code in WebView.
142 &quot;screenResolutionWidth&quot;: &quot;A String&quot;, # Device display resolution width.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]143 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]144 &quot;appInstallationTime&quot;: &quot;A String&quot;, # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match.
145 &quot;iosVersion&quot;: &quot;A String&quot;, # iOS version, ie: 9.3.5. Consider adding &quot;build&quot;.
146 &quot;retrievalMethod&quot;: &quot;A String&quot;, # App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 }
148
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # Response for iSDK to execute strong match flow for post-install attribution.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]158 &quot;utmSource&quot;: &quot;A String&quot;, # Scion source value to be propagated by iSDK to Scion at post-install.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]159 &quot;invitationId&quot;: &quot;A String&quot;, # Invitation ID attributed post-install via one of several techniques (fingerprint, copy unique).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]160 &quot;isStrongMatchExecutable&quot;: 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.
161 &quot;fallbackLink&quot;: &quot;A String&quot;, # 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).
162 &quot;utmTerm&quot;: &quot;A String&quot;, # Scion term value to be propagated by iSDK to Scion at app-reopen.
163 &quot;appMinimumVersion&quot;: &quot;A String&quot;, # The minimum version for app, specified by dev through ?imv= parameter. Return to iSDK to allow app to evaluate if current version meets this.
164 &quot;deepLink&quot;: &quot;A String&quot;, # The deep-link attributed post-install via one of several techniques (fingerprint, copy unique).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]165 &quot;utmMedium&quot;: &quot;A String&quot;, # Scion medium value to be propagated by iSDK to Scion at post-install.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]166 &quot;attributionConfidence&quot;: &quot;A String&quot;, # The confidence of the returned attribution.
167 &quot;externalBrowserDestinationLink&quot;: &quot;A String&quot;, # 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
168 &quot;utmContent&quot;: &quot;A String&quot;, # Scion content value to be propagated by iSDK to Scion at app-reopen.
169 &quot;matchMessage&quot;: &quot;A String&quot;, # Describes why match failed, ie: &quot;discarded due to low confidence&quot;. This message will be publicly visible.
170 &quot;resolvedLink&quot;: &quot;A String&quot;, # 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 &gt;1 fallback links).
171 &quot;requestedLink&quot;: &quot;A String&quot;, # Entire FDL (short or long) attributed post-install via one of several techniques (fingerprint, copy unique).
172 &quot;requestIpVersion&quot;: &quot;A String&quot;, # Which IP version the request was made from.
173 &quot;utmCampaign&quot;: &quot;A String&quot;, # Scion campaign value to be propagated by iSDK to Scion at post-install.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 }</pre>
175</div>
176
177<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]178 <code class="details" id="reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 <pre>Get iOS reopen attribution for app universal link open deeplinking.
180
181Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]182 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 The object takes the form of:
184
Dmitry Frenkel3e17f892020-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.
186 &quot;requestedLink&quot;: &quot;A String&quot;, # 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/
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]187 &quot;bundleId&quot;: &quot;A String&quot;, # APP bundle ID.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]188 &quot;sdkVersion&quot;: &quot;A String&quot;, # Google SDK version. Version takes the form &quot;$major.$minor.$patch&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 }
190
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196Returns:
197 An object of the form:
198
Dmitry Frenkel3e17f892020-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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]200 &quot;utmContent&quot;: &quot;A String&quot;, # Scion content value to be propagated by iSDK to Scion at app-reopen.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]201 &quot;utmSource&quot;: &quot;A String&quot;, # Scion source value to be propagated by iSDK to Scion at app-reopen.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]202 &quot;deepLink&quot;: &quot;A String&quot;, # The deep-link attributed the app universal link open. For both regular FDL links and invite FDL links.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]203 &quot;resolvedLink&quot;: &quot;A String&quot;, # The entire FDL, expanded from a short link. It is the same as the requested_link, if it is long.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]204 &quot;iosMinAppVersion&quot;: &quot;A String&quot;, # FDL input value of the &quot;&amp;imv=&quot; parameter, minimum app version to be returned to Google Firebase SDK running on iOS-9.
205 &quot;utmMedium&quot;: &quot;A String&quot;, # Scion medium value to be propagated by iSDK to Scion at app-reopen.
206 &quot;utmTerm&quot;: &quot;A String&quot;, # Scion term value to be propagated by iSDK to Scion at app-reopen.
207 &quot;utmCampaign&quot;: &quot;A String&quot;, # Scion campaign value to be propagated by iSDK to Scion at app-reopen.
208 &quot;invitationId&quot;: &quot;A String&quot;, # Optional invitation ID, for only invite typed requested FDL links.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 }</pre>
210</div>
211
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]212</body></html>