1409886 - Drop an event when User clicks on a Pocket Story on Activity Stream (for Leanplum)

Status: RESOLVED FIXED

(Firefox for iOS :: General, enhancement, P2)

Description

[Jean Collings]

For iOS 10.0, we'll have Pocket Stories and we want the ability to track when a user clicks on one of these stories so we can send relevant messaging to this segment through Leanplum. 


Chenxia - tagging you here so you can review as the data steward. Thanks!

Comment 1

[Chenxia Liu [:liuche]]

Hi Jean, please clone this doc and fill it out, and attach it back to this bug.
https://docs.google.com/document/d/1SSn5w8DfCSkHWJS8DNTd7ya82diWRxaDUFM5aL4UDDo/edit?ts=59e7d65c

Please also update the LeanPlum wiki and then flag me for review.

Comment 2

[Jean Collings]

(In reply to Chenxia Liu [:liuche] from comment #1)
> Hi Jean, please clone this doc and fill it out, and attach it back to this
> bug.
> https://docs.google.com/document/d/
> 1SSn5w8DfCSkHWJS8DNTd7ya82diWRxaDUFM5aL4UDDo/edit?ts=59e7d65c
> 
> Please also update the LeanPlum wiki and then flag me for review.

Will do. And to clarify is this the Leanplum Wiki you are referring to: https://wiki.mozilla.org/Leanplum_Contextual_Hints?

It's the only I have access to. I wasn't sure if there was a different Wiki that the engineers have access to in regards to events and deeplinks.

Comment 3

[Farhan Patel [:farhan]]

Attachment: Pull Request

Not sure if you need to look at this But thought I'd tag you Chenxia  :)

This is my first time adding a new event so please let me know if I'm missing something!

Comment 4

[Jean Collings]

Here's the updated Wiki:
https://wiki.mozilla.org/Leanplum_Contextual_Hints

Here's the data review request form:
https://docs.google.com/document/d/1aaBgDOKnJiNd2F4ACzvkydkA10XBVCJmsWmFyXUhp4w/edit#heading=h.66r1vxgfrdjy

Please let me know what else is needed.

Thanks,
Jean

Comment 5

[Chenxia Liu [:liuche]]

Okay, thanks for the doc and wiki page update, Jean, and the updated in-tree documentation Farhan!

Jean, one small nit: my understanding is that Pocket is only enabled for certain locales (about 5?), so it doesn't make sense to collect this (or rather, show LeanPlum interactions) for all these locales.

---

Since this is Type 2 data collection, and there is public documentation for what is being collected (which is opening Pocket links), giving this an r+ for data review.

1) Is there documentation that describes the schema for the ultimate data set available publicly, complete and accurate? 
Yes, this is documented in the LeanPlum wiki ( https://wiki.mozilla.org/Leanplum_Contextual_Hints ), and in the in-tree documentation ( https://github.com/mozilla-mobile/firefox-ios/blob/master/MMA.md ).

2) Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism)  
Yes, users can opt out of Telemetry in the normal fashion.

3) If the request is for permanent data collection, is there someone who will monitor the data over time?
Jean Collings

4) Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under? 
This is type 2.

5) Is the data collection default-on or default-off? 
default-on

6) Does the instrumentation include the addition of any new identifiers (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)? 
No.

7) Is the data collection covered by the existing Firefox privacy notice? If unsure: escalate to legal.
Yes.

8) Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No) 
No

Comment 6

[Jean Collings]

(In reply to Chenxia Liu [:liuche] from comment #5)
> Okay, thanks for the doc and wiki page update, Jean, and the updated in-tree
> documentation Farhan!
> 
> Jean, one small nit: my understanding is that Pocket is only enabled for
> certain locales (about 5?), so it doesn't make sense to collect this (or
> rather, show LeanPlum interactions) for all these locales.
> 
> ---
> 
> Since this is Type 2 data collection, and there is public documentation for
> what is being collected (which is opening Pocket links), giving this an r+
> for data review.
> 
> 1) Is there documentation that describes the schema for the ultimate data
> set available publicly, complete and accurate? 
> Yes, this is documented in the LeanPlum wiki (
> https://wiki.mozilla.org/Leanplum_Contextual_Hints ), and in the in-tree
> documentation (
> https://github.com/mozilla-mobile/firefox-ios/blob/master/MMA.md ).
> 
> 2) Is there a control mechanism that allows the user to turn the data
> collection on and off? (Note, for data collection not needed for security
> purposes, Mozilla provides such a control mechanism)  
> Yes, users can opt out of Telemetry in the normal fashion.
> 
> 3) If the request is for permanent data collection, is there someone who
> will monitor the data over time?
> Jean Collings
> 
> 4) Using the category system of data types on the Mozilla wiki, what
> collection type of data do the requested measurements fall under? 
> This is type 2.
> 
> 5) Is the data collection default-on or default-off? 
> default-on
> 
> 6) Does the instrumentation include the addition of any new identifiers
> (whether anonymous or otherwise; e.g., username, random IDs, etc. See the
> appendix for more details)? 
> No.
> 
> 7) Is the data collection covered by the existing Firefox privacy notice? If
> unsure: escalate to legal.
> Yes.
> 
> 8) Does there need to be a check-in in the future to determine whether to
> renew the data? (Yes/No) 
> No

Make sense Chenxia - we're testing in en first but put "all locales" in the event of the future it's available for most. We can change it to just the 5 locales if you prefer.

Comment 7

[Farhan Patel [:farhan]]

master cd51fa956875446d25e9fcc2f3ad787def74dd64

Comment 8

[Chenxia Liu [:liuche]]

Comment on attachment 8920253 [details] [diff] [review]
Pull Request

Review of attachment 8920253 [details] [diff] [review]:
-----------------------------------------------------------------

Reviewed in the PR: https://github.com/mozilla-mobile/firefox-ios/pull/3332