@ -25,12 +25,17 @@ Who will have Leanplum enabled?
Users who have a device locale listed in the following code snippet will have Leanplum enabled: https://github.com/mozilla-mobile/firefox-ios/blob/master/Client/Application/LeanplumIntegration.swift
--- ^ Note: NEED TO CONFIRM WITH ENG ---
Where does data sent to the Leanplum backend go?
==============================================
The Leanplum SDK is hard-coded to send data to the endpoint https://www.leanplum.com. The endpoint is
defined by ``com.leanplum.internal.Constants.API_HOST_NAME`` at
The user is identified by Leanplum using a random UUID generated by Apple when Leanplum is initialized for the first time (see https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor).
@ -43,6 +48,7 @@ What data is collected and sent to the Leanplum backend?
The Leanplum SDK collects and sends the following information at various times while the SDK is in use.
Sent every time when an event is triggered:
--- Note: NEED TO CONFIRM WITH ENG ---
~~~~~~~~~~~~~~~
"action" -> "track" // track: an event is tracked.
"event" -> "Launch" // Used when an event is triggered. e.g. E_Saved_Bookmark.
@ -52,23 +58,22 @@ Sent every time when an event is triggered:
"timezoneOffsetSeconds" -> "28800" // User timezone offset with PST.
"deviceName" -> "sdaswani-31710" // System device name.
"region" -> "(detect)" // Not used. We strip location so this is will be the default stub value in Leanplum SDK.
@ -80,13 +85,16 @@ Sent when the app starts:
~~~~~~~~~~~~~~~
Sent every time a session is renewed or has a state change:
--- Note: NEED TO CONFIRM WITH ENG ---
~~~~~~~~~~~~~~~
"action" -> "heartbeat" // heartbeat: every 15 minutes when app is in the foreground
// pauseSession: when app goes to background
// resumeSession: when app goes to foreground
~~~~~~~~~~~~~~~
Sent for every Message:
--- Note: NEED TO CONFIRM WITH ENG ---
~~~~~~~~~~~~~~~
"userId" -> "b13b3c239d01aa7c" // Set by Fennec, we use random uuid so users are anonymous to Leanplum.
"deviceId" -> "b13b3c239d01aa7c" // Same as above.
@ -100,6 +108,7 @@ Notes on what data is collected
===============================
User Identifier
---------------
--- Note: NEED TO CONFIRM WITH ENG ---
Since Device ID is a random UUID, Leanplum can't map the device to any know Client ID in Fennec nor Advertising ID.
Events
@ -111,6 +120,8 @@ Default value for event value is 0.0. Default value for event info is empty stri
Here is the list of current Events sent, which can be found here in the code base: https://github.com/mozilla-mobile/firefox-ios/blob/master/Client/Application/LeanplumIntegration.swift#L21
^ --- Note: NEED TO CONFIRM WITH ENG WHAT THE URL SHOULD BE ---
The first launch after install
~~~~
{
@ -118,12 +129,6 @@ The first launch after install
}
~~~~
The second launch after install
~~~~
{
"event": "E_Second_Run"
}
~~~~
Whenever the App is launched.
~~~~
@ -132,29 +137,6 @@ Whenever the App is launched.
}
~~~~
The user loads a bookmark from home panel.
~~~~
{
"event": "E_Opened_Bookmark"
}
~~~~
The user opened a new tab.
~~~~
{
"event": "E_Opened_New_Tab"
}
~~~~
The user opens a Pocket trending story
~~~~
{
"event": "E_Opened_Pocket_Story"
}
~~~~
The user interacts with search url area.
~~~~
{
@ -162,33 +144,6 @@ The user interacts with search url area.
}
~~~~
The user saves a bookmark.
~~~~
{
"event": "E_Saved_Bookmark"
}
~~~~
The user opened a mailto link from a web page.
~~~~
{
"event": "E_Opened_Mailto_Link"
}
~~~~
The user cleared their private data.
~~~~
{
"event": "E_Cleared_Private_Data"
}
~~~~
Download videos or any other media
~~~~
{
"event": "E_Download_Media_Saved_Image"
}
~~~~
Save password and login from door hanger
~~~~
@ -199,19 +154,16 @@ Save password and login from door hanger
Deep Links
----------
--- Note: NEED TO CONFIRM WITH ENG WHICH TRIGGERS HAVE BEEN ADDED ---
Deep links are actions that can point Firefox to open certain pages or load features such as `show bookmark list` or
`open Firefox Account Settings`. When users receives a Message, they can click the button(s) on it. These buttons can
trigger the following deep links:
* Link to sync signup/sign in (firefox://deep-link?url=settings/fxa)
* Link to set default browser (firefox://default_browser?uid={{User ID}})
* Link to default search engine settings (firefox://deep-link?url=settings/search)
* Link to bookmark list (firefox://deep-link?url=homepanel/bookmarks)
* Link to history list (firefox://deep-link?url=/history)
* Link to general preferences (firefox://deep-link?url=settings)
* Link to the mailto preferences (firefox://deep-link?url=settings/mailto)
* Link to open a new tab (firefox://deep-link?url=settings/newtab)
* Link to open the user's homepage (firefox://deep-link?url=settings/homepage)
* Link to open the settings page so the user can clear their private data (firefox://deep-link?url=settings/clear-private-data)
* Link to open a new private tab (firefox://deep-link?url=homepanel/new-private-tab)
Note these deep links can only be processed from within Firefox (i.e., if they are clicked from outside of Firefox, Firefox will open but nothing further will happen).
@ -220,4 +172,6 @@ Messages
-----------
Messages are in-app prompts to the user from Leanplum. The user interaction of that prompt will be sent to the Leanplum backend (such as "Accept" or "Show") to track overall engagement with the Message. The Message is downloaded from Leanplum when the Leanplum SDK is initialized at App start, assuming the fulfillment criteria for the Message is met. As mentioned before, the fulfillment criteria is a set of required Events and User Attributes. The fulfillment criteria are set in the Leanplum backend.
--- Note: NEED TO CONFIRM WITH ENG/JESS WHICH MESSAGES HAVE BEEN PLANNED ---
The List of current Messages for iOS can be found here: https://wiki.mozilla.org/Leanplum_Contextual_Hints
Barbara Bermes
5 years ago
committed by
GitHub