Android向けの自動ガイドボットのSDK(開発キット)の操作

Android向けの自動ガイドボットのSDK(開発キット)の操作

スマートフォンが登場して以来、モバイルアプリはビジネス分野でも重要なものとなりました。今日、企業においては、顧客との関係をより深めるために、モバイルアプリを通じてさまざまなサービスが提供されています。モバイルアプリを提供している場合には、顧客の利便性を高めるために、アプリに顧客サポート機能を組み込みたいという場合も多いでしょう。

Zoho Deskで提供されている、Android向けの自動ガイドボットのSDK(開発キット)を利用すると、自社が提供しているAndroidアプリにZoho Deskの自動ガイドボット機能を組み込むことが可能です。自動ガイドボット機能を組み込むと、従来、サポート担当者からの直接的なサポートを必要としていた顧客が、チャット上の自動ガイダンスに従って、自分で問題を解決したり、手続きを行ったりできるようになります。 

自動ガイドボットについての詳細は、こちらの記事をご参照ください。

自動ガイドボットのSDK(開発キット)の設定  

提供中のAndroidアプリに自動ガイドボットの機能を追加するには、まず、Zoho Deskで自動ガイドボットのアドオンの設定を行う必要があります。

      1.      Zoho Deskの画面で画面右上にある設定アイコンをクリックし、[一般]の欄にある[自動ガイドボット]を選択します。
 
      2.      画面左側のメニューで[一般]の欄にある[自動ガイドボット]をクリックします。
                  自動ガイドボットの一覧が表示されます。
                  関連情報自動ガイドボットのフローの作成
 
      3.      アプリに埋め込みたい自動ガイドボットの欄で、(共有)アイコンをクリックします。
                     共有設定に関する画面が表示されます。
 
 
      4.      [モバイルSDK]をクリックします。


表示された画面で以下の情報を確認できます。
 
  • 組織ID:組織ごとに個別のIDです。
  • ウィジェットID:自動ガイドボットのウィジェットごとに個別のIDです。
  • ドメイン:組織ごとに個別のURLです。
これらの情報は、自動ガイドボットの表示処理の設定に必要です。

自動ガイドボットのSDK(開発キット)とAndroidアプリとの連携  

Zoho Deskで自動ガイドボットのアドオンの設定を行ったら、Mavenを使用してAndroidアプリとZohoの自動ガイドボットのSDK(開発キット)を連携する必要があります。
SDK(開発キット)とアプリを連携するには、以下のコードを最上位のフォルダー(ルートフォルダー)の「build.gradle」ファイルに追加します。
repositories { maven { url 'https://maven.zohodl.com/' } maven { url 'https://downloads.zohocdn.com/wmslibrary' } }
アプリ内の「build.gradle」ファイルの依存関係のセクションに、依存関係に関する以下のコードを追加します。
 
dependencies {
implementation 'com.zoho.gc:chat:1.0_beta03'
}

Zohoの自動ガイドボットのSDK(開発キット)と互換性のあるバージョン:
minSdkVersion - 21
compileSdkVersion - 32 
targetSdkVersion - 32 
kotlin_version - 1.5.20

自動ガイドボットの表示  


アプリ内で自動ガイドボットを表示するには、メソッド内で以下の情報を指定する必要があります。
  • 組織ID(orgId)
  • ウィジェットID(widgetId)
  • ドメイン(domain)
これらの情報は、Zoho Deskの自動ガイドボットのアドオンの設定ページから確認できます(詳細は、上記の「自動ガイドボットのSDK(開発キット)の設定」のセクションをご参照ください)。
  
 
自動ガイドボットの表示:
Kotlin
ZohoGC.getInstance(context).show(activity, orgId, widgetId, domain) 
Java
  ZohoGC.Companion.getInstance(context).show(activity,orgId, widgetId, domain);


位置情報ブロックの設定  

位置情報ブロックを有効にするには、以下の手順を実施します。
1. Google マップ用のAPIキーを取得します。
    APIの取得方法については、こちらをご参照ください。
2. 「Androidmanifet.xml」のファイルを開き、以下のコードを追加します。
 なお、コード内の「YOUR_MAP_API_KEY」の部分には、取得したAPIキー挿入します。
<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="YOUR_MAP_API_KEY" /> 
3. 「strings.xml」のファイルを開き、以下のコードを追加します。
<string name="zoho_gc_places_api_key">YOUR_MAP_API_KEY</string> 
検索欄:
利用者は検索欄から特定の場所を検索して、該当の位置情報をサポート担当者宛てに共有できます。特別な設定を行わない場合(初期設定のままの場合)、検索欄は表示されます。不要な場合、非表示にするように設定することも可能です。その場合はこの後に記載されているメソッドを使用します。
メモ:検索欄で住所を検索する機能は有料です。

  
Kotlin
ZohoGCUtil.setHideLocationSearch(true);
Java
ZohoGCUtil.setHideLocationSearch(true); 


会話変数:   

会話変数は、自動ガイドボットでのやりとりを通じて、顧客が入力/選択した情報を保存するために使用します。組織内の複数のフローで共通して利用することができます。
関連情報:会話変数
 
会話変数の設定方法と更新方法は以下のとおりです。
 

会話変数の設定: 


Kotlin

val sessionVariableMap = HashMap<String, Any>()
sessionVariableMap.apply

      {
    this["name"] = "exampleName"
    this["value"] = "exampleValue"
}
      val sessionVariableList = ArrayList<HashMap<String, Any>>()
sessionVariableList.add(sessionVariableMap)
ZohoGC.getInstance(context).setSessionVariables(sessionVariableList)
Java
HashMap<String, Object> sessionVariableMap= new HashMap<>();
sessionVariableMap.put("name","exampleName");
sessionVariableMap.put("value","exampleValue");
ArrayList<HashMap<String,Object>> sessionVariableList= new ArrayList<>();
sessionVariableList.add(sessionVariableMap);
 
 

会話変数の更新:   

Kotlin

val sessionVariableMap = HashMap<String, Any>()
sessionVariableMap.apply

       {
    this["name"] = "exampleName"
    this["value"] = "exampleValue"
}
      val sessionVariableList = ArrayList<HashMap<String, Any>>()
sessionVariableList.add(sessionVariableMap)
ZohoGC.getInstance(context).updateSessionVariables(sessionVariableList)
 
Java
HashMap<String, Object> sessionVariableMap= new HashMap<>();
sessionVariableMap.put("name","exampleName");
sessionVariableMap.put("value","exampleValue");
ArrayList<HashMap<String,Object>> sessionVariableList= new ArrayList<>();
sessionVariableList.add(sessionVariableMap);

ZohoGC.Companion.getInstance(context).updateSessionVariables(sessionVariableList);
 

テーマのカスタマイズ:  

自動ガイドボットの標準のテーマの種類には、ライトテーマとダークテーマがあります。テーマは、必要に応じて変更できます。また、テーマの強調色(アクセントカラー)や基調色をカスタマイズすることも可能です。
 
メモ:初期設定のテーマは、ライトテーマです。
 
Kotlin
val light: ZDTheme = ZDTheme.Builder(false).build() 
Java
ZDTheme light = new ZDTheme.Builder(false).build();

 


ダークモードに変更したい場合は、以下のメソッドを使用します。
 
Kotlin
val dark: ZDTheme = ZDTheme.Builder(true).build()
  
Java
ZDTheme dark = new ZDTheme.Builder(true).build(); 
テーマの色をカスタマイズするには、「ThemeBuilder」を使用します。強調色(アクセントカラー)を指定するには「setColorAccent」、基調色を指定するには「setTextColorPrimary」を使用します。


 
Kotlin
        val light: ZDTheme = ZDTheme.Builder(false).build()
val dark: ZDTheme = ZDTheme.Builder(true).build()
ZohoGCUtility.themeBuilder = light
 
Java
ZDTheme light = new ZDTheme.Builder(false).build();
ZDTheme dark = new ZDTheme.Builder(true).build();
ZohoGCUtility.INSTANCE.setThemeBuilder(light);

メモ:テーマの色をカスタマイズする場合も、テーマの種類の設定が必要です。自動ガイドボットのテーマには、設定に従って、ダークテーマまたはライトテーマのいずれかが適用されます。

ローカルデータのクリア  

データベースやファイルなど、SDK(開発キット)内に保存されたすべてのデータ(ローカルデータ)を削除するには、以下のメソッドを使用します。
 
Kotlin
ZohoGC.getInstance(context)
    .clearData(object : ZDChatCallback.ZDClearDataCallback {
        override fun onSuccess() {}
        override fun onFailed(exception: Exception) {}
    })
Java
ZohoGC.Companion.getInstance(context).clearData(new ZDChatCallback.ZDClearDataCallback() {
    @Override
    public void onSuccess() {

    }
    @Override
    public void onFailed(Exception exception) {

    }
});
  

ログの有効化  


初期設定では、ログは無効になっています。デバッグ用の情報をログ出力機能(Logcat)を通じて表示したい場合は、以下のメソッドを使用すると、ログを有効にできます。
 
Kotlin
ZohoGC.getInstance(context).enableLog(true)
 
Java
ZohoGC.Companion.getInstance(context).enableLog(true);



    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Desk Resources

              • Desk Community Learning Series


              • Digest


              • Functions


              • Meetups


              • Kbase


              • Resources


              • Glossary


              • Desk Marketplace


              • MVP Corner


              • Word of the Day









                                • Related Articles

                                • iOS向けの自動ガイドボットのSDK(開発キット)の操作

                                  スマートフォンが登場して以来、モバイルアプリはビジネス分野でも重要なものとなりました。今日、企業においては、顧客との関係をより深めるために、モバイルアプリを通じてさまざまなサービスが提供されています。モバイルアプリを提供している場合には、顧客の利便性を高めるために、アプリに顧客サポート機能を組み込みたいという場合も多いでしょう。 Zoho Deskで提供されている、iOS向けの自動ガイドボットのSDK(開発キット)を利用すると、自社が提供しているiOSアプリにZoho ...
                                • Flutter向けのどこでもサポートSDKの操作

                                  Flutter向けのどこでもサポートSDK(ソフトウェア開発キット)を活用すると、Flutterで開発したモバイルアプリ内にZoho Deskのサポート機能をかんたんに埋め込むことができます。 これにより、アプリの利用者に対して、以下の機能を提供できます。 サポート窓口への問い合わせ(問い合わせの送信) ナレッジベース(製品やサービスに関するヘルプやよくある質問)の参照 コミュニティの利用(他の利用者やサポート担当者とのやりとり) サポート担当者とのチャット、Ziaボットや自動ガイドボットの利用 ...
                                • React Native向けのどこでもサポートSDKの操作

                                  React Native向けのどこでもサポートSDK(ソフトウェア開発キット)を活用すると、モバイルアプリのエンドユーザーが手軽に利用できるヘルプ機能を提供することができます。SDKを使用することで、iOSやAndroidアプリ内のアドオンを作成したり、カスタマイズしたりできます。また、エンドユーザーが以下の機能に簡単にアクセスできるようになります: カスタマーサポートチームへの問い合わせ(問い合わせの送信、サポート担当者とのチャット) ナレッジベース(ヘルプ記事へのアクセス) ...
                                • Android向けのどこでもサポートSDKの操作(バージョン3.0)

                                  はじめに Android向けのどこでもサポートSDK(ソフトウェア開発キット)を活用すると、Androidアプリ内に利用者が手軽に利用できるサポート機能を埋め込むことができます。これにより、アプリの利用者はアプリ内から以下の機能を利用できるようになります。 問い合わせの送信、サポート担当者とのチャット ナレッジベース(自社の製品やサービスに関するヘルプやよくある質問) コミュニティ(アプリを通じた他の顧客とのやりとり) この機能を活用すれば、アプリの利用者はヘルプセンター(Zoho ...
                                • iOS向けのどこでもサポートSDKの操作(バージョン3.0)

                                  はじめに iOS向けのどこでもサポートSDK(ソフトウェア開発キット)を活用すると、iOSアプリ内に、利用者が手軽に利用できるサポート機能を埋め込むことができます。これにより、アプリの利用者はアプリ内から以下の機能を利用できるようになります。 サポート窓口への問い合わせ(問い合わせの送信、サポート担当者とのチャット) ナレッジベースの参照(製品やサービスに関するヘルプやよくある質問) コミュニティの利用(他の利用者とのやりとり) この機能を活用すれば、アプリの利用者はヘルプセンター(Zoho ...

                                Resources

                                Videos

                                Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                eBooks

                                Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                Webinars

                                Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                CRM Tips

                                Make the most of Zoho CRM with these useful tips.