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

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

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

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

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

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

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

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

      4.      [モバイルSDK]をクリックします。


表示された画面で以下の情報を確認できます。

  • 組織ID:組織ごとに個別のIDです。

  • ウィジェットID:自動ガイドボットのウィジェットごとに個別のIDです。

  • ドメイン:組織ごとに個別のURLです。 

これらの情報は、自動ガイドボットの表示処理の設定に必要です。  

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

Zoho Deskで自動ガイドボットのアドオンの設定を行ったら、iOSアプリとZohoの自動ガイドボットのSDK(開発キット)を連携する必要があります。
連携方法には以下の2種類があります。

(i)CocoaPodsを利用した連携:iOSアプリのライブラリー管理ツールであるCocoaPodsを利用します。CocoaPodsを利用すると、外部サービスの機能を自分のプロジェクトに追加することができます。
 
(ii)手動連携: CocoaPodsを利用せずに、手動で連携を行います。

CocoaPodsを利用した自動連携

自動ガイドボットとアプリを連携するには、まずCocoaPodsでプロジェクトのPodfileを作成する必要があります。Podfileをまだ作成していない場合は、以下の手順を実行します。
      1.      ターミナルで、プロジェクトの最上位のフォルダーに移動します(「xcodeproj」ファイルが含まれるフォルダーです)。
      2.      コマンド「$ pod init」を実行します。
      3.      次に、コマンド「open -a Xcode Podfile」を実行して、XcodeのPodfileを開きます。

                  ファイルの内容が以下のように表示されます。

# Uncomment this line to define a global platform for your project
# platform :ios, '11.0'
# Uncomment this line if you're using Swift
# use_frameworks!
target 'My Sample App' do
end 

      4.      ライブラリーの作成にSwiftを利用している場合は、「use frameworks!」  の行頭にあるハッシュ記号(#)を削除してください。

次に、自動ガイドボットのSDKをPodfileに追加し、プロジェクトにSDKをインストールします。
手順は以下のとおりです。

 

      1.      はじめに、該当のSDKを対象のPodfileに追加します。自動ガイドボットのSDKを連携するには、以下のコードをPodfileのdoブロックに追加します。  


target 'My Sample App' do pod 'ZohoGCSDK' end  

      2.      Podfileを保存します。

      3.      ターミナルでコマンド「$ pod install」を実行します。

CocoaPodsのインストール前は、「xcodeproj」としてファイルが開きます。インストール後は、「xcodeproj」ファイルを閉じて、「xcworkspace」ファイルを開きます。

 

手動連携

自動ガイドボットのSDKとアプリは手動で連携することもできます。手順は以下のとおりです。

 

      1.     はじめに、自動ガイドボットのSDKダウンロードします。

      2.      ダウンロードしたzipファイルを解凍します。 

      3.      拡張子が「.XCFramework」であるフレームワークファイルを、 Xcodeのプロジェクト「Frameworks, Libraries, and Embedded」のセクションにドラッグ&ドロップします。

InfoInfoなお、自動ガイドボットのSDKは、iOS 11以降のバージョンに対応しています。
Notes
メモ:自動ガイドボットのSDKを連携する場合は、アプリの「info.plist」ファイルに「NSPhotoLibraryUsageDescription」「NSCameraUsageDescription」「NSMicrophoneUsageDescription」の各キーを追加してください。
Warning
注意:「info.plist」ファイルにこれらのキーが追加されていない場合、アプリを起動してもアプリが正常に動作しません。また、関連するビューコントローラーが存在する場合、App Storeによる認証に失敗する可能性があります。

自動ガイドボットの表示  

アプリ内で自動ガイドボットを表示するには、メソッド内で以下の情報を指定する必要があります。

  • 組織ID(orgId)

  • ウィジェットID(widgetId)

  • ドメイン(domain)

これらのキーの値は、Zoho Deskの自動ガイドボットのアドオンの設定ページから確認できます(詳細は、上記の「自動ガイドボットのSDK(開発キット)の設定」のセクションをご参照ください)。

 

自動ガイドボットに関するメソッドの呼び出しには、以下のimport文を使用します。

自動ガイドボットの表示:

 

Swift

import ZohoGCSDK

Objective-C

  @import ZohoGCSDK;

自動ガイドボットの画面を表示するには、以下のメソッドを使用します。


Swift

ZohoGC.show(orgId: <#T##String#>, widgetId: <#T##String#>, domain: <#T##String#>) 

Objective-C

[ZohoGC showWithOrgId:<#(NSString * _Nonnull)#> widgetId:<#(NSString * _Nonnull)#> domain:<#(NSString * _Nonnull)#>]

会話変数:   

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

関連情報:会話変数

 

会話変数の設定方法と更新方法は以下のとおりです。

会話変数の設定:   

ZohoGC.setSessionVariables(sessionVariables: <#T##[String : String]#>)

会話変数の更新:

ZohoGC.updateSessionVariables(sessionVariables: <#T##[String : String]#>)

テーマのカスタマイズ  

標準テーマ:操作画面の標準テーマとしては、ホワイトとダークの2種類が用意されています。
これらのテーマを適用するには、以下のメソッドを使用します。

 

 

 

ZDTHEMETYPE.WHITE                     

     


  ZDTHEMETYPE.DARK
        

   


テーマを更新したい場合は、以下のimport文を使用して「ZDThemeKit」をインポートする必要があります。

 

Swift

import ZDThemeKit

Objective-C

@import ZDThemeKit;

「ZDThemeKit」には、テーマに関連するすべてのAPIが含まれています。そのため、「ZDThemeManager」のメソッドを呼び出す前に、「ZDThemeKit」をインポートする必要があります。


ホワイトテーマ(初期設定)を適用するメソッド

Swift

ZDThemeManager.setTheme(type: .white)

Objective-C

[ZDThemeManager setTheme:ZDThemeTypeWhite];

ダークテーマを適用するメソッド

Swift

ZDThemeManager.setTheme(type: .dark)

Objective-C

[ZDThemeManager setTheme:ZDThemeTypeDark];
iOSのバージョン13以降では、自動ガイドボットのテーマをデバイスのテーマと連動させることが可能です。この場合、自動ガイドボットには、OSと同じテーマが設定されます。

Swift

ZDThemeManager.setTheme(type: .system)

Objective-C

[ZDThemeManager setTheme:ZDThemeTypeSystem];

Notes
メモ:
- 「ZDThemeType.system」は、iOS 13以降でのみ利用できます。
- 初期設定のテーマには、iOS 13以降の場合、OSのテーマが、iOS 13以前の場合、ホワイトテーマが適用されます。

テーマのカスタマイズ:自動ガイドボットの標準のテーマの種類には、ホワイトテーマとダークテーマがあります。テーマは、必要に応じて変更できます。また、テーマの強調色(アクセントカラー)や基調色をカスタマイズすることも可能です。

 

標準のホワイトテーマを更新するには、以下のメソッドを使用します。

Swift

ZDThemeManager.updateTheme(theme:<#ZDThemeProtocol#>)

Objective-C

[ZDThemeManager updateThemeWithTheme:<#ZDThemeProtocol#>];

 

標準のダークテーマを更新するには、以下のメソッドを使用します。

Swift

ZDThemeManager.updateDarkTheme(theme: <#ZDThemeProtocol#>)

Objective-C

[ZDThemeManager updateDarkThemeWithTheme:<#ZDThemeProtocol#>];

 

「ZDThemeProtocol」には、自動ガイドボットで使用したい色の属性のリストを指定できます。,(例:「primaryTextColor」「navigationBarTextColor」)。なお、プロトコル内のプロパティはすべて任意です。独自のクラスを作成した上で、対象のクラスの属性を実装し、「updateLightTheme」メソッドや「updateDarkTheme」メソッドの「ZDThemeProtocol」内に複数指定できます。これにより、標準テーマの色を、クラスで設定した色に変更できます。

 

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

ローカルデータのクリア  

データベースやファイルなど、SDK(開発キット)内に保存されたすべてのデータ(ローカルデータ)を削除するには、以下のメソッドを使用します。

 

Swift

 ZohoGC.clearData()

Objective-C

 [ZohoGC clearData];

ログの有効化  

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


Swift

 import ZohoGCSDK ... ZohoGC.enableLog(isLogEnabled: <#T##Bool#>)

Objective-C
@import ZohoGCSDK; ... [ZohoGC enableLogWithIsLogEnabled:<#(BOOL)#>];



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

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

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

    Zoho CRM Training



              Zoho WorkDrive Resources



                Zoho Desk Resources

                • Desk Community Learning Series


                • Digest


                • Functions


                • Meetups


                • Kbase


                • Resources


                • Glossary


                • Desk Marketplace


                • MVP Corner


                • Word of the Day









                                  • Related Articles

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

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

                                    Flutterアプリ向けのどこでもサポートSDK(ソフトウェア開発キット)を利用すると、Flutterで開発したアプリ内にZoho Deskのサポート機能を埋め込むことができます。アプリの利用者に対して、さまざまなサポート機能を提供することが可能です。利用者に対して提供できる主なサポート機能は、以下のとおりです。 • ナレッジベース:ヘルプ記事やよくある質問とその回答を公開できます。利用者は、自身で質問の回答を検索することが可能です。 • ...
                                  • Android向けどこでもサポートSDKの操作

                                    Android向けのどこでもサポートSDK(ソフトウェア開発キット)を利用すると、Androidアプリ内にZoho Deskのサポート機能を埋め込むことができます。アプリの利用者に対して、さまざまなサポート機能を提供することが可能です。利用者に対して提供できる主なサポート機能は、以下のとおりです。 • カスタマーサポート(問い合わせの送信、担当者とのチャット) • ナレッジベース(ヘルプ記事へのアクセス) • コミュニティ(ポータルでの他の顧客やサポート担当者との交流) ...
                                  • iOS向けどこでもサポートSDKの操作

                                    iOS向けのどこでもサポートSDK(ソフトウェア開発キット)を利用すると、iOSアプリ内にZoho Deskのサポート機能を埋め込むことができます。アプリの利用者に対して、さまざまなサポート機能を提供することが可能です。利用者に対して提供できる主なサポート機能は、以下のとおりです。 • カスタマーサポート(問い合わせの送信、担当者とのチャット) • ナレッジベース(ヘルプ記事へのアクセス) • コミュニティ(ポータルでの他の顧客やサポート担当者との交流) ...
                                  • React Native向けどこでもサポートSDKの操作

                                    React Nativeアプリ向けのどこでもサポートSDK(ソフトウェア開発キット)を利用すると、React Nativeで開発したアプリ内にZoho Deskのサポート機能を埋め込むことができます。アプリの利用者に対して、さまざまなサポート機能を提供することが可能です。利用者に対して提供できる主なサポート機能は、以下のとおりです。 • カスタマーサポート(問い合わせの送信、担当者とのチャット) • ナレッジベース(ヘルプ記事へのアクセス) • ...

                                  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.