跳轉至

所有引擎

無論開發引擎(Unity、Unreal等)和平台(Android、iOS等),Hive SDK 設定必須在構建應用程序之前定義在hive_config.xml文件中。因此,要使用 Hive SDK,您必須創建一個新的hive_config.xml文件,輸入內容,並將其包含在您的應用程序項目中。 此文件中的設置適用於初始化 Hive SDK 的時候。建議在此文件中預先定義所有在運行時不會改變的靜態項目。該文件應位於以下路徑中。

  • Unity
    • Android
      • 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
  • Unreal Engine
    • Android
      • /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
  • Android Native
    • /app/res/raw/hive_config.xml
  • iOS Native
    • 在所需位置创建<hive_config.xml文件,并直接将其链接到Xcode项目

Hive SDK 通用設定

無論您使用哪個 Hive SDK 功能,基本上都必須在 hive_config.xml 中輸入一項項目。必填項目必須輸入,而選填項目則根據需要輸入。如果未輸入選填項目,則 Hive SDK 將使用默認值運行。

項目 作業系統 描述 必需 SDK 預設值
appId Android, iOS, Windows 遊戲建置識別碼。 X
  • Android: 套件名稱
  • iOS: Bundle 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 App商店
  • ON: OneStore
  • AM: Amazon App商店
  • LE: Com2us Lebi
  • HS: Hive 商店
  • GA: Samsung Galaxy商店
  • HU: Huawei AppGallery
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 的設置,用於控制是否使用由 Hive SDK 管理的 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>