Skip to content

API

Jump to bottom
Eason edited this page Jan 16, 2021 · 8 revisions

API

Send Action Beacon

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_LABEL : ["123" : "abc",
                                                                                                              "321" : 123],
                                                                                   PayloadType.EVENT_ACTION : EventActionType.CLICK_MENU,
                                                                                   PayloadType.EVENT_CATEGORY : "TestCategory",
                                                                                   PayloadType.EVENT_VALUE : 123])

Complete Registration

var completeRegistration = CompleteRegistration()
completeRegistration.birthdayYear = "1994"
completeRegistration.city = "Taipei"
completeRegistration.gender = GenderType.MALE
completeRegistration.regType = "regType"

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT,
                                        dict: [
                                        PayloadType.EVENT_CATEGORY : EventCategoryType.COMPLETE_REGISTRATION,
                                        PayloadType.EVENT_ACTION : EventActionType.COMPLETE_REGISTRATION,
                                        EventActionType.COMPLETE_REGISTRATION : completeRegistration])

Content Group

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.CONTENT_GROUP : "Home"])

Product Impressions

var impression1 = Impression.init(id: "12345", name: "Triblend Android T-Shirt")
impression1.price = "15.25"
impression1.brand = "Google"
impression1.category = "Apparel"
impression1.variant = "Gray"
impression1.list = "Search Results"
impression1.position = "1"

var impression2 = Impression.init(id: "123455", name: "Same list T-Shirt")
impression2.price = "15.25"
impression2.brand = "Google"
impression2.category = "Apparel"
impression2.variant = "Gray"
impression2.list = "Search Results"
impression2.position = "2"

var impression3 = Impression.init(id: "67890", name: "Donut Friday Scented T-Shirt")
impression3.price = "33.75"
impression3.brand = "Google"
impression3.category = "Apparel"
impression3.variant = "Black"
impression3.position = "1"

let impressions : [Impression] = [impression1, impression2, impression3]

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.PAGEVIEW, dict: [PayloadType.CONTENT_GROUP : "default category list",
                                                                            PayloadType.CURRENCY_CODE : "TWD",
                                                                            DataType.IMPRESSIONS : impressions])

Product Click

var product1 = Product.init(id: "product1_id", name: "product1_name", price: "10.10", quantity: 1)
product1.brand = "Omni_Brand"
product1.category = "Omni_Category"
product1.variant = "Omni_Variant"
product1.coupon = "Omni_Coupon"

let products : [Product] = [product1]

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.CLICK_PRODUCT,
                                                                        PayloadType.PRODUCT_ACTION_LIST : "Search Results",
                                                                        PayloadType.CURRENCY_CODE : "TWD",
                                                                        DataType.PRODUCTS : products])

Product Detail Impressions

var product1 = Product.init(id: "product1_id", name: "product1_name", price: "10.10", quantity: 1)
product1.brand = "Omni_Brand"
product1.category = "Omni_Category"
product1.variant = "Omni_Variant"
product1.coupon = "Omni_Coupon"

let products : [Product] = [product1]
OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.PAGEVIEW, dict: [PayloadType.PRODUCT_ACTION : ActionType.DETAIL,
                                                                            PayloadType.PRODUCT_ACTION_LIST : "category list",
                                                                            PayloadType.CURRENCY_CODE : "TWD",
                                                                            DataType.PRODUCTS : products])

Add To Cart

var product1 = Product.init(id: "product1_id", name: "product1_name", price: "10.10", quantity: 1)
product1.brand = "Omni_Brand"
product1.category = "Omni_Category"
product1.variant = "Omni_Variant"
product1.coupon = "Omni_Coupon"

let products : [Product] = [product1]
OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.ADD_TO_CART,
                                                                        PayloadType.CURRENCY_CODE : "TWD",
                                                                        DataType.PRODUCTS : products])

Remove From Cart

var product1 = Product.init(id: "product1_id", name: "product1_name", price: "10.10", quantity: 1)
product1.brand = "Omni_Brand"
product1.category = "Omni_Category"
product1.variant = "Omni_Variant"
product1.coupon = "Omni_Coupon"

let products : [Product] = [product1]
OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.REMOVE_FROM_CART,
                                                                        PayloadType.CURRENCY_CODE : "TWD",
                                                                        DataType.PRODUCTS : products])

Promotion Impressions

var promotion1 = Promotion.init(id: "JUNE_PROMO13", name: "June Sale")
promotion1.creative = "banner1"
promotion1.position = "slot1"

var promotion2 = Promotion.init(id: "FREE_SHIP13", name: "Free Shipping Promo")
promotion2.creative = "skyscraper1"
promotion2.position = "slot2"

let promotions : [Promotion] = [promotion1, promotion2]
OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.PAGEVIEW, dict: [DataType.PROMOTIONS : promotions])

Promotion Clicks

var promotion1 = Promotion.init(id: "JUNE_PROMO13", name: "June Sale")
promotion1.creative = "banner1"
promotion1.position = "slot1"

let promotions : [Promotion] = [promotion1]
OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.PAGEVIEW, dict: [PayloadType.EVENT_ACTION : EventActionType.CLICK_PROMOTION,
                                                                            DataType.PROMOTIONS : promotions])

Purchases

var product1 = Product.init(id: "product1_id", name: "product1_name", price: "10.10", quantity: 1)
product1.brand = "Omni_Brand"
product1.category = "Omni_Category"
product1.variant = "Omni_Variant"
product1.coupon = "Omni_Coupon"
let product2 = Product.init(id: "product2_id", name: "product2_name", price: "12.12", quantity: 2)
let product3 = Product.init(id: "product3_id", name: "product3_name", price: "15.15", quantity: 3)

let products : [Product] = [product1, product2, product3]
OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.PURCHASE,
                                                                        PayloadType.REVENUE : 20.20,
                                                                        PayloadType.TRANSACTION_ID : "ABC-12345",
                                                                        DataType.PRODUCTS : products])

Refunds

Full Refunds

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.REFUND,
                                                                        PayloadType.TRANSACTION_ID : "ABC",
                                                                        PayloadType.PRODUCT_ACTION : "custom_product_action"])

Partial Refunds

var product1 = Product.init(id: "product1_id", name: "product1_name", price: "10.10", quantity: 1)
    product1.brand = "Omni_Brand"
    product1.category = "Omni_Category"
    product1.variant = "Omni_Variant"
    product1.coupon = "Omni_Coupon"
    let product2 = Product.init(id: "product2_id", name: "product2_name", price: "12.12", quantity: 2)
    let product3 = Product.init(id: "product3_id", name: "product3_name", price: "15.15", quantity: 3)
    
    let products : [Product] = [product1, product2, product3]
    OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.REFUND,
                                                                            PayloadType.TRANSACTION_ID : "ABC",
                                                                            PayloadType.PRODUCT_ACTION : "custom_product_action",
                                                                            DataType.PRODUCTS : products])

Checkout

OmniSegmentService.sharedInstance.logEvent(hit_type: HitType.EVENT, dict: [PayloadType.EVENT_ACTION : EventActionType.CLICK_CHECKOUT,
                                                                        PayloadType.CHECKOUT_STEP_OPTION : currSelect,
                                                                        PayloadType.CHECKOUT_STEP : self.currRow])

Tracking open notification

in AppDelegate 

func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
    let content = response.notification.request.content
    // omnisegment tracking notification open
    OmniSegmentService.sharedInstance.processUserInfo(userInfo: content.userInfo)
    completionHandler()
}

Clone this wiki locally