SDK バージョン2.0

はじめに

• カスタマーサポートチームへの問い合わせ（問い合わせの送信、サポート担当者とのチャット）
  
• ナレッジベース（ヘルプ記事へのアクセス）
  
• ユーザーコミュニティ（アプリを通じた他の顧客とやりとり）
  

この機能を活用すれば、エンドユーザーはアプリを終了してWebサイトにアクセスし直したり、サポートを受けるためにメールを送信したりする必要はありません。ユーザーはアプリ内でヘルプ記事を検索することができます。顧客満足度の向上につなげることができます。

現在、バージョン1.2.7以前のASAP SDKを利用している場合、バージョン2.0を利用するには既存のコードを移行する必要があります。コードの移行手順については、この記事の 「バージョン1.xから2.0への移行」 セクションをご参照ください。

Zoho DeskでのSDKの設定

1. Zoho Deskで、 ［設定］ → ［チャネル］ → ［ASAP］ の順に移動します。
   
2. 左側の 設定 メニューの ASAP にて、 モバイル の隣にある ［+］ ボタンをクリックします。 モバイルアドオンの作成 画面が表示されます。
   
   
   
   
3. ［アドオンの詳細］ で、以下の内容を設定します：
   
   1. 名前： ASAPアドオンの名前です。この名前は参照用です。アプリの操作画面上には表示されません。
      
   2. 有効： ASAPアドオンを有効にする部門を選択します。
      
   3. チャット：切り替えボタンをクリックすると、チャット機能の有効／無効を切り替えることができます。
      
      メモ：チャット機能には、ポータルでのチャット機能の設定内容が反映されます。そのため、設定変更は、Zoho Deskの設定画面から行う必要があります。
      
   4. Zia：Zoho DeskのZia（ZohoのAIアシスタント）機能を有効にすると、顧客がモバイルアプリからZiaの案内に従って必要な情報を得ることができます。たとえば、質問を送信すると、対応するヘルプやよくある質問の記事（ナレッジベース）の内容が自動で表示されます。Zia機能を有効にするには、切り替えボタンをクリックします。
      
   5. 案内チャット：案内チャットは、顧客が、担当者からのサポートを受けずに、自力で問題を解決するのに役立つ機能です。自動応答によるやりとりを通じて、顧客の求めている内容を絞り込みながら、適切な解決策や手続きを提示できます。提供には、チャットのフローの事前設定が必要です。切り替えボタンをクリックすると、案内チャット機能の状態（有効／無効）を切り替えることができます。
      有効にしたら、使用したい案内チャットのフローを選択する必要があります。詳細はこちら
      

      

      メモ：Ziaと案内チャットの機能は、両方を有効にすることも可能です。
   6. バンドルID： Android の項目に、AndroidアプリのバンドルIDを入力します。（バンドルIDは、Androidアプリの「applicationId」です。アプリ内の「 build.gradle 」ファイルからこのデータを取得できます。）
      
      メモ： チャット機能を有効にしたり、プッシュ通知を送信したりするには、バンドルIDが必須です。
   7. プッシュ通知： 切り替えボタンを操作することで、プッシュ通知を有効または無効にできます。プッシュ通知を有効にするには、「 Enter GCM/FCM 」キーの項目にGCM/FCMサーバーキーを入力します。（このキーを取得するには、Firebaseコンソールで次の順に移動します： プロジェクトの設定 > クラウドメッセージング > サーバーキー ）
      
      メモ： 通知を有効にするには、JWT方式でのユーザー認証が必須となります。匿名ユーザーに対して、問い合わせに関するプッシュ通知を送信することはできません。
      
   8. 認証方法： このアドオンにおけるユーザーの認証方法を設定します。
      
      1. 匿名 - この方法では、エンドユーザーはゲストユーザーとみなされます。ゲストユーザーが行える操作は、問い合わせの送信、ユーザーコミュニティでの投稿内容の表示、サポート担当者とのチャット、に限定されます。自分が送信した問い合わせを表示したり、ユーザーコミュニティに参加したりすることはできません。
         
      2. JWT - この方法では、エンドユーザーは認証済みユーザーとみなされます。ゲストユーザーが行える操作に加えて、認証済みユーザーは、自分が送信した問い合わせのステータスを表示したり、問い合わせに返信やコメントしたり、ユーザーコミュニティに参加したりすることもできます。コミュニティでは、トピックのフォロー、トピックの追加、既存の投稿へのコメントの追加など、さまざまな操作を行うことができます。
         
4. ［保存］ をクリックします
   

SDKとアプリとの連携

repositories {
   jcenter()
   google()
   maven { url 'http://maven.zohodl.com/' }
   maven { url 'https://downloads.zohocdn.com/wmslibrary' }
​}

メモ： ASAP SDKは、Android アーキテクチャ コンポーネントを使用して開発が行われました。そのため、アプリのコード内に「 maven.google.com/google() 」を追加する必要があります。

            dependencies {
            implementation 'com.zoho.desk:asapsdk:2.1.4' 
            }         
   

• compileSdkVersion - 30
  
• supportLibVersion - 27.1.1
  
• minSdkVersion - 16
  
• targetSdkVersion - 30

                     
                        -dontwarn com.squareup.okhttp.**
                        -keep class android.support.v7.widget.SearchView { *; }
                        -dontwarn okhttp3.**
                        -dontwarn okio.**
                        -dontwarn retrofit2.**
                        -dontwarn com.zoho.desk.**
                     

アプリ内のSDKの初期設定

• 組織ID（Org ID）
  
• アプリID（App ID）
  
• データセンター（Datacenter）
  

      
         
            import android.app.Application; 
            import com.zoho.desk.asap.api.ZohoDeskPortalSDK; 
            public class MyApplication extends Application {
            public static ZohoDeskPortalSDK apiProvider;
            @Override
            public void onCreate() {
            super.onCreate();
            ZohoDeskPortalSDK.Logger.enableLogs();
            apiProvider = ZohoDeskPortalSDK.getInstance(getApplicationContext());
            apiProvider.initDesk(orgId, appId, datacenterValue);
            }
            }
         
      
      

   

メモ

配置の種類の応じたデータセンターの値は、以下のとおりです：

CN - DataCenter.CN

EU - DataCenter.EU

US - DataCenter.US

IN - DataCenter.IN

AU - DataCenter.AU

JP - DataCenter.JP

ヘルプ項目の表示

メモ： 初期設定では、SDKの操作画面にてチャットタブは無効になっています。利用するには、はじめにZoho Deskのポータルでチャットタブを有効にする必要があります。

      
         
            ZDPortalHome.show(MainActivity.this);
         
      
      

   

      
         
            ZDPHomeConfiguration homeConfiguration = new ZDPHomeConfiguration.Builder() 
            .showKB(true) 
            .showMyTickets(true) 
            .showCommunity(true) 
            .showLiveChat(true) 
            .showNavDrawer(true).build(); 
            ZDPortalHome.show(MainActivity.this, homeConfiguration);
         
      
      

   

      
         
            ZDPortalChat.show(activity);
         
      
      

   

      
         
            ZDPortalChatUser chatUser = new ZDPortalChatUser(); 
            chatUser.setName(name); 
            chatUser.setEmail(email); 
            chatUser.setPhone(phone); 
            ZDPortalChat.setGuestUserDetails(chatUser); 
         
      
      

   

      
         
            ZDPortalKB.show(activity);
         
      
      

   

      
         
            ZDPortalSubmitTicket.show(activity);
         
      
      

   

      
         
            ZDPortalSubmitTicket.show(activity, new ZDPortalCallback.CreateTicketCallback() {
            @Override
            public void onTicketCreated(Ticket ticket) {
            //Ticket created
            } 
            @Override
            public void onException(ZDPortalException e) {
            //Exception
            }
            } : null);
         
      
      

   

メモ： 認証済みユーザーによって問い合わせが送信されると、問い合わせのすべての詳細情報がアプリに送信されます。ゲストユーザーによって問い合わせが送信されると、問い合わせ番号のみが送信されます。

      
         
            ZDPortalTickets.show(activity);
         
      
      

   

      
         
            ZDPortalCommunity.show(activity);
         
      
      

   

SDKでのユーザー認証

• 匿名 - この方法では、エンドユーザーはゲストユーザーとみなされます。ゲストユーザーが行える操作は、問い合わせの送信、ユーザーコミュニティでの投稿内容の表示、サポート担当者とのチャット、に限定されます。自分が送信した問い合わせを表示したり、ユーザーコミュニティに参加したりすることはできません。
  
• JWT - この方法では、エンドユーザーは認証済みユーザーとみなされます。ゲストユーザーが行える操作に加えて、認証済みユーザーは、自分が送信した問い合わせを表示したり、ユーザーコミュニティに参加したりすることもできます。コミュニティでは、トピックのフォロー、トピックの追加、既存の投稿へのコメントの追加など、さまざまな操作を行うことができます。
  

      
         
            if(!MyApplication.deskInstance.isUserSignedIn()) {
            MyApplication.deskInstance.setUserToken(userToken, new ZDPortalCallback.SetUserCallback() {
            @Override
            public voidonUserSetSuccess() {
            //User set success
            }
            @Override
            public voidonException(ZDPortalException e) {
            //Exception
            }
            }); 
            }
         
      
      

   

• 「 userToken 」は、ユーザー（メールアドレスなど）を識別するための重複しない情報です。この情報は暗号化されています。
  
• 「 setUserToken 」は、ユーザーのトークンを入力する関数です。
  
• 「 callback 」は、「 ZDPortalCallback.SetUserCallback 」のインスタンスです。「 userFetch 」が実行された後に呼び出されます。
  

      
         
            boolean isUserLoggedIn = MyApplication.deskInstance.isUserSignedIn();
         
      
      

   

      
         
            MyApplication.deskPortalSDK.logout(new ZDPortalCallback.LogoutCallback() {
            @Override
            public void onLogoutSuccess() {
            //User logged out
            }
            @Override
            public void onException(ZDPortalException e) { 
            }
            });
         
      
      

   

ローカルデータのクリア

      
         
            MyApplication.deskInstance.clearDeskPortalData();
         
      
      

   

アドオンの操作画面のカスタマイズ

      
         
            ZDPortalConfiguration.setThemeResource(R.style.deskTheme_Light);
         
      
      

   

      
         
            ZDPortalConfiguration.setThemeResource(R.style.deskTheme_Dark);
         
      
      

   

      
         
            ZDPortalConfiguration.setThemeResource(R.style.deskTheme);
         
      
      

   

      
         
            <style name="deskTheme" parent="deskTheme_Light">
            <!-- Customize your theme here.--><item name="colorPrimary">@color/colorPrimary </item>
            <item name="colorPrimaryDark">@color/colorPrimaryDark </item>
            <item name="colorAccent">@color/colorAccent </item>
            <item name="android:fontFamily">@font/dosis_regular </item>
            </style>
         
      
      

   

メモ： カスタムフォントを使用しない場合、初期設定ではシステムのフォントが表示されます。

言語設定の変更

      
         
            ZDPortalConfiguration.setLanguage("en");
         
      
      

   

      
         
            android {
            defaultConfig {
            ...
            resConfigs "en", "ta", "fi"
            }
            }
         
      
      

   

操作画面上の文字列のカスタマイズ

1. アプリの「 strings.xml 」ファイル内に、SDKの操作画面に関連するキーを追加します。（対応しているキーの一覧については、以下の表をご参照ください。）
   
2. コードをコンパイルして、検証します。
   

通知の有効化

メモ： プッシュ通知を設定する際は、Zoho DeskのASAPアドオンの設定画面にて行う必要があります。

      
         
            MyApplication.deskInstance.enablePush("fcmId");
         
      
      

   

      
         
            MyApplication.deskInstance.disablePush("fcmId");
         
      
      

   

      
         
            ZDPortalConfiguration.handleNotification(Context context, Map data, int icon);
         
      
      

   

プログラムによる問い合わせの追加

      
         
            ZDPortalTicketsAPI.createTicket(new CreateTicketCallback() {
            　　 @Override
            　　 public void onTicketCreated(Ticket ticket) {
            　　 }
            　　 @Override
            　　 public void onException(ZDPortalException exception) {
            　　 }
            }, ticketData, params);
         
      
      

   

      
         
            ZDPortalAPI.getDepartments(new ZDPortalCallback.DepartmensCallback() {
            　　 @Override
            　　 public void onDepartmentsDownloaded(DepartmentsList response) {
            　　 }
            　　 @Override
            　　 public void onException(ZDPortalException exception) {
            　　 }
            });
         
      
      

   

      
         
            HashMap<String, String> options = new HashMap<>();
            options.put("from", String.valueOf(1)); 
            options.put("limit", String.valueOf(100)); 
            options.put("departmentId", departmentId); 
            ZDPortalAPI.getProductsList(new ZDPortalCallback.ProductsCallback() {
            　　 @Override
            　　 public void onProductsDownloaded(ProductsList productsList) {
            　　　　 productsMap.put(departmentId, productsList.getData()); 
            　　　　　responseLiveData.setValue(productsList.getData());
            　　 }
            　　 @Override
            　　 public void onException(ZDPortalException exception) {
            　　 }
            }, options);
         
      
      

   

      
         
            ZDPortalTicketsAPI.getTicketFields(new TicketFieldsCallback() {
            　　 @Override
            　　 public void onTicketFieldsDownloaded(TicketFieldsList ticketFieldsList) {
            　　 }
            　　 @Override public void onException(ZDPortalException exception) {
            　　 }
            }, fieldsParams, "apiName");
         
      
      

   

      
         
            ZDPortalTicketsAPI.uploadAttachment(new UploadAttachmentCallback() {
            　 　@Override
            　　　public void onAttachmentUploaded(ASAPAttachmentUploadResponse response) {
            　　 }
            　　 @Override
            　　 public void onException(ZDPortalException exception) {
            　　 }
            }, fileTobeUploaded, null);
         
      
      

   

ナレッジベース

      
         
            ZDPortalKB.showCategoryWithPermalink(activity, permaLink);
         
      
      

   

1. 「 activity 」は、活動のインスタンスです。
   
2. 「 permalink 」は、対象のナレッジベースのカテゴリーのURLです。
   

      
         
            ZDPortalKB.showArticleWithPermalink(activity, permalink);
         
      
      

   

1. 「 activity 」は、活動のインスタンスです。
   
2. 「 permalink 」は、ヘルプ記事のURLです。

コミュニティ

      
         
            ZDPCommunityConfiguration communityConfiguration = new ZDPCommunityConfiguration(); 
            communityConfiguration.setTopicEditAllowed(false); 
            communityConfiguration.setTopicDeleteAllowed(false); 
            communityConfiguration.setReplyAllowed(true); 
            communityConfiguration.setReplyEditAllowed(true); 
            communityConfiguration.setReplyDeleteAllowed(false); 
            ZDPortalCommunity.setConfiguration(communityConfiguration);
         
      
      

   

      
         
            HashMap<String, String> params = new HashMap<>(); 
            params.put("from", "1"); 
            params.put("limit", "5"); 
            ZDPortalCommunityAPI.getMostPopularTopics(new ZDPortalCallback.CommunityTopicsCallback() {
            　　　　　 @Override
            　　　　　　public void onCommunityTopicsDownloaded(DeskTopicsList deskTopicsList) {
            　　　 　　}
            　　　　　@Override
            　　　　　　public void onException(ZDPortalException e) {
            　　　　　 }
            }, params);
         
      
      

   

1. categoryId - string - トピックを取得するコミュニティのカテゴリーのIDです。すべてのカテゴリーを追加する場合、値に「null」を指定します。
   
2. filterType - string - フォーラムのトピックの種類です。指定可能な値は次のとおりです： QUESTION 、 IDEA 、 ANNOUNCEMENT 、 PROBLEM 、 DISCUSSION
   
3. from - int -  インデックス番号です。この番号からトピックのデータを取得します。値は「1」から開始できます。
   
4. limit - int - 取得するトピックの件数です。
   
5. includeCount - Boolean - 取得したトピックの件数を表示するかどうかを指定するパラメーターです。
   

      
         
            HashMap<String, String> params = new HashMap<>(); 
            params.put("from", "1"); 
            params.put("limit", "5"); 
            ZDPortalCommunityAPI.getMostDiscussedTopics(new ZDPortalCallback.CommunityTopicsCallback() {
            　　 @Override
            　　 public void onCommunityTopicsDownloaded(DeskTopicsList deskTopicsList) {
            　　 }
            　　 @Override
            　　 public void onException(ZDPortalException e) {
            　　 }
            }, params);
         
      
      

   

1. categoryId - string - トピックを取得するコミュニティのカテゴリーのIDです。すべてのカテゴリーを追加する場合、値に「null」を指定します。
   
2. filterType - string - フォーラムのトピックの種類です。指定可能な値は次のとおりです： QUESTION 、 IDEA 、 ANNOUNCEMENT 、 PROBLEM 、 DISCUSSION
   
3. from - int -  インデックス番号です。この番号からトピックのデータを取得します。値は「1」から開始できます。
   
4. limit - int - 取得するトピックの件数です。
   
5. includeCount - Boolean - 取得したトピックの件数を表示するかどうかを指定するパラメーターです。
   

問い合わせ

      
         
            ZDPortalSubmitTicket.setTicketsFieldsListTobeShown(ticketListTobeShown, deptId);
         
      
      

   

1. ticketListTobeShown - 文字列の一覧です（問い合わせ項目のapiNameです）
   
2. deptId - 問い合わせ項目の一覧を設定する部門のIDです。
   

      
         
            ZDPortalSubmitTicket.preFillTicketFields(preFillTicketFields, deptId);
         
      
      

   

1. preFillTicketFields - 「 PreFillTicketField 」オブジェクトの一覧です
   
2. deptId - 問い合わせ項目の一覧を設定する部門のIDです。
   

1. fieldApiName - string - 問い合わせ項目の「apiName」です。それぞれの項目の「apiName」を取得するには、「 getTicketFields() 」メソッドを使用します。
   
2. fieldValue - object
   
   1. 複数選択項目の場合、選択可能な文字列の値を指定します。
      
   2. 選択リスト項目の場合、選択可能な文字列の値のいずれかを指定します。
      
   3. 日付項目の場合、文字列の値を「 dd-MM-yyyy 」形式で指定します。
      
   4. 日時項目の場合、文字列の値を「 dd-MM-yyyy HH:mm a 」形式で指定します。
      
   5. 真偽値の項目の場合、真偽値を指定します。
      
   6. 他の項目の場合、文字列の値を指定します。
      
   7. こちらで指定した値が、項目で設定されている文字数や小数点の上限内になるようにしてください。
      
3. isEditable - Boolean - 対象の項目が編集可能かどうかを指定するキーです。
   

メモ： コードの詳細については、 こちら をご参照ください。

      
         
            ZDPTicketConfiguration ticketConfiguration = new ZDPTicketConfiguration(); 
            ticketConfiguration.setReplyAllowed(false); 
            ticketConfiguration.setCommentAllowed(true); 
            ticketConfiguration.setTicketUpdateAllowed(true); 
            ticketConfiguration.setCommentEditAllowed(false); 
            ticketConfiguration.setCommentDeleteAllowed(false); 
            ZDPortalTickets.setConfiguration(ticketConfiguration);
         
      
      

   

その他

      
         
            HashMap<String, String> params = new HashMap<>(); 
            params.put("timeZone", "asia/kolkatta"); 
            ZDPortalAPI.updateProfileDetails(new ZDPortalCallback.UserDetailsCallback() {
            　　 @Override
            　　 public void onUserDetailsSuccess(DeskUserProfile userProfile) {
            　　 }
            　　 @Override
            　　 public void onException(ZDPortalException exception) {
            　　 }
            }, params);
         
      
      

   

SDKのログ

      
         
            ZohoDeskPortalSDK.Logger.enableLogs();
         
      
      

   

メモ： SDKに関するデバッグの情報は、「logcat」に保存されます。そのため、リリースビルド内に「 enableLogs() 」が存在しないようにしてください。

リリースノート

• 複数言語のナレッジベースの設定に対応しました。
  
• 問い合わせの追加タブにて、条件付きレイアウトと問い合わせテンプレートが利用できるようになりました。
  
• 利用可能なすべてのAPIを含む別のフレームワークとして、APIプロバイダーを追加しました。操作画面をカスタマイズして、APIを組み込めるようになりました。
  

SDKバージョン1.0

はじめに

• カスタマーサポートチームへの問い合わせ（問い合わせの送信、サポート担当者とのチャット）
  
• ナレッジベース（ヘルプ記事へのアクセス）
  
• ユーザーコミュニティ（アプリを通じた他の顧客とやりとり）
  

Zoho DeskでのSDKの設定

1. Zoho Deskで、 ［設定］ > ［チャネル］ > ［ASAP］の順に移動します。
   
2. 左側の 設定 メニューの ASAP にて、 モバイル の隣にある ［+］ ボタンをクリックします。 モバイルアドオンの作成 画面が表示されます。 
   
   
   

   
   
3. ［アドオンの詳細］ で、以下の内容を設定します：
   
   • 名前： ASAPアドオンの名前です。この名前は参照用です。アプリの操作画面上には表示されません。
     
   • 有効： ASAPアドオンを有効にする部門を選択します。
     
   • バンドルID： Android の項目に、AndroidアプリのバンドルIDを入力します。（バンドルIDは、Androidアプリの「applicationId」です。アプリ内の「 build.gradle 」ファイルからこのデータを取得できます。）
     
     メモ： チャット機能を有効にしたり、プッシュ通知を送信したりするには、バンドルIDが必須です。
     
   • チャット： 切り替えボタンを操作することで、チャット機能を有効または無効にできます。
     
     メモ： チャットの項目には、ポータルのチャットチャネルにて設定された内容が反映されます。そのため、設定を変更するには、Zoho Deskの設定画面で行う必要があります。
     
   • プッシュ通知： 切り替えボタンを操作することで、プッシュ通知を有効または無効にできます。プッシュ通知を有効にするには、「 Enter GCM/FCM 」キーの項目にGCM/FCMサーバーキーを入力します。（このキーを取得するには、Firebaseコンソールで次の順に移動します： プロジェクトの設定 > クラウドメッセージング > サーバーキー ）
     
     メモ： 通知を有効にするには、JWT方式でのユーザー認証が必須となります。匿名ユーザーに対して、問い合わせに関するプッシュ通知を送信することはできません。
     
   • 認証方法： このアドオンにおけるユーザーの認証方法を設定します。
     
     • 匿名 - この方法では、エンドユーザーはゲストユーザーとみなされます。ゲストユーザーが行える操作は、問い合わせの送信、ユーザーコミュニティでの投稿内容の表示、サポート担当者とのチャット、に限定されます。自分が送信した問い合わせを表示したり、ユーザーコミュニティに参加したりすることはできません。
       
     • JWT - この方法では、エンドユーザーは認証済みユーザーとみなされます。ゲストユーザーが行える操作に加えて、認証済みユーザーは、自分が送信した問い合わせのステータスを表示したり、問い合わせに返信やコメントしたり、ユーザーコミュニティに参加したりすることもできます。コミュニティでは、トピックのフォロー、トピックの追加、既存の投稿へのコメントの追加など、さまざまな操作を行うことができます。 
       
4. ［保存］ をクリックします。
   

SDKとアプリとの連携

      
         
            repositories {
            　　 jcenter()
            　　 maven { url '
            
               https://maven.google.com/
            
            ' }
            　　 maven { url '
            
               http://maven.zohodl.com/
            
            ' }
            }
         
      
      

   

メモ： ASAP SDKは、Android アーキテクチャ コンポーネントを使用して開発が行われました。そのため、アプリのコード内に「 maven.google.com 」を追加する必要があります。

      
         
            dependencies {
            　　 compile 'com.zoho.desk:asapsdk:1.2.7' 
            }
         
      
      

   

• compileSdkVersion - 30 
  
• supportLibVersion - 26.1.0
  
• minSdkVersion - 16
  
• targetSdkVersion - 30 
  

      
         
            
               -keep 
            
            class com.zoho.**{*;} 
            
               -keep 
            
            interface android.support.v7.**{ *; } 
            
               -keep
            
            class android.support.v7.**{ *; } 
            
               -keep
            
            interface android.support.v4.**{ *; } 
            
               -keep
            
            class android.support.v4.**{ *; } 
            
               -keepattributes
            
            Signature 
            
               -keepattributes 
            
            Annotation 
            
               -keep
            
            class okhttp3.*{ *; } 
            
               -keep
            
            interface okhttp3.*{ *; } 
            
               -dontwarn
            
            okhttp3.**
            
               -dontwarn 
            
            okio.**
            
               -dontwarn
            
            com.zoho.accounts.**
            
               -dontwarn
            
            com.squareup.okhttp.**
            
               -dontwarn
            
            okio.**
            
               -dontwarn
            
            retrofit2.**
         
      
      

   

アプリ内のSDKの初期設定

• 組織ID（Org ID）
  
• アプリID（App ID）
  
• データセンター（Datacenter）
  

      
         
            import android.app.Application; 
            import com.zoho.deskportalsdk.DeskConfig; 
            import com.zoho.deskportalsdk.ZohoDeskPortalSDK; 
            public class MyApplication extends Application {
            public static ZohoDeskPortalSDK deskInstance;
            @Override
            public void onCreate() {
            super.onCreate();
            ZohoDeskPortalSDK.Logger.enableLogs(); 
            DeskConfig config = new DeskConfig.Builder().build();
            deskInstance = ZohoDeskPortalSDK.getInstance(this);
            deskInstance.initDesk(orgId, appId, dataCenterValue, config);
            } 
            }
         
      
      

   

配置の種類の応じたデータセンターの値は、以下のとおりです：

CN - DataCenter.CN

EU - DataCenter.EU

US - DataCenter.US

IN - DataCenter.IN

ヘルプ項目の表示

メモ： 初期設定では、SDKの操作画面にてチャット機能は無効になっています。利用するには、はじめにZoho Deskのポータルでチャット機能を有効にする必要があります。

      
         
            MyApplication.deskInstance.startDeskHomeScreen(activity.this);
         
      
      

   

      
         
            DeskConfig deskConfig = new DeskConfig.Builder().showCommunity(false).build(); 
            MyApplication.deskInstance.startDeskHomeScreen(activity.this, deskConfig);
         
      
      

   

      
         
            MyApplication.deskInstance.startLiveChat();
         
      
      

   

      
         
            MyApplication.deskInstance.startHelpCenter(activity.this);
         
      
      

   

      
         
            MyApplication.deskInstance.startNewTicket(activity.this);
         
      
      

   

      
         
            MyApplication.deskInstance.startNewTicket(activity.this, new DeskCallback.DeskAddTicketCallback() {
            @Override
            public void onTicketAdded(DeskTicketResponse deskTicketResponse) {
            Toast.makeText(MainActivity.this, "onTicketAdded", Toast.LENGTH_SHORT).show(); 
            }
            @Override
            public void onException(DeskException e) {
            Toast.makeText(MainActivity.this, "onException", Toast.LENGTH_SHORT).show();
            } 
            });
         
      
      

   

メモ： 認証済みユーザーによって問い合わせが送信されると、問い合わせのすべての詳細情報がアプリに送信されます。ゲストユーザーによって問い合わせが送信されると、問い合わせ番号のみが送信されます。

      
         
            MyApplication.deskInstance.startTickets(activity.this);
         
      
      

   

      
         
            MyApplication.deskInstance.startCommunity(activity.this);
         
      
      

   

案内チャットは、顧客が、担当者からのサポートを受けずに、自力で問題を解決するのに役立つ機能です。自動応答によるやりとりを通じて、顧客の求めている内容を絞り込みながら、適切な解決策や手続きを提示できます。提供には、チャットのフローの事前設定が必要です。基本的には、追加的な開発は不要で利用できます（案内チャットの処理を他の処理と組み合わせて利用する場合を除く）。

案内チャットは、次のメソッドによって表示できます。

ZDPortalLiveChat.show(<activity>);

フローは、フラグメントのコンポーネントとしても設計されているため、必要に応じて次のメソッドも利用できます。

ZDPortalLiveChat.getChatFragment()

Ziaや案内チャットの機能を有効にすると、チャットの画面は以下のように表示されます。

1. すでにサインインしているユーザーが最新のバージョンに移行し、案内チャットを利用する場合、一度サインアウト（ログアウト）してから、もう一度サインイン（ログイン）の操作を行い、再認証する必要があります。再認証が完了すると、ユーザーの認証情報が案内チャット機能に同期されます。
   
2. 案内チャットとZiaを一緒に有効にすると、初期設定では案内チャットが読み込まれます。必要に応じて、Ziaに切り替えることもできます。会話を再開するメニューをクリックしてフローをリセットしない限り、フロー中にZiaと案内チャットを切り替えることはできませんので、ご注意ください。
3. Ziaのボットから回答が得られなかったときに顧客が実行できる処理は、チャットタブが有効になっているかどうかによって異なります。たとえば、チャットタブが有効な場合、顧客は担当者とやりとりを行うように切り替えることもできます。無効になっている場合、顧客は問い合わせの送信のみを行うことができます。

SDKでのユーザー認証

• 匿名 - この方法では、エンドユーザーはゲストユーザーとみなされます。ゲストユーザーが行える操作は、問い合わせの送信、ユーザーコミュニティでの投稿内容の表示、サポート担当者とのチャット、に限定されます。自分が送信した問い合わせを表示したり、ユーザーコミュニティに参加したりすることはできません。
  
• JWT - この方法では、エンドユーザーは認証済みユーザーとみなされます。ゲストユーザーが行える操作に加えて、認証済みユーザーは、自分が送信した問い合わせを表示したり、ユーザーコミュニティに参加したりすることもできます。コミュニティでは、トピックのフォロー、トピックの追加、既存の投稿へのコメントの追加など、さまざまな操作を行うことができます。
  

      
         
            if(!isUserLoggedIn) {
            MyApplication.deskInstance.setUserToken("userToken", new DeskCallback.DeskSetUserCallback() {
            @Override
            public void onUserSetSuccess() {
            }
            @Override
            public void onException(DeskException exception) {
            }
            });
            } else{
            //User already signed into SDK 
            }
         
      
      

   

• 「 userToken 」は、ユーザー（メールアドレスなど）を識別するための重複しない情報です。この情報は暗号化されています。
  
• 「 setUserToken 」は、ユーザーのトークンを入力する関数です。 
  
• 「 callback 」は、「 DeskCallback.DeskSetUserCallback 」のインスタンスです。「 userFetch 」が実行された後に呼び出されます。
  

      
         
            boolean isUserLoggedIn = MyApplication.deskInstance.isUserSignedIn();
         
      
      

   

      
         
            MyApplication.deskInstance.removeUser(new DeskCallback.DeskRemoveUserCallback() {
            @Override
            public void onUserRemoveSuccess() {
            //user removed from SDK.
            }
            @Override
            public void onException(DeskException exception) {
            }
            });
         
      
      

   

ローカルデータのクリア

      
         
            MyApplication.deskInstance.clearDeskPortalData();
         
      
      

   

ヘルプ項目の非表示

      
         
            DeskConfig config = new DeskConfig.Builder().showHelpCenter(false).build();
         
      
      

   

      
         
            DeskConfig config = new DeskConfig.Builder().showCreateTicket(false).build();
         
      
      

   

      
         
            DeskConfig config = new DeskConfig.Builder().showMyTickets(false).build();
         
      
      

   

      
         
            DeskConfig config = new DeskConfig.Builder().showCommunity(false).build();
         
      
      

   

      
         
            DeskConfig config = new DeskConfig.Builder().showNavDrawer(false).build();
         
      
      

   

メモ： 関数「 deskInstance.initDesk 」に設定したオブジェクトを送信する必要があります。詳細については、このドキュメントの「 アプリ内のSDKの初期設定 」セクションをご参照ください。 

アドオンの操作画面のカスタマイズ

      
         
            deskInstance.setThemeResource(R.style.deskTheme_Light);
         
      
      

   

      
         
            deskInstance.setThemeResource(R.style.deskTheme_Dark);
         
      
      

   

      
         
            MyApplication.deskInstance.setThemeResource(R.style.deskTheme);
         
      
      

   

      
         
            <style name="deskTheme" parent="deskTheme_Light">
            <!-- Customize your theme here.-->
            <item name="colorPrimary">@color/colorPrimary </item>
            <item name="colorPrimaryDark">@color/colorPrimaryDark </item>
            <item name="colorAccent">@color/colorAccent </item>
            <item name="android:fontFamily">@font/dosis_regular </item>
            </style>
         
      
      

   

メモ： カスタムフォントを使用しない場合、初期設定ではシステムのフォントが表示されます。

言語設定の変更

      
         
            DeskConfig config = new DeskConfig.Builder().setLanguage("de").build();
         
      
      

   

操作画面上のテキストのカスタマイズ

1. アプリの「 strings.xml 」ファイル内に、SDKの操作画面に関連するキーを追加します。（対応しているキーの一覧については、以下の表をご参照ください。）
   
2. コードをコンパイルして、検証します。
   

通知の有効化

メモ： プッシュ通知を設定する際は、Zoho DeskのASAPアドオンの設定画面にて行う必要があります。

      
         
            MyApplication.deskInstance.enablePush("fcmId");
         
      
      

   

      
         
            MyApplication.deskInstance.disablePush("fcmId");
         
      
      

   

      
         
            MyApplication.deskInstance.handleNotification(Context context, Map data, int icon);
         
      
      

   

担当者に対する匿名ユーザーの詳細データの表示

      
         
            DeskUser user = new DeskUser();
            user.setEmail(email);
            user.setPhone(phone);
            user.setName(name);
            MyApplication.deskInstance.setGuestUserDetails(user);
         
      
      

   

プログラムによる問い合わせの追加

      
         
            DeskNewTicketData ticketData = new DeskNewTicketData(); 
            ticketData.setEmail("
            
               emailAddress@test.com
            
            "); 
            ticketData.setContactName("ContactName"); 
            ticketData.setDepartmentId(departmentId); 
            ticketData.setSubject("Subject of the Ticket"); 
            ticketData.setDescription("Description of the ticket"); 
            MyApplication.deskInstance.addGuestTicket(ticketData, new DeskCallback.DeskAddGuestTicketCallback() {
            @Override
            public void onTicketAdded() {
            Log.i("APITEST", "addGuestTicket success "); 
            }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "addGuestTicket exception "+exception.getErrorMsg());
            }
            });
         
      
      

   

      
         
            MyApplication.deskInstance.getDepartmentsList(new DeskCallback.DeskDepartmentsCallback() {
            @Override
            public void onDepartmentsLoaded(DeskDepartmentsList response) {
            Log.i("APITEST", "getDepartmentsList success "); 
            }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "getDepartments exception "+exception.getErrorMsg());
            } 
            });
         
      
      

   

      
         
            public void getProducts(View view) {
            MyApplication.deskInstance.getProductsList(new DeskCallback.DeskProductsCallback() {
            @Override
            public void onProductsCompleted(DeskProductsList response) {
            Log.i("APITEST", "getProducts success");
            }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "getProducts exception "+exception.getErrorMsg());
            }
            }, departmentId,1,10); 
            }
         
      
      

   

      
         
            public void getTicketsFields(View view) {
            MyApplication.deskInstance.getTicketsFieldsList(new DeskCallback.DeskTicketsFieldsCallback() {
            @Override
            public void onTicketsFieldsLoaded(DeskTicketFieldList response) {
            Log.i("APITEST", "getTicketsFieldsList success");
            }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "getTicketsFieldsList exception "+exception.getErrorMsg()); 
            }
            }, departmentId); 
            }
         
      
      

   

      
         
            MyApplication.deskInstance.uploadAttachment(new DeskCallback.DeskUploadAttachmentCallback() {
            @Override
            public void onUploadSuccess(DeskUploadAttachmentResponse response) {
            Log.i("APITEST", "uploadAttachment success ");
              }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "uploadAttachment exception "+exception.getErrorMsg());
            }
            }, fileTobeuploaded);
         
      
      

   

ナレッジベース

      
         
            MyApplication.deskInstance.startKBCategory(activity, permalink);
         
      
      

   

• 「 activity 」は、活動のインスタンスです。
  
• パーマリンクが対象のナレッジベースのカテゴリーのURLを指すようになります。
  

      
         
            MyApplication.deskInstance.startKBArticle(activity, permalink);
         
      
      

   

1. 「 activity 」は、活動のインスタンスです。
   
2. パーマリンクが対象のヘルプ記事のURLを指すようになります。
   

コミュニティ

      
         
            ZDeskCommunityConfiguration communityConfiguration = new ZDeskCommunityConfiguration(); 
            communityConfiguration.setTopicEditAllowed(false); 
            communityConfiguration.setTopicDeleteAllowed(false); 
            communityConfiguration.setReplyEditAllowed(false); 
            MyApplication.deskInstance.setCommunityConfiguration(communityConfiguration);
         
      
      

   

      
         
            MyApplication.zohoDeskPortalSDKInstnace.getMostPopularTopics(new DeskCallback.DeskCommunityTopicsListCallback() {
            @Override
            public void onTopicsListCompleted(DeskTopicsList response) {
            Log.i("APITEST", "success");
            }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "exception");
            }
            }, categoryId, type, from, limit, includeCount);
         
      
      

   

1. 「 DeskCallback.DeskCommunityTopicsListCallback 」は、コールバックオブジェクトです。
   
2. categoryId - long - トピックを取得するコミュニティのカテゴリーのIDです。すべてのカテゴリーを追加する場合、値に「-1」を指定します。 
   
3. type - string - フォーラムのトピックの種類です。指定可能な値は次のとおりです： QUESTION 、 IDEA 、 ANNOUNCEMENT 、 PROBLEM 、 DISCUSSION
   
4. from - int -  インデックス番号です。この番号からトピックのデータを取得します。値は「1」から開始できます。
   
5. limit - int - 取得するトピックの件数です。
   
6. includeCount - Boolean - 取得したトピックの件数を表示するかどうかを指定するパラメーターです。
   

      
         
            MyApplication.zohoDeskPortalSDKInstnace.getMostDiscussedTopics(new DeskCallback.DeskCommunityTopicsListCallback() {
            @Override
            public void onTopicsListCompleted(DeskTopicsList response) {
            Log.i("APITEST", "success");
            }
            @Override
            public void onException(DeskException exception) {
            Log.i("APITEST", "exception");
            }
            }, categoryId, type, from, limit, includeCount);
         
      
      

   

1. 「 DeskCallback.DeskCommunityTopicsListCallback 」は、コールバックオブジェクトです。
   
2. categoryId - long - トピックを取得するコミュニティのカテゴリーのIDです。すべてのカテゴリーを追加する場合、値に「-1」を指定します。 
   
3. type - string - フォーラムのトピックの種類です。指定可能な値は次のとおりです： QUESTION 、 IDEA 、 ANNOUNCEMENT 、 PROBLEM 、 DISCUSSION
   
4. from - int -  インデックス番号です。この番号からトピックのデータを取得します。値は「1」から開始できます。
   
5. limit - int - 取得するトピックの件数です。
   
6. includeCount - Boolean - 取得したトピックの件数を表示するかどうかを指定するパラメーターです。
   

問い合わせ

1. fieldApiName - string - 問い合わせ項目の「apiName」です。それぞれの項目の「apiName」を取得するには、「 getTicketFields() 」メソッドを使用します。
   
2. fieldValue - object
   
   • 複数選択項目の場合、選択可能な文字列の値を指定します。
     
   • 選択リスト項目の場合、選択可能な文字列の値のいずれかを指定します。
     
   • 日付項目の場合、文字列の値を「 dd-MM-yyyy 」形式で指定します。
     
   • 日時項目の場合、文字列の値を「 dd-MM-yyyy HH:mm a 」形式で指定します。
     
   • 真偽値の項目の場合、真偽値を指定します。
     
   • 他の項目の場合、文字列の値を指定します。
     
   • こちらで指定した値が、項目で設定されている文字数や小数点の上限内になるようにしてください。
     
3. isEditable - Boolean - 対象の項目が編集可能かどうかを指定するキーです。
   

メモ： コードの詳細については、 こちら をご参照ください。

      
         
            ZDeskTicketConfiguration ticketConfiguration = new ZDeskTicketConfiguration(); 
            ticketConfiguration.setReplyAllowed(false); 
            ticketConfiguration.setTicketUpdateAllowed(false); //Ticket update will affect for Ticket close and Priority update 
            ticketConfiguration.setCommentAllowed(true); 
            ticketConfiguration.setCommentEditAllowed(false); 
            ticketConfiguration.setCommentDeleteAllowed(false); 
            MyApplication.deskInstance.setTicketConfiguration(ticketConfiguration);
         
      
      

   

その他

      
         
            HashMap<String, String> profileData = new HashMap<>(); 
            profileData.put("displayName", "displayName"); 
            profileData.put("mobile", "123456"); 
            MyApplicaiton.zohoDeskPortalSDKInstnace.updateProfile(profileData, new DeskCallback.DeskUpdateProfileCallback() {
            @Override
            public void onProfileUpdated(JSONObject jsonObject) {
            Log.i("UpdateProfile", "Success"); 
            }
            @Override
            public void onException(final DeskCallback.DeskException exception) {
            Log.i("UpdateProfile", "Exception"); 
            } 
            }); 
         
      
      

   

1. HashMap <String, String> - キーと値のペアです。キーには次の値が含まれます： twitter 、 phone 、 facebook 、 name 、 displayName 、 mobile 、 countryLocale 、 timeZone  
   
2. DeskCallback.DeskUpdateProfileCallback - コールバックオブジェクトです
   

SDKのログ

      
         
            ZohoDeskPortalSDK.Logger.enableLogs();
         
      
      

   

メモ： SDKに関するデバッグの情報は、「logcat」に保存されます。そのため、リリースビルド内に「 enableLogs() 」が存在しないようにしてください。

リリースノート

• ユーザーの詳細データを更新するAPIを追加しました。詳細については こちらをクリック してください。
  
• 問い合わせの送信画面でのユーザの操作を有効または無効にする条件を追加しました。詳細については、 こちらをクリック してください
  

• ログアウトに失敗する問題を解決しました。
  

• 初回にアプリ/アドオンを通じて電話のストレージにアクセスする際に、権限の画面を表示する機能を追加しました。
  

• 識別に関する問題を解決しました。
  

• 問い合わせの送信画面の項目でカスタマイズ設定を行えるメソッドを追加しました。詳細については、 こちらをクリック してください。
  
• コミュニティタブのサブフォーラムに「すべて」のオプションを追加しました。
  
• ナレッジベースのカテゴリーに対してディープリンクを利用できるようになりました。詳細については、 こちらをクリック してください。
  
• コミュニティタブでのユーザの操作を有効または無効にする条件を追加しました。詳細については、 こちらをクリック してください。
  

• コミュニティタブにディスカッションのトピックの種類を追加しました。
  
• コミュニティタブの検索機能に関連する問題を解決しました。（バージョン1.0からSDKを使用し始めた場合、この問題に対して操作を行う必要はありません。1.0以前のバージョンからSDKを使用していて、Zoho DeskのポータルでJWT認証を有効にしている場合は、1.0にアップグレードした後にユーザートークンを再生成する必要があります。アプリケーションのデモについては こちら をご確認ください。エンドユーザーに対する影響はありません。）
  

• 問い合わせのコメントにてリッチテキスト（書式付きテキスト）でテキストの書式を設定できるようにしました。
  
• ユーザーコミュニティのフォーラムのトピックにスレッド形式でコメントを追加できるようにしました。
  
• フォーラムのトピックでのコメントに対して、操作を行えるようにしました。
  
• ユーザーコミュニティに検索機能を追加しました。
  
• イベントのコールバック機能を追加しました。詳細については、 こちらをクリック してください。
  
• コミュニティのカテゴリー、最も人気のあるトピック、最も議論されたトピックに関連するAPIを追加しました。詳細については、 こちらをクリック してください。
  
• トピックIDが入力された際にトピックの詳細画面が表示されるようにするメソッドを追加しました。
  

• コミュニティタブのカテゴリーに「 フォロー 」オプションを追加しました。このオプションは、認証済みユーザーに対してのみ表示されます。
  

• アプリに「 androidx 」の依存関係が含まれる場合にアプリが突然終了する問題を解決しました。
  

• インドのデータセンターのサポートを開始しました。インドのデータセンターにてASAPアドオンをホスティングするには、 SDKの初期設定 時にデータセンターのキーに「 DataCenter.IN 」と指定してください。
  
• 設定を上書きしたアドオンのダッシュボードを表示できる新しいメソッドを追加しました。詳細については、 こちらをクリック してください
  
• 商品に関するAPIに「from」、「limit」のパラメーターを追加しました。パラメーター「from」はリソースのインデックス番号を表します。パラメーター「limit」は返すデータの件数を表します。この2種類のパラメーターがAPIリクエストで指定されない場合、初期設定で最初の10件の商品が返されます。
  

• 以下の操作が行われた際にプッシュ通知を送信できるようにしました：
  
  • 担当者がユーザーの代わりに問い合わせを作成。
    
  • 担当者が新たに問い合わせに返信。
    
  • 問い合わせの優先度の変更。
    
  • 問い合わせのステータスの変更。
    
  • 問い合わせに新たにコメントを追加。
    
  • 問い合わせのコメントを編集。
    
• 問い合わせの送信画面にコールバックメソッドを追加しました。このメソッドを使用すると、問い合わせの送信後に、問い合わせの詳細データが即座にアプリに送信されるように、ASAPアドオンを設定することができます。
  

• 2MBを超えるサイズのナレッジベースの記事を読み込む際にアプリが突然終了する問題を解決しました。
  

• Zoho DeskのポータルのSDKが含まれるアプリの内部ディレクトリに保存されているファイルに他のアプリからアクセスできる、という設定に関する問題を修正しました。
  

バージョン1.xから2.0への移行

SDKとAndroidアプリとの連携

ビルドの設定の詳細

初期化コード

ヘルプ項目の表示

SDKでのユーザー認証

ユーザーをSDKからログアウト

アドオンの操作画面のカスタマイズ

言語設定の変更

通知の有効化

プログラミングによる問い合わせの追加

ナレッジベース

コミュニティ

問い合わせ

その他