Reward Actions

Reward Action are used to trigger the reward engine for the given action. There are already built in reward actions already defined in producer suite where producer/integrators could also create their own custom reward actions.

Some example of custom reward actions could be:

Opening an app once a day
Completing an on-boarding process
Reading an article
Watching a video

Creating a Custom Reward Action

In producer suite, browse to the "Rewards" section from the left navigation panel.
Click on Actions tab which will show you list of all available reward actions.
Click on "New Reward Action" button, fill in the required details and click "Create".

List of all Reward Actions

Get list of all reward actions. Each list item is a reward action object that contains a "key" property which could be used to fetch invoked reward actions for a given program id.

LiveLike.getRewardActions().then(({results}) => console.log(results))

sdk.rewards().getRewardActions(
                LiveLikePagination.FIRST,
                object : LiveLikeCallback<LLPaginatedResult<RewardActionInfo>>() {
                    override fun onResponse(
                        result: LLPaginatedResult<RewardActionInfo>?,
                        error: String?
                    ) {
                       Log.d("result",result)
                    }
                })

//SDK 2.79 onwards
sdk.rewards().getRewardActions(
                LiveLikePagination.FIRST,
                object : LiveLikeCallback<List<RewardActionInfo>>() {
                    override fun onResponse(
                        result: List<RewardActionInfo>?,
                        error: String?
                    ) {
                       Log.d("result",result)
                    }
                })

self.sdk.rewards.getRewardActions(
	page: .first
) { result in
	switch result {
  case .failure(let error):
    //Failure Block
	case .success(let rewardActions):
    //Success Block
	}
}

List of all invoked Reward actions

Get list all the invoked reward actions for a given program. You could also filter the reward actions by passing a list of reward action keys.

LiveLike.getInvokedRewardActions({
  programId: "xxx-yyy-zzz",
  rewardActionKeys: ["xx-yy-zz"]
}).then(({results}) => console.log(results))

sdk.rewards().getInvokedRewardActions(
                LiveLikePagination.FIRST,
                invokedActionRequestParams = GetInvokedRewardActionParams(programId, rewardActionKeys)
                , object : LiveLikeCallback<LLPaginatedResult<InvokedRewardAction>>() {
                    override fun onResponse(
                        result: LLPaginatedResult<InvokedRewardAction>?,
                        error: String?
                    ) {
                         Log.d("result",result)
                    }
                })

//SDK 2.79 onwards
sdk.rewards().getInvokedRewardActions(
                LiveLikePagination.FIRST,
                invokedActionRequestParams = GetInvokedRewardActionParams(programId, rewardActionKeys)
                , object : LiveLikeCallback<List<InvokedRewardAction>>() {
                    override fun onResponse(
                        result: List<InvokedRewardAction>?,
                        error: String?
                    ) {
                         Log.d("result",result)
                    }
                })

self.sdk.rewards.getInvokedRewardActions(
	page: .first,
	options: GetInvokedRewardActionsOptions(
		programID: programID,
		rewardActionKeys: rewardActionKeys
	)
) { result in
	switch result {
	case .failure(let error):
    //Failure Block
  case .success(let invokedActions):
    //Success Block
	}
}

further filters can be supplied to narrow down your results.

filters include:

profile ids to limit to specific users
attributes to filter on integration supplied data

sdk.rewards().getInvokedRewardActions(
                LiveLikePagination.FIRST,
                invokedActionRequestParams = GetInvokedRewardActionParams(
                  profileIDs = listOf("userA", "userB"),
                  attributes = mapOf( 
                    "Season" to "2023",
                    "Rarity" to "Uncommon"
                    )
                )
                , object : LiveLikeCallback<LLPaginatedResult<InvokedRewardAction>>() {
                    override fun onResponse(
                        result: LLPaginatedResult<InvokedRewardAction>?,
                        error: String?
                    ) {
                         Log.d("result",result)
                    }
                })

//SDK 2.79 onwards
sdk.rewards().getInvokedRewardActions(
                LiveLikePagination.FIRST,
                invokedActionRequestParams = GetInvokedRewardActionParams(
                  profileIDs = listOf("userA", "userB"),
                  attributes = mapOf( 
                    "Season" to "2023",
                    "Rarity" to "Uncommon"
                    )
                )
                , object : LiveLikeCallback<List<InvokedRewardAction>>() {
                    override fun onResponse(
                        result: List<InvokedRewardAction>?,
                        error: String?
                    ) {
                         Log.d("result",result)
                    }
                })

LiveLike.getInvokedRewardActions({
  profileIds: ["xxx-yyy", "www-zzz"],
  attributes: [{ key: "color", value: "red" }]
}).then(({results}) => console.log(results))