1 功能介绍

保证这些接口功能都在 登录成功 以后调用

请在合适的时机使用这些接口功能，避免 多次调用

完成本文 接口 接入，你可以实现

• 注销账号

• 账号中心

• 切换账号

• 内置网页浏览器

2 前置条件

拓展功能在接入前必须保证已经完成快速接入,否则部分接口会返回空值

3 接入步骤

3.1 注销账号

场景介绍

• 根据最新网信部政策要求，游戏必须拥有「注销账号」流程
• 接入该接口游戏需要自绘按钮，按钮点击后调用此接口即可

接入建议

由于注销账号需要获取玩家账号信息，建议将注销账号功能接入在游戏登陆后，例如：游戏设置页面、玩家信息界面等

/*
 *  账号删除
 *  调用此接口会弹出删除账号界面，删除账号后服务器也会删除，请谨慎操作
 */
void accountCancellation();

HeroUsdkSupportKit::GetInstance()->accountCancellation();

注销成功后，渠道内部会做登出操作

3.2 账号中心[全球渠道]

场景介绍

• 账号绑定接口，用于玩家绑定第三方账号信息，接入该接口游戏需要自绘按钮，
• 方便玩家以游客身份成功进入游戏以后，能使用该接口绑定三方账号信息
• 此接口无任何回调，SDK处理相应逻辑

/*
 *  打开用户中心
 */
void showAccountCenter();

HeroUsdkSupportKit::GetInstance()->showAccountCenter();

3.3 切换账号

场景介绍

• 全球渠道切换账号，接入该接口游戏需要自绘按钮，调用接口后会弹出SDK切换账号页面;

注意

由于平台实现不同，移动端和PC接入方式有差异!

Android和iOS直接调用如下方法，无需绘制页面。调用接口后，SDK内部会打开原生界面，如下：

/*
 *  切换账号
 */
void switchAccount();

HeroUsdkSupportKit::GetInstance()->switchAccount();

PC使用账号切换，需要添加WebBrowser UWidgets到Viewport以打开账号切换网页，如下：

void switchAccount();

void UHeroUsdkUserWidget::openSwitchAccountAction()
{
#if PLATFORM_MAC || PLATFORM_WINDOWS || PLATFORM_LINUX
	HeroUsdkSupportPcDelegate::GetInstance()->SetSwitchAccountCallback([this]()
	{
		SwitchAccountWindow = CreateWidget<UPC_SwitchAccountPannel>(this, SwitchCenterWid);
		SwitchAccountWindow->AddToViewport();
	});
#endif

	// Android和iOS直接调用，PC需要先SetSwitchAccountCallback
	HeroUsdkSupportKit::GetInstance().switchAccount();
}

3.4 内置网页浏览器

场景介绍

• 内置网页浏览器可以通过 webId 显示内置浏览器界面，webId 需要从中台配置获取
• 内置网页浏览器为全屏显示
• 内置网页浏览器有4个功能按钮，分别为前进、后退、关闭、刷新，需要到中台配置

WebID获取位置:中台游戏管理 (opens new window)-业务支持能力-全部渠道通用-内嵌H5管

/*
 *  打开内置浏览器
 */
void openBrowser(FString openID) ;

HeroUsdkSupportKit::GetInstance()->openBrowser("test02");

3.5 USDK埋点

场景介绍

• USDK内置埋点接口

/*
 *  调用 track 接口，追踪一个带有属性的 event
 */
void trackWithProperties(FString event,TMap<FString, FString> propertys);

TMap<FString, FString> parameters ;
parameters.Add("sdkOrderId",orderInfo.sdkOrderId) ;
//支付结果埋点
HeroUsdkSupportKit::GetInstance()->trackWithProperties("PayResult",parameters);

3.6 USDK埋点回调

场景介绍

• USDK内置埋点接口数据回调

/*
 *  调用 track 接口，追踪一个带有属性的 event
 */
void trackEventDataCallback();

//USDK埋点事件回调
HeroUsdkSupportKit::GetInstance()->trackEventDataCallback();

void usdk_onTrackDataCallBack(FString JSONContent)
{
  //data为回调数据 
}

3.7 Xsolla商城

场景介绍

• 使用Xsolla商城支付

/*
 *  调用 track 接口，追踪一个带有属性的 event
 */
startXsollaPayWithXsollaProperties(TMap<FString, FString> propertys);

TMap<FString, FString> xsollaParameters;
xsollaParameters.Add("roleId", "HU12345678");
xsollaParameters.Add("roleName", TEXT("测试角色昵称"));
xsollaParameters.Add("serverId", "12345678");
xsollaParameters.Add("serverName", TEXT("测试服"));
xsollaParameters.Add("cpUid", "HU12345678");
xsollaParameters.Add("isJumpOutBrowser", "0");
HeroUsdkSupportKit::GetInstance()->startXsollaPayWithXsollaProperties(xsollaParameters);

参数说明

字段	类型	说明
serverId	string	服务器ID
serverName	string	服务器名称
roleId	string	角色ID
roleName	string	角色昵称
cpUid	string	游戏用户ID
isJumpOutBrowser	string	是否跳转外部浏览器，1为外部浏览器，0为内置浏览器

3.8 全球账号绑定状态

场景介绍

• 获取全球账号绑定状态

/*
 *  调用 track 接口，追踪一个带有属性的 event
 */
void getGlobalBindState();

HeroUsdkSupportKit::GetInstance()->getGlobalBindState();

void usdk_onGetGlobalBindState(HeroUsdkResult result,FString JSONContent,FString msg)
{
  if (result == HeroUsdkSuccess)
	{
		  //data为返回数据
         /*
      {
        "huaweiBind" : 0,
        "weChatBind" : 0,
        "gameWithBind" : 0,
        "twitterBind" : 0,
        "appleBind" : 0,
        "fbBind" : 0,
        "lineBind" : 0,
        "oppoBind" : 0,
        "googleBind" : 0,
        "gcBind" : 0
      }
   */
	}
	else
	{
		  //msg为错误信息
	}
}

参数说明

字段	类型	说明
huaweiBind	string	华为账号绑定状态
weChatBind	string	微信账号绑定状态
gameWithBind	string	GameWith账号绑定状态
twitterBind	string	Twitter账号绑定状态
appleBind	string	Apple账号绑定状态
fbBind	string	Facebook账号绑定状态
lineBind	string	Line账号绑定状态
oppoBind	string	Oppo账号绑定状态
googleBind	string	Google账号绑定状态
gcBind	string	GameCenter账号绑定状态

3.9 自定义事件追踪融合接口

场景介绍

• 自定义事件追踪融合接口，包含AppsFlyer、Facebook、Firebase、Adjust(根据中台市场插件开关)

void logEvent(FString eventName,TMap<FString, FString> propertys);

TMap<FString, FString> parameters1 ;
parameters1.Add("sdkUserId",Info.sdkUserId) ;
parameters1.Add("userName",Info.userName) ;
//开始登录结果埋点
HeroUsdkSupportKit::GetInstance()->logEvent("LoginResult",parameters1);

3.10 购买事件追踪融合接口

场景介绍

• 购买事件追踪融合接口，包含AppsFlyer、Facebook、Adjust(根据中台市场插件开关)，调用购买事

void logPurchaseWithOrderId(FString orderId,double amount,FString currency,TMap<FString, FString> propertys)

TMap<FString, FString> parameters;
//市场插件支付日志上报
HeroUsdkSupportKit::GetInstance()->logPurchaseWithOrderId(orderInfo.sdkOrderId, 128, "CNY", parameters);

3.11 跳转到其他APP[仅Android]

场景介绍

• Android端应用内跳转到其他APP首页

void jumpToApp(FString url) 

FString url = TEXT("https://www.facebook.com/EternalEvolutionOfficial/");
HeroUsdkSupportKit::GetInstance()->jumpToApp(url);

3.12 USDK保存图片到相册

场景介绍

• 需要将图片保存到相册中的功能

void addPicToAlbum(FString imagePath,FString albumName) ;

FString filePath = "图片路径" ; //游戏需要根据平台传不同的图片路径
HeroUsdkSupportKit::GetInstance()->addPicToAlbum(filePath,TEXT("HeroUSDK"));

3.13 USDK获取Google/AppleStore商品详情[Android & iOS]

场景介绍

• 获取谷歌/苹果后台商品id对应的商品在不同地区的详细信息，比如币种 、价格 等,

void HeroUsdkSupportKit::getGoogleSkuDetailsList(const TArray<FString>& gameGoodsList)

TArray<FString> ids ; 
ids.Add("123") ; //ID为USDK中台配置的商品ID
HeroUsdkSupportKit::GetInstance()-> getGoogleSkuDetailsList(ids);

void usdk_onGetGoogleSkuDetailsList(HeroUsdkResult Result, const FString& JsonArray, const FString& ErrorMsg)
{
  if (Result == HeroUsdkSuccess)
    {
    /* 读取JsonArray，格式如下
      [
        {
          "usdkGoodsId":"xxx",
          "price":"xxx",
          "googleGoodsId":"xxx",
          "currency":"xxx",
          "amount":"100000"
        }
      ]
      */
    }
    else
    {
        //msg为错误信息
    }
}

参数说明

字段	类型	说明
usdkGoodsId	string	游戏商品id
price	string	当地商品的格式化价格，包括其货币符号
googleGoodsId	string	谷歌后台商品id
currency	string	当地价格和原始价格的 ISO 4217 货币代码。 比如英镑 GBP 、 美元 USD
amount	string	微单位为单位的价格，比如定价1美元的商品，返回1000000。获取单位价格可强制转换成long型除以1000000即可

ios回调字段说明

字段	类型	说明
gameGoodsId	NSString	游戏商品id
appleGoodsId	NSString	苹果后台商品id
price	NSString	当地商品的格式化价格，包括其货币符号。比如 "$99.99"，"HK$148.00"，"¥3,000"，"8 990,00 ₽"
currency	NSString	当前苹果账号所在地区的价格的 ISO 4217 货币代码。 比如俄罗斯卢布 RUB 、 美元 USD
amount	NSString	单位为苹果开发者后台配置商品ID的单位，如USD为美元，CNY为元

3.14 USDK获取OAID [仅支持Android平台]

场景介绍

• 匿名设备标识符（Open Anonymous Device Identifier，简称OAID）是一种用于安卓设备的唯一标识符，可由用户重置。该标识符由移动安全联盟（MSA）、中国信息通信研究院以及设备厂商合力推出，旨在替代IMEI等不可重置的设备标识符，以保护用户隐私。
• OAID通常用于不支持Google Play Services的设备（即没有Google Advertising ID的设备），以对其进行广告衡量及激活归因。

WARNING

• OAID模块已经封装成插件，会在打渠道包的时候由出包工具将OAID插件自动加入到游戏中，因此只有渠道包才会有OAID的返回值，母包的返回值为空字符串

	/*
	 * 获取当前设备的OAID值
	 */
	void HeroUsdkSupportKit::getOAID();

  HeroUsdkSupportKit::GetInstance()->getOAID();

	/*
	 * 获取OAID结果
	 */
  class HeroUsdkSupportNotifyImpl : public HeroUsdkSupportNotify
  {
    void usdk_onGetOAIDResultAction(FString msg)
    {
      GEngine->AddOnScreenDebugMessage(-1,10, FColor::Red, msg );
      UE_LOG(LogTemp, Log, TEXT("usdk_onGetOAIDResultAction : %s"), *msg);
    }
  }

参数说明

字段	类型	说明
msg	FString	OAID

3.15 USDK获取Appsflyer的归因 [仅支持Android平台][不是单接市场，用打包工具出包可以使用]

• 直接添加回调消息就行，设置回调在安卓onCreat里面添加过了

void UHeroUsdkUserWidget::usdk_nativeonConversionDataSuccess(const FString& Data)
{
	GEngine->AddOnScreenDebugMessage
	(
		-1, // 可以理解为屏幕上相同信息显示的行数,一般持续打印时会用到, -1:全部显示, 1: 显示一行
		10, // 显示的时间/秒
		FColor::Red, // 显示的颜色
		TEXT("usdk_nativeonConversionDataSuccess:")+Data // 输出的信息,类型为FString
	);
}

void UHeroUsdkUserWidget::usdk_nativeonConversionDataFail(const FString& Data)
{
	GEngine->AddOnScreenDebugMessage
	(
		-1, // 可以理解为屏幕上相同信息显示的行数,一般持续打印时会用到, -1:全部显示, 1: 显示一行
		10, // 显示的时间/秒
		FColor::Red, // 显示的颜色
		TEXT("usdk_nativeonConversionDataFail:")+Data // 输出的信息,类型为FString
	);
}

void UHeroUsdkUserWidget::usdk_nativeonAppOpenAttribution(const FString& Data)
{
	GEngine->AddOnScreenDebugMessage
	(
		-1, // 可以理解为屏幕上相同信息显示的行数,一般持续打印时会用到, -1:全部显示, 1: 显示一行
		10, // 显示的时间/秒
		FColor::Red, // 显示的颜色
		TEXT("usdk_nativeonAppOpenAttribution:")+Data // 输出的信息,类型为FString
	);
}

void UHeroUsdkUserWidget::usdk_nativeonAttributionFailure(const FString& Data)
{
	GEngine->AddOnScreenDebugMessage
	(
		-1, // 可以理解为屏幕上相同信息显示的行数,一般持续打印时会用到, -1:全部显示, 1: 显示一行
		10, // 显示的时间/秒
		FColor::Red, // 显示的颜色
		TEXT("usdk_nativeonAttributionFailure:")+Data // 输出的信息,类型为FString
	);
}

3.16 USDK兑换苹果礼包码 [仅支持iOS平台]

场景介绍

• 用户玩家在Apple Store兑换礼包码后，进入游戏进行兑换

• 必须在收到SDK回调usdk_onExternalPay方法后，游戏客户端生成订单号cpOrder,并调用redeemExternalPay进行礼包码兑换。

• goodsId参数的值从usdk_onExternalPay方法返回的结果中进行获取。

• FHeroUPaymentParameters类字段说明

字段	类型	说明
goodsId	string	商品ID
extraParams	string	透传参数
cpOrder	string	CP订单号
callbackUrl	string	内购回调地址，两种配置方式： 1、可由运营在后台-游戏管理中进行配置，若运营在后台进行了配置则此参数无效； 2、可由开发者在代码中写入 3、如果想实现不同区服的回调，则需要游戏自己区分区服实现

/**
  * @brief iOS独有接口-兑换礼包码
  * 游戏必须在收到<usdk_onExternalPay>回调后进行调用
  * @param paymentParametersData 
  */
void redeemExternalPay(const EUsdkRedeemType& redeemType, FHeroUPaymentParameters paymentParametersData);

/*
 * iOS收到兑换码通知
 */
void UHeroUsdkUserWidget::usdk_onExternalPay(const EUsdkRedeemType Type, const FString& GoodsId, const FString& Amount)
{
  FHeroUPaymentParameters Params;
	Params.goodsId = GoodsId;
	Params.cpOrder = FString::FromInt(FMath::Rand()); //这里填写的是游戏生成的订单号
	Params.extraParams = TEXT("UE Redeem");
	HeroUsdkSupportKit::GetInstance().redeemExternalPay(Type,Params);
}

/*
 * iOS兑换礼包码成功回调
 */
void UHeroUsdkUserWidget::usdk_onRedeemCallback(const HeroUsdkResult result, const FString& msg)
{
  if (result == HeroUsdkSuccess)
	{
	  //兑换成功
	}
	else
	{
    //兑换失败
	}
}

3.17 抖音视频录制

场景介绍

• 游戏需要自绘按钮，并调用接口进行控制抖音视频开始/结束录制
• 视频录制完成后保存在相册中

/**
  * 设置抖音视频录制回调监听
  */
void setDouYinRecordCallbackListener();

/**
  * 开始录制
  */
void douyinStartAutoRecord();

/**
  * 结束录制
  */
void douyinStopAutoRecord();

/*
 * 设置回调监听
 */
void UHeroUsdkUserWidget::OnInitButtonClicked()
{
   //初始化SDK
	 HeroUsdkSupportKit::GetInstance().init();
   //oppo
	 HeroUsdkSupportKit::GetInstance().setOppoResourceCopyListener();
   //抖音视频录制回调监听
   HeroUsdkSupportKit::GetInstance().setDouYinRecordCallbackListener();
}

/*
 * 开始录制
 */
void UHeroUsdkUserWidget::OnDouYinStartButton()
{

	 HeroUsdkSupportKit::GetInstance().douyinStartAutoRecord();
	
}

/*
 * 结束录制
 */
void UHeroUsdkUserWidget::OnDouYinStopButton()
{
	 HeroUsdkSupportKit::GetInstance().douyinStopAutoRecord();
}

/*
* 录制视频开始成功回调
*/
void UHeroUsdkUserWidget::usdk_onDouYinStartAutoRecordSuccess(const FString& data)
{
	GEngine->AddOnScreenDebugMessage(-1, 10, FColor::Red, data);
}

/*
 * 录制视频开始失败回调
 */
void UHeroUsdkUserWidget::usdk_onDouYinStartAutoRecordFail(const FString& data)
{
	GEngine->AddOnScreenDebugMessage(-1, 10, FColor::Red, data);
}

/*
 * 录制视频停止成功回调
 */
void UHeroUsdkUserWidget::usdk_onDouYinStopAutoRecordSuccess(const FString& data)
{
	GEngine->AddOnScreenDebugMessage(-1, 10, FColor::Red, data);
	TSharedPtr<FJsonObject> JsonObject;
	TSharedRef<TJsonReader<TCHAR>> JsonReader = TJsonReaderFactory<TCHAR>::Create(data);
	// 尝试解析 JSON 字符串
	if (FJsonSerializer::Deserialize(JsonReader, JsonObject))
	{
		// 假设 data 中包含一个叫 "videoPath" 的字段
		if (JsonObject->HasField("video_path"))
		{
			  VideoPath = JsonObject->GetStringField(TEXT("video_path"));
			  GEngine->AddOnScreenDebugMessage(-1, 10, FColor::Red,TEXT("VideoPath：")+ VideoPath);
        //获取视频路径，后续用于抖音视频分享参数传入
        FShareInfo temp;

        temp.sharePlatform= HeroUSDKSharePlatformDouyin_Moment;
        temp.shareType = HeroUSDKShareTypeVideo ;
        temp.title = shareInfo.title;
        temp.text = shareInfo.text;
        temp.videoPath = VideoPath ;
        temp.tagOne = "标签1";
        HeroUsdkSupportKit::GetInstance().share(temp);
		}
	}
	else
	{
		UE_LOG(LogTemp, Error, TEXT("Failed to parse JSON data"));
	}
	
}
/*
 * 录制失败停止失败回调
 */
void UHeroUsdkUserWidget::usdk_onDouYinStopAutoRecordFail(const FString& data)
{
	GEngine->AddOnScreenDebugMessage(-1, 10, FColor::Red, data);
}