Developer Guide

Event Collection in Android SDK

In order to collect app events and use that data to create behavioural segments in D·engage you have to determine the type of events and data that needs to collect. Once you have determined that, you will need to create a “Big Data” table in D·engage. Collected events will be stored in this table. Multiple tables can be defined depending on your specific need.

Any type of event can be collected. The content and the structure of the events are completely flexible and can be changed according to unique business requirements. You will just need to define a table for events.

Once defined, all you have to do is to send the event data to these tables. D·engage SDK has only two functions for sending events: sendDeviceEvent and sendCustomEvent. Most of the time you will just need the sendDeviceEvent function.

For eCommerce accounts, there are predefined event tables. And you can feed these tables by using eCommerce event functions.

1. Login / Logout Action

If the user logs in or you have user information, this means you have contact_key for that user. You can set contact_key in order to match user with the device. There are two functions for getting and setting contact_key.

setContactKey

If user logged in set user id. This is important for identifying your users. You can put this function call in every page. It will not send unnecessary events.

Dengage.setContactKey("userId");

getSubscription

If you need to get current user information from SDK use this function.

Dengage.getSubscription();

2. Event Collection

If your D·engage account is an eCommerce account, you should use standard eCommerce events in the SDK. If you need some custom events or your account is not a standard eCommerce account, you should use custom event functions.

a) Events for eCommerce Accounts

There are standart eCommerce events in D·engage SDK.

  • Page View Events
    • Home page view
    • Product page view
    • Category page view
    • Promotion page view

  • Shopping Cart Events
    • Add to cart
    • Remove from cart
    • View Cart
    • Begin Checkout
  • Order Events
    • Order
    • Cancel order
  • Wishlist Events
    • Add to wishlist
    • Remove from wishlist
  • Search Event

For their event, there are related tables in your account.

Page View Events

Page view events will be sent to the page_view_events table. If you add new columns to this table. You can send these in the event data.

// Home page view
HashMap<String, Object> data = new HashMap<>();  
data.put("page_type", "home");  
// ... extra columns in page_view_events table, can be added here
Dengage.pageView(data);

// category page view
HashMap<String, Object> data = new HashMap<>();  
data.put("page_type", "category");  
data.put("category_id", 123); 
// ... extra columns in page_view_events table, can be added here
Dengage.pageView(data);

// product page view
HashMap<String, Object> data = new HashMap<>();  
data.put("page_type", "product");  
data.put("product_id", 123); 
// ... extra columns in page_view_events table, can be added here
Dengage.pageView(data);

// promotion page view
HashMap<String, Object> data = new HashMap<>();  
data.put("page_type", "promotion");  
data.put("promotion_id", 123); 
// ... extra columns in page_view_events table, can be added here
Dengage.pageView(data);

// custom page view
HashMap<String, Object> data = new HashMap<>();  
data.put("page_type", "custom");  
// ... extra columns in page_view_events table, can be added here
Dengage.pageView(data);

For other pages you can send anything as page_type

Shopping Cart Events

These events will be stored in shopping_cart_events and shopping_cart_events_detail.
There are 4 shopping cart event functions. addToCart, removeFromCart, viewCart, beginCheckout


// Add To Cart
HashMap<String,Object> data = new HashMap<>();  
data.put("product_id", "123");  
data.put("product_variant_id", "1222");  
data.put("quantity", 1);  
data.put("unit_price", 9.99);  
data.put("shipping", 5);  ,
data.put("discounted_price", 9.99);
data.put("coupon_code", "");
// ... extra columns in shopping_cart_events table, can be added here
Dengage.addToCart(data); 
 
// Remove From Cart
HashMap<String,Object> data = new HashMap<>();  
data.put("product_id", "123");  
data.put("product_variant_id", "1222");  
data.put("quantity", 1);  
data.put("unit_price", 9.99);  
data.put("shipping", 5);  ,
data.put("discounted_price", 9.99);
data.put("coupon_code", "");
// ... extra columns in shopping_cart_events table, can be added here
Dengage.removeFromCart(data); 
 
// ... extra columns in shopping_cart_events table, can be added here
Dengage.viewCart(data); 
  
// Begin Checkout
Dengage.beginCheckout(data);

Order Events

Orders events will be sent to order_events and order_events_detail tables.

// Paid Order
HashMap<String,Object> data = new HashMap<>();  
data.put("order_id", "123");  
data.put("item_count", 1);  
data.put("total_amount", 99.9);  
data.put("payment_method", "card");  
data.put("shipping", 5);  ,
data.put("discounted_price", 29.99);   // use total price if there is no discount
data.put("coupon_code", "");  // use if necessary
 // ordered items
// ... extra columns in order_events table, can be added here
Dengage.order(data); 

// Order Cancel
HashMap<String,Object> data = new HashMap<>(); 
data.put("item_count", 1);  
data.put("total_amount", 99.9); 
data.put("discounted_price", 29.99);  // use total price if there is no discount 
  // canceled items
// ... extra columns in order_events table, can be added here
Dengage.cancelOrder(data);

Search Event

Search events will be stored in search_events table.

HashMap<String, Object> data = new HashMap<>();  
data.put("keywords", "hello"); 
data.put("result_count", 123); 
data.put("filters", "q=keywords"); //you use can send extra filters selected by user here. Formating is not specified
// ... extra columns in search_events table, can be added here 
Dengage.search(data);

Wishlist Events

These events will be stored in wishlist_events and wishlist_events_detail.
There are 2 wishlist event functions. addToWishlist, removeFromWishlist.
In every event call, you can send all items to the wishlist. It makes it easy to track current items on the wishlist.

// Add To Wish List
HashMap<String,Object> data = new HashMap<>();  
data.put("product_id", 123); ,
data.put("product_id", 1); 
// ... extra columns in wishlist_events table, can be added here
Dengage.addToWishList(data);  

// Remove From Wish List
HashMap<String,Object> data = new HashMap<>();  
data.put("product_id", 123); ,
// ... extra columns in wishlist_events table, can be added here
Dengage.removeFromWishList(data);

b) Custom Events

Send Device Specific Events

You can use sendDeviceEvent function for sending events for the device. Events are sent to a big data table defined in your D·engage account. That table must have relation to the master_device table.
If you set contact_key for that device. Collected events will be associated for that user.

DengageEvent.sendDeviceEvent(tableName, data);

// for example if you have a table named "events"
// and events table has "key", "event_date", "event_name", "product_id" columns
// you just have to send the columns except "key" and "event_date", because those columns sent by the SDK

HashMap<String,Object> data = new HashMap<>();  
data.put("event_name", "page_view");  
data.put("product_id", "12345"); 
// ... extra columns in events table, can be added here
Dengage.sendDeviceEvent("events", data);

Changing Event Api Endpoint

<meta-data
    android:name="den_push_api_url"
    android:value="https://your_push_api_endpoint" />