跳转至

所有引擎

无论开发引擎（Unity、Unreal等）和平台（Android、iOS等）如何，Hive SDK 设置必须在构建应用程序之前定义在hive_config.xml文件中。因此，要使用Hive SDK，您必须创建一个新的hive_config.xml文件，输入内容，并将其包含在您的应用程序项目中。此文件中的设置适用于初始化Hive SDK时。建议在此文件中预定义所有在运行时不变的静态项。该文件应位于以下路径。

  • Unity
    • 安卓
      • Unity 2021及以上版本: /Assets/HiveSDK/hive.androidlib/src/main/res/raw/hive_config.xml
      • Unity 2021以下版本: /Assets/Plugins/Android/res/raw/hive_config.xml
    • iOS
      • /Assets/Plugins/iOS/hive_config.xml
    • Windows
      • /Assets/Plugins/Windows/res/hive_config.xml
  • 虚幻引擎
    • 安卓
      • /HIVESDK/Source/HIVESDK/ThirdParty/android/resource/res/raw/hive_config.xml
    • iOS
      • /HIVESDK/Source/HIVESDK/ThirdParty/iOS/resource/hive_config.xml
    • Windows
      • /HIVESDK/Source/HIVESDK/ThirdParty/Windows/config/hive_config.xml
  • 安卓原生
    • /app/res/raw/hive_config.xml
  • iOS原生
    • 在所需位置创建<hive_config.xml文件，并直接将其链接到Xcode项目

Hive SDK 通用设置

无论您使用哪个 Hive SDK 功能，基本上都必须在 hive_config.xml 中输入该项。必须输入必需项，而可选项根据需要输入。如果未输入可选项，Hive SDK 将使用默认值进行操作。

项目 操作系统 描述 必需 SDK 默认
appId Android, iOS, Windows 游戏构建标识符。 X
  • Android: 包名
  • iOS: 包 ID
  • Windows: 应用 ID
zone Android, iOS, Windows Hive 客户端将连接的服务器。
  • real: 生产服务器
  • sandbox: 测试服务器
 X `real`
useLog Android, iOS, Windows 是否启用 Hive 客户端内部操作的日志记录。当启用日志记录时，日志将输出到开发工具屏幕。
  • true: 启用日志记录
  • false: 禁用日志记录
 X `false`
ageGateU13 Android, iOS, Windows COPPA ageGateU13 应用状态。要将 COPPA ageGateU13 应用于 Hive SDK，您必须在 Hive 控制台中注册 COPPA 条款，并在初始化 Hive SDK 之前将此值设置为 true。如果您不想应用 COPPA ageGateU13，您必须在 Hive 控制台中注册 COPPA 以外的条款，并在初始化 Hive SDK 之前将此值设置为 false。
  • true: 将 COPPA ageGateU13 应用于 HiveSDK
  • false: 不将 COPPA ageGateI13 应用于 HiveSDK
 X `false`
hiveOrientation Android, iOS, Windows Hive SDK 的 UI 将根据设备方向设置进行显示。
  • all: 根据横屏和竖屏方向显示
  • portrait: 以竖屏模式显示
  • landscape: 以横屏模式显示
  • undefined: 遵循游戏应用设置
 X 'undefined'
channel Android, iOS, Windows 在游戏应用中使用的登录和应用内支持服务的平台。如果您通过 Hive SDK 登录外部社交媒体或使用应用内购买，则对应于 C2S。用于 Hive SDK 分析数据收集。
  • C2S: Hive 平台
  • KAK: Kakao
  • LIN: Line
  • STE: Steam
  • EPI: Epic Store
  • FAS: FastSprint
 O `C2S`
市场 Android, iOS, Windows 这是用于处理应用内购买的市场。它用于Hive SDK分析收集。
  • GO: Google Play商店
  • AP: Apple AppStore
  • ON: OneStore
  • AM: 亚马逊应用商店
  • LE: Com2us Lebi
  • HS: Hive 商店
  • GA: Samsung Galaxy商店
  • HU: 华为应用市场
 O 空值
agreementDetermineBase Android, iOS 确定获取协议的标准。您可以选择`device`或`account`，默认值为`device`。
  • 选择device时，协议同意弹出窗口在AuthV4.setup()的初始化阶段显示，并仅基于设备获得同意。一旦基于设备获得同意，用户在同一设备上使用不同账户登录时将不再被要求同意。您可以使用`resetAgreement()`清除协议同意记录。
  • 选择account时，协议同意弹出窗口在登录时显示，并根据每个PlayerId获得一次同意。仅在未应用COPPA ageGateU13时可以使用。协议同意记录无法通过`resetAgreement()`清除。营销跟踪工具将在协议同意时开始运行。
 X `device`
authV1Agreement Android, iOS Hive SDK v1或Hive SDK C2S单独模块特定设置，选择显示为身份验证v1或v4的条款的UI。使用Hive SDK v4的游戏不设置此项，且不受默认值的影响。
  • true: 身份验证v1条款
  • false: 身份验证v4条款
 X `true`
unsupportedUAShareType Android Android特定设置，当使用推广用户获取（UA）分享功能时，设置不会显示为图标的共享应用。指定的目标在UI中不会显示图标。
  • SMS
  • URL
  • KAKAO
  • LINE
  • WHATSAPP
  • FACEBOOK
  • MESSENGER
  • WECHAT
 X 空值
httpConnectTimeout Android, iOS, Windows Hive 客户端内部使用的HTTP连接的超时持续时间（以秒为单位）。
  • 默认值设置为8秒，除非在特殊情况下，否则禁止更改该值。
 X `8`（单位：秒）
httpReadTimeout Android, iOS, Windows HTTP读取超时持续时间（秒），由Hive客户端内部使用。
  • 默认值设置为8秒，除非在特殊情况下，否则禁止更改该值。
 X `8`（单位：秒）
usePrivateBrowsingForAuth Windows 确定在Google登录认证期间是否使用隐身模式。
  • true：使用隐身模式认证。
  • false：使用正常模式认证。
仅在PC SDK中支持。 		X true
Note

当应用 COPPA ageGateU13 时，仅可以显示 基于设备的同意弹出窗口。
当应用 COPPA ageGateU13 时，如果任何用户在同意过程中回应他们已满 13 岁或以上，则 Hive SDK 将不对该用户应用 COPPA ageGateU13。然而，hive_config.xml 中设置的值 (true) 本身不会改变。

Hive SDK 功能设置

设置您想要使用的 Hive SDK 功能，例如身份验证、计费和营销归因。仅输入您将在 hive_config.xml 中使用的 Hive SDK 功能对应的项目。有关更多详细信息，请参阅每个 Hive SDK 功能开发者指南的准备页面，如下所示。

不支持的配置

hive_config.xml 文件中的项目如下，不再受支持。

项目 描述 备注
usePush 设置是否使用通知。 自 v4.16.2 起已弃用
permissions Android
这是一个特定于 Android 的设置，用于控制是否使用由 HiveSDK 管理的 Android 权限。permissions 设置允许通过 sdwrite 设置控制外部存储访问权限。		 自 v4.16.2 起已弃用
useCrashReport iOS
这是一个特定于 iOS 的功能，用于检测应用因错误即将崩溃的情况，并将等待发送到服务器的分析日志保存为文件。如果使用具有类似功能的第三方崩溃报告工具，则应将其设置为 false，以防止冲突。(+v4.16.0)		 自 v4.16.3 起已弃用
exitEventEnabled Android iOS exitEvent 表示游戏应直接退出应用，而不是 Hive SDK。如果该值为 True，则将接收到此事件，此时 Hive SDK 不会直接退出游戏应用。如果该值为 False，则 Hive SDK 可以直接退出游戏应用。(+v4.9.0). 自 v4.16.4 起已弃用
company Android iOS Windows
设置游戏发行公司的名称。		 自 v4.23.0 起已弃用
gameLanguage Android iOS
这是在 Hive SDK 中设置的游戏语言。		 自 v4 25.2.0 起已弃用

hive_config.xml 示例

以下是使用身份验证（Google 身份验证）和支付（Google Play 商店）时的hive_config.xml文件示例。请根据您想要使用的 Hive SDK 功能和应用环境更改、添加或删除值。iOS 平台仅支持 Apple AppStore 支付，因此在 Unity iOS 环境中，将市场设置为 AP。

<properties>

    <!-- Hive SDK Common Settings: START -->
    <!-- Set unique game build identifier -->
    <appId>com.sample.your</appId>

    <!-- Select Hive platform server. sandbox for development, real for production
        (sandbox, real) -->
    <zone>real</zone>

    <!-- Set whether to use SDK internal operation logs
        (true, false) -->
    <useLog>false</useLog>

    <!-- Set whether to apply ageGateU13
        (true, false) -->
    <ageGateU13>false</ageGateU13>

    <!-- Hive Orientation setting -->
    <hiveOrientation>landscape</hiveOrientation>

    <!-- Channel setting (login and in-app support service platform)
        (C2S: Hive platform) -->
    <channel>C2S</channel>

    <!-- Payment market setting (GO: Google Play, LE: Com2us Lebi, AP: Apple App Store) -->
    <market>GO</market>

    <!-- Set criteria for receiving agreement to terms
        (device, account) -->
    <agreementDetermineBase>false</agreementDetermineBase>

    <!-- Set terms exposure design (not set for SDK v4)
        (true, false) -->
    <!-- <authV1Agreement>device</authV1Agreement> -->

    <!-- Set sharing apps not to be displayed for Promotion UA Share (Android Only) -->
    <unsupportedUAShareType>
        <value>SMS</value>
        <value>URL</value>
    </unsupportedUAShareType>

    <!-- Set HTTP Connect Timeout used internally by Hive SDK in seconds
        (Do not change unless in special cases) -->
    <httpConnectTimeout>8</httpConnectTimeout>

    <!-- Set HTTP Read Timeout used internally by Hive SDK in seconds
        (Do not change unless in special cases) -->
    <httpReadTimeout>8</httpReadTimeout>
    <!-- Hive SDK Common Settings: END -->

    <!-- Hive SDK Analytics Settings: START -->
        <!-- Analytics settings, refer to Analytics pre-configuration guide -->
    <!-- Hive SDK Analytics Settings: END -->

    <!-- Hive SDK Feature Settings: START -->
    <providers>             
        <!-- Set authentication product, refer to Authentication pre-configuration guide -->
        <!-- Set billing product, refer to Billing pre-configuration guide -->
        <!-- Set marketing attribution product, refer to Marketing Attribution pre-configuration guide -->
    </providers>
    <!-- Hive SDK Feature Settings: END -->

</properties>