#Version 4 of the Appta Game SDK for Unity

Version 4 of the Appota Game for Unity has been published in this reposity and in Developer Preview. Version 3 will continue to be available in our appota-ios-game-sdk3 repository. If you upgrade from SDK3 to SDK4 please check our Upgrade Document

##Highlights

• Appota Login – Support multiple login methods Appota, Google, Facebook, Twitter, Guest.
• Appota Payment – Support mutiple payment methos SMS, Card, E-Bank, Apple Payment.
• Appota Analytics – A service for collecting, visualizing, and understanding user and app data (session, active, error log, ...) at scale.
• Push Notification on multiple platforms (iOS, Android, WP).

1. Integrate SDK
2. Client API
   • Init and setup SDK
   • User function
   • Payment function
   • Analytic function
   • Push notification function
3. Class document
4. FAQ and Glossary

##1. Integrate SDK The sample apps are standalone projects that are already set up for you. You can also integrate the SDK for Unity with an existing application. Open AppotaGameSDK4.unitypackage to install SDK to your project.

###1.1. Prerequisites To get started with the Appota Game SDK for Unity, you can set up the SDK and start building a new project, or you can integrate the SDK in an existing project. You can also run the samples to get a sense of how the SDK works.

Required Unity 4.5 or later

###1.2. Obtain app api key and client key

• Retreive Appota app information ClientKey, APIKey, ClientSecret from app dashboard. If you haven't already registered your app with Appota by creating a Appota app, you should create a new app then retreive app information from developer dashboard.
• Retreive Facebook Application ID.
  Detail about how to create ,retreive and setup Facebook app info for iOS. If you can not access Facebook Developer page, please contact our support (sale@appota.com) to get the application id.
• Retreive Google Client ID and Client Secret.
  Create new project from https://console.developers.google.com, in API & Auth-Credentials add iOS support and get ClientID and ClientSecret. If you can not access Google Developer page, please contact our support (sale@appota.com) to get the application id and secret.

###1.3. Configure your Unity Project

####1.3.1. Import plugin

####1.3.2. Configure Unity project

• Use FacebookAppID, ApiKey, GoogleClientID, GoogleClientSecret has created in IntegrateSDK to update setting
• Create your Facebook App Link URL to have new Facebook Invite function inside your SDK (Create Facebook AppLink URL)

###1.4. Configure Frameworks (iOS platform only) To use the SDK for the iOS platform, drag and drop AppotaSDK.framework, AppotaBundle.bundle and FacebookSDK.framework into your Xcode project (which project you get from Unity3D)

Tick on checkbox: “Copy items into destination group's folder (if needed)”.

To use other setting like admob and Appsflyer please fill in your developer ID

##2. Client API

###2.1 Init and setup SDK Related class and function:
AppotaSDKHandler
AppotaSDKReceiver
Appota SDK init must be called once when application start via AppotaSDKHandler class call AppotaSDKHandler.Instance.Init() so most of the time it will be called in your first scene

AppotaSDKHandler.Instance.Init();

There are some functions to control SDK flows, have to call them after AppotaSDKHandler.Instance.Init()

• SetKeepLoginSession(BOOL) this function will control the Appota Login Session will be kept or removed at app lauching (when session's removed user has to login again when app start).
  Note If this function is not called, login session will be kept by default.

• SetAutoShowLoginDialog(BOOL) this function will control the Appota Login View will be automatically show at app lauching (when user's not logged in) or you have to call ShowLoginView function to show the LoginView.
  Note If this function is not called, login view will automatically show at app lauching (when user's not logged in)

• SetSDKButtonVisibility(BOOL) call this function to setting hide or show SDK floating button

• FinishSDK() call this function in OnApplicationQuit script ###2.2. User function Related class and function:

• AppotaSDKHandler

• AppotaSDKReceiver

• AppotaSession

Once you've implemented init SDK function, start using login features.

####2.2.1. Show login view As mentioned above login dialog flow can be control by function SetAutoShowLoginDialog(BOOL). Automatically show login view at app launching or manual call ShowLoginView when you need:

• Show Login View

AppotaSDKHandler.Instance.ShowLoginView();

Appota Login Dialog contains 5 authorization methods: Facebook, Google, Twitter, Appota User and Quick Login

Follow this mechanism for login function, please implement didLoginSuccess callback to authenticate your in-game user.

• Logout function

AppotaSDKHandler.Instance.Logout();

• Switch account function

Call this function when user logged in will show a login view and allow to login other account. When switch account succeed OnLoginSucceed callback will be called again, so please logout your game account and reauthenticate with new switched account.

AppotaSDKHandler.Instance.SwitchAccount();

• Show User Info function

This function will show user profile view

AppotaSDKHandler.Instance.ShowUserInfo();

• Check user login This function will return user logged in state

AppotaSDKHandler.Instance.IsUserLogin();

• Get AppotaSession Return AppotaSession if logged in

AppotaSDKHandler.Instance.GetAppotaSession();

• Set Character Set character function to support character management on web

public void SetCharacter(string name, string server, string characterID)

####2.2.2. Handle authenticaiton callbacks

AppotaSDK provide 4 callbacks delegate for login defined in AppotaSDKReceiver , please implement these functions to handle login result

Login succeed callback
Retreive Appota user info from AppotaSession then post to your server to verify and create game user. For more detail about user integration on server: User Integration

Note Remember verify Appota UserID, UserName and Access token on your server before procceeding game user integration

public void  OnLoginSucceed(string appotaSession)

Login fail callback
Callback when login have problems

public void  OnLoginError(string error);

Logout callback
Callback after user logout with user name, please logout your game account and call showLoginView to login other account

public void  OnLogoutSuccess(string userName)

Close login view callback
Callback when user close login view at app launching

public void  OnCloseLoginView();

###2.2. Payment function

Related class and function:

• AppotaSDKHandler - payment function
• AppotaSDKReceiver
• AppotaPaymentResult

Because using AppotaSDK payment function you should understand Appota Payment mechanism and configuration. Please study Appota payment mechanism at Appota Payment Document and payment configuration at Appota Developer Portal.

####2.2.1. Show payment view

You have 3 methods to show payment view. Each payment view represents one or list of payment package. Each package contains information of game coin amount or in-game package.

Show default list payment view

You can show payment view with default list payment packages (which is configured on Appota Developer Portal)

AppotaSDKHandler.Instance.ShowPaymentView()

Show payment view for a specific package

You can show a specific package depends on your in-game mechanism

AppotaGameSDK.Instance.ShowPaymentViewWithPackageID(string packageID)

Show payment view from SDK floating button
User can open Payment, Information and Transaction History view via floating button

(Show image of floating button and then SDK show gif)

####2.2.2 Handle payment callback

You have to implement and modified all callbacks in AppotaSDKReceiver.

Callback after a successful payment

Depends on your payment machenism (IPN, please readmore about Appota Payment), proceed payment verification or alert payment succeed for user

public void OnPaymentSuccess(string transactionResult);

Callback for payment state

** YOU HAVE TO IMPLEMENT THIS FUNCTION TO ENSURE GOLD CHARING CORRECTLY **
PAYMENT_STATE is required for our SDK to make correct payment with package. Depends on your payment package implement this function and return a correct payment state.
For example packageID: com.gold.package1 - (defined in integration process) corresponds with a package of 1000 gold and current game user is X in server Y. Then payment state can be constructed : com.gold.package1_1000_gold_X_Y (depends on your format).

public void GetPaymentState(string packageID);

###2.3. Analytic function

Appota SDK support calling track for view and event. These track information is very use for game advertisement and tracking.

** View tracking function **
When enter a view send view for tracking

public void SendView(string name);

** Event tracking function **
When user perform an event send event for tracking

public void SendEvent(string category,string action,string label)

Define category, action, label detail of the action

###2.3. Push notification function ** Register push notification with groupname **
Register push notification: Use group name to choose user group for easy pushing (for example only push user in server 1 then groupName = "server 1").

public void setPushGroup(string groupName)

##3. Class Document

• AppotaSDKHandler
• AppotaSDKReceiver
• AppotaSession
• AppotaPaymentResult

##4. FAQ and Glossary

• When using SDK in games with server and game user support. To prevent user to make payment before entering the game (actually choose server and game user). You should call SetSDKButtonVisibility(False) when configure the SDK and then call SetSDKButtonVisibility(True) when game user is ready.
• IPN is payment machenism used by Appota System to increase gold for game user. Detail in https://github.com/appota/ios-game-sdk/wiki/Passive-Confirmation-via-IPN . Each app in Appota system will be configured with only one IPN url to callback when payment.
• PackageID each payment package in game should be defined along with a package ID (provided by SDKTool) to identify package.
• PackageID each payment package in game should be defined along with a package ID (provided by SDKTool) to identify package.
• PaymentState payment state must be implemented in GetPaymentState function. And use PackageID and game server information to build up PaymentState.
  For example packageID: com.gold.package1 - (defined in integration process) corresponds with a package of 1000 gold and current game user is X in server Y. Then payment state can be constructed : com.gold.package1_1000_gold_X_Y (depends on your format). Flow of getPaymentState function: