mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-16 06:45:42 +00:00
Bug 1331169 - Fix Android ActivityStream docs. r=gkruglov
This commit is contained in:
parent
fc3193aa2b
commit
a6d7adc430
@ -1,8 +1,9 @@
|
||||
.. -*- Mode: rst; fill-column: 80; -*-
|
||||
|
||||
==============
|
||||
============================
|
||||
Activity Stream UI Telemetry
|
||||
==============
|
||||
============================
|
||||
|
||||
Building on top of UI Telemetry, Activity Stream records additional information about events and user context in which they occur.
|
||||
The ``extras`` field is used for that purpose; additional information is structured as JSON blobs.
|
||||
|
||||
@ -28,13 +29,16 @@ Two event types are recorded:
|
||||
|
||||
For each event, in addition to global extras, the following information is recorded:
|
||||
|
||||
extras: {
|
||||
...
|
||||
"source_type": "topsites",
|
||||
"source_subtype": "pinned"/"suggested"/"top"
|
||||
}
|
||||
.. code-block:: js
|
||||
|
||||
extras: {
|
||||
...
|
||||
"source_type": "topsites",
|
||||
"source_subtype": "pinned"/"suggested"/"top"
|
||||
}
|
||||
|
||||
Subtype indicates a reason an item which is being interacted with appeared in the Top Sites:
|
||||
|
||||
- "pinned": a pinned top site, specifically a non-positioned "Activity Stream pinned" site
|
||||
- "suggested": a suggested top site, one of the default ones displayed when there's not enough browsing history available
|
||||
- "top": a frecency-based top site, based on browsing history. Neither "pinned" nor "suggested".
|
||||
@ -48,11 +52,13 @@ Two event types are recorded:
|
||||
|
||||
For both event types, in addition to global extras, the following information is recorded:
|
||||
|
||||
extras: {
|
||||
...
|
||||
"source_type": "highlights",
|
||||
"source_subtype": "visited"/"bookmarked"
|
||||
}
|
||||
.. code-block:: js
|
||||
|
||||
extras: {
|
||||
...
|
||||
"source_type": "highlights",
|
||||
"source_subtype": "visited"/"bookmarked"
|
||||
}
|
||||
|
||||
Subtype indicates reason an item being which is being interacted with appeared in the Highlights:
|
||||
- "visited": a website has been visited recently
|
||||
@ -60,11 +66,13 @@ Subtype indicates reason an item being which is being interacted with appeared i
|
||||
|
||||
For "loadurl.1" event, the following extra information is also recorded:
|
||||
|
||||
extras: {
|
||||
...
|
||||
"action_position": number, /* 0-based index of a highlight being interacted with */
|
||||
"count": number, /* total number of highlights displayed */
|
||||
}
|
||||
.. code-block:: js
|
||||
|
||||
extras: {
|
||||
...
|
||||
"action_position": number, /* 0-based index of a highlight being interacted with */
|
||||
"count": number, /* total number of highlights displayed */
|
||||
}
|
||||
|
||||
Context Menu interactions
|
||||
-------------------------
|
||||
@ -72,14 +80,17 @@ Every interaction with a context menu item is recorded using: event="action.1",
|
||||
|
||||
For all interactions, in addition to global extras, the following information is recorded:
|
||||
|
||||
extras: {
|
||||
...
|
||||
"item": string, /* name of a menu item */
|
||||
"source_type": "topsites"/"highlights",
|
||||
"source_subtype": string, /* depending on type, one of: "pinned", "suggested", "top", "visited", "bookmarked" */
|
||||
}
|
||||
.. code-block:: js
|
||||
|
||||
extras: {
|
||||
...
|
||||
"item": string, /* name of a menu item */
|
||||
"source_type": "topsites"/"highlights",
|
||||
"source_subtype": string, /* depending on type, one of: "pinned", "suggested", "top", "visited", "bookmarked" */
|
||||
}
|
||||
|
||||
Possible values for "item" key (names of menu items), in no particular order:
|
||||
|
||||
- "share"
|
||||
- "add_bookmark"
|
||||
- "remove_bookmark"
|
||||
@ -96,52 +107,52 @@ Full Examples
|
||||
Following examples of events are here to provide a better feel for the overall shape of telemetry data being recorded.
|
||||
|
||||
1) User with an active Firefox Account clicked on a menu item for a "visited highlight":
|
||||
``
|
||||
session="activitystream.1"
|
||||
event="show.1"
|
||||
method="contextmenu"
|
||||
extras="{
|
||||
'fx_account_present': true,
|
||||
'source_type': 'highlights',
|
||||
'source_subtype': 'visited'
|
||||
}"
|
||||
``
|
||||
::
|
||||
|
||||
session="activitystream.1"
|
||||
event="show.1"
|
||||
method="contextmenu"
|
||||
extras="{
|
||||
'fx_account_present': true,
|
||||
'source_type': 'highlights',
|
||||
'source_subtype': 'visited'
|
||||
}"
|
||||
|
||||
2) User with no active Firefox Account clicked on a second highlight (recent bookmark), with total of 7 highlights being displayed:
|
||||
``
|
||||
session="activitystream.1"
|
||||
event="loadurl.1"
|
||||
method="listitem"
|
||||
extras="{
|
||||
'fx_account_present': false,
|
||||
'source_type': 'highlights',
|
||||
'source_subtype': 'bookmarked'
|
||||
'action_position': 1,
|
||||
'count': 7
|
||||
}"
|
||||
``
|
||||
::
|
||||
|
||||
session="activitystream.1"
|
||||
event="loadurl.1"
|
||||
method="listitem"
|
||||
extras="{
|
||||
'fx_account_present': false,
|
||||
'source_type': 'highlights',
|
||||
'source_subtype': 'bookmarked'
|
||||
'action_position': 1,
|
||||
'count': 7
|
||||
}"
|
||||
|
||||
3) User with an active Firefox Account clicked on a pinned top site:
|
||||
``
|
||||
session="activitystream.1"
|
||||
event="loadurl.1"
|
||||
method="listitem"
|
||||
extras="{
|
||||
'fx_account_present': true,
|
||||
'source_type': 'topsites',
|
||||
'source_subtype': 'pinned'
|
||||
}"
|
||||
``
|
||||
::
|
||||
|
||||
session="activitystream.1"
|
||||
event="loadurl.1"
|
||||
method="listitem"
|
||||
extras="{
|
||||
'fx_account_present': true,
|
||||
'source_type': 'topsites',
|
||||
'source_subtype': 'pinned'
|
||||
}"
|
||||
|
||||
4) User with an active Firefox Account clicked on a "share" context menu item, which was displayed for a regular top site:
|
||||
``
|
||||
session="activitystream.1"
|
||||
event="action.1"
|
||||
method="contextmenu"
|
||||
extras="{
|
||||
'fx_account_present': true,
|
||||
'source_type': 'topsites',
|
||||
'source_subtype': 'top',
|
||||
'item': 'share'
|
||||
}"
|
||||
``
|
||||
::
|
||||
|
||||
session="activitystream.1"
|
||||
event="action.1"
|
||||
method="contextmenu"
|
||||
extras="{
|
||||
'fx_account_present': true,
|
||||
'source_type': 'topsites',
|
||||
'source_subtype': 'top',
|
||||
'item': 'share'
|
||||
}"
|
||||
|
@ -13,6 +13,7 @@ Contents:
|
||||
|
||||
localeswitching
|
||||
uitelemetry
|
||||
activitystreamtelemetry
|
||||
adjust
|
||||
defaultdomains
|
||||
bouncer
|
||||
|
Loading…
Reference in New Issue
Block a user