JS SDK JavaScript SDK

JS SDK JavaScript SDK

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

前提条件

JS https://js.zohocdn.com/projects/js/client_sdk.min.js を組み込んでから、以下の SDK メソッドの実装に進んでください。
CSS https://css.zohocdn.com/projects/styles/zps-extn/client_sdk.css を組み込むことで、Zoho プロジェクトのスタイルを活用できます。

初期化

これにより拡張機能が初期化されます。 


zohoprojects.init().then(function(){});
 
このメソッドを最初に呼び出すことが重要です。他の SDK メソッドは、このメソッドの呼び出し後にのみ機能します。初期化中に他の機能を使用したい場合は、init 関数内で使用できます。 


 zohoprojects.init().then(function () {
      zohoprojects.get('portal.name').then(function (response) 
      });

メタデータ

これにより、拡張機能の支払いと設定の詳細が取得されます。 

zohoprojects.metadata().then(function(response)
  {
       /* 出力
  {
        'data': {
        'configs': [
             {
             'name': '名前',
             'type': 'text',
             'is_mandatory': true,
             'is_secure': false,
             'description': '名前を入力してください',
             'value': 'Helen Collins'
               },
                {
                 'name': '社員ID',
                 'type': 'text',
                 'is_mandatory': true,
                 'is_secure': false,
                   'description': 'Emp. IDを入力してください',
                   'value': 'EMP08'
                    }
                     ],
                    'payments_info': {
                     'edition': 'trial'
                     },
                     'status': '成功'
                      }
                     }
                    */
           });

コンテキスト

この項目では、現在地のモジュール名とエンティティIDを取得します。ここでいうモジュール名は「tasks」または「issues」で、エンティティIDはそれぞれのタスクまたはイシューのIDです。 


 zohoprojects.context().then(function(response)
 {
 /* 出力
 {
     'module_name': 'tasks',
      'entity_id': '27092000000031079'
  }
     */
      });

 ウィジェットの場所 'app_settings' のエンティティIDは提供しておりません。

取得

これにより、現在地におけるインスタンス、現在のユーザー、ポータル、プロジェクト、タスク、イシューの詳細が取得されます。 


zohoprojects.get('task.id
').then(function(response)

{
/* 出力結果
 {
'data': 27092000000031080,
'status': '成功'
}
*/
});
以下は、getメソッドで使用可能なキーのリストです。

インスタンス

  • インスタンス

現在のユーザー

  • current_user（現在のユーザー）

ポータル

  1. ポータル。試用可能
  2. ポータル。設定
  3. ポータル。GMTタイムゾーン
  4. ポータル。プロジェクト数
  5. ポータル。役割
  6. ポータル。利用可能ユーザー数
  7. ポータル。ロケール
  8. ポータル。プロジェクト接頭辞
  9. ポータル。利用可能なプロジェクト
  10. ポータル。最大ユーザー数
  11. ポータル。プロファイルID
  12. ポータル。名前
  13. ポータル。ID文字列
  14. ポータル。複数形のバグ
  15. ポータル。プラン
  16. ポータル。バグプラン
  17. ポータル。バグ（単数形） ポータル。デフォルト
  18. ポータル。拡張機能
  19. ポータル。CRMパートナーですか
  20. ポータル。プロジェクト接頭辞を表示しますか
  21. ポータル。タスク接頭辞を表示しますか
  22. ポータル。新しいプランですか
  23. ポータル。レイアウト
  24. ポータル。リンク

プロジェクト

  1. プロジェクト。厳格ですか
  2. プロジェクト。役割
  3. プロジェクト。バグ数
  4. プロジェクト。所有者ID
  5. プロジェクト。タスクとバグの接頭辞
  6. プロジェクト。リンク
  7. プロジェクト。説明
  8. プロジェクト。マイルストーン数
  9. プロジェクト。更新日（長い形式）
  10. プロジェクト。タスク数
  11. プロジェクト。更新日形式
  12. プロジェクト。ワークスペースID
  13. プロジェクト。請求状況
  14. プロジェクト。キー
  15. プロジェクト。チャットが有効ですか
  16. プロジェクト。所有者の名前
  17. プロジェクト。プロファイルID
  18. プロジェクト。有効なタブ
  19. プロジェクト。名前
  20. プロジェクト。公開されていますか
  21. プロジェクト。レイアウト詳細
  22. プロジェクト。状態
  23. プロジェクト。権限
  24. プロジェクト。バグが有効ですか
  25. プロジェクト。バグのデフォルトビュー
  26. プロジェクト。バグの接頭辞
  27. プロジェクト。カスケード設定
  28. プロジェクト。完了日
  29. プロジェクト。完了日（長い形式）
  30. プロジェクト。作成日
  31. プロジェクト。作成日形式
  32. プロジェクト。作成日（長い形式）
  33. プロジェクト。カスタムステータスID
  34. プロジェクト。ID文字列
  35. プロジェクト。プロジェクト概要を表示
  36. プロジェクト。開始日
  37. プロジェクト。開始日（長い形式）
  38. プロジェクト。更新日
  39. プロジェクト。ユーザー
  40. プロジェクト。カスタムフィールド
  41. プロジェクト。カスタムフィールズ

タスク

  1. task。name
  2. task。completed（完了済み）
  3. task。created_by（作成者）
  4. task。priority（優先度）
  5. task。percent_complete（進捗率）
  6. task。start_date（開始日）
  7. task。end_date（終了日）
  8. task。dependency（依存関係）
  9. task。duration（期間）
  10. task。details（詳細）
  11. task。link（リンク）
  12. task。created_person（作成者）
  13. task。created_time（作成時間）
  14. task。created_time_format（作成時間の形式）
  15. task。created_time_long（作成時間（長））
  16. task。custom_fields（カスタムフィールド）
  17. task。depth （サブタスクのみ適用）
  18. task。duration_type（期間タイプ）
  19. task。id_string（ID文字列）
  20. task。is_comment_added（コメントが追加されたか）
  21. task。is_forum_associated（フォーラムが関連付けられているか）
  22. task。is_recurrence_set（反復設定がされているか）
  23. task。is_reminder_set（リマインダーが設定されているか）
  24. task。isparent（親タスクか）task。key（キー）
  25. task。last_updated_time（最終更新時間）
  26. task。last_updated_time_format（最終更新時間の形式）
  27. task。last_updated_time_long（最終更新時間（長））
  28. task。milestone_id（マイルストーンID）
  29. task。order_sequence（オーダーシークエンス）
  30. task。parent_task_id （サブタスクのみ適用）
  31. task。parenttask_id （サブタスクのみ適用）
  32. task。root_task_id （サブタスクのみ適用）
  33. task。status（ステータス）
  34. task。task_followers（タスクフォロワー）
  35. task。tasklist（タスクリスト）
  36. task。work（作業）task。work_type（作業タイプ）
  37. task。comments（コメント）
  38. task。subtasks（サブタスク）
  39. task。customfields（カスタムフィールド）
  40. task。attachments（添付ファイル）

問題点

  1. issue。module（モジュール）
  2. issue。created_time_long（作成時間（長））
  3. issue。customfields（カスタムフィールド）
  4. issue。status（ステータス）
  5. issue。reproducible（再現性あり）
  6. issue。link（リンク）
  7. issue。severity（重大度）
  8. issue。reported_person（報告者）
  9. issue。title（タイトル）
  10. issue。flag（フラグ）
  11. issue。assignee_name（担当者名）
  12. issue。reporter_id（レポーターID）
  13. issue。classification（分類）
  14. issue。created_time_format（作成時間の形式）
  15. issue。invisible（非表示）
  16. issue。created_time（作成時間）
  17. issue。key（キー）
  18. issue。attachment_count（添付ファイル数）
  19. issue。bug_number（バグ番号）
  20. issue。bug_prefix（バグ接頭辞）
  21. issue。comment_count（コメント数）
  22. issue。escalation_level（エスカレーションレベル）
  23. issue。id_string（ID文字列）
  24. issue。reporter_email（レポーターのメールアドレス）
  25. issue。reporter_non_zuser（レポーターがZuserでないか）
  26. issue。updated_time（更新時間）
  27. issue。updated_time_format（更新時間の形式）
  28. issue。updated_time_long（更新時間（長））
  29. issue。attachments（添付ファイル）
  30. issue。comments（コメント）
  31. issue。views（閲覧数）

マイルストーン

  1. マイルストーン。非表示
  2. マイルストーン。コメント数
  3. マイルストーン。作成時刻
  4. マイルストーン。作成時刻フォーマット
  5. マイルストーン。作成時刻（長い形式）
  6. マイルストーン。終了日
  7. マイルストーン。終了日フォーマット
  8. マイルストーン。終了日（長い形式）
  9. マイルストーン。フラグ
  10. マイルストーン。コメント存在有無
  11. マイルストーン。ID
  12. マイルストーン。ID文字列
  13. マイルストーン。作業分野削除有無
  14. マイルストーン。最終更新時刻
  15. マイルストーン。最終更新時刻フォーマット
  16. マイルストーン。最終更新時刻（長い形式）
  17. マイルストーン。リンク
  18. マイルストーン。名称
  19. マイルストーン。所有者ID
  20. マイルストーン。所有者名
  21. マイルストーン。所有者ZPUID
  22. マイルストーン。プロジェクト
  23. マイルストーン。順序
  24. マイルストーン。開始日
  25. マイルストーン。開始日フォーマット
  26. マイルストーン。開始日（長い形式）
  27. マイルストーン。ステータス
  28. マイルストーン。ステータス詳細

選択済みファイル

アップロードを待機中のファイルは chosen_files に保存されます。このキーは添付ファイルピッカーでのみ対応しています。
  • chosen_files

デプロイメントタイプ

現在のデータセンターを取得します。 

zohoprojects.get('deployment_type').then(function() {
/* 出力
com
 */
 });

プロフィール

当社では、ポータルレベルでのすべてのプロフィールや、現在のユーザーのプロフィール詳細を取得する複数のキーをサポートしています。
  1. all_profiles: ポータル内の全プロフィール情報を取得します。
  2. current_profile: 現在のユーザーのプロフィール詳細を取得します。

テーマ

Zoho プロジェクトは、ポータルのためのテーマをサポートしています。
  • current_theme: 現在のテーマを取得します。 
zohoprojects.get('current_theme').then(function() {
 /* 出力
{mode: 'default', zpPrimary: '255, 100, 0', zpPrimaryHover: '255, 247, 243'}
 */
 });

Blueprint 中

  • 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} ]
 */
});

set

現在の位置の特定のタスクまたは問題の属性を更新します。 


var nameObj={name:'新しいチェックリストを作成'};
zohoprojects.set('task',nameObj).then(function(response)
  {
    /* 出力
   {
   'data': {
   'tasks': [
     {
      'milestone_id': '2*******************2',
       'link': {
       'timesheet': {
          'url': '

タスク

  1. 担当者
  2. オーナーの作業
  3. 作業タイプ
  4. 名前
  5. 開始日
  6. 終了日
  7. 開始時間
  8. 終了時間
  9. 進捗率
  10. 期間
  11. 期間の種類
  12. リマインダー
  13. 優先度
  14. 説明
  15. カスタムフィールド（このキーはカスタムフィールドの作成にのみ使用できます。）
  16. 日付をクリア
  17. インデックス
    18.
  18. 範囲

  19. json文字列
  20. サブタスク（このキーはサブタスクの作成にのみ使用できます。こちらをクリックしてサブタスクのパラメータを知ってください。）
    21.
次のキーは問題をセットする方法で使用できます：

問題

  1. タイトル
  2. 説明
  3. 担当者
  4. フラグ
  5. 分類ID
  6. マイルストーンID
  7. 締め切り日
  8. モジュールID
  9. 重大度ID
  10. 再現可能性ID
  11. 状態ID
  12. 解決
  13. 影響マイルストーンID
    14.
次のキーはプロジェクトを更新する方法で使用できます：

プロジェクト

  1. 名前
  2. 説明
  3. 状態
  4. 開始日
  5. 終了日
  6. 厳密なプロジェクト
  7. 公開
  8. グループID
  9. 完了日
  10. UDF_CHAR([1-9]|[1-2][0-9]|30)。 例: UDM_CHAR1
  11. UDF_TEXT([1-9]|1[0-5])
  12. UDF_LONG([1-9]|1[0-5])
  13. UDF_USER[1-5]
  14. UDF_DOUBLE([1-9]|[1-2][0-9]|3[0-5])
  15. UDF_DATE[1-5]
  16. UDF_ENCRYPT([1-9]|10)
  17. オーナー
  18. ビリング方式
  19. 請求の状態
  20. プロジェクトの概要を表示
  21. カスタムステータス
    22.
次のキーはマイルストーンを更新する方法で使用できます：

マイルストーン

  1. 名前
  2. 開始日
  3. 終了日
  4. オーナー
  5. フラグ
  6. 予算
  7. 閾値
  8. 収益予算
    9.
linkfiles keyを使用して、あなたのロケーションにファイルを関連付けます。このキーは以下のロケーションをサポートしています：タスクの詳細タブ、問題の詳細タブ、添付ファイルピッカー。配列は最大サイズ10である必要があり、id、name、type、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&export=download',
}]
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) {
  /* 出力
[{'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}]
*/
 });

リクエスト

プラグインマニフェストの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&export=download',
'name': 'Eiffel_Tower_01.jpg',
'webViewLink': 'https://drive.google.com/file/d/1-QabBt69U8myXYRDVU-1YiCo2k-JWRfu/view?usp=drivesdk',
'id': '1-QabBt69U8myXYRDVU-1YiCo2k-JWRfu',
'thumbnailLink': 'https://lh3.googleusercontent.com/nhyq9mHrGDOZfNdQUHRj_xVlOoNAP5PEYkW4X2svGXKjVt53MvMGfjhQ2PlTv4cmv5-PgbjrR-c=s220'
},
'status': 'success'
}
*/
});
引数名 データ型 説明
URL string エクステンションから呼び出すサードパーティのURL。
オブジェクト JSONObject キー データ型 値
    タイプ 文字列 'GET' / 'POST' / 'PUT' / 'DELETE' / 'PATCH'
    パラメータ JSONObject APIの要求パラメータです。
    ヘッダー JSONObject APIのヘッダーです。
    body JSONObject

APIの本文です。

 
    ファイル JSONArray

ファイルをアップロードするためのパラメータ。

値: 実際のファイル。

*実際のファイルがアップロードされると本文は無視されます

*タイプをバイナリとして指定すると、ファイルはバイナリとして送信されます。ファイルの本文も考慮されます
    replace_secure_config Boolean

プラグインマニフェスト.jsonファイル内のis_secureパラメーターがtrueの場合、このパラメーターの値をtrueに設定してください。

Zoho プロジェクトはURL内の値を置換します。

メモ: デフォルト値はfalseです。
connection_link_name 文字列 connection link nameはZappsウェブサイトから生成されます。

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

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

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

    Zoho CRM Training




              Zoho Desk Resources

              • Desk Community Learning Series


              • Digest


              • Functions


              • Meetups


              • Kbase


              • Resources


              • Glossary


              • Desk Marketplace


              • MVP Corner


              • Word of the Day






                        Latest Feature Updates



                                • Related Articles

                                • CLIを使用して拡張機能を作成する

                                  お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 はじめに Zoho マーケットプレイスは、Zoho製品のために開発された拡張機能をアップロードできるデジタルプラットフォームです。また、ビジネスに役立つストアの拡張機能も利用できます。この開発者ガイドは、拡張機能のビルドとマーケットプレイスへのデプロイのお手伝いをします。 ...

                                • クラウドエディタを使用して拡張機能を作成

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

                                • カスタム関数

                                  カスタム関数を使用して、課題のワークフローを自動化できます。カスタム関数は、プロセスの自動化に使用できる、簡単なプログラムです。自社のニーズに合わせて、関数を独自のスクリプト（ Deluge ）で書き、業務ルールから呼び出せます。 DATE 、 CONCAT 、 REPLACE などの、Javascriptの組み込み関数と同様に設定できます。Zoho ...

                                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.