plugin-manifest.json の設定

plugin-manifest.json の設定

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

plugin-manifest.json

こちらは、参考用のJSON記述子ファイルのサンプルです。

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

locale

拡張機能が対応する言語です。現在、対応しているロケールは「en」（日本語）のみです。

キー
型
値
locale*
JSONArray
en

service

拡張機能を作成する対象のZoho製品名です。こちらでは「PROJECTS」です。

キー
型
値
service*
String
PROJECTS

storage

この設定がtrueの場合、この拡張機能用のストレージ領域が製品内に割り当てられます。初期設定では、値はfalseです。


キー
型
値
storage*
Boolean

  1. true
  2. false

whiteListedDomains

この配列で指定したドメインは、拡張機能から呼び出せます。接続が確立されているドメインを除き、他のドメインへの呼び出しは拡張機能では処理されません。拡張機能でサードパーティーサービスを使用しない場合、この配列は空として宣言できます。


キー
型
値
whiteListedDomains*
Array

タブ

拡張機能のタブです。現在、ウィジェットに対応しています。


キー
型
値
タブ
JSONObject

例：

'widgets':[{
'location':'task_tab',
'name':'GDrive for Zoho Projects',
'url':'/app/index.html',
'countkey' : 'extensionUniqueKey'
}]

widgets

このキーにはオブジェクトの配列を格納します。各オブジェクトには、「location」、「name」、「URL」の3つのキーがあります。


キー
型
オブジェクトの詳細



widgets
JSONArray
キー
型
説明
値


String
製品内で拡張機能を表示する場所です。
  • issue_tab
  • app_settings
  • top_band
  • attachment_picker
  • issuedetails_rightpanel
メモ：ロケーション名は一意である必要があります。


name
String
ウィジェットの名前です。
例：Checklist


url
URL
ウィジェットを読み込むファイルの相対パスです。
/app/index.html


icon
String
ウィジェットのアイコンです
attachment_pickerではアイコンが必須です


countkey
（phase_tabとissue_tab）
String
ウィジェット数を取得するための一意のIDです。
extensionUniqueKey

1つの拡張機能に複数のウィジェットを設定できます。

メモ：extensionUniqueKeyは、拡張機能データの保存／更新に使用されます。

connectors

ウィジェットと同様に、このキーにもオブジェクトの配列を格納します。コネクターは、拡張機能とサードパーティーサービスを連携させるために役立ちます。このようなサードパーティーサービスの認証は、通常Zoho Projectsによって処理されます。


キー
種類
オブジェクトの詳細



connectors
JSONArray
キー
種類
説明
値


connectionLinkName
String
外部サービス接続用に生成されるリンク名

接続概要の［JSON］タブで生成されるconnectionLinkNameパラメーターの値です。

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


connectionName
String
接続名
接続概要の［JSON］タブで生成されるconnectionNameパラメーターの値です。


serviceName
String
外部サービス名
接続概要の［JSON］タブで生成されるserviceNameパラメーターの値です。


userAccess
Boolean
このパラメーターでは、拡張機能を各ユーザーが個別に認証する必要があるか、管理者のみが認証すればよいかを指定します。
  • true
  • false


isUserDefinedService
Boolean
カスタムサービスとの接続かどうかを示します。
  • true
  • false


Scope
JSONArray
ユーザー／管理者に設定されるアクセス権限です。
1つの拡張機能は、最大5件の外部サービスに同時に接続できます。

config

このキーは、拡張機能を動作させるためにユーザーから追加の入力を取得する必要がある場合に使用できます。たとえば、拡張機能の動作に外部サービスのユーザーのドメイン名が必要な場合があります。その場合、このキーを使用して、ユーザーから必要な入力を取得できます。


キー
種類
オブジェクトの詳細



config
JSONArray
キー
種類
説明
値


name*
String
パラメーター名です。
名前は一意である必要があります。


type*
String
パラメーターのデータ型です
  • 'text'
  • 'password'
  • 'checkbox'
  • 'url'
  • 'number'
  • 'multiline'
  • 'selectbox'
  • 'hidden'


default
String
パラメーターの初期値です
メモ：このパラメーターは任意です。


options
JSON配列
種類に「selectbox」を選択した場合、optionsは必須です。
例['新機能', '機能強化']


is_secure*
Boolean
これを「true」に設定すると、開発者は拡張機能からこの設定にアクセスできなくなります。
  • true
  • false


is_mandatory
Boolean
設定は必須ですか？
  • true
  • false


説明
String
設定の簡単な説明です
メモ：このパラメーターは任意です。