Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / firebasedynamiclinks_v1.v1.html
blob: 3dec584bd0bf59cea256fde1ab5d0ce5e17ff2e8 [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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#getLinkStats">getLinkStats(dynamicLink, sdkVersion=None, durationDays=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]79<p class="firstline">Fetches analytics stats of a short Dynamic Link for a given</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#installAttribution">installAttribution(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Get iOS strong/weak-match info for post-install attribution.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#reopenAttribution">reopenAttribution(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 reopen attribution for app universal link open deeplinking.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88 <code class="details" id="getLinkStats">getLinkStats(dynamicLink, sdkVersion=None, durationDays=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]89 <pre>Fetches analytics stats of a short Dynamic Link for a given
90duration. Metrics include number of clicks, redirects, installs,
91app first opens, and app reopens.
92
93Args:
94 dynamicLink: string, Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 sdkVersion: string, Google SDK version. Version takes the form "$major.$minor.$patch"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]96 durationDays: string, The span of time requested in days.
97 x__xgafv: string, V1 error format.
98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
101
102Returns:
103 An object of the form:
104
105 { # Analytics stats of a Dynamic Link for a given timeframe.
106 "linkEventStats": [ # Dynamic Link event stats.
107 { # Dynamic Link event stat.
108 "count": "A String", # The number of times this event occurred.
109 "platform": "A String", # Requested platform.
110 "event": "A String", # Link event.
111 },
112 ],
113 }</pre>
114</div>
115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 <code class="details" id="installAttribution">installAttribution(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 <pre>Get iOS strong/weak-match info for post-install attribution.
119
120Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 The object takes the form of:
123
124{ # Request for iSDK to execute strong match flow for post-install attribution.
125 # This is meant for iOS requests only. Requests from other platforms will
126 # not be honored.
127 "visualStyle": "A String", # Strong match page information. Disambiguates between default UI and
128 # custom page to present when strong match succeeds/fails to find cookie.
129 "sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
130 "appInstallationTime": "A String", # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).
131 # This is a client signal for a more accurate weak match.
132 "uniqueMatchLinkToCheck": "A String", # Possible unique matched link that server need to check before performing
133 # fingerprint match. If passed link is short server need to expand the link.
134 # If link is long server need to vslidate the link.
135 "device": { # Signals associated with the device making the request. # Device information.
136 "languageCode": "A String", # Device language code setting.
137 "languageCodeRaw": "A String", # Device language code raw setting.
138 # iOS does returns language code in different format than iOS WebView.
139 # For example WebView returns en_US, but iOS returns en-US.
140 # Field below will return raw value returned by iOS.
141 "deviceModelName": "A String", # Device model name.
142 "languageCodeFromWebview": "A String", # Device language code setting obtained by executing JavaScript code in
143 # WebView.
144 "screenResolutionHeight": "A String", # Device display resolution height.
145 "timezone": "A String", # Device timezone setting.
146 "screenResolutionWidth": "A String", # Device display resolution width.
147 },
148 "retrievalMethod": "A String", # App post install attribution retrieval information. Disambiguates
149 # mechanism (iSDK or developer invoked) to retrieve payload from
150 # clicked link.
151 "iosVersion": "A String", # iOS version, ie: 9.3.5.
152 # Consider adding "build".
153 "bundleId": "A String", # APP bundle ID.
154 }
155
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161Returns:
162 An object of the form:
163
164 { # Response for iSDK to execute strong match flow for post-install attribution.
165 "utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at post-install.
166 "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at post-install.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "appMinimumVersion": "A String", # The minimum version for app, specified by dev through ?imv= parameter.
168 # Return to iSDK to allow app to evaluate if current version meets this.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 "attributionConfidence": "A String", # The confidence of the returned attribution.
170 "externalBrowserDestinationLink": "A String", # User-agent specific custom-scheme URIs for iSDK to open. This will be set
171 # according to the user-agent tha the click was originally made in. There is
172 # no Safari-equivalent custom-scheme open URLs.
173 # ie: googlechrome://www.example.com
174 # ie: firefox://open-url?url=http://www.example.com
175 # ie: opera-http://example.com
176 "isStrongMatchExecutable": True or False, # Instruction for iSDK to attemmpt to perform strong match. For instance,
177 # if browser does not support/allow cookie or outside of support browsers,
178 # this will be false.
179 "requestIpVersion": "A String", # Which IP version the request was made from.
180 "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
181 "utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
182 "invitationId": "A String", # Invitation ID attributed post-install via one of several techniques
183 # (fingerprint, copy unique).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the
185 # requested_link, if it is long. Parameters from this should not be
186 # used directly (ie: server can default utm_[campaign|medium|source]
187 # to a value when requested_link lack them, server determine the best
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]188 # fallback_link when requested_link specifies &gt;1 fallback links).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 "requestedLink": "A String", # Entire FDL (short or long) attributed post-install via one of several
190 # techniques (fingerprint, copy unique).
191 "fallbackLink": "A String", # The link to navigate to update the app if min version is not met.
192 # This is either (in order): 1) fallback link (from ?ifl= parameter, if
193 # specified by developer) or 2) AppStore URL (from ?isi= parameter, if
194 # specified), or 3) the payload link (from required link= parameter).
195 "utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at post-install.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 "matchMessage": "A String", # Describes why match failed, ie: "discarded due to low confidence".
197 # This message will be publicly visible.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 "deepLink": "A String", # The deep-link attributed post-install via one of several techniques
199 # (fingerprint, copy unique).
200 }</pre>
201</div>
202
203<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]204 <code class="details" id="reopenAttribution">reopenAttribution(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 <pre>Get iOS reopen attribution for app universal link open deeplinking.
206
207Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]208 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 The object takes the form of:
210
211{ # Request for iSDK to get reopen attribution for app universal link open
212 # deeplinking. This endpoint is meant for only iOS requests.
213 "sdkVersion": "A String", # Google SDK version. Version takes the form "$major.$minor.$patch"
214 "requestedLink": "A String", # FDL link to be verified from an app universal link open.
215 # The FDL link can be one of:
216 # 1) short FDL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]217 # e.g. &lt;app_code&gt;.page.link/&lt;ddl_id&gt;, or
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 # 2) long FDL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 # e.g. &lt;app_code&gt;.page.link/?{query params}, or
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 # 3) Invite FDL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]221 # e.g. &lt;app_code&gt;.page.link/i/&lt;invite_id_or_alias&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "bundleId": "A String", # APP bundle ID.
223 }
224
225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
229
230Returns:
231 An object of the form:
232
233 { # Response for iSDK to get reopen attribution for app universal link open
234 # deeplinking. This endpoint is meant for only iOS requests.
235 "utmMedium": "A String", # Scion medium value to be propagated by iSDK to Scion at app-reopen.
236 "utmSource": "A String", # Scion source value to be propagated by iSDK to Scion at app-reopen.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]237 "iosMinAppVersion": "A String", # FDL input value of the "&amp;imv=" parameter, minimum app version to be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 # returned to Google Firebase SDK running on iOS-9.
239 "utmTerm": "A String", # Scion term value to be propagated by iSDK to Scion at app-reopen.
240 "utmContent": "A String", # Scion content value to be propagated by iSDK to Scion at app-reopen.
241 "invitationId": "A String", # Optional invitation ID, for only invite typed requested FDL links.
242 "resolvedLink": "A String", # The entire FDL, expanded from a short link. It is the same as the
243 # requested_link, if it is long.
244 "utmCampaign": "A String", # Scion campaign value to be propagated by iSDK to Scion at app-reopen.
245 "deepLink": "A String", # The deep-link attributed the app universal link open. For both regular
246 # FDL links and invite FDL links.
247 }</pre>
248</div>
249
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]250</body></html>