plugin-manifest.jsonの設定方法

plugin-manifest.jsonの設定方法

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

plugin-manifest。json

参照用のサンプル JSON 記述子ファイルを以下に示します。



次に、このファイルのプロパティの定義方法を説明します。

種類

種類には「personal」を指定するとすべてのユーザーが拡張機能を設定でき、「org」を指定すると管理者のみが拡張機能を設定できます。

キー 種類
種類 String
使用可能な値 : personal, org

locale

拡張機能がサポートする言語です。現在は locale「en」(英語)のみサポートされています。
キー 種類
locale* JSONArray en

サービス

拡張機能を作成する対象の Zoho 製品名です。ここでは「プロジェクト」です。
キー 種類
サービス* String プロジェクト

storage

この設定が true の場合、この拡張機能用に製品側でストレージ領域が割り当てられます。既定では値は無効です。
キー 種類
storage* Boolean
  • true
  • false

whiteListedDomains

この配列で指定したドメインのみが、拡張機能から呼び出し可能になります。確立済みの接続先ドメイン以外への通話は、拡張機能では処理されません。拡張機能でサードパーティサービスを使用しない場合は、この配列は空のままにできます。
キー 種類
whiteListedDomains* Array  

タブ

拡張機能のタブを定義します。現在はウィジェットのみをサポートしています。
キー 種類
タブ JSONObject

例:

'widgets':[{
'場所':'task_tab',
'名前':'GDrive for Zoho プロジェクト',
'url':'/app/index.html',
'countkey' : 'extensionUniqueKey'
}]

widgets

このキーにはオブジェクトの配列が格納されます。各オブジェクトは「場所」「名前」「URL」の 3 つのキーを持ちます。
キー 種類 オブジェクトの詳細
ウィジェット JSONArray キー 種類 説明
  場所 String 拡張機能を商品内のどこに表示するかを指定します。
  • task_tab
  • issue_tab
  • milestone_tab
  • project_tab
  • app_settings
  • top_band
  • attachment_picker
  • taskdetails_rightpanel
  • issuedetails_rightpanel
  • blueprint_during
  • task_transition

メモ: 場所名は一意である必要があります。

名前 String ウィジェットの名前。 例: チェックリスト
url URL ウィジェットを読み込むファイルの相対パス。 /app/index.html
icon String ウィジェットのアイコン。 添付ファイルピッカーではアイコンの指定が必須です。
  countkey
(task_tab、milestone_tab、issue_tab で利用可能)
String ウィジェットの件数を取得するための一意の ID。 extensionUniqueKey


1 つの拡張機能に、複数のウィジェットを含めることができます。
メモ: extensionUniqueKey は、拡張機能データの保存/更新に使用されます。

connectors

ウィジェットと同様に、このキーもオブジェクトの配列を保持します。コネクターは、拡張機能とサードパーティサービスを連携させるために使用します。このようなサードパーティサービスの認可は、通常 Zoho プロジェクトによって処理されます。
キー 種類 オブジェクトの詳細
connectors JSONArray キー 種類 説明
  connectionLinkName String サードパーティサービス接続用に作成したリンク名

connectionLinkName パラメーターの値は、接続概要の JSON タブで作成した値を指定します。

メモ: 接続名は一意である必要があります。

connectionName String 接続の名前 connectionName パラメーターの値は、接続概要の JSON タブで作成した値を指定します。
serviceName String サードパーティサービスの名前 serviceName パラメーターの値は、接続概要の JSON タブで作成した値を指定します。
userAccess Boolean このパラメーターは、拡張機能をユーザーごとに個別に認証する必要があるか、管理者のみが認証すればよいかを指定します。
  • true
  • false
  isUserDefinedService Boolean 接続がカスタムサービスで確立されているかどうか。
  • true
  • false
  Scope JSONArray ユーザー/管理者に設定されているアクセス権限。 例: ['https://www.googleapis.com/auth/drive.readonly']

1つの拡張機能には、同時に最大5つのサードパーティサービスを接続できます。

config

このキーは、拡張機能を動作させるためにユーザーから追加の入力が必要な場合に使用します。たとえば、拡張機能の動作にサードパーティサービスのユーザーのドメイン名が必要な場合、このキーを使用してユーザーから入力を取得できます。
キー 種類 オブジェクトの詳細
config JSONArray キー 種類 説明
  名前* String パラメーターの名前。 名前は一意である必要があります。
種類* String パラメーターのデータ型
  • 'text'
  • 'password'
  • 'checkbox'
  • 'url'
  • 'number'
  • 'multiline'
  • 'selectbox'
  • 'hidden'
初期設定 String パラメーターの初期値 メモ: このパラメーターは任意です。
設定 JSON array 種類に 'selectbox' を選択した場合、設定は必須です。 ['新規機能', 'Enhancement']
is_secure* Boolean これを 'true' に設定すると、拡張機能から開発者がこの設定にアクセスできなくなります。
  • true
  • false
is_mandatory Boolean この設定が必須かどうか
  • true
  • false
説明 String 設定の簡単な説明 メモ: このパラメーターは任意です。

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

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

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

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts









                                  • Related Articles

                                  • ウィジェットの配置場所

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho プロジェクトでのウィジェット配置一覧 配置場所 拡張機能のウィジェットは、プロダクト内の複数の場所に表示できます。このキー(場所)で、ウィジェットを表示する位置を指定します。Zoho ...
                                  • CLIを使った拡張機能の作成

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 概要 Zoho マーケットプレイスは、開発した Zoho 製品向け拡張機能をアップロードできるオンラインストアです。また、ストアで公開されている拡張機能を自社で利用することもできます。本開発者ガイドでは、拡張機能を作成し、Zoho マーケットプレイスに公開するまでの手順を説明します。 ...
                                  • コネクタの設定

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 利用可能なサードパーティサービスとの接続を確立する 拡張機能でサードパーティサービスを使用する場合は、そのサードパーティサービスとの接続を確立するためのコネクターを設定する必要があります。複数のサードパーティサービスに同時に接続することもできます。ユーザーは Zoho ...
                                  • クラウドエディターで拡張機能を作成する

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho プロジェクトでは、クラウドエディターを使用して拡張機能を作成でき、事前設定の手間を省き、開発プロセス全体をオンラインで管理できます。 クラウドエディターの操作方法については、次のウェビナーをご覧ください。 概要 Zoho マーケットプレイスは、Zoho ...
                                  • JS SDKの概要

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 前提条件 次の SDK メソッドを呼び出す前に、コード内に JS https://js.zohocdn.com/projects/js/client_sdk.min.js を含めてください。 Zoho Projects のスタイルを使用するには、コード内に CSS ...

                                  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.