Rails analytics for Firebase

The following events are modified/added to the list of base events that clients report to Firebase. See the ION documentation for details of the base reporting.

Analytics type

Detail

Firebase event

(The links take you to the React Native Firebase methods.)

Screen engagement

CODE

{

loop all_rails:

       ID of the rail, ( rail_id ) : Depth of interaction (depth) 

       vertical_interaction_depth : Depth of vertical interaction

       template_ref_id: ID of the template where rails existed. 

}

in_screen_engagement

CODE

{
"Strip_1":7,
"Strip_2":7,
"Strip_3":7,
"Strip_4":7,
"Strip_5":7,
"template_ref_id":"discover_template_id",
"vid":5
}

Content playback

Firebase event

Key

Value reference

Select_promotion

FirebaseAnalytics.Param.CREATIVE_NAME (String) (optional)

N/A

FirebaseAnalytics.Param.CREATIVE_SLOT (String) (optional)

N/A

FirebaseAnalytics.Param.ITEMS (Parcelable[]) (optional)

CODE

Bundle item1 = new Bundle();
item1.putString(Param.ITEM_NAME, "Marvels avengers"); item1.putString(Param.ITEM_CATEGORY, "live-event");
item1.putString(Param.ITEM_ID, "GLOBAL_12929_12392929");

Type

Source

Reference

VOD

(vod-ed)

MDS

Editorial ID

Live event

(live-event, live-stcu-event)

MDS

Editorial ID

NPVR

(npvr-event)

CDVR (User Recordings)

Editorial ID

CODE

if live or npvr ...

item1.putString(Param.ITEM_CATEGORY2, "## channel_name");


item1.putString(Param.ITEM_VARIANT, "en-GB");

item1.putString(Param.ITEM_LOCATION_ID, "(x,y)");

The index of the item in the rail or strip. ( for x & y ref in heatmaps )

FirebaseAnalytics.Param.LOCATION_ID (String) (optional)

ID of the Rail if the impression originated from the Rail

FirebaseAnalytics.Param.PROMOTION_ID (String) (optional)

Template ID of origin screen

FirebaseAnalytics.Param.PROMOTION_NAME (String) (optional)

Template name

select_promotion

CODE

{
  "creative_name": "April Beier 26",
  "creative_slot": "(1,27)",
  "items": [
    {
      "item_category": "live-stcu-event",
      "item_category2": "BBC News HD",
      "item_id": "435d4165-fddb-4150-9f3b-4fdbdc69e3de",
      "item_location_id": "(1,27)",
      "item_name": "April Beier 26",
      "item_variant": "en_GB"
    }
  ],
  "location_id": "Strip_1",
  "promotion_id": "435d4165-fddb-4150-9f3b-4fdbdc69e3de",
  "promotion_name": "April Beier 26"
}

View

Firebase event

KEY

Value reference

view_promotion

FirebaseAnalytics.Param.CREATIVE_NAME (String) (optional)

N/A

FirebaseAnalytics.Param.CREATIVE_SLOT (String) (optional)

N/A

FirebaseAnalytics.Param.ITEMS (Parcelable[]) (optional)

CODE

Bundle item1 = new Bundle();
item1.putString(Param.ITEM_NAME, "Marvels avengers"); item1.putString(Param.ITEM_CATEGORY, "live-event");
item1.putString(Param.ITEM_ID, "GLOBAL_12929_12392929");

Type

Source

Reference

VOD

(vod-ed)

MDS

Editorial ID

Live event

(live-event, live-stcu-event)

MDS

Editorial ID

NPVR

(npvr-event)

CDVR (User Recordings)

Editorial ID

CODE

if live or npvr ...

item1.putString(Param.ITEM_CATEGORY2, "## channel_name");


item1.putString(Param.ITEM_VARIANT, "en-GB");

item1.putString(Param.ITEM_LOCATION_ID, "(x,y)");

The index of the item in the rail or strip. ( for x & y ref in heatmaps )

FirebaseAnalytics.Param.LOCATION_ID (String) (optional)

ID of the Rail if the impression originated from the Rail

FirebaseAnalytics.Param.PROMOTION_ID (String) (optional)

Template ID of origin screen

FirebaseAnalytics.Param.PROMOTION_NAME (String) (optional)

Template name

view_promotion

CODE

{
  "items": [
    {
      "item_category": "live-stcu-event",
      "item_category2": "BBC News HD",
      "item_id": "435d4165-fddb-4150-9f3b-4fdbdc69e3de",
      "item_location_id": "(1,27)",
      "item_name": "April Beier 26",
      "item_variant": "en_GB"
    }
  ],
  "location_id": "Strip_1",
  "promotion_id": "435d4165-fddb-4150-9f3b-4fdbdc69e3de",
  "promotion_name": "April Beier 26"
}