Unity
Unity環境でhive_config.xmlを設定する方法は2つあります。
1. Unityハイブ構成エディタによる自動構成¶
Unity環境では、hive_config.xmlファイルを自動的に作成し、Unity Hive Config Editorを使用してその内容のほとんどを構成できます。ただし、Unity Hive Config Editorを使用している場合でも、hive_config.xml ファイルの一部の値は手動で設定する必要があります。
Note
Androidアプリを開発する際は、AndroidManifest.xmlを直接設定する必要がないのが便利ですので、Unity Hive Config Editorの使用をお勧めします。
Unityハイブ設定エディタの実行¶
ハイブを選択 > ハイブ設定 (設定を編集)し、エディタ画面で必要な値を設定します。
実行環境を選択¶
まず、アプリ実行環境(Android、iOS、macOS、Windows)を選択します。
共通 (ハイブSDKの共通機能)¶
共通タブでは、Hive SDKのすべての機能に適用される設定を構成できます。Hive AppIDを設定し、サーバー(本番またはサンドボックス)を選択できます。また、アプリが起動したときに表示される画面の向きを決定することもできます。共通タブのすべての設定は必ず入力する必要があります。
フィールド | 説明 | 値の範囲 |
---|---|---|
Hive アプリ ID | Hive コンソールアプリセンターに登録されたAppID | (例: com.sample.your ) |
ゾーン | Hive サーバー | * サンドボックス * 本番 |
ロギング | Hive SDKの内部操作のロギングを有効にするかどうか | * オン * オフ |
AgeGateU13 | COPPA ageGateU13 を適用するかどうか | * オフ * オン |
Hive オリエンテーション | デバイスのオリエンテーション設定に応じて表示される Hive SDK のUI | * すべて * 縦 * 横 * 未定義 |
チャンネル | ゲームアプリで使用されるログインおよびアプリ内サポートサービスプラットフォーム | * C2S (Hive プラットフォーム) * KAK (カカオ) * LIN (ライン) * STE (スチーム) * EPI (エピックストア) * FAS (ファストスプリント) |
マーケット | アプリ内購入の支払い市場(分析収集用) | * GO (Google Playストア) * AP (Apple Appストア) * ON (OneStore) * AM (Amazon Appストア) * LE (Com2us Lebi) * HS (Hive ストア) * GA (Samsung Galaxyストア) * HU (Huawei AppGallery) |
ユニバーサルリンク | iOSの遅延ディープリンク設定のためのユニバーサルリンク | アプリ開発者によって指定されたドメイン (例: https://yourdomain.com ) |
認証 (authentication)¶
Authタブは、Hive SDK認証機能を使用するための設定を構成する場所です。 Hive SDKは、Facebook、Google、QQなどのIdPログインをサポートしています。ログインに使用するIdPを選択した後、このIdPの開発者コンソール(例えば、Googleコンソール)からAppId
、ClientId
などを取得して入力する必要があります。
例えば、Google SignInを使用するには、Google ConsoleからGoogle SignInアイテムに必要な値を取得し、以下に示すようにAuthタブに入力する必要があります。
- GoogleアプリID: Googleコンソールから発行されたAppIDを入力してください
- GoogleサーバークライアントID: Googleコンソールから発行されたWebアプリケーションのクライアントID値を入力してください
Note
各認証IdP設定値に関する詳細情報については、認証準備ページを参照してください。
マーケット (請求)¶
マーケットタブは、Hive SDKの請求機能を使用するための設定を構成する場所です。Hive SDKはGoogle PlayストアやApple App Storeなどのアプリマーケットをサポートしており、このタブではアプリ内購入に必要な値を設定する必要があります。
例えば、アプリがAndroid LebiマーケットとWechat Payの支払いをサポートしている場合、マーケットタブにWechatコンソールから発行されたPayment Keyを入力する必要があります。
フィールド | 説明 | 値の範囲 |
---|---|---|
Wechat 支払いキー | Android の Lebi マーケットで Wechat を課金方法として使用する際 Wechat の支払いキーを設定します | (例: abcDEF1234xYz789) |
アナリティクス (マーケティング帰属)¶
分析タブは、Hive SDKのマーケティング帰属機能を使用するための設定を構成する場所です。Hive SDKは、Adjust、Firebaseなどを通じてマーケティング帰属をサポートしており、それぞれのサービス開発者コンソールからkey
とevent
の値を取得し、このタブに入力する必要があります。
例えば、Adjustを使用するには、以下の情報に従ってAnalyticsタブのAdjust項目に必要な値を入力してください。
- appToken: Adjustコンソールから発行されたAppTokenを入力してください
- Event: Adjustコンソールに登録されたイベントの名前と値を入力してください
Note
各マーケティングアトリビューション設定の詳細については、マーケティングアトリビューション準備ページを参照してください。
オプション(ネットワーク通信オプション、ログ記録、その他の機能)¶
オプション タブでは、Hive SDKを使用する際のネットワーク通信オプション、ログ、およびその他の設定を入力できます。
例えば、Hive SDKメソッドを呼び出すときにネットワークタイムアウトを延長したい場合は、httpConnectTimeout
とhttpReadTimeout
の値を増やしてください。別の例として、リモートログを送信する際には、送信サイクルと送信されるログデータのサイズを変更することができ、分析ログ設定値を変更することができます。絶対に必要でない限り、オプショナルタブ項目のデフォルト値を使用することをお勧めします。
フィールド | 説明 | 値の範囲 |
---|---|---|
サポートされていない UA シェアタイプ | Android UA シェア機能を使用する際に、Hive シェア UI で使用されるソーシャルメディアのタイプ | * SMS * URL * KAKAO * LINE * MESSENGER |
agreementDetermineBase | 利用規約への同意を決定するための基準 | * device * account |
httpConnectTimeout | Hive プロトコル通信中の接続タイムアウトの期間(秒)を設定します(推奨されるデフォルト値) | * 8(デフォルト) |
httpReadTimeout | Hive プロトコル通信中の読み取りタイムアウトの期間(秒)を設定します(推奨されるデフォルト値) | * 8(デフォルト) |
maxGameLogSize | 非構造化データファイルとして保存されるゲームログの最大数 | |
analyticsSendLimit | ログ送信サイクルごとに送信するログの最大量 | |
analyticsQueueLimit | キューに追加できるログの最大量 | |
analyticsSendCycle | ログ送信サイクル | |
saveAnalytisLogBeforeCrash | アプリがNSException タイプのエラーまたはUnixシグナルタイプのエラーによりクラッシュしそうなときに、保留中の分析ログをサーバーに送信するのではなくファイルに保存するかどうかを決定するiOS専用の設定 |
設定を保存してhive_config.xmlファイルを作成する¶
Unity Hive Config Editorのすべてのタブ設定を完了した後、設定ファイルを保存して再生成をクリックすると、自動的にhive_config.xmlファイルが生成されます。
アンドロイド¶
保存して再生成設定ファイルをクリックすることで、AndroidManifest.xmlファイルとhive_config.xmlファイルが作成されます。hive_config.xmlファイルが作成される場所は、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¶
保存して設定ファイルを再生成するをクリックすると、Info.plistファイルとhive_config.xmlファイルが作成されます。hive_config.xmlファイルは以下の場所に作成されます。
/Assets/Plugins/iOS/hive_config.xml
ウィンドウズ¶
Windowsボタンを押すと、ファイル hive_config.xml が作成されます。 hive_config.xml ファイルは以下の場所に作成されます。
/Assets/Plugins/Windows/res/hive_config.xml
2. 手動設定¶
Unity Hive Config Editor を使用しない場合は、hive_config.xml ファイルを作成し、ファイル内のほとんどの値を手動で設定する必要があります。
hive_config.xml ファイルの作成¶
以下のパスに直接hive_config.xmlファイルを作成してください。
- Android
- Unity 2021以降:
/Assets/HiveSDK/hive.androidlib/src/main/res/raw/hive_config.xml - 2021以前のUnity:
/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
hive_config.xml の変更¶
次を参照して、hive_config.xmlファイルを直接修正して保存してください。ただし、ファイル内のいくつかの値は開発者のニーズに応じて設定されています。
hive_config.xml ファイルの例¶
以下は、認証(Google 認証)および支払い(Google Play ストアまたは Apple AppStore)を使用する際のhive_config.xmlファイルの例です。使用したいHive SDKの機能とアプリ環境に応じて、値を変更、追加、または削除してください。iOSはApple AppStoreの支払いのみをサポートしているため、Unity iOS環境ではマーケットをAP
に設定してください。
<properties>
<!-- Hive SDK common settings: START -->
<!-- Set game build unique identifier -->
<appId>com.sample.your</appId>
<!-- Select server for Hive platform. sandbox is for development, real is for commercial
(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 standard for receiving terms agreement
(device, account) -->
<agreementDetermineBase>false</agreementDetermineBase>
<!-- Terms exposure design setting (Not set for SDK v4)
(true, false) -->
<!-- <authV1Agreement>device</authV1Agreement> -->
<!-- Set sharing apps to not expose when sharing promotion UA (Android Only) -->
<unsupportedUAShareType>
<value>SMS</value>
<value>URL</value>
</unsupportedUAShareType>
<!-- Set HTTP Connect Timeout time in seconds used internally by Hive SDK
(Do not change unless it is a special case) -->
<httpConnectTimeout>8</httpConnectTimeout>
<!-- Set HTTP Read Timeout time in seconds used internally by Hive SDK
(Do not change unless it is a special case) -->
<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>
Info
Hive SDKの設定は、アプリのビルド前に設定ファイルに値を保存したり、実行時(アプリ実行中)に設定を変更したりできます。詳細については、Hive SDKの設定を確認してください。