Helpshift API

Helpshiftでは、お客様の要件に応じてSDKの機能を使用する方法を提供しています。

注意

SDKに含まれているすべてのパブリックAPIは、Helpshift.install() APIを介してSDKを初期化した後に呼び出す必要があります

お問い合わせとアプリ内メッセージの統合

Helpshift.showConversation(MyActivity.this, configurationMap)を呼び出すことにより、ユーザーが最初にFAQを閲覧することなく直接フィードバックを送信したり、新しい会話を開始したりすることができるようになります。ユーザーが新しい会話を開始すると、このAPI呼び出しは会話画面を表示します。会話は、エージェントによって解決されるか、または拒否されるまで継続されます。

例:

    // config map
    Map<String, Object> config = new HashMap<>();

    // set tags for tracking
    config.put("tags", new String[]{"foo", "bar"});

    // set custom issue fields
    Map<String, Object> cifMap = new HashMap<>();
    Map<String, String> isPro = new HashMap<>();
    isPro.put("type", "boolean");
    isPro.put("value", "true");
    cifMap.put("is_pro", isPro);

    config.put("cifs", cifMap);

    //..etc

    // pass the config map in the api
    Helpshift.showConversation(MainActivity.this, config);

Note

The "customIssueFields" key has been deprecated. We strongly recommend transitioning to using the "cifs" key as the preferred method for passing custom issue fields.

Helpshift.showConversation(MyActivity.this, configMap);のMyActivity.thisはHelpshiftを呼び出すアクティビティであり、configMapはSDKを構成するために渡す構成マップです。

これらの APIオプションに対応しています。

FAQの統合

API呼び出しHelpshift.showFAQs(Activity a, Map<String, Object> configMap)を使用することで、ユーザーがアプリ内に設けられたヘルプ/サポートセクションを呼び出すことができるようになります。シンプルで直感的なインターフェースにHelpshift SDKのすべての機能がバンドルされているため、これがアプリでヘルプを有効にする場合の最も簡単なアプローチとなります。このAPI呼び出しは、アプリのヘルプまたはサポートアクションに結び付けることができます。

このアクティビティは、FAQ機能、検索機能、お問い合わせ機能を1つのインターフェースに統合したものです。このビューでは、ユーザーはFAQで特定の質問を検索し、見つからなかった場合には問題を報告することができます。Helpshiftエージェントダッシュボードから相手の質問に返信すると、その返信はお問い合わせの横にカウント数として表示され、クリックすると会話が開始されます。

例: Helpshift.showFAQs(MyActivity.this, configMap);のMyActivity.thisはHelpshiftを呼び出すアクティビティであり、configMapはSDKを構成するために渡す構成マップです。

これらの APIオプションを対応しています。

特定のFAQセクションの表示

API呼び出し Helpshift.showFAQSection(Activity a, String sectionPublishId, Map<String, Object> configMap)を使用することで、特定のFAQセクションのFAQを表示できるようになります。

このAPIを使用するには、以下のようにFAQセクションのpublish-idが必要となります。

この機能は、アプリ内で特定のFAQセクションを文脈依存ヘルプとして表示させるパーマリンクのようなものとして機能します。たとえば、ユーザーがメールアドレスやFacebook、Twitterを使用してあなたのアプリにログインしなければならない場合、ログイン画面にヘルプアクションを紐づけて、ログイン方法に関する質問が複数記載されている「ログインのヘルプ」という名前のHelpshiftのFAQセクションにリンクさせることができます。

例: Helpshift.showFAQSection(MyActivity.this, "11", configMap);のMyActivity.thisはHelpshiftを呼び出すアクティビティであり、"11"はFAQセクションのpublish-idです

これらの APIオプションをサポートしています。

特定のFAQの表示

API呼び出しHelpshift.showSingleFAQ(Activity a, String questionPublishId, Map<String, Object> configMap)を使用することで、個別のFAQを表示できるようになります。

このAPIを使用するには、以下のようにFAQのpublish-idが必要となります。

例: Helpshift.showSingleFAQ(MyActivity.this, "51", configMap);のMyActivity.thisはHelpshiftを呼び出すアクティビティであり、"51"はFAQのpublish-idです。

これらの APIオプションをサポートしています。

SDKの言語を設定する

このAPIと言語の詳細については、こちらを参照してください。

SDKのバージョンを取得する

Helpshift SDK Xの現在のバージョンを取得するには、getSDKVersion APIを使用します。

注意

このAPIは、バージョン10.3.0からご利用いただけます。

  // Returns SDK version as a string eg. "10.3.0"
  String helpshiftVersion = Helpshift.getSDKVersion();

Helpshiftのセッションの終了

アクティブなSDKセッションを終了するには、Helpshift.closeSession APIを使用します。アクティブなSDKセッションが存在しない場合には、このAPIを呼び出しても何の効果もありません。

注意

このAPIは、バージョン10.3.0からご利用いただけます。

  // closes Helpshift sdk session
  Helpshift.closeSession();