JS SDK
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
前提条件
以下のSDKメソッドを呼び出す前に、JS https://js。zohocdn。com/プロジェクト/js/client_sdk。min。js をあなたのコードに組み込んでください。
Zoho プロジェクトのスタイルを利用するため、 CSS https://css。zohocdn。com/プロジェクト/styles/zps-extn/client_sdk。css をあなたのコードに組み込んでください。
初期化
これにより拡張機能が初期化されます。
zohoprojects.init().then(function(){});
このメソッドは、他のSDKメソッドがそれの呼び出し後のみ機能するため、開始時に呼び出す必要があります。initが読み込まれている間に他の機能を使用する場合は、init関数内でそれらを使用することができます。
zohoprojects.init().then(function () {
zohoprojects.get('portal.name').then(function (response)
});
メタデータ
これにより、拡張機能の支払いおよび設定詳細が取得されます。
zohoprojects.metadata().then(function(response)
{
/* 出力
{
'data': {
'configs': [
{
'name': '名前',
'type': 'テキスト',
'is_mandatory': true,
'is_secure': false,
'description': 'あなたの名前を入力してください',
'value': 'Helen Collins'
},
{
'name': '従業員ID',
'type': 'テキスト',
'is_mandatory': true,
'is_secure': false,
'description': 'あなたの従業員IDを入力してください',
'value': 'EMP08'
}
],
'payments_info': {
'edition': '試用版'
},
'status': '成功'
}
}
*/
}); コンテクスト
これは現在の場所のタブ名とデータIDを取得します。 タブ名は 'タスク' または 'issues' であり、データIDは対応するタスクまたは問題のIDです。
zohoprojects.context().then(function(response)
{
/* 出力
{
'module_name': 'タスク',
'entity_id': '27092000000031079'
}
*/
}); 
'app_settings', 'attachment_picker', 'blueprint_during'および'top_band'の場所に対してはデータIDを提供していません。
取得する
これにより、インスタンス、現在のユーザー、ポータル、プロジェクト、タスク、および現在の場所の問題の詳細を取得します。
zohoprojects.get('task.id
').then(function(response)
{
/* 出力結果
{
'data': 27092000000031080,
'status': 'success'
}
*/
});
以下は、取得するメソッドで使用中のキーのリストです:
インスタント
-
インスタント
現在のユーザー
-
現在のユーザー
ポータル
- ポータル。試用版が有効
- ポータル。設定
- ポータル。gmtタイムゾーン
- ポータル。プロジェクトの数
- ポータル。役割
- ポータル。利用可能なユーザー数
- ポータル。ロケール
- ポータル。プロジェクトプレフィックス
- ポータル。利用可能なプロジェクト
- ポータル。最大ユーザー数
- ポータル。プロファイルID
- ポータル。名前
- ポータル。IDストリング
- ポータル。バグ（複数形）
- ポータル。プラン
- ポータル。バグプラン
- ポータル。バグ（単数形）ポータル。初期設定
- ポータル。拡張機能
- ポータル。CRMパートナーであるかどうか
- ポータル。プロジェクトプレフィックスを表示するかどうか
- ポータル。タスクプレフィックスを表示するかどうか
- ポータル。新しいプランであるかどうか
- ポータル。レイアウト
- ポータル。リンク
プロジェクト
- プロジェクト。厳格であるかどうか
- プロジェクト。役割
- プロジェクト。バグの数
- プロジェクト。オーナーID
- プロジェクト。タスク／バグのプレフィックス
- プロジェクト。リンク
- プロジェクト。説明
- プロジェクト。マイルストーンの数
- プロジェクト。更新日（ロングフォーマット）
- プロジェクト。タスクの数
- プロジェクト。更新日のフォーマット
- プロジェクト。ワークスペースID
- プロジェクト。課金ステータス
- プロジェクト。キー
- プロジェクト。チャットが有効かどうか
- プロジェクト。オーナー名
- プロジェクト。プロファイルID
- プロジェクト。有効なタブ
- プロジェクト。名前
- プロジェクト。公開しているかどうか
- プロジェクト。レイアウト詳細
- プロジェクト。ステータス
- プロジェクト。権限
- プロジェクト。バグが有効かどうか
- プロジェクト。バグのデフォルトビュー
- プロジェクト。バグプレフィックス
- プロジェクト。カスケート設定
- プロジェクト。完了日
- プロジェクト。完了日（ロングフォーマット）
- プロジェクト。作成日
- プロジェクト。作成日のフォーマット
- プロジェクト。作成日（ロングフォーマット）
- プロジェクト。カスタムステータスID
- プロジェクト。IDストリング
- プロジェクト。プロジェクト概要の表示するかどうか
- プロジェクト。開始日
- プロジェクト。開始日（ロングフォーマット）
- プロジェクト。更新日
- プロジェクト。ユーザー
- プロジェクト。カスタム項目
- プロジェクト。カスタムフィールド
タスク
- タスク。名前
- タスク。完了
- タスク。作成者
- タスク。優先度
- タスク。進行率
- タスク。開始日
- タスク。終了日
- タスク。依存性
- タスク。期間
- タスク。詳細
- タスク。リンク
- タスク。作成者
- タスク。作成時間
- タスク。作成時間の形式
- タスク。長い形式の作成時間
- タスク。カスタムフィールド
- タスク。深度 (サブタスクのみ適用)
- タスク。期間の種類
- タスク。ID文字列
- タスク。コメントが追加されました
- タスク。フォーラムが関連付けられました
- タスク。リカレンスが設定されました
- タスク。リマインダーが設定されました
- タスク。親タスクです
- タスク。最終更新時間
- タスク。最終更新時間の形式
- タスク。長い形式の最終更新時間
- タスク。マイルストーンID
- タスク。順序シーケンス
- タスク。親タスクID (サブタスクのみ適用)
- タスク。親タスクID (サブタスクのみ適用)
- タスク。ルートタスクID (サブタスクのみ適用)
- タスク。ステータス
- タスク。タスクフォロワー
- タスク。タスクリスト
- タスク。作業
- タスク。作業タイプ
- タスク。コメント
- タスク。サブタスク
- タスク。カスタムフィールド
- タスク。添付ファイル
問題
- 問題。タブ
- 問題。長い形式の作成時間
- 問題。カスタムフィールド
- 問題。ステータス
- 問題。再現可能
- 問題。リンク
- 問題。重症度
- 問題。報告者
- 問題。件名
- 問題。旗
- 問題。担当者の名前
- 問題。報告者ID
- 問題。分類
- 問題。作成時間の形式
- 問題。完了
- 問題。作成時間
- 問題。キー
- 問題。添付ファイルの数
- 問題。バグ番号
- 問題。バグプレフィックス
- 問題。コメント数
- 問題。エスカレーションレベル
- 問題。ID文字列
- 問題。報告者のメール
- 問題。報告者がZユーザーでない
- 問題。更新時間
- 問題。更新時間の形式
- 問題。長い形式の更新時間
- 問題。添付ファイル
- 問題。コメント
- 問題。閲覧回数
マイルストーン
- milestone。完了済み
- milestone。コメント数
- milestone。作成時間
- milestone。作成時間フォーマット
- milestone。長い作成時間
- milestone。終了日
- milestone。終了日フォーマット
- milestone。長い終了日
- milestone。フラグ
- milestone。コメントあり
- milestone。id
- milestone。文字列ID
- milestone。作業フィールドを削除
- milestone。最終更新時間
- milestone。最終更新時間フォーマット
- milestone。長い最終更新時間
- milestone。リンク
- milestone。名前
- milestone。所有者ID
- milestone。所有者名
- milestone。所有者のzpuid
- milestone。プロジェクト
- milestone。シーケンス
- milestone。開始日
- milestone。開始日フォーマット
- milestone。開始日の長い形式
- milestone。ステータス
- milestone。ステータス詳細
選択済みファイル
アップロード待ちのファイルは、chosen_filesに保存されます。このキーは、添付ファイルピッカーでのみサポートされます。
-
選択済みファイル
デプロイメントカテゴリー
現在のデータセンターを取得します。
zohoprojects.get('deployment_type').then(function() {
/* 出力
com
*/
});
権限情報
ポータルレベルの全権限と、現在ユーザーの権限詳細を取得するキーをいくつか提供しています。
- all_profiles: ポータル内の全権限の情報を取得します。
- current_profile: 現在のユーザーの権限詳細を取得します。
テーマ
Zoho プロジェクトはあなたのポータルのためのテーマをサポートしています。
-
current_theme: 現在のテーマを取得します。
zohoprojects.get('current_theme').then(function() {
/* 出力
{mode: 'default', zpPrimary: '255, 100, 0', zpPrimaryHover: '255, 247, 243'}
*/
});
ブループリント中
-
blueprint_during: During操作に設定された値を取得します。
zohoprojects.get('blueprint_during').then(function(res) {
/* 出力
[ {field_id: 'UDF_CHAR1', is_visible: true, is_pii: false, is_encrypted: false}
{field_id: 'UDF_CHAR2', is_visible: true, is_pii: false, is_encrypted: false}]
*/
});
遷移
現在の遷移の詳細を取得します。
- transition: 現在の遷移のIDと名前を取得します。
- blueprint : ブループリントのIDと名前を取得します。
セット
特定のタスクや現在の場所の問題の属性を更新します。
var nameObj={name:'新しいチェックリストを作成'};
zohoprojects.set('task',nameObj).then(function(response)
{
/* output
{
'data': {
'tasks': [
{
'milestone_id': '2*******************2',
'link': {
'timesheet': {
'url': 'https://p*************e.********.com/restapi/ポータル/5******7/プロジェクト/2****************9/タスク/2****************9/logs/'
},
'self': {
'url': 'https://p*************e.********.com/restapi/ポータル/5******7/プロジェクト/2****************9/タスク/2****************9/'
}
},
'description': '',
'duration': '0',
'last_updated_time_long': 1542193097398,
'details': {
'owners': [
{
'name': 'JOHN MARSH',
'id': '5************3'
}
]
},
'id': 2************0,
'key': 'WEUT-T1',
'created_person': 'Steve Banks',
'created_time_long': 1525668983347,
'created_time': '05-07-2018',
'is_reminder_set': false,
'is_recurrence_set': false,
'created_time_format': '05-07-2018 10:26:23 AM',
'subtasks': false,
'work': '0:00',
'custom_fields': [
{
'column_name': 'UDF_LONG1',
'label_name': '費用総額',
'value': '24573'
},
{
'column_name': 'UDF_LONG3',
'label_name': 'サンプル',
'value': '0'
},
{
'column_name': 'UDF_LONG2',
'label_name': 'テスト',
'value': '200'
}
],
'isparent': false,
'work_type': 'work_hrs_per_day',
'completed': false,
'priority': 'None',
'created_by': '5******3',
'percent_complete': '0',
'last_updated_time': '11-14-2018',
'name': '新しいチェックリストを作成',
'id_string': '2************9',
'last_updated_time_format': '11-14-2018 04:28:17 PM',
'tasklist': {
'name': '一般',
'id': '2************7'
},
'order_sequence': 1,
'status': {
'name': 'オープン',
'id': '2************1',
'type': 'open',
'color_code': ''
}
}
]
},
'status': '成功'
}
*/
});
以下のキーは、タスクのsetメソッドで使用できます:
タスク
- 担当者
- オーナーの作業
- 作業タイプ
- 名前
- 開始日
- 終了日
- 開始時間
- 終了時間
- 完了率
- 期間
- 期間タイプ
- リマインダー
- 優先度
- 説明
- カスタムフィールド（このキーはカスタム項目の作成にのみ使用できます）
- クリア日
- インデックス
- 範囲
- json_string
- サブタスク（このキーはサブタスクの作成にのみ使用できます。 ここをクリックしてサブタスクのパラメータを確認してください。）
次のキーは問題を設定するメソッドで使用できます：
問題
- 件名
- 説明
- 担当者
- フラグ
- 分類ID
- マイルストーンID
- 期日
- モジュールID
- 重症度ID
- 再現可能ID
- ステータスID
- 解析
- 影響マイルID
次のキーはプロジェクトを更新するメソッドで使用できます：
プロジェクト
- 名前
- 説明
- ステータス
- 開始日
- 終了日
- 厳格なプロジェクト
- 公開する
- グループID
- 完了時
- UDF_CHAR([1-9]|[1-2][0-9]|30)。例： UDF_CHAR1
- UDF_TEXT([1-9]|10)
- UDF_LONG([1-9]|10)
- UDF_USER[1-5]
- UDF_DOUBLE([1-9]|[1-2][0-9]|30)
- UDF_DATE[1-5]
- UDF_ENCRYPT([1-9]|10)
- 担当者
- 課金方法
- 請求状況
- プロジェクト概要を表示
- カスタムステータス
マイルストーンを更新するためにsetメソッドで使用できる次のキー：
マイルストーン
- 名前
- 開始日
- 終了日
- 担当者
- フラグ
- 予算
- 閾値
- 収益目標
ファイルのリンク
linkfilesキーを使用して、ファイルをあなたの場所に関連付けます。このキーは次の場所をサポートしています: タスク詳細タブ、Issue詳細タブ、添付ファイルピッカータブ。最大サイズ10の配列である必要があり、以下の項目は必須です: id, 名前, 種類, permanent_url, download_url, size, created_by, created_time; preview_urlは画像ファイルに対して必須です。
-
linkfiles
linkfiles=[{
'created_time': 1561028014712,
'id': '1LavBS5sauJ-AAFJZWp8Ch9Cp2ehydahk',
'type': 'image/jpeg',
'created_by': 'Patricia Boyle',
'permanent_url': 'https://***************',
'size': 7409,
'preview_url': 'https://******************',
'name': 'sample-image.jpeg',
'download_url': 'https://drive.google.com/a/web-mailhosting.com/uc?id=1LavBS5sauJ-AAFJZWp8Ch9Cp2ehydahk&エクスポート=ダウンロード',
}]
zohoprojects.set('linkfiles', linkFiles).then(function (response) {
zohoprojects.invoke('attachment_picker.close');
});
Blueprint During
ブループリントの遷移のDuring操作を構成するときに値を設定します。
var sample = [ {field_id: 'UDF_CHAR1', is_visible: true, is_pii: false, is_encrypted: false} {field_id: 'UDF_CHAR2', is_visible: true, is_pii: false, is_encrypted: false}]; zohoprojects.set('blueprint_during', sample).then(function(res) { /* output [ {field_id: 'UDF_CHAR1', is_visible: true, is_pii: false, is_encrypted: false} {field_id: 'UDF_CHAR2', is_visible: true, is_pii: false, is_encrypted: false}] */ });
エクスポート先
クラウドストレージサービスにあなたのタスクをエクスポートします。「詳細のエクスポート」ポップアップに表示されるデータ項目を最大5つ選択できます。データを表示するにリンクパラメータが追加された場合、選択された場所はアクセスしやすいようにハイパーリンクとして掲載されます。
let paramObj = {
'custom_data': {
'path': 'G/pics',
'portal_id': '89031033',
'project_id': '185977000000199005'
},
'display_data' : [
{
'名前': 'Path',
'値': 'G's Drive',
'リンク': 'https://drive。google。com/drive/フォルダー/1e1xWqREV'
}, {
'名前': 'アプリ名',
'値': 'G- Drive'
}
]
zohoprojects。set('実行する', paramObj);リクエスト
プラグインマニフェスト.jsonファイルで定義された接続を使用して、拡張機能からサードパーティのURLを呼び出します。外部連携のリンク名が指定されていない場合、出力は入力に基づいて提供されます。
var file = document.getElementById('inputbox').files[0];
var file_detail = {
type: 'GET',
files: [{
uploaddoc : file
type : 'binary' //ファイルがバイナリとしてアップロードされた場合
}],
parameters: {
fields: 'id,name, thumbnailLink, webViewLink, webContentLink'
}
};
var url = 'https://www。googleapis。com/drive/v3/files/1-QabBt69U8myXYRDVU-1YiCo2k-JWRfu';
zohoprojects.request(url, file_detail, 'google_drive').then(function (response)
/* 出力
{
'result': {
'webContentLink': 'https://drive。google。com/uc?id=1-QabBt69U8myXYRDVU-1YiCo2k-JWRfu&エクスポートする=ダウンロードする',
'name': 'Eiffel_Tower_01.jpg',
'webViewLink': 'https://drive。google。com/file/d/1-QabBt69U8myXYRDVU-1YiCo2k-JWRfu/表示する?usp=drivesdk',
'id': '1-QabBt69U8myXYRDVU-1YiCo2k-JWRfu',
'thumbnailLink': 'https://lh3。googleusercontent。com/nhyq9mHrGDOZfNdQUHRj_xVlOoNAP5PEYkW4X2svGXKjVt53MvMGfjhQ2PlTv4cmv5-PgbjrR-c=s220'
},
'status': 'success'
}
*/});| 引数の名前 | データタイプ | 説明 | ||
| URL | 文字列 | 差出人の拡張機能が呼び出す必要があるサードパーティURL。 | ||
| オブジェクト | JSONObject | キー | データのタイプ | バリュー |
| 種類 | string | '取得する' / 'POST' / 'PUT' / '削除' / 'PATCH' | ||
| パラメーター | JSONObject | APIのリクエストパラメーター。 | ||
| ヘッダー | JSONObject | APIのヘッダー。 | ||
| 本文 | JSONObject |
APIの本文。
|
||
| ファイル | JSONArray |
ファイルをアップロードするためのパラメーター。 値: 実際のファイル。 *実際のファイルがアップロードされると本文は無視されます *種類をバイナリとして指定すると、ファイルはバイナリとして送信されます。ファイルの本文も考慮されます |
||
| replace_secure_config | ブール値 |
プラグインマニフェストのjsonファイル内のis_secureパラメータが真である場合、このパラメータの値を真に設定します。
この形式でURLとオブジェクトパラメータに値を渡すことができます- {{名前}} //設定の名前
Zoho プロジェクトは設定値を置き換えます |
||
| connection_link_name | 文字列 | 外部連携のリンク名は、zappsウェブサイトが提供するもので、plugin-manifestから取得できます。 | ||
実行する関数
Sigmaでトリガーなしにカスタム関数を実行します。関数のuuidとそのバージョンは、関数を実行するために必須です。
let customData = {'名前':'新しいチェックリストを作成'};
zohoprojects.function.実行('c8a9e660-95e2-11ef-9d3c-2d653cc724d7', '1.+10,-10', customData).then(function(response){
/* 出力
{ 'result':{'output':'{}','タスク':[],'outputType':'無効','メッセージ':{}},
'unique_id':'c8a9e660-95e2-11ef-9d3c-2d653cc724d7',
'コード':3009,
'function_id':1234567890,
'メッセージ':'関数が正常に実行されました',
'ステータス':'完了'
}
*/
});
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
CLIを使用して拡張機能を作成する
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 はじめに Zoho マーケットプレイスは、Zoho製品のために開発された拡張機能をアップロードできるデジタルプラットフォームです。また、ビジネスに役立つストアの拡張機能も利用できます。この開発者ガイドは、拡張機能のビルドとマーケットプレイスへのデプロイのお手伝いをします。 ...