Skip to content

Latest commit

 

History

History
361 lines (304 loc) · 14.5 KB

README.md

File metadata and controls

361 lines (304 loc) · 14.5 KB

TOP　> API Reference

Table of Contents

API Reference

RakutenReward

RakutenReward class is to provide main settings and main functions of Reward SDK

API Name Description Example
Get version Get Rakuten Reward SDK Version RakutenReward.shared.getVersion()
Open SDK Portal For detail, please check sample application implementation RakutenReward.shared.openPortal(completionHandler: {r in})
Open Ad Portal (JP region) Open Ad Portal RakutenReward.shared.openAdPortal { openAdPortalCompletion in }
Open Help Page Open Reward SDK Help page with mini browser RakutenReward.shared.openSupportPage(.Help)
Open Terms and Condition Page Open Reward SDK Terms and Conditions Page with mini browser RakutenReward.shared.openSupportPage(.TermsCondition)
Open Privacy Policy Page Open Reward SDK Privacy Policy Page with mini browser RakutenReward.shared.openSupportPage(.PrivacyPoilicy)
Get Missions Get missions RakutenReward.shared.getMissionListWithProgress(completion: { r in })
Get Missions Lite Get missions lite (without progress and reachedCap) RakutenReward.shared.getMissionLiteList(completion: { r in })
Get Mission Details Get full details from mission lite RakutenReward.shared.getMissionDetails(actionCode: "example", completion: { r in }
Get Point history Get 3 month user's point history RakutenReward.shared.getPointHistory(completion: { r in })
Log Action Post user action RakutenReward.shared.logAction(actionCode: "xxxxxx", completionHandler: { r in})
Get Unclaimed Items Get Unclaim item list RakutenReward.shared.getUnclaimedMission({ completion: { r in })
Get Dynamic API last failed info Get last failed API info(paremeter) RakutenReward.shared.retryLastFailedFunctionByNewToken
Get Point & Rank Load latest point & rank from server RakutenReward.shared.loadMemberInfoRank({_ in })
Log In Open Log In page RakutenReward.shared.openLoginPage({_ in })
Check Log In Check if user is logged in with internal system (token not expired) RakutenReward.shared.isLogin()
Log Out Log out from Rakuten Auth RakutenReward.shared.logout { }
Blacklisted URLs Add blacklist URL to block access specific URL, (This is for Apple Reject, if the ad URL has problem, use this API) RakutenReward.shared.blacklistURLs
Custom URL Session To use custom URL session instead of default URL session RakutenReward.shared.customURLSession
User updated delegate Callback when user is updated RakutenReward.shared.didUpdateUser = { user in }
Status updated delegate Callback when Reward Status is updated RakutenReward.shared.didUpdateStatus = { status in }
User achieved mission delegate Callback when user has achieved a mission RakutenReward.shared.didUpdateUnclaimedAchievement = { unclaimedItem in }
Is Portal present status updated delegate Callback when portal is present or hidden RakutenReward.shared.didUpdateIsPortalPresentedStatus = { isPortalPresent in }
Is AdPortal present status updated delegate Callback when ad portal is present or hidden RakutenReward.shared.didUpdateIsAdPortalPresentedStatus = { isAdPortalPresent in }
Request for user consent Request User Consent (Since v5.0) RakutenReward.shared.requestForConsent { status in }
Show user consent notification banner Show consent banner (Since v6.3.0) RakutenReward.shared.showConsentBanner { status in }
Did present consent UI Callback when user consent UI is presented RakutenReward.shared.didPresentConsentUI = {}
Did dismiss consent UI Callback when user consent UI is dismissed RakutenReward.shared.didDismissConsentUI = {}

RakutenRewardConfiguration

RakutenRewardConfiguration is user setting class.

API Name Description Example
Get Optout Get Optout status
true : Optout (Reward SDK function does not work)		 RewardConfiguration.isUserOptingOut
Set Optout Set Optout status RewardConfiguration.isUserOptingOut = false
UI Enabled Get whether Notification UI is enabled or not RewardConfiguration.isUserSettingUIEnabled
Set UI Enabled Set whether Notification UI is enabled or not RewardConfiguration.isUserSettingUIEnabled = true
Enable Logging Set value to true to receive additional Debug log info RewardConfiguration.isDebug = true
Rz Cookie Set value for the Rz cookie RewardConfiguration.rzCookie = "example"
Rp Cookie Set value for the Rp cookie RewardConfiguration.rpCookie = "example"
Ra Cookie Set value for the Ra cookie RewardConfiguration.raCookie = "example"
Is Portal Present Get whether Portal is currently showing or not RewardConfiguration.isPortalPresent
Is AdPortal Present Get whether AdPortal is currently showing or not RewardConfiguration.isAdPortalPresent (Deprecated in v4.1)
Is MissionEventFeatureEnabled Get and set MissionEvent feature status RewardConfiguration.isMissionEventFeatureEnabled = true
setCustomDomain This setting is for setting custom domain for Staging RewardConfiguration.setCustomDomain("stg.test.com")
setCustomPath This setting is for setting custom path for Staging RewardConfiguration.setCustomPath("/testPath/test/")
isUsingSDKPortal Set whether app using SDK Portal or not RewardConfiguration.isUsingSDKPortal = true
setAppLanguage Set in app language manually. SDK supported language value are 'ja', 'en', 'ko', 'zh-hans', 'zh-hant'. Set empty string value to use language from device settings. Unsupported value will be defaulted to 'ja' RewardConfiguration.setAppLanguage("en")

Open Reward Web page

SDK provide page open with API

extension RakutenReward {
    public enum SupportPage : CaseIterable {
 
        case help
        case termsCondition
        case privacyPolicy
 
    }
    public func openSupportPage(_ page: RakutenRewardNativeSDK.RakutenReward.SupportPage)
}

SDKUser

SDKUser : User class

RakutenReward.shared.user
Parameter Description
signIn Whether the user is singin or not
unclaimedMissionCount Number of unclaim mission
point Reward SDK Point
currentPointRank MemberPointRank; member points and rank, persistent & loaded separately
getName Get user's username

RakutenRewardStatus

RakutenRewardStatus is Reward SDK status

Parameter Description
.online Finished SDK initialization(Update User info correctly)
.offline Not finished SDK initialization or initialization failed
.appcodeInvalid Wrong Application Code
.tokenExpired Expired Token. If tokenType is RakutenAuth, .TokenExpired means user should log in again
.userNotConsent User has not agree with RakutenReward terms of service and privacy policy agreement

RakutenRewardConsentStatus

RakutenRewardConsentStatus Description
consentProvided User already provide consent
consentNotProvided User have not provide consent
consentFailed There is some error with API request
consentProvidedRestartSessionFailed User provided consent but failed to restart SDK session

Checking the status

let status = RakutenReward.shared.status

API Data


Mission

Parameter Description Example
name Mission name Mission A
actionCode Mission Action Key ZIJCjBeQBHac8nJa
iconurl Mission icon URL https://mprewardsdk.blob.core.windows.net/sdk-portal/appCode/actionCode.png
instruction Mission instruction One day one play
condition Descritpion about mission max achievable 10 times achievable
notificationtype Mission UI Type NONE, BANNER, MODAL, CUSTOM, BANNER_50, BANNER_250
point Mission Point 10
enddatestr Mission End Date
Daily : Today
Weekly : End of week
Monthly : Endof Month
Custom : Custom End Date
 20190403
till Mission End date 3 days
addtional Additional messages
reachedCap Whether mission reached max cap or not true
times Required action times 3
progress Current action times 1

MissionLite

Parameter Description Example
name Mission name Mission A
actionCode Mission Action Key ZIJCjBeQBHac8nJa
iconurl Mission icon URL https://mprewardsdk.blob.core.windows.net/sdk-portal/appCode/actionCode.png
instruction Mission instruction One day one play
condition Descritpion about mission max achievable 10 times achievable
notificationtype Mission UI Type NONE, BANNER, MODAL, CUSTOM, BANNER_50, BANNER_250
point Mission Point 10
enddatestr Mission End Date
Daily : Today
Weekly : End of week
Monthly : Endof Month
Custom : Custom End Date
 20190403
till Mission End date 3 days
addtional Additional messages
times Required action times 3

PointHistory

Method Description Example
getPointHistory Get a list of point history RakutenReward.shared.getPointHistory { (result) in }

PointRecord

Parameter Description
point Point
month Point Date(Month)

UnclaimedItem

Parameter Description
name Mission name
iconurl Mission icon URL
instruction Mission Instruction
actionCode Mission Action Code
notificationtype Mission UI Type
point Point
unclaimedTimes Number of Unclaim Item
achieveddatestr Mission Achievement Date
getAchievedDate() Get achievement date in "yyyy/MM/dd" format

API Errors


RewardSDKSessionError

Name Description
userNotFound Failed startSession
appcodeInvalid SDK status is APPCODEINVALID
bundleError Parameters are wrong
loginRequired (internal log-in only) start session or use API before log in
invalidTokenType (internal log-in only) Token type is not valid
cannotRetrieveSessionToken (internal log-in only) failed to get token to use APIs, please start session again
cannotLogOutOnServer (internal log-in only) failed to log out

RPGRequestError

Name Description
tokenExpire Access token is expired
serverError Cannot connect
badRequest Bad request
unavailableForLegalReasons Error because of legal reason (for example, user has not consent to RewardSDK's terms and condition)

SDKError

Name Description
noMissionFound Mission list is empty
missionReachedCap When a mission achievement is already reached its cap (v6.2.0 and newer)
noUnclaimedItemFound UnclaimedItem list is empty
sessionNotInitialized SDK is not initialized
featureDisabledByUser SDK function is not active by user
sdkStatusNotOnline SDK status is not online
sdkStatusUserNotConsent SDK status - user has not consent to RewardSDK's terms and condition

Get current user action status

RakutenReward.shared.getMissionListWithProgress(completion: {r in
                    switch r {
                    case .success(let mList): // mission List to display
		            case .failure(let err): // handling the error
		    }
}

Set Rakuten Cookie

This function can be used from SDK v2.2.0 This function is mainly for Rakuten App and use cookies which app keeps in App If you use default login option(TokenType.RakutenAuth), cookie is set by SDK. If you use other options, can override cookie using this API

Set Rp cookie

RewardConfiguration.rpCookie = "example"

Set Rz cookie

RewardConfiguration.rzCookie = "example"

Set Ra cookie (version 5.1.0)

RewardConfiguration.raCookie = "example"

Event Analytics

This function can be used from SDK v3.3.0

RakutenMissionEvent.shared.logAction(eventCode: "exampleEventCode", eventTrackingType: .ratSpecificEvent, parameters: nil) { error in
    if let error = error {
        // Error
        return
    }
    // Success
}

Parameters

Status Summary
eventCode Analytics SDK event code
eventTrackingType RakutenMissionEventTrackingType / Analytics SDK tracking type
parameters (optional) Analytics SDK parameters

Enum RakutenMissionEventTrackingType

Type Summary
genericEvent tracking generic event
ratSpecificEvent tracking Analytics SDK specific event

How to create custom mission UI

When the user achieves a mission, this callback is invoked

// From RakutenReward class
public var didUpdateUnclaimedAchievement: ((UnclaimedItem) -> Void)?
  
// Example
RakutenReward.shared.didUpdateUnclaimedAchievement = { unclaimedItem in }

Example of showing custom UI

Note: Currently SDK doesn't support showing notifications inside Portal. Therefore, developers need to check RewardConfiguration.isPortalPresent API and only show Notification UI if Portal is not showing. This API is available from version 2.3.0

RakutenReward.shared.didUpdateUnclaimedAchievement = { unclaimedItem in
    guard unclaimedItem.notificationType == .CUSTOM, // Check notification type
          RewardConfiguration.isUserSettingUIEnabled, // Check if user enable the UI setting or not
          !RewardConfiguration.isPortalPresent else { // Check if Portal is currently showing, not support for showing notification inside Portal.
            
        return
    }
  
    // Show Custom UI in Main thread
}

Example for claim points

RakutenReward.shared.didUpdateUnclaimedAchievement = { unclaimedItem in
    RakutenReward.shared.claim(unclaimedItem: unclaimedItem, completion: { pointClaimScreenEvent in }
}

LANGUAGE :

ja