Table of Contents

• Table of Contents
• Overview
• Quick Start Guide
  • Install Vue SDK
    • Using Android Studio
  • Initialize VueSDK
  • Discover Events
  • Track Event
  • Get Recommendations
    • Get Recommendations by Page
    • Get Recommendations by Module
    • Get Recommendations by Strategy
  • Set User
  • Reset User
  • VueSDK debugging and logging
  • Complete Code Example
  • I want to know more!

Overview

VueSDK is a library/SDK providing all the functions and utilities required to help you build and integrate all the recommendations and search offered by Vue.AI. To know about the detailed set of use cases available - please visit this link

Quick Start Guide

Install Vue SDK

You will need your sdk token for initializing your library. You can get your sdk token from sdk settings.

Using Android Studio

1. If this is your first time using Android Studio, Install Android Studio and dependencies from Android Studio's Website. And start a new project.
2. Add the JitPack repository to your build file

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

3. Add the dependency

dependencies {
    implementation 'com.github.mad-street-den:vue-sdk-android:1.1.1'
}

Initialize VueSDK

Import and initialize VueSDK in MainActivity, passing the context, token and baseUrl

import com.msd.vuesdk.helper.client.VueSDK

class MainActivity {
    ...
    val vueSDKClient = VueSDK.getInstance(
        context = applicationContext,
        token = "YOUR_TOKEN",
        baseUrl = "GIVEN_MSD_BASE_URL"
    )
    ...
}

Discover Events

To ensure accurate and comprehensive event tracking, it is recommended to call the discoverEvents function before invoking the track function in your SDK integration. The discoverEvents function retrieves the essential information related to track events, such as event names, properties, and default properties. This step allows you to populate the necessary data and configure the event tracking accordingly.

vueSDKClient.discoverEvents(object : DiscoverEventsCallback {
    override fun onDiscoverEventsFetched(response: DiscoverEventsResponse) {
        // Save the response if needed
    }

    override fun onError(errorResponse: JSONObject) {
        // Handle failure of discover events
    }
})

Track Event

To track custom events using our SDK, you can utilize the track function. This function allows you to capture specific actions or interactions within your application and gather valuable data for analysis.

Here's an example of how to use the track function:

val vueSDKConfig = VueSDKConfig(medium = "RANDOM_MEDIUM", referrer  = "RANDOM_REFERRER", url = "RANDOM_URL",platform="RANDOM_PLATFORM")

vueSDKClient.track(
    eventName = "Event_Name",
    properties = <JSON_Object>,
    correlationID = "UNIQUE_CORRELATION_ID",
    sdkConfig = vueSDKConfig
)

Note: The correlationId is an optional parameter that allows you to provide a unique correlation ID for the event. It is important to ensure that the correlationId is unique across each page for both search and track API calls.

The SDK automatically includes several properties when tracking events. These properties are essential for comprehensive event tracking and provide valuable insights into user interactions. Given below are the properties that are automatically added by the SDK. By explicitly providing the SDK config parameter for the track function, the user can override each property's value:

key	Description	Example Value
platform	Platform of the user	android
medium	Medium from where requests are sent	application
referrer	same values as platform for mobile app	android
url	Bundle id of the application	com.example.myapp

Get Recommendations

The getRecommendation functions in the SDK allows you to retrieve recommendations based on specific search criteria and properties. This function provides a convenient way to fetch recommendations and receive the results asynchronously.

Get Recommendations by Page

val vueSDKConfig = VueSDKConfig(medium = "RANDOM_MEDIUM", referrer  = "RANDOM_REFERRER", url = "RANDOM_URL",platform="RANDOM_PLATFORM")

 vueSDKClient.getRecommendationsByPage(
    pageReference = "YOUR_PAGE_NAME",
    properties = RecommendationRequest(
        catalogs = <JSON_Object>
    ),
    correlationID = "UNIQUE_CORRELATION_ID", sdkConfig = vueSDKConfig,callback =
    object : RecommendationCallback {
        override fun onRecommendationsFetched(response: JSONArray) {
            // Action on recommendations fetched
        }

        override fun onError(errorResponse: JSONObject) {
            // Action on fetch failure
        }
    })

Get Recommendations by Module

val vueSDKConfig = VueSDKConfig(medium = "RANDOM_MEDIUM", referrer  = "RANDOM_REFERRER", url = "RANDOM_URL",platform="RANDOM_PLATFORM")

 vueSDKClient.getRecommendationsByModule(
    moduleReference = "YOUR_MODULE_NAME",
    properties = RecommendationRequest(
        catalogs = <JSON_Object>
    ),
    correlationID = "UNIQUE_CORRELATION_ID", sdkConfig = vueSDKConfig,callback =
    object : RecommendationCallback {
        override fun onRecommendationsFetched(response: JSONArray) {
            // Action on recommendations fetched
        }

        override fun onError(errorResponse: JSONObject) {
            // Action on fetch failure
        }
    })

Get Recommendations by Strategy

val vueSDKConfig = VueSDKConfig(medium = "RANDOM_MEDIUM", referrer  = "RANDOM_REFERRER", url = "RANDOM_URL",platform="RANDOM_PLATFORM")

vueSDKClient.getRecommendationsByStrategy(
    strategyReference = "YOUR_STRATEGY_NAME",
    properties = RecommendationRequest(
        catalogs = <JSON_Object>
    ),
    correlationID = "UNIQUE_CORRELATION_ID", sdkConfig = vueSDKConfig,callback =
    object : RecommendationCallback {
        override fun onRecommendationsFetched(response: JSONArray) {
            // Action on recommendations fetched
        }

        override fun onError(errorResponse: JSONObject) {
            // Action on fetch failure
        }
    })

Note: The correlationId is an optional parameter that allows you to provide a unique correlation ID for the search request. It is important to ensure that the correlationId is unique across each page for both search and track API calls.

Given below are the properties that are automatically added by the SDK. By explicitly providing the SDK config parameter for the getRecommendations function, the user can override each property's value.

key	Description	Example Value
platform	Platform of the user	android
medium	Medium from where requests are sent	application
referrer	same values as platform for mobile app	android
url	Bundle id of the application	com.example.myapp

Set User

The setUser function in the SDK allows you to associate a user ID with subsequent API calls after the user has logged in. This user ID is used to track user-specific events and behaviors, providing personalized experiences and accurate analytics.

 vueSDKClient.setUser(userId = "YOUR_USER_ID")

Reset User

The resetUser function in the SDK allows you to clear the user information, we recommend you to call this function on user logout/switch. This ensures that any user-specific data and tracking are cleared and no longer associated with the user.

 vueSDKClient.resetUser()

VueSDK debugging and logging

The SDK provides internal logging capabilities for debugging purposes. By default, the logging feature is disabled.

To enable internal logging, pass true to the function setLogging:

vueSDKClient.setLogging(loggingState = true)

Set BloxUUID

The setBloxUUID function in the SDK allows you to set the blox UUID which is passed as argument for the getRecommendations and track functions. In the case where you do not set bloxUUID, the SDK internally generates a random UUID upon an SDK function call and will maintain the same value till setBloxUUID is called.

vueSDkClient.setBloxUUID(YOUR_UUID)

Note: The BloxUUID provided will be stored in App's cache and will be maintained throughout App's lifecycle.

Get BloxUUID

The getBloxUUID function in the SDK returns the blox UUID configured in the SDK.

vueSDkClient.getBloxUUID()

Note: In case if setBloxUUID or an SDK function is not called throughout an app's lifecycle the getBloxUUID function will return a null value.

Complete Code Example

Here's a runnable code example that covers everything in this quick start guide.

import com.msd.vuesdk.helper.client.VueSDK

class MainActivity {
    ...
    
    val vueSDKClient =  VueSDK.getInstance(
        context = applicationContext,
        token = "YOUR_TOKEN",
        baseUrl = "https://api.msd.com"
    );

    vueSDKClient.track(
        eventName = "YOUR_CUSTOM_EVENT_NAME",
        properties = JSONObject()
    );

    vueSDKClient.getRecommendationsByPage(
        pageReference = "YOUR_PAGE_NAME",
        properties = RecommendationRequest(
            catalogs = JSONObject()
        ),
        correlationID = "UNIQUE_CORRELATION_ID"
        object : RecommendationCallback {
            override fun onRecommendationsFetched(response: JSONArray) {
                // Action on recommendations fetched
            }

            override fun onError(errorResponse: JSONObject) {
                // Action on fetch failure
            }
        })
    ...
}

I want to know more!

Have any questions? Reach out to MSD Support to speak to someone smart, quickly.