Unity SDK_登录相关功能

集成Google、Facebook、NAVER等各种登录SDK功能，可在GAMEPOT Unity SDK使用。

使用前设置

如要使用登录相关SDK功能，需完成控制台设置并声明登录相关代码。

设置Google登录环境

---

为使用登录功能，按以下方法设置Google Firebase控制台。

1. 请将自Google Firebase控制台获取的安卓用google-service.json文件复制到/Assets/Plugins/Android/路径。

2. 将配置APK时使用的Keystore文件的SHA-1值添加到Firebase控制台。

   • 尝试Google登录时，如果onCancel响应并无法登录，请按以下方法解决。

     • 确认是否正常应用google-service.json文件

     • 确认配置APK时使用的Keystore和为注册到Firebase控制台导出SHA-1值的Keystore是否相同

     • 确认构建时是否使用了注册到Firebase控制台的包名称

设置Facebook登录环境

---

为使用登录功能，按以下方法设置Facebook控制台。

1. 在Facebook for Developers控制台选择None、Consumer或Instant Games作为应用类型后创建应用。

2. 将配置APK时使用的Keystore的密钥哈希值添加到Facebook for Developers控制台。

3. 将从Facebook for Developers控制台获取的应用ID输入到下列代码后，添加到Android专用mainTemplate.gradle文件。

   ...
   defaultConfig {
       resValue "string", "facebook_app_id", "{应用ID}"
       resValue "string", "fb_login_protocol_scheme", "fb{应用ID}"
   }
   ...

4. 请在项目/Assets/Plugins/IOS/Frameworks路径中添加下列框架。

   • FBSDKLoginKit.framework, FBSDKCoreKit.framework, GamePotFacebook.framework

设置Apple登录环境

---

若要设置iOS专用Apple登录环境，在项目中选择Target后，请在Signing & Capabilities菜单添加Sign In with Apple Capability。

设置游戏中心登录环境

---

iOS专用Game Center登录环境的设置方法如下。

1. 在项目Assets/Plugins/IOS/etcFrameworks/路径下选择GamePotGameCenter.framework后，选择Select platforms for plugin列表中的iOS设置。

2. 在Xcode中选择Target后，在Build Phases > Linked Binary With Libraries菜单下添加Gamekit.framework。

3. 请在 Signing & Capabilities 菜单中添加 GameCenter Capability。

登录功能

如要使用根据开发商实现的登录UI点击登录按钮时操作的SDK登录功能，请使用下列代码。

• 方式1

  GamePot.login(NCommon.LoginType);
  
  // 登录成功
  public void onLoginSuccess(NUserInfo userInfo)
  {
  }
  // 登录失败
  public void onLoginFailure(NError error)
  {
      // 请使用error.message显示错误消息。
  }
  // 取消登录
  public void onLoginCancel()
  {
      // 用户取消登录
  }
  // 强制更新（商店版本和客户端版本不一致时调用）
  public void onNeedUpdate(NAppStatus status)
  {
      // 须基于参数传递的status信息创建并显示弹窗。 请从下列两种方式中选择一种配置弹窗。
      // 方式1：使用开发商自行实现UI的游戏内弹窗
      // 方式2：调用下列代码后使用SDK自主弹窗
      // GamePot.showAppStatusPopup(status.ToJson());
  }
  // 维护（仪表盘的维护选项处于激活状态时调用）
  public void onMainternance(NAppStatus status)
  {
       // 须基于参数传递的status信息创建并显示弹窗。 请从下列两种方式中选择一种配置弹窗。
      // 方式1：使用开发商自行实现UI的游戏内弹窗
      // 方式2：调用下列代码后使用SDK自主弹窗
      // GamePot.showAppStatusPopup(status.ToJson());
  }
  // 结束应用
  public void onAppClose()
  {
      // 如果使用方式2实现强制更新或维护功能时，因有可能强制结束应用，请在此处可执行结束应用。
  }

• 方式2

  GamePot.login(NCommon.LoginType, GamePotCallbackDelegate.CB_Login);
  
  GamePot.login(NCommon.LoginType, (resultState, userInfo, appStatus, error) => {
      switch (resultState)
      {
          case NCommon.ResultLogin.SUCCESS:
          // login success
          break;
          case NCommon.ResultLogin.CANCELLED:
          // login cancel
          break;
          case NCommon.ResultLogin.FAILED:
          // login fail
          break;
          case NCommon.ResultLogin.NEED_UPDATE:
              // 须基于参数返回的appStatus信息创建和显示弹窗。 请从下列两种方式中选择一种配置弹窗。
              // 方式1：使用开发商自行实现UI的游戏内弹窗
              // 方式2：调用下列代码后使用SDK自主弹窗
              // GamePot.showAppStatusPopup(status.ToJson());
          break;
          case NCommon.ResultLogin.MAINTENANCE:
              // 须基于参数返回的appStatus信息创建和显示弹窗。 请从下列两种方式中选择一种配置弹窗。
              // 方式1：使用开发商自行实现UI的游戏内弹窗
              // 方式2：调用下列代码后使用SDK自主弹窗
              // GamePot.showAppStatusPopup(status.ToJson());
          break;
          case NCommon.ResultLogin.APP_CLOSE:
              // 如果使用方式2实现强制更新或维护功能时，因有可能强制结束应用，请在此处可执行结束应用。
          break;
          default:
          break;
      }
  });

定义LoginType、NUserInfo、NAppStatus

---

如要设置登录功能的各个参数，请使用下列代码。

• LoginType

  public enum LoginType
  {
      NONE,
      GOOGLE,
      GOOGLEPLAY,
      FACEBOOK,
      NAVER,
      GAMECENTER,
      TWITTER,
      LINE,
      APPLE,
      GUEST,
      THIRDPARTYSDK
  }

• NUserInfo

  public class NUserInfo
  {
      public string memberid { get; set; }        // 用户唯一ID
      public string name { get; set; }            // 姓名
      public string profileUrl { get; set; }      // 简介URL（如有）
      public string email { get; set; }          // 邮件（如有）
      public string token { get; set; }           //用户有效性验证Token（在Token Authentication API中使用）
      public string userid { get; set; }          // 社交媒体ID
  }

• NAppStatus

  public class NAppStatus
  {
      public string type { get; set; }        // 按AppStatus类型“maintenance”：维护，“needupdate”：更新
      public string message { get; set; }     // 维护设置：在仪表盘输入的消息
      public string url { get; set; }         // 维护设置：在仪表盘输入的URL
      public string currentAppVersion { get; set; }   // 更新：当前的应用版本
      public string updateAppVersion { get; set; }    // 更新：在仪表盘输入的应用版本
      public int currentAppVersionCode { get; set; }  // 更新：当前的应用代码
      public int updateAppVersionCode { get; set; }   // 更新：在仪表盘输入的应用版本代码
      public bool isForce { get; set; }           // 更新：在仪表盘设置强制更新时，为true
      public string resultPayload { get; set; }   // 由客户端SDK传递的JSON值，可忽略。
      public double startedAt { get; set; }       // 维护：开始时间
      public double endedAt { get; set; }        // 维护：结束时间
  }

设置用于获取IDFA值的权限请求弹窗

---

如果要在iOS平台使用权限请求弹窗以获取用户IDFA值，请使用下列代码。

// 可随机弹出IDFA值获取权限请求弹窗。
// 获取权限后，即使调用方法也不会显示弹窗。

GamePot.requestTrackingAuthorization((NResultTrackingAuthorizationresultState) =>
{
   // 正在处理获得的NResultTrackingAuthorizationresultState..
});

• NResultTrackingAuthorizationresultState定义

  public class NResultTrackingAuthorization
  {
      public NCommon.ResultTrackingAuthorization authorization { get; set; }
  }
  
  public enum ResultTrackingAuthorization
  {
      ATTrackingManagerAuthorizationStatusNotDetermined,
      ATTrackingManagerAuthorizationStatusRestricted,
      ATTrackingManagerAuthorizationStatusDenied,
      ATTrackingManagerAuthorizationStatusAuthorized,
      ATTrackingManagerAuthorizationStatusUnknown
  }

获得会员唯一ID

---

如要获得游戏会员的唯一ID值，请使用下列代码。

GamePot.getMemberId();

使用第三方账户登录功能

如要使用第三方账户登录功能，请使用下列代码应用设置。

NAVER登录

---

若要使用NAVER登录功能，在NAVER Developers控制台中选择Naver ID Login作为使用API，然后注册应用并使用下方代码。

• Android

  • 修改mainTemplate.gradle

    ...
    defaultConfig {
        resValue "string", "gamepot_naver_clientid", "abcdefg1234567890"
        resValue "string", "gamepot_naver_secretid", "hijklmn"
    }
    ...
    
    // 请将从NAVER Developers控制台获取的Client ID输入到gamepot_naver_clientid值中，并在gamepot_naver_secretid值中输入客户端密钥。
        ```

• iOS

  • 修改GamepotConfig-info.plist文件

    gamepot_naver_clientid // 拟在NAVER使用的Client ID 
    gamepot_naver_secretid // 拟在NAVER使用的Secret ID 
    gamepot_naver_urlscheme // 拟在NAVER使用的URL Scheme 

    用SourceCode确认时，如下进行添加

    ... 
    gamepot_naver_clientid xxxxxx 
    gamepot_naver_secretid xxxxxx 
    gamepot_naver_urlscheme xxxxxx 
    ... 

LINE登录

---

如要使用LINE登录功能，需将配置APK时使用的包名称、Keystore的SHA-1值、URL Scheme值添加到LINE Developers控制台后使用下列代码。

• Android

  • 修改mainTemplate.gradle

    ...
    defaultConfig {
        resValue "string", "gamepot_line_channelid","xxxxxxx"
    }
    ...
    
    // 请在gamepot_line_channelid值中输入从LINE Developers控制台获取的Client ID。

• iOS

  • 修改GamepotConfig-info.plist文件

    gamepot_line_channelid // 拟在NAVER使用的Client ID 
    gamepot_line_url_schemes // Line URL Scheme （line3rdp.{项目绑定identifier}） 

    用SourceCode确认时，如下进行添加

    ... 
    gamepot_line_channelid xxxxxx 
    gamepot_line_url_schemes xxxxxx 
    ... 

Apple Web登录

---

若要使用Apple网页登录功能，在仪表盘的项目设置 > 一般菜单中设置Apple ID登录后，在项目/Assets/Plugins/Android/libs路径下添加gamepot-channel-apple-signin.aar文件。

自动登录功能

如要使用通过传输会员最后一次登录信息的API自动登录功能时，请使用下列代码。

NCommon.LoginType type = GamePot.getLastLoginType();
if(type != NCommon.LoginType.NONE) {
{
    // 以最后一次登录的类型登录的方式。
    GamePot.login(type);
}
else
{
    // 第一次运行游戏或已退出登录的状态。 请跳转到可以进行登录的登录界面。
}

退出功能

如要使用退出功能，请使用下列代码。

• 方式1

  GamePot.logout();
  
  /// 成功退出登录
  public void onLogoutSuccess()
  {
  }
  
  /// 退出登录失败
  public void onLogoutFailure(NError error)
  {
      // 请使用error.message显示错误消息。
  }

• 方式2

  GamePot.logout(GamePotCallbackDelegate.CB_Common);
  
  GamePot.logout((success, error) => {
     if(success)
     {
         // 成功退出登录
     }
     else
     {
          // 退出登录失败
          // 请使用error.message显示错误消息。
     }
  });

会员注销功能

如要使用会员注销功能，请使用下列代码。

• 方式1

  GamePot.deleteMember();
  
  /// 会员注销成功
  public void onDeleteMemberSuccess() {
  }
  
  /// 会员注销失败
  public void  onDeleteMemberFailure(NError error) {
      // 请使用error.message显示错误消息。
  }

• 方式2

  GamePot.deleteMember(GamePotCallbackDelegate.CB_Common);
  
  GamePot.deleteMember((success, error) => {
     if(success)
     {
          // 会员注销成功
     }
     else
     {
          // 会员注销失败
          // 请使用error.message显示错误消息。
     }
  });

登录验证功能

登录成功并由开发商服务器向GAMEPOT服务器传递登录信息后，即可进行登录验证。

详细说明请参考登录验证请求。