シグナル

Zoho Booksのシグナルの機能は、設定したサードパーティーーアプリで処理が実行されるたびに、組織内のユーザーに対してアプリ内通知を送信します。シグナルは、ビジネスに影響を及ぼす可能性のある活動について情報を提供し、情報を元にした意思決定をサポートします。これをより理解するために、シナリオを見てみましょう。

シナリオ: Door to Door社は、主にオンラインで運営されているeコマース企業です。同社は、ビジネス運営においてZoho Booksを用い、製品の配送にはPremier Courierを利用しています。Zoho Booksの「シグナル」機能の使用により、Door to Door社は、パッケージのステータスに関する適時の通知を受け取ることができます。この情報により、同社は、出荷ステータスについて顧客に情報提供することが可能となります。また、何らかの理由で配送ができなかった場合も通知を受け、すぐに顧客へ連絡をし、配送が届かなかった原因を突き止めたうえで、再度配送を手配します。これにより、ポジティーブな顧客体験を提供することにつながります。

同様に、シグナル機能を活用して、Zoho Books組織をサードパーティーーアプリと連携させ、ビジネスニーズに合わせた通知を受け取ることができます。

メモ: この機能はZoho Booksの特定のプランでのみ利用可能です。現在のプランで利用可能かどうかを確認するには、価格ページをご確認ください。

新しいシグナルの作成

Zoho Booksで新しいシグナルを設定するには、以下の手順に従ってください。

ページの右上隅にある［設定］に移動してください。
［開発者向け情報］内で、［シグナル］を選択してください。
ページの右上にある［+ 新しいシグナル］をクリックしてください。

［シグナル名］項目にシグナルの名前を入力してください。
［サービス］のドロップダウンから、通知を受け取るサードパーティーーアプリを追加または選択してください
- ドロップダウンから［新しいサービスを追加］をクリックしてください。

［新しいサービス］ページで、サードパーティーーアプリの名前を［サービス名］項目に入力し、［追加］をクリックしてください。サードパーティーーアプリが［サービス］項目に表示されます。

［サービス］のドロップダウンをクリックし、シグナルを作成するサードパーティーーアプリを選択してください。

シグナルの識別に役立つ画像をアップロードするオプションがあります。
［シグナルアイコン］の隣にある［画像をアップロード］をクリックしてください。
表示されるページでアイコンを選択し、［開く］をクリックしてください。
［トリガーの種類］のドロップダウンから、シグナルをどのようにトリガーするかを選択できます。関数またはAPIを使用してシグナルをトリガーします。
- シグナルのメッセージがサードパーティーーアプリ内で生成できる場合、APIを使用してシグナルをトリガーできます。
- メッセージと処理を動的に構築する必要がある場合、つまり、Zoho Booksからデータが必要な場合、関数を使用してシグナルをトリガーできます。
［受信者］項目では、組織内のユーザーがこのシグナルの通知をどのように受け取るかを設定できます。
- すべてのユーザー：このオプションを選択すると、組織内のすべてのユーザーにこのシグナルの通知が送信されます。ユーザーはこのシグナルの通知を無効にすることはできません。
- デフォルトで無効：このオプションを選択すると、シグナルを作成したユーザーのみがその通知を受け取ります。組織内の他のユーザーに対しては通知が無効になります。必要な場合、他のユーザーはシグナルの一覧ページからこのシグナルの通知を有効にすることができます。
- デフォルトで有効：このオプションを選択すると、組織内のすべてのユーザーにこのシグナルの通知が送信されます。ユーザーはシグナルの一覧ページからこのシグナルの通知を無効にすることができます。
［保存］をクリックしてください。

メモ : トリガーの種類を関数と選択し、関数内でコネクションを使用している場合、「ZohoBooks.Signals.CREATE」および「ZohoBooks.Signals.READ」のスコープも選択する必要があります。これらのスコープは「ZohoBooks.fullaccess.All」スコープに含まれていないためです。

ヒント: 関数またはAPIのメッセージ項目のコンテンツをフォーマットするオプションがあります。以下のフォーマットオプションがサポートされています。

太字：コンテンツをアスタリスク（*）で囲みます。例：このコンテンツは太字です。
斜体：コンテンツをキャレット（^）で囲みます。例：このコンテンツは斜体です。
改行：改行を挿入するには、「~br~」を使用します。

シグナルのトリガーの種類を［関数］に選択した場合、OAuthのURLおよびZAPIキーの URLは生成され、ポップアップで表示されます。このポップアップからURLをコピーできます。

シグナルのトリガーの種類を［API］に選択した場合、名前空間が生成され、ポップアップで表示されます。このポップアップから名前空間をコピーできます。

関数とAPIの両方のトリガーの種類に対して、OAuthのURLおよびZAPIキーのURLはシグナルの編集ページでもアクセス可能です。そこからもコピーできます。

また、シグナルの一覧ページでシグナルの横にある3点リーダーアイコンをクリックして、これらのURLを取得することもできます。

ヒント: サードパーティーアプリがOAuth認証をサポートしている場合はOAuthを使用することが必要です。サードパーティーアプリがOAuth認証をサポートしていない場合や、シグナルの設定を簡単に行いたい場合はZAPIキーを使用します。

これで、サードパーティーアプリ内でURLを設定してシグナルを確立する準備ができました。スクリプトに追加の属性を含めたい場合は、APIコール時にそれを行うことができます。

属性	説明
ヘッダー	APIリクエストのヘッダーです。
パラメーター	APIのクエリパラメータです。
ボディ	API呼び出しのリクエストボディを含む文字列です

アドバイス: URLへのアクセスを信頼性の高い特定の承認済みユーザーに制限することをお勧めします。URLが誰にでもアクセス可能になった場合、それを使用してシグナルの通知をトリガーすることができます。

シグナルを正常に作成したので、サードパーティーアプリが設定したタスクを実行した際に、Zoho Books組織内でアプリ内通知を受け取ることができます。

シグナル通知の管理

設定へのアクセス権を持つユーザーは、シグナルの一覧ページからシグナルの通知設定を直接管理できます。以下はその方法です。

ページの右上隅にある［設定］に移動してください。
［開発者向け情報］の下で、［シグナル］を選択してください。
シグナルの一覧ページで、通知設定を変更したい特定のシグナルにカーソルを合わせます。
- そのシグナルからの通知を受け取りたくない場合、［有効］の横にあるトグルをオフの位置にスライドししてください。
- そのシグナルからの通知を受け取りたい場合、［無効］の横にあるトグルをオンの位置にスライドしてください。

設定へのアクセス権がないユーザーでも、通知セクションからシグナルの通知設定を以下の方法で管理できます。

ページの右上隅にある［通知］ボタンをクリックしてください。

通知セクション右上隅にある歯車アイコンをクリックしてください。

［シグナル通知の設定］ページで、通知設定を変更したい特定のシグナルにカーソルを合わせます。
そのシグナルからの通知を受け取りたくない場合、［有効］の横にあるトグルをオフの位置にスライドしてください。
そのシグナルからの通知を受け取りたい場合、［無効］の横にあるトグルをオンの位置にスライドしてください。

メモ : シグナルを作成したユーザーが［すべてのユーザー］を受信者として選択した場合、組織内のすべてのユーザーはそのシグナルからの通知を自動的に受け取り、個別に無効にすることはできません。

シグナルの編集

シグナルを変更する必要がある場合、そのシグナルの［編集］ページで以下の方法を通じて編集できます。

ページの右上隅にある［設定］に移動してください。
［開発者向け情報］の下で、［シグナル］を選択してください。
対象のシグナルの横にある［編集］ボタンをクリックしてください

［シグナルの編集］ページで必要な変更を行い、その後［保存］をクリックしてください。

シグナルの削除

シグナルが不要になった場合、それを削除することができます。

注意: シグナルを削除すると、復元することはできず、そのシグナルからの通知も停止します。

シグナルを削除するには：

ページの右上隅にある［設定］に移動してください。
［開発者向け情報］の下で、［シグナル］を選択してください。
対象のシグナルの横にある3点リーダーアイコンをクリックしてください
ドロップダウンから［削除］を選択してください。
表示されるポップアップで、［削除］をクリックしてください。

Zoho Booksでシグナルを削除した後も、サードパーティーアプリに作成された対応する設定は残ります。サードパーティーアプリ内の設定も削除する必要があります。

シグナルの無効化

不要になったシグナルを削除せずに無効にしたい場合、以下の方法で行うことができます。

ページの右上隅にある［設定］に移動してください。
［開発者向け情報］の下で、［シグナル］を選択してください。
対象のシグナルの横にある3点リーダーアイコンをクリックしてください。

ドロップダウンから［無効にする］を選択してください。

ZAPIキーのURLの再生成

ZAPIキーはクエリパラメーターの一部として呼び出しURLに含まれます。URLの一部として含まれているため、追加の設定は不要です。ただし、ZAPIキーのURLが公開されてしまうと、どのユーザーでもそれを使用してシグナルの通知をトリガーできる可能性があります。このような場合、ZAPIキーを再生成することをお勧めします。以下の方法で行います。

ページの右上隅にある［設定］
［開発者向け情報］の下で、［シグナル］を選択してください。
対象のシグナルの横にある［編集］ボタンをクリックしてください。
［シグナルの編集］ページで、［ZAPIキーのURL］項目の下にある［再生成］を選択してください。

ZAPIキーが再生成されます。以前に使用したすべての場所で古いZAPIキーを新しいものに置き換えることを忘れないようにしてください。