Developer Space - 拡張機能の開発

［Developer Space］の［拡張機能の開発］セクションでは、独自のeWidget拡張を作成できます。作成した拡張機能は、マーケットプレイスからインストールして、他のユーザーが使用できます。 

目次

Zohoマーケットプレイス

Zohoマーケットプレイスは、複数アプリにわたってワークフローを強化できる拡張機能をユーザーに提供する、オンラインプラットフォームです。ユーザーは、Zohoマーケットプレイスから拡張機能をインストールして、Zohoアプリケーションの既存機能を拡張できます。 

すでに使用可能な拡張機能に加えて、Zoho Mail向けにより包括的な拡張機能を開発者が作成できるようになりました。これらの拡張機能は、Zoho Mailの機能を外部アプリの機能と連携するように構築できます。そのため、ユーザーはカスタム要件に合わせて拡張機能を構築できます。 

拡張機能を構築したら、送信してレビューを受ける必要があります。その拡張機能が機能分析を経て承認されると、Zohoマーケットプレイスに公開され、すべてのZohoユーザーがインストールして使用できるようになります。

拡張機能の開発

事前入力済みZoho Mailプラグインマニフェストを使用して、Zoho Sigmaプラットフォームから直接拡張機能の作成を開始できます。または、ZET CLIを使用して拡張機能を作成し、そのファイルをZoho Sigmaにアップロードして提出することもできます。 

Zoho Sigmaでの拡張機能の作成 

作成を開始するには、次の手順に従ってZoho Sigmaで自分用のワークスペースを作成します。

  1. Zoho Sigmaにサインインします。
  2. ワークスペース名を入力します。
  3. ［ワークスペースの作成］をクリックします。

ワークスペースを作成したら、右上隅にある［新規拡張機能］ボタンをクリックします。名前、説明などの詳細を入力し、［サービス］セクションから［Zoho Mail］を選択します。次に、［下書きとして保存］をクリックし、このヘルプページに記載されている詳細な手順に従って、Zoho Sigmaで拡張機能の作成を開始します。 

ZET CLIを使用した拡張機能の作成

コマンドラインインターフェイス（CLI）を使用して、ウィジェットの作成とパッケージ化を行います。ZETコマンドは、Zoho Mailのウィジェットをパッケージ化するために使用するCLIです。

前提条件

Zoho Mail向けの独自のウィジェットを作成するには、nodejsをダウンロードする必要があります。こちらからダウンロードできます。（バージョン7より前のバージョンはサポートされていません）

次のコマンドを実行して、ノードを確認できます。

$ node -vは、ノードのバージョンを確認します。
$ npm -vは、npmのバージョンを確認します。

インストール

次のコマンドを実行して、ZET（Zoho Extension Kit）CLIをインストールします。

$ npm install -g zoho-extension-toolkit@latest 

次のZETコマンドを実行して、インストールを確認します。さまざまなサポートコマンドに関するヘルプ詳細が表示されます。

$ zet

プロジェクトの作成

次のコマンドを実行して、プロジェクトを作成します。

$ zet init

Zoho Servicesのリストが表示されます。［Zoho Mail］を選択し、Enterキーを押します。

プロジェクト名の入力を求められます。目的のプロジェクト名を入力し、Enterキーを押します。

リソースの配置

プロジェクト名を入力すると、システムに同じ名前のディレクトリーが作成されます。プロジェクトディレクトリーには、必要なフォルダー、ファイル、パッケージがすべて含まれています。

プロジェクトディレクトリーに移動し、「App」フォルダーを開きます。ウィジェットのリソースを関連するサブフォルダーに含めます。

サーバーの実行

次のコマンドを実行して、拡張機能をローカルで実行するHTTPサーバーを起動します。

$ zet run

このコマンドは、ローカルマシンの5000ポートを使用します。サーバーを起動する前に、5000ポートが使用されていないことを確認してください。

サーバーが正常に実行されていることを確認するには、指定された以下のURLをブラウザーで開きます。

http://127.0.0.1:5000/

検証とパッケージ化

次のコマンドを実行して、拡張を検証します。

$ zet validate

拡張機能は、次に記載する仕様に従う必要があります。validateコマンドを実行すると、仕様違反があった場合に特定されます。このような違反は、zipファイルをアップロードする前に修正する必要があります。

次のpackコマンドを実行して、拡張機能の実行に必要なすべてのファイルとフォルダーを含むzipファイルを作成します。

$ zet pack

このzipファイルは、プロジェクトディレクトリーの「dist」フォルダーに保存されます。このzipファイルをマーケットプレイスにアップロードできます。

仕様

拡張機能のプロジェクトディレクトリーには、plugin-manifest.jsonファイルが含まれています。このファイルには、拡張機能の設定詳細が含まれています。このファイルに含まれるキーは、次の設定に従う必要があります。

  • locale：これは拡張機能の既定ロケールです。プロジェクトディレクトリーの翻訳フォルダーには、すべての翻訳ファイルが含まれている必要があります。ファイルの形式は「<locale-code>.json」にする必要があります。 
  • *service：拡張機能作成の対象となるZoho製品。 
    • Zoho Mailの拡張機能を作成する場合、サービスキーはマニフェストに"service": "MAIL"として自動入力されます。
  • storage：拡張機能にアプリケーションデータを保存する場合は、このキーの値を「true」に設定する必要があります。
  • logo：拡張機能のロゴとして使用する画像のファイルパス。例：「apps/images/logo.png」
  • *modules：ウィジェットはZoho Mail拡張機能に使用されるタブです。これは、拡張機能の詳細の配列です。ウィジェットタブには、次のプロパティーセットが必要です。
    • location：Zoho製品でのウィジェットの場所。Zoho Mailの場合は、「Zoho.mail.preview.rightpanel」でなければなりません。
    • name：ウィジェットのプロジェクトディレクトリーの名前。これは自動入力されます。

    • url：ウィジェットに定義されたパス。

      マニフェストのサンプル：

      "modules": {
            "widgets": [
      ​                         {
                                      "location": "zoho.mail.preview.rightpanel",
                                      "name": "extension_name",
                                      "url": "/app/widget.html"
                               }
                          ]
      ​                 }

  • connectors：コネクターを使用すると、拡張機能を外部アプリと連携できます。コネクターの詳細については、こちらをクリックしてください。
    コネクターキーは、次の構造を持つ必要があります。

    "connectors": [
                             {
    ​                              "serviceName": "name_of_the_service"
                             }                   
                         ]

  • config：このキーには、拡張機能のインストール時に設定する必要があるパラメーターが含まれています。設定キーの構造は次のようになります。

    "config": [
                             {
                                    "name": "Param name",
                                    "mandatory": "true/false",
                                    "secure": "true/false",
                                    "inputType": "text /dropdown/ checkbox"
                                    "option": [{
                                                      "text": "option1"
                                                      "value": "1"
                                                  }]
                             }
                   ]

    ​

    パラメーター値
    name*パラメーター名を表す項目。
    mandatory*true - パラメーターを必須にする必要がある場合
    false - パラメーターを必須にする必要がない場合
    secure*true - 入力した値を非表示にする必要がある場合
    false - 入力した値を非表示にする必要がない場合
    inputType*テキスト/ドロップダウン/チェックボックス
    optionこれは、選択したinputTypeがドロップダウンの場合にのみ必要です。ドロップダウンのさまざまなオプションと、それに対応する値を示すために使用されます。


    ​*必須

拡張機能のテスト

いくつかの簡単な手順を実行して、拡張機能をローカルでテストできます。

  1. 端末を開き、プロジェクトディレクトリーに移動します。
  2. 拡張機能を実行するには、zet runコマンドを実行します。
  3. Zoho Mailアカウントにサインインし、URL https://mail.zoho.com/zm/sandbox.doにアクセスします。 
  4. ［設定］>［連携］>［Developer Space］の順に移動します。 
  5. ［連携］アイコンをクリックして、eWidgetペインを開きます。
  6. ［開発者モード］をオンに切り替えます。 

ローカルで実行されている拡張機能は、さらなるテストのために、ここにリストされます。

拡張機能の送信

拡張機能をパッケージ化したら、レビューを受けるためにzipファイルをZohoマーケットプレイスに送信する必要があります。

zipファイルのアップロード

  1. Zohoアカウントにサインインします。
  2. Sigmaのウェブサイトに移動します。
  3. ページの右上隅にある［新規拡張機能］ボタンをクリックします。
  4. 次の詳細を入力します：
    • 名前 - 送信する拡張機能の名前
    • 説明 - 拡張機能の簡単な説明
    • サービス - リストから［Zoho Mail］アイコンを選択します。
  5. アップロードするプラグインマニフェストzipファイルがある場合は、［既存ファイルのアップロード］をオンに切り替えます。 
  6. ［利用規約に同意します］ボタンを選択し、［下書きとして保存］をクリックします。
  7. プラグインマニフェストエディターウィンドウが開きます。変更があれば保存し、ウィンドウを閉じます。すべての拡張機能がカードとして表示されます。
  8. 送信する拡張機能にカーソルを合わせ、［拡張の詳細］アイコンをクリックします。
  9. ページの右上隅にある［公開］ボタンをクリックします。
  10. ［アプリの可視性］ポップアップが開きます。拡張機能を［公開］にするか、［非公開］にするかを選択して、［アップロード］をクリックします。
    • 非公開 -小さなグループ内で拡張機能を使用する場合は、［非公開］オプションを選択できます。非公開拡張機能は、インストールリンクを共有するユーザーのみが使用できます。
    • 公開 - 顧客が拡張機能をインストールできるように、Zohoマーケットプレイスに公開する場合は、［公開］オプションを選択する必要があります。

非公開アップロードまたは公開アップロードのどちらを選択したかによって、最初の2つの手順で入力が必要なデータは異なります。以下のとおりです。

公開拡張機能

Zohoマーケットプレイスで公開拡張機能を公開するには、次の詳細情報を入力します。

  1. メイン：
    • 次の情報を入力します： 
      1. カテゴリー - 拡張機能の目的と性質に適したタグを選択します。 
      2. プライバシーポリシー - 拡張機能のプライバシー詳細のリンクを入力します。
      3. サービス利用規約 - 拡張機能のサービス利用規約文書のURLを入力します。
    • ［マーケットプレイスベンダー契約に同意します］チェックボックスをオンにします。
    • ［次へ］をクリックします。
       
  2. 前提条件：
    • ［サポートするエディション］ドロップダウンから、拡張機能をサポートする料金プランを選択します。
    • ［次へ］をクリックします。
  3. 画像：
    • 拡張機能の次のファイルをアップロードします。
      1. 拡張機能アイコン - 解像度180 x 180
      2. サムネイル - 解像度740 x 340
      3. スクリーンショット - 拡張機能に必要なスクリーンショットを追加します。
    • ［次へ］をクリックしてください。
  4. サマリー：
    • 次の詳細を入力します： 
      1. タグライン 
      2. 説明
      3. 主な機能
      4. ユーザートレーニングリンク
      5. ヘルプ動画リンク
    • ［次へ］をクリックしてください。 
  5. 料金：
    • 次の詳細を入力します：
      1. ［グローバルに使用可能］ - グローバルに拡張機能を使用できるようにする場合に選択します。
      2. 料金 - 拡張機能の料金を選択します。
    • ［送信］をクリックしてください。

これで、作成した拡張機能は、レビューを受けるためにZoho Mailチームに送信されました。アプリケーションの機能と使いやすさがテストされ、必要に応じて改善が提案されます。レビュープロセスが完了すると、そのアプリはZohoマーケットプレイスに公開され、ユーザーがインストールできるようになります。

拡張機能の共有 

作成した拡張機能は、Zoho Mailの連携設定から組織のメンバーと共有できます。

  1. Zoho Mailにサインインしてください。 
  2. ［設定］->［連携］の順に移動します。
  3. フィルターメニューから［自分の拡張機能］を選択して、自分が作成した拡張機能をすべて表示します。
  4. 組織と共有したい拡張機能の［組織に共有］オプションをクリックします。 
  5. ［送信］をクリックします。

この拡張機能は、承認を受けるために管理者に送信されます。組織の管理者から承認されると、この拡張機能を他の組織メンバーがインストールして使用できるようになります。詳細はこちら。

拡張機能の更新 

拡張機能のバージョンを更新して、機能の追加やバグの修正を行えます。  

  1. Sigmaアプリリストに移動し、更新する拡張機能の上にカーソルを合わせます。
  2. ［拡張機能の詳細］ボタンをクリックします。
  3. 右上隅の［拡張機能の編集］ボタンをクリックします。
  4. ［編集ビルダー］ウィンドウが開きます。必要な変更を行い、［保存］をクリックします。ウィンドウを閉じます。 
  5. ページの右上隅の［公開］ボタンをクリックして、更新した拡張機能をアップロードします。

レビュープロセスが完了すると、更新したバージョンのアプリがZohoマーケットプレイスで利用できるようになります。非公開拡張機能の場合、更新したアプリケーションのインストールリンクが取得されます。 

Developer Space SDK 

Developer Space APIは、作成したアプリケーションにさまざまなZoho Mail機能を組み込むコマンドです。全コマンドリストについては、このヘルプページを参照してください。 

拡張機能サンプル

拡張機能サンプルでは、Zoho Mail Developer Spaceが提供する機能の詳細を確認できます。拡張機能サンプルの機能は、カスタム拡張機能に組み込めるさまざまな処理を試せるように設計されています。

拡張機能サンプルは、こちらからダウンロードできます。Zoho Sigma拡張機能ギャラリーから、サンプルアプリをテストすることもできます。

メモ：

  • Developer Spaceは、有料の組織ユーザーのみが利用できます。
  • 組織管理者は、組織メンバーがDeveloper Spaceを利用できるようにする必要があります。利用できない場合は、管理者にお問い合わせください。詳細はこちら

必要な情報は見つかりましたか？

メールお問い合わせ窓口：support@zohomail.com