はじめに
以下の簡単な手順に従うことで、今すぐにHelpshiftのアプリ内サポートを Androidアプリに追加することができます。
要件
SDK Xをご利用の場合、またはSDK Xに移行中の場合には、以下の要件にご注意ください。
- SDK Xは、APIレベル24以上（Android OS 7 Nougat以上）でのみ動作します。
- コード内の
minSDKVersionは、APIレベル16（Android 4.4 Jelly Bean）までをインストール可能なアプリでSDKをインポートしてコンパイルできるようにするために、APIレベル16として保持されています。 - あなたのアプリがAPIレベル24以下（Android OS 7 Nougat以下）のデバイスにインストールされている場合、サポートの提供に別のメディアを選択することができます。たとえば、電子メールやウェブサイトなどです。SDKがAPIレベル24未満で初期化された場合、
UnsupportedOSVersionExceptionをスローします。必要に応じてこの例外をキャッチして使用してください。詳細については、「SDKの初期化」を参照してください。
- 10.4.0以降、SDKはJava 8でコンパイルを行うことでAndroid 15のコンパイルに対応します。
- アップデート（2023年8月）: SDK X 10.2.Xは、APIレベル24以上（Android OS 7 Nougat以上）でのみ動作します。
- SDK 10.3.0はAndroid 7以上（APIレベル24以上）に対応しており、このバージョン以上で機能します。最低限のAPIレベルであるレベル16でコンパイルすることは可能ですが、対応はAPIレベル24以上です。 Helpshift SDKのAndroid OSサポートポリシーの詳細については、こちらの記事を参照してください。
Gradleベースのプロジェクト
以下の依存関係をbuild.gradleファイル内の依存関係セクションに追加します。
- Above 10.3.X
- Below 10.2.2
dependencies {
// androidx support library dependency
implementation 'androidx.appcompat:appcompat:1.0.0'
implementation 'com.helpshift:helpshift-sdkx:10.4.0'
}
dependencies {
// legacy android support library dependency
implementation 'com.android.support:appcompat-v7:28.0.0'
implementation 'com.helpshift:helpshift-sdkx:10.2.X'
}
Helpshift SDKは47の言語に組み込みで対応しています。SDKの言語を変更するためのAPIも提供されており、こちらからご確認いただけます。
これでHelpshiftがあなたとユーザーとの間の会話をサポートする準備が整いました！
Helpshiftの使用を開始する
バージョンの必要条件
| Helpshift SDKのバージョン | minSDKVersion | compileSDKVersion | buildToolsVersion |
|---|---|---|---|
| 10.4.0以上 | 19 | 35 | 35 |
| 10.3.0以上 | 16 | 34 | 34 |
| 10.2.0以上 | 16 | 33 | 33 |
| 10.0.2以上 | 16 | 31 | 31 |
| 10.0.0以上 | 16 | 29 | 29 |
アプリでHelpshiftを初期化する
最初に、Helpshiftダッシュボードでアプリを作成します
選択した
PlatformにAndroidを指定してアプリを作成します
Helpshiftは、登録済みの各種アプリを以下の2つのトークンの組み合わせによって一意に識別します。
Platform ID | アプリ固有のプラットフォームID（ダッシュボード上のアプリのApp IdがプラットフォームIDです） |
Domain Name | あなたのHelpshiftドメイン。例: happyapps.helpshift.com |
これらの値を取得するには、以下の手順に従ってください。
- 自身のHelpshiftダッシュボードにアクセスする
Settings、SDKs (for Developers)の順に移動する- ドロップダウンから目的のアプリを選択する
- 「Android」テーブルに記載されている2つのトークンをコピーする
com.helpshift.Helpshift.install()メソッドを呼び出してSDKを初期化します。
オプションで構成マップをHelpshift.install() APIに渡すことも可能です。対応する構成を確認するには、「SDKの構成」ページをご確認ください。
public class MainApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// Add install configs in the config map
Map<String, Object> config = new HashMap<>();
//...
// Install call
try {
Helpshift.install(this,
"<App Id from the Helpshift Dashboard>",
"<Domain name from the Helpshift Dashboard>",
config);
} catch (UnsupportedOSVersionException e) {
// Android OS versions prior to Android 7 Nougat (< API Level 24) are not supported.
// SDK will be non-operational so you can choose to provide support to your users via other mediums like Web, Email etc.
}
}
}
中国向けのアプリでHelpshiftを初期化する
中国リージョン向けにHelphift SDKを統合するには、特別なインストール設定キーであるisForChinaを使用する必要があります。
この設定キーはブール値を受け入れます。中国リージョン向けのアプリでSDKを統合する場合には、trueを渡してください。指定がない場合のデフォルト値は、falseです。
public class MainApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// Add install configs in the config map
Map<String, Object> config = new HashMap<>();
config.put("isForChina", true);
//...
// Install call
try {
Helpshift.install(this,
"<App Id from the Helpshift Dashboard>",
"<Domain name from the Helpshift Dashboard>",
config);
} catch (UnsupportedOSVersionException e) {
// Android OS versions prior to Android 7 Nougat (< API Level 24) are not supported.
// SDK will be non-operational so you can choose to provide support to your users via other mediums like Web, Email etc.
}
}
}
インストール呼び出しの配置
インストール呼び出しは、Application.onCreate()以外の場所には配置しないでください。これを他の場所に配置すると、実行時の予期せぬ問題が引き起こされてしまう可能性があります。
HelpshiftInitializationException
インストール呼び出しよりも先にAPIを呼び出すと、デバッグモードでチェックされていないHelpshiftInitializationExceptionがスローされる可能性があります。
UnsupportedOSVersionException
バージョン24未満のAndroid SDKでinstall()を呼び出すと、このチェック済み例外がスローされます。すべてのAPIが操作不可能となります。