1.2.1/event fix (#10) (#11)

Tealium · May 10, 2021 · e2b42f6 · e2b42f6
1 parent 6078722
commit e2b42f6
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 63 deletions.
diff --git a/app/src/main/assets/firebase.json b/app/src/main/assets/firebase.json
@@ -9,9 +9,10 @@
     "achievement_id": "event.param_achievement_id",
     "ad_network_click_id": "event.param_ad_network_click_id",
     "affiliation": "event.param_affiliation",
-    "campaign_keywords": "event.param_cp1",
     "campaign": "event.param_campaign",
-    "game_character": "event.param_character",
+    "campaign_keywords": "event.param_cp1",
+    "campaign_medium": "event.param_medium",
+    "campaign_source": "event.param_source",
     "checkout_option": "event.param_checkout_option",
     "checkout_step": "event.param_checkout_step",
     "content": "event.param_content",
@@ -20,70 +21,68 @@
     "creative_name": "event.param_creative_name",
     "creative_slot": "event.param_creative_slot",
     "currency_code": "event.param_currency",
-    "travel_destination": "event.param_destination",
+    "currency_type": "event.param_virtual_currency_name",
+    "current_index": "param_index",
+    "current_level": "event.param_level",
+    "customer_id": "firebase_user_id",
     "end_date": "event.param_end_date",
-    "flight_number": "pevent.param_flight_number",
+    "tealium_event": "firebase_event_name",
+    "flight_number": "event.param_flight_number",
+    "game_character": "event.param_character",
     "group_id": "event.param_group_id",
-    "current_index": "param_index",
+    "most_recent_location": "event.param_location",
+    "number_nights": "event.param_number_nights",
+    "number_pax": "event.param_number_pax",
+    "number_rooms": "event.param_number_rooms",
+    "order_currency": "event.param_currency",
+    "order_id": "event.param_transaction_id",
+    "order_shipping_amount": "event.param_shipping",
+    "order_tax_amount": "event.param_tax",
+    "order_total": "event.param_value",
     "product_brand": "items.param_item_brand",
     "product_category": "items.param_item_category",
     "product_id": "items.param_item_id",
     "product_list": "items.param_item_list",
     "product_location_id": "items.param_item_location_id",
     "product_name": "items.param_item_name",
-    "product_variant": "items.param_item_variant ",
-    "current_level": "event.param_level",
-    "most_recent_location": "event.param_location",
-    "campaign_medium": "event.param_medium",
-    "number_nights": "event.param_number_nights",
-    "number_pax": "event.param_number_pax",
-    "number_rooms": "event.param_number_rooms",
-    "travel_origin": "event.param_origin",
-    "product_unit_price": "items.param_price",
     "product_quantity": "items.param_quantity",
+    "product_term": "event.param_term",
+    "product_unit_price": "items.param_price",
+    "product_variant": "items.param_item_variant ",
     "score": "event.param_score",
+    "screen_class": "firebase_screen_class",
+    "screen_name": "firebase_screen_name",
     "search_keyword": "event.param_search_term",
-    "order_shipping_amount": "event.param_shipping",
     "signup_method": "event.param_signup_method",
-    "campaign_source": "event.param_source",
     "start_date": "event.param_start_date",
-    "order_tax_amount": "event.param_tax",
-    "product_term": "event.param_term",
-    "order_id": "event.param_transaction_id",
     "travel_class": "event.param_travel_class",
-    "order_total": "event.param_value",
-    "currency_type": "event.param_virtual_currency_name",
+    "travel_destination": "event.param_destination",
+    "travel_origin": "event.param_origin",
     "user_signup_method": "event.param_user_signup_method",
-    "tealium_event": "firebase_event_name",
-    "screen_name": "firebase_screen_name",
-    "screen_class": "firebase_screen_class",
-    "username": "firebase_property_name, firebase_property_value",
-    "customer_id": "firebase_user_id"
+    "username": "firebase_property_name, firebase_property_value"
   },
   "commands": {
-    "launch": "config",
-    "user_login": "setuserproperty, setuserid",
-    "share": "logevent",
-    "show_offers": "logevent",
+    "add_to_cart": "logevent",
+    "begin_checkout": "logevent",
+    "checkout_progress": "logevent",
+    "earn_virtual_currency": "logevent",
+    "email_signup": "logevent",
     "join_group": "logevent",
-    "travel_order": "logevent",
-    "earn_currency": "logevent",
-    "spend_currency": "logevent",
-    "unlock_achievement": "logevent",
+    "launch": "config",
     "level_up": "logevent",
-    "start_tutorial": "logevent",
-    "stop_tutorial": "logevent",
+    "login": "setuserproperty, setuserid",
+    "purchase": "logevent",
     "record_score": "logevent",
-    "category": "logevent",
-    "product": "logevent",
-    "cart_add": "logevent",
-    "wishlist_add": "logevent",
-    "checkout": "logevent",
-    "checkout_progress": "logevent",
-    "email_signup": "logevent",
-    "order": "logevent",
+    "reset_data" : "resetdata",
     "screen_view" : "setscreenname",
-    "order_basket" : "logevent",
-    "reset_data" : "resetdata"
+    "share": "logevent",
+    "show_offers": "logevent",
+    "spend_virtual_currency": "logevent",
+    "tutorial_begin": "logevent",
+    "tutorial_complete": "logevent",
+    "unlock_achievement": "logevent",
+    "view_item": "logevent",
+    "view_item_list": "logevent",
+    "wishlist_add": "logevent"
   }
 }
diff --git a/app/src/main/java/com/tealium/example/EcommerceActivity.java b/app/src/main/java/com/tealium/example/EcommerceActivity.java
@@ -7,6 +7,7 @@
 import androidx.annotation.Nullable;
 import androidx.appcompat.app.AppCompatActivity;
 
+import com.google.firebase.analytics.FirebaseAnalytics;
 import com.tealium.example.helper.DataLayer;
 import com.tealium.example.helper.TealiumHelper;
 import com.tealium.example.model.Basket;
@@ -58,13 +59,13 @@ public void onClick(View view) {
         switch (id) {
             case R.id.btn_ecom_category_view:
                 data.put(DataLayer.PRODUCT_CATEGORY, product.getProductCategory());
-                TealiumHelper.trackEvent("category", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.VIEW_ITEM_LIST, data);
                 break;
             case R.id.btn_ecom_product_view:
                 data.put(DataLayer.PRODUCT_ID, product.getProductId());
                 data.put(DataLayer.PRODUCT_NAME, product.getProductName());
                 data.put(DataLayer.PRODUCT_CATEGORY, product.getProductCategory());
-                TealiumHelper.trackEvent("product", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.VIEW_ITEM, data);
                 break;
             case R.id.btn_ecom_cart_add:
                 data.put(DataLayer.PRODUCT_ID, product.getProductId());
@@ -75,13 +76,13 @@ public void onClick(View view) {
 
                 data.put(DataLayer.ORDER_CURRENCY, "USD");
                 data.put(DataLayer.ORDER_TOTAL, product.getProductUnitPrice());
-                TealiumHelper.trackEvent("cart_add", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.ADD_TO_CART, data);
 
                 Basket.getInstance().addProduct(product);
                 updateBasket();
                 break;
             case R.id.btn_ecom_checkout:
-                TealiumHelper.trackEvent("checkout", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.BEGIN_CHECKOUT, data);
                 break;
             case R.id.btn_ecom_purchase:
                 data.put(DataLayer.PRODUCT_ID, product.getProductId());
@@ -93,7 +94,7 @@ public void onClick(View view) {
                 data.put(DataLayer.ORDER_CURRENCY, "USD");
                 data.put(DataLayer.ORDER_TOTAL, product.getProductUnitPrice());
                 data.put(DataLayer.ORDER_ID, "ORD-12345");
-                TealiumHelper.trackEvent("order", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.PURCHASE, data);
                 break;
             case R.id.btn_ecom_purchase_basket:
                 data.put(DataLayer.PRODUCT_ID, Basket.getInstance().getProductIds());
@@ -109,7 +110,7 @@ public void onClick(View view) {
                 Basket.getInstance().clear();
                 updateBasket();
 
-                TealiumHelper.trackEvent("order_basket", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.PURCHASE, data);
                 break;
         }
     }

diff --git a/app/src/main/java/com/tealium/example/TravelActivity.java b/app/src/main/java/com/tealium/example/TravelActivity.java
@@ -8,6 +8,7 @@
 import androidx.annotation.Nullable;
 import androidx.appcompat.app.AppCompatActivity;
 
+import com.google.firebase.analytics.FirebaseAnalytics;
 import com.tealium.example.helper.DataLayer;
 import com.tealium.example.helper.TealiumHelper;
 
@@ -52,7 +53,7 @@ public void onClick(View view) {
                 data.put(DataLayer.ORDER_CURRENCY, "GBP");
                 data.put(DataLayer.ORDER_TOTAL, 100.00);
                 data.put(DataLayer.ORDER_ID, "TRAVEL-ORD-12345");
-                TealiumHelper.trackEvent("travel_order", data);
+                TealiumHelper.trackEvent(FirebaseAnalytics.Event.PURCHASE, data);
                 break;
         }
     }

diff --git a/app/src/main/java/com/tealium/example/UserActivity.java b/app/src/main/java/com/tealium/example/UserActivity.java
@@ -8,6 +8,7 @@
 import androidx.annotation.Nullable;
 import androidx.appcompat.app.AppCompatActivity;
 
+import com.google.firebase.analytics.FirebaseAnalytics;
 import com.tealium.example.helper.DataLayer;
 import com.tealium.example.helper.TealiumHelper;
 
@@ -46,6 +47,6 @@ private void setUserid() {
         data.put(DataLayer.CUSTOMER_ID, mUserIdEditText.getText().toString());
         data.put(DataLayer.USERNAME, mUserPropertyValueEditText.getText().toString());
 
-        TealiumHelper.trackEvent("user_login", data);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.LOGIN, data);
     }
 }
diff --git a/app/src/main/java/com/tealium/example/model/Player.java b/app/src/main/java/com/tealium/example/model/Player.java
@@ -1,5 +1,6 @@
 package com.tealium.example.model;
 
+import com.google.firebase.analytics.FirebaseAnalytics;
 import com.tealium.example.helper.DataLayer;
 import com.tealium.example.helper.TealiumHelper;
 
@@ -43,7 +44,7 @@ public void earnVirtualCurrency(int amount) {
         Map<String, Object> data = new HashMap<>();
         data.put(DataLayer.NUMBER_OF_TOKENS, amount);
         data.put(DataLayer.CURRENCY_TYPE, CURRENCY);
-        TealiumHelper.trackEvent("earn_currency", data);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.EARN_VIRTUAL_CURRENCY, data);
     }
 
     public void spendVirtualCurrency() {
@@ -60,7 +61,7 @@ public void spendVirtualCurrency(int amount) {
         data.put(DataLayer.PRODUCT_NAME, "Beast Shield");
         data.put(DataLayer.CURRENCY_TYPE, CURRENCY);
         data.put(DataLayer.NUMBER_OF_TOKENS, amount);
-        TealiumHelper.trackEvent("spend_currency", data);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.SPEND_VIRTUAL_CURRENCY, data);
     }
 
     public boolean canSpend(int amount) {
@@ -81,7 +82,7 @@ public void levelUp(int newLevel) {
         Map<String, Object> data = new HashMap<>();
         data.put(DataLayer.LEVEL, mCurrentLevel);
         data.put(DataLayer.CHARACTER, mName);
-        TealiumHelper.trackEvent("level_up", data);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.LEVEL_UP, data);
     }
 
     public int getCurrenLevel() {
@@ -91,17 +92,17 @@ public int getCurrenLevel() {
     public void unlockAchievement(String achievementId) {
         Map<String, Object> data = new HashMap<>();
         data.put(DataLayer.ACHIEVEMENT_ID, achievementId);
-        TealiumHelper.trackEvent("unlock_achievement", data);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.UNLOCK_ACHIEVEMENT, data);
     }
 
     public void startTutorial() {
         mIsInTutorial = true;
-        TealiumHelper.trackEvent("start_tutorial", null);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.TUTORIAL_BEGIN, null);
     }
 
     public void stopTutorial() {
         mIsInTutorial = false;
-        TealiumHelper.trackEvent("stop_tutorial", null);
+        TealiumHelper.trackEvent(FirebaseAnalytics.Event.TUTORIAL_COMPLETE, null);
     }
 
     public boolean isInTutorial() {

diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@
 
 buildscript {
     ext.kotlin_version = '1.4.10'
-    ext.tealium_firebase_version = '1.2.0'
+    ext.tealium_firebase_version = '1.2.1'
 
     repositories {
         google()

diff --git a/.../src/androidTest/java/com/tealium/remotecommands/firebase/FirebaseRemoteCommandTests.java b/.../src/androidTest/java/com/tealium/remotecommands/firebase/FirebaseRemoteCommandTests.java
@@ -152,7 +152,7 @@ public void logEvent(String eventName, JSONObject eventParams) {
                 super.logEvent(eventName, eventParams);
 
                 Assert.assertNull("Unexpected eventName value", eventName);
-                Assert.assertNull("Unexpected eventParams value", eventParams);
+                Assert.assertEquals("{}", eventParams.toString());
             }
         };
 
@@ -178,7 +178,7 @@ public void logEvent(String eventName, JSONObject eventParams) {
                 super.logEvent(eventName, eventParams);
 
                 Assert.assertNull("Unexpected eventName value", eventName);
-                Assert.assertNull("Unexpected eventParams value", eventParams);
+                Assert.assertEquals("{}", eventParams.toString());
             }
         };
 

diff --git a/firebase/src/main/java/com/tealium/remotecommands/firebase/FirebaseRemoteCommand.java b/firebase/src/main/java/com/tealium/remotecommands/firebase/FirebaseRemoteCommand.java
@@ -90,6 +90,9 @@ private void parseCommands(String[] commandList, JSONObject payload) {
                         JSONObject items = payload.optJSONObject(FirebaseConstants.Keys.ITEMS_PARAMS);
                         if (params == null) {
                             params = payload.optJSONObject(FirebaseConstants.Keys.TAG_EVENT_PARAMS);
+                            if (params == null) {
+                                params = new JSONObject();
+                            }
                         }
                         if (items != null) {
                             params.put("param_items", itemsParamsToJsonArray(items));
@@ -234,6 +237,7 @@ private JSONArray formatItems(JSONObject json, int numItems) {
                         case FirebaseConstants.ItemProperties.LOCATION_ID:
                         case FirebaseConstants.ItemProperties.VARIANT:
                             item.put(key, json.get(key));
+                            break;
                         default:
                             Log.d(FirebaseConstants.TAG, "Invalid item param key: " + key + ".");
                             break;