すべてのエンジン
開発エンジン(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
- Unity 2021以降:
- iOS
/Assets/Plugins/iOS/hive_config.xml
- Windows
/Assets/Plugins/Windows/res/hive_config.xml
- Android
- 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
- Android Native
/app/res/raw/hive_config.xml
- iOS Native
- hive_config.xmlファイルを希望の場所に作成し、Xcodeプロジェクトに直接リンクします
Hive SDK 共通設定¶
どのHive SDK機能を使用しても、それは基本的にhive_config.xmlに入力しなければならない項目です。必須項目は入力する必要があり、オプション項目は必要に応じて入力されます。オプション項目が入力されない場合、Hive SDKはデフォルト値で動作します。
アイテム | OS | 説明 | 必須 | SDKデフォルト |
---|---|---|---|---|
appId | Android, iOS, Windows | ゲームビルド識別子。 | X |
|
zone | Android, iOS, Windows | Hive クライアントが接続するサーバー。
| X | `real` |
useLog | Android, iOS, Windows | Hive クライアントの内部操作のログを有効にするかどうか。ログが有効な場合、ログは開発ツール画面に出力されます。
| X | `false` |
ageGateU13 | Android, iOS, Windows | COPPA ageGateU13 アプリケーションのステータス。COPPA ageGateU13をHive SDKに適用するには、Hive コンソールにCOPPAの条件を登録し、この値をtrue に設定してからHive SDKを初期化する必要があります。COPPA ageGateU13を適用したくない場合は、Hive コンソールにCOPPA以外の条件を登録し、この値をfalse に設定してからHive SDKを初期化する必要があります。
| X | `false` |
hiveOrientation | Android, iOS, Windows | Hive SDKのUIは、デバイスの向き設定に従って表示されます。
| X | 'undefined' |
channel | Android, iOS, Windows | ゲームアプリで使用されるログインおよびアプリ内サポートサービスのプラットフォーム。外部のソーシャルメディアにログインするか、Hive SDKを通じてアプリ内購入を使用する場合、C2Sに対応します。Hive SDKの分析データ収集に使用されます。
| O | `C2S` |
マーケット | Android、iOS、Windows | これはアプリ内購入を処理するためのマーケットです。Hive SDKの分析収集に使用されます。
| O | 空白の値 |
agreementDetermineBase | Android、iOS | 利用規約への同意を得るための基準を決定します。`device`または`account`のいずれかを選択でき、デフォルトは`device`です。
| X | `device` |
authV1Agreement | Android、iOS | Hive SDK v1またはHive SDK C2S個別モジュール特定設定、認証v1またはv4として表示される利用規約のUIを選択します。Hive SDK v4を使用するゲームはこれを設定せず、デフォルトの影響を受けません。
| X | `true` |
unsupportedUAShareType | Android | Android特有の設定で、プロモーションユーザー獲得(UA)シェア機能を使用する際に、アイコンとして表示されない共有アプリを設定します。指定されたターゲットはUIにアイコンを表示しません。
| X | 空白の値 |
httpConnectTimeout | Android、iOS、Windows | Hive クライアントが内部で使用するHTTP接続のタイムアウト期間(秒単位)。
| X | `8`(単位: 秒) |
httpReadTimeout | Android、iOS、Windows | Hive クライアントによって内部で使用されるHTTP読み取りタイムアウトの期間(秒)。
| X | `8`(単位:秒) |
usePrivateBrowsingForAuth | Windows | Googleログイン認証中にシークレットモードを使用するかどうかを決定します。
| 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 これは、HiveSDKによって管理されるAndroidの権限が使用されるかどうかを制御する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>