JS SDKの概要

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

前提条件

次の SDK メソッドを呼び出す前に、コード内に JS https://js.zohocdn.com/projects/js/client_sdk.min.js を含めてください。

Zoho Projects のスタイルを使用するには、コード内に CSS https://css.zohocdn.com/projects/styles/zps-extn/client_sdk.css を含めてください。

init

拡張機能を初期化します。


zohoprojects.init().then(function(){});

このメソッドは必ず最初に呼び出してください。ほかの SDK メソッドは、このメソッドが呼び出された後でのみ動作します。init の読み込み中にほかの関数を使用したい場合は、init 関数内でそれらを使用できます。


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

metadata

拡張機能の支払い情報と設定の詳細を取得します。

zohoprojects.metadata().then(function(response)
  {
       /* output
  {
        'data': {
        'configs': [
             {
             'name': 'Name',
             'type': 'text',
             'is_mandatory': true,
             'is_secure': false,
             'description': 'Enter your name',
             'value': 'Helen Collins'
               },
                {
                 'name': 'Employee ID',
                 'type': 'text',
                 'is_mandatory': true,
                 'is_secure': false,
                   'description': 'Enter your Emp. ID',
                   'value': 'EMP08'
                    }
                     ],
                    'payments_info': {
                     'edition': 'trial'
                     },
                     'status': 'success'
                      }
                     }
                    */
           });

context

現在の場所のタブ名と項目 ID を取得します。タブ名は「tasks」または「issues」で、項目 IDは、それぞれのタスクまたは課題の ID です。


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

ウィジェットの配置場所が「app_settings」「attachment_picker」「blueprint_during」「top_band」の場合、項目 ID は提供されません。

取得する

現在の場所におけるインスタンス、現在のユーザー、ポータル、プロジェクト、タスク、課題の詳細を取得します。


zohoprojects.get('task.id

').then(function(response)

{
/* output
 {
'data': 27092000000031080,
'status': 'success'
}
*/
});

取得するメソッドで使用できるキーは次のとおりです。

インスタンス

instances

現在のユーザー

current_user

ポータル

portal.trial_enabled
portal.settings
portal.gmt_time_zone
portal.project_count
portal.roles
portal.avail_user_count
portal.locale
portal.project_prefix
portal.available_projects
portal.max_user_count
portal.profile_id
portal.name
portal.id_string
portal.bug_plural
portal.plan
portal.bug_plan
portal.bug_singular  ポータル。初期設定
ポータル。拡張機能
portal.is_crm_partner
portal.is_display_projectprefix
portal.is_display_taskprefix
portal.is_new_plan
portal.layouts
portal.links

プロジェクト

project.is_strict
project.roles
project.bug_count
project.owner_id
project.taskbug_prefix
project.links
project.description
project.milestone_count
project.updated_date_long
project.task_count
project.updated_date_format
project.workspace_id
project.billing_status
project.key
project.is_chat_enabled
project.owner_name
project.profile_id
project.enabled_tabs
project.name
project.is_public
project.layout_details
project.status
project.permissions
project.IS_BUG_ENABLED
project.bug_defaultview 
project.bug_prefix
project.cascade_setting
project.completed_on
project.completed_on_long
project.created_date
project.created_date_format
project.created_date_long 
project.custom_status_id
 project.id_string
project.show_project_overview 
project.start_date 
project.start_date_long
project.updated_date 
project.users
project.custom_fields_ja
project.custom_fields

タスク

タスク.name
task.completed
タスク.created_by
タスク.priority
タスク.percent_complete
タスク.start_date
タスク.end_date
タスク.dependency
タスク.duration
タスク.description
タスク.link
タスク.created_person
タスク.created_time
タスク.created_time_format
タスク.created_time_long 
タスク.custom_fields
タスク.depth (サブタスクにのみ適用)
タスク.duration_type 
タスク.id_string
タスク.is_comment_added 
タスク.is_forum_associated 
タスク.is_recurrence_set 
タスク.is_reminder_set
タスク.isparent タスク.key 
タスク.last_updated_time
タスク.last_updated_time_format 
タスク.last_updated_time_long
タスク.milestone_id 
タスク.order_sequence
タスク.parent_task_id (サブタスクにのみ適用)
タスク.parenttask_id (サブタスクにのみ適用)
タスク.root_task_id (サブタスクにのみ適用)
タスク.status
タスク.task_followers
タスク.tasklist
タスク.work タスク.work_type
task.comments
タスク.subtasks 
タスク.custom_fields
タスク.attachments

Issue

issue.tab
issue.created_time_long
issue.custom_fields
issue.status
issue.reproducible
issue.link
issue.severity
issue.reported_person
issue.subject
issue.flag
issue.assignee_name
issue.reporter_id
issue.classification
issue.created_time_format
issue.completed
issue.created_time
issue.key
issue.attachment_count
 issue.bug_number
 issue.bug_prefix 
issue.comment_count
 issue.escalation_level
 issue.id_string 
issue.reporter_email
 issue.reporter_non_zuser
 issue.updated_time
 issue.updated_time_format
 issue.updated_time_long
issue.attachments
issue.comments
issue.views

Milestone

milestone.completed
milestone.comments_count
milestone.created_time
milestone.created_time_format
milestone.created_time_long
milestone.end_date
milestone.end_date_format
milestone.end_date_long
milestone.flag
milestone.has_comments
milestone.id
milestone.id_string
milestone.is_workfield_removed
milestone.last_updated_time
milestone.last_updated_time_format
milestone.last_updated_time_long
milestone.link
milestone.name
milestone.owner_id
milestone.owner_name
milestone.owner_zpuid
milestone.project
milestone.sequence
milestone.start_date
milestone.start_date_format
milestone.start_date_long
milestone.status
milestone.status_det

Chosen files

アップロード待ちキューに含まれるファイルは、chosen_files に保存されます。このキーは添付ファイルピッカーでのみサポートされます。

chosen_files

Deployment 種類

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

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

権限

ポータルレベルのすべての権限と、現在のユーザーの権限詳細を取得するためのキーを用意しています。

all_profiles: ポータル内のすべての権限情報を取得します。
current_profile: 現在のユーザーの権限詳細を取得します。

Theme

Zoho プロジェクトでは、ポータル用のテーマをサポートしています。

current_theme: 現在のテーマを取得します。

zohoprojects.get('current_theme').then(function() {
 /* output
{mode: 'default', zpPrimary: '255, 100, 0', zpPrimaryHover: '255, 247, 243'}
 */
 });

Blueprint During

blueprint_during: During アクションで設定された値を取得します。

zohoprojects.get('blueprint_during').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}]
 */
});

Transition

現在のトランジションの詳細を取得します。

transition: 現在のトランジションの ID と名前を取得します。
blueprint : ブループリントの ID と名前を取得します。

set

現在のコンテキスト内の特定のタスクまたは課題の属性を更新します。


var nameObj={name:'Create a new checklist'};
zohoprojects.set('task',nameObj).then(function(response)
  {
    /* output
   {
   'data': {
   'tasks': [
     {
      'milestone_id': '2*******************2',
       'link': {
       'timesheet': {
          'url': 'https://p*************e.********.com/restapi/portal/5******7/projects/2****************9/tasks/2****************9/logs/'
         },
         'self': {
           'url': 'https://p*************e.********.com/restapi/portal/5******7/projects/2****************9/tasks/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': 'Expense Amount',
'value': '24573'
},
{
'column_name': 'UDF_LONG3',
'label_name': 'sample',
'value': '0'
},
{
'column_name': 'UDF_LONG2',
'label_name': 'test',
'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': 'Create a new checklist',
'id_string': '2************9',
='last_updated_time_format': '11-14-2018 04:28:17 PM',
'tasklist': {
'name': 'General',
'id': '2************7'
},
'order_sequence': 1,
'status': {
'name': 'Open',
'id': '2************1',
'type': 'open',
'color_code': ''
}
}
]
},
'status': 'success'
}
*/
});

タスクの set メソッドでは、次のキーを使用できます。

タスク

person_responsible
owner_work
work_type
名前
start_date
end_date
start_time
end_time
percent_complete
期間
duration_type
リマインダー
優先度
説明
custom_fields (このキーはカスタム項目を作成する場合にのみ使用できます。)
clear_date
index
range
json_string
subtasks (このキーはサブタスクを作成する場合にのみ使用できます。サブタスクのパラメーターについてはこちらをクリックしてください。)

以下のキーは、課題に対する set メソッドで使用できます。

Issues

件名
説明
担当者
flag
classification_id
milestone_id
due_date
module_id
severity_id
reproducible_id
status_id
resolution
affectedmile_id

以下のキーは、プロジェクトを更新するための set メソッドで使用できます。

プロジェクト

名前
説明
ステータス
start_date
end_date
strict_project
公開する
group_id
completed_on
UDF_CHAR([1-9]|[1-2][0-9]|30). 例: UDF_CHAR1
UDF_TEXT([1-9]|1[0-5])
UDF_LONG([1-9]|1[0-5])
UDF_USER[1-5]
UDF_DOUBLE([1-9]|[1-2][0-9]|3[0-5])
UDF_DATE[1-5]
UDF_ENCRYPT([1-9]|10)
担当者
billing_method
bill_status
show_project_overview
custom_status

プロジェクトマイルストーンを更新するための set メソッドでは、次のキーを使用できます。

Milestone

名前
start_date
end_date
担当者
flag
予算
threshold
revenue_budge

リンク files

linkfiles キーを使用して、ファイルを任意の場所に関連付けます。このキーは、次の場所をサポートします: タスク詳細タブ、Issue 詳細タブ、添付ファイル picker。配列の最大サイズは 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&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) {
  /* 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/folders/1e1xWqREV'
}, {
'名前': 'アプリ名',
'値': 'G- Drive'
}
]
      
zohoprojects。set('実行する', paramObj);

request

plugin-manifest.json ファイルで定義された接続を使用して、拡張機能からサードパーティの URL を呼び出します。外部連携のリンク名を指定しない場合、レスポンスは入力内容に基づいて返されます。


var file = document.getElementById('inputbox').files[0];
var file_detail = {
type: 'GET',
files: [{
uploaddoc : file
type : 'binary' //If the file is uploaded as 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)
 /* Output
 { 
'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'
}
*/});

Argument 名前	データの種類	説明
URL	string	拡張機能から呼び出すサードパーティのURL。
object	JSONObject	キー	データの種類	値
		種類	string	'GET' / 'POST' / 'PUT' / 'DELETE' / 'PATCH'
		パラメーター	JSONObject	APIのリクエストパラメーター。
		ヘッダー	JSONObject	APIのヘッダー。
		本文	JSONObject	APIの本文。
		files	JSONArray	ファイルをアップロードするためのパラメーター。値: 実際のファイル。実際のファイルがアップロードされる場合、本文は無視されます。種類をbinaryと指定した場合、ファイルはバイナリとして送信されます。この場合、ファイルの本文も考慮されます。
		replace_secure_config	Boolean	plugin-manifest.json ファイルの is_secure パラメーターが true の場合、このパラメーターの値を true に設定します。 URL と object パラメーターの値は、次の形式で渡すことができます: {{名前}} （設定名） Zoho Projects は設定値を置き換えます。メモ: 既定値は false です。
connection_link_name	string	外部連携のリンク名。zapps Web サイトで作成済みのものを指定します。外部連携のリンク名は、plugin-manifest から取得できます。

関数の実行

トリガーなしで Sigma 内のカスタム関数を実行します。関数を実行するには、function_uuid とそのバージョンを指定する必要があります。

let customData = {'名前':'新しいチェックリストを作成'};
zohoprojects。function。実行する('c8a9e660-95e2-11ef-9d3c-2d653cc724d7', '1。0', customData).then(function(response){
/* 出力
{ 'result':{'output':'{}','タスク':[],'outputType':'無効','メッセージ':{}},
'unique_id':'c8a9e660-95e2-11ef-9d3c-2d653cc724d7',
'コード':3009,
'function_id':1234567890,
'メッセージ':'Function Executed Successfully',
'ステータス':'完了'
}
*/
});

カスタムデータを取得するには、次の構文を使用します:

metaData = data。getJSON('パラメーター').getJSON('metadata').toMap();

データの内容 = metaData。getJSON('custom_data');

JS SDKの概要

JS SDKの概要

前提条件

init

metadata

context

取得する

インスタンス

現在のユーザー

ポータル

プロジェクト

タスク

Issue

Milestone

Chosen files

Deployment 種類

権限

Theme

Blueprint During

Transition

set

タスク

Issues

プロジェクト

Milestone

リンク files

Blueprint During

エクスポートする 場所

request

関数の実行

エクスポートする場所