スタンドアロン関数の実行

スタンドアロン関数の実行

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

スタンドアロン関数を使用すると、外部パラメーターに基づいてデータを処理できます。Zoho Sprintsでは、関数を作成し、REST APIを使用して実行することで、業務上の課題をシンプルに解決できます。これらの関数は、外部サービスやWebから呼び出すことができます。

スタンドアロン関数を実行するには、実行スケジュールを作成する方法と、APIを使用する方法の2つがあります。

シナリオ1：スケジュールによる実行

情報
管理者として、期限を過ぎた作業項目についてユーザーに通知する必要があるとします。この場合、期限を過ぎた作業項目の一覧ファイルを添付したリマインダーメールを毎週送信するスタンドアロン関数を作成できます。この関数を定期的に実行するために、毎週繰り返すスケジュールを設定できます。一度スクリプトを作成するだけで、重要な業務プロセスを自動化できます。

シナリオ2：APIによる実行

情報
Zoho CRMから関数を呼び出す場合を考えてみましょう。CRMに新しい見込み客を追加するときに、対応する作業項目をZoho Sprintsに作成したいとします。これを実現するには、作業項目の各項目をカスタムパラメーターとして渡す必要があります。

スタンドアロン関数の作成

スタンドアロン関数を作成するには：
  1. 右上の歯車アイコンをクリックします。設定画面が表示されます。
  2. ［自動化］の［カスタム関数］を選択します。
  3. ［関数］ボタンのドロップダウンをクリックします。
  4. ［関数］を選択します。カスタム関数の作成画面が表示されます。
  5. ［表示名］を入力します。
  6. ［関数名］を入力します。
    メモ：一般的な命名規則に従い、関数名にスペースは使用できません。
  7. ［カテゴリー］で［スタンドアロン］を選択します。
  8. ［繰り返しの種類］を選択して、関数を実行する頻度を指定します。
  9. 繰り返しの種類に応じて、スケジュールの詳細を入力します。
  10. 関数の［説明］を入力します。
  11. Delugeスクリプトビルダーを使用して、関数のスクリプトを記述します。
  12. ［保存］をクリックして関数の作成を完了するか、［保存して実行］をクリックして関数の作成を完了し、実行します。
 

APIを使用した関数の実行

APIを使用すると、関数の一意のIDを指定してリモートで実行できます。

情報
https://sprintsapi.zoho.com/zsapi/team/{teamId}/customfunction/{functionId}/execute/?arguments={'parameters':{'key1':'value1','key2':'value2', ....最大25個のパラメーター }}

パラメーターへのアクセス

スタンドアロン関数にはカスタムパラメーターを渡すことができます。パラメーターとは、関数に渡す値のことです。この値を関数に渡すことで、必要な応答や出力を取得できます。パラメーターは、キーと値のペアの形式で指定します。

情報
Delugeでパラメーター「key1」にアクセスするには、value = sprintsAPIRequestMap.toMap().get('params').toMap().get('key1'); と入力します。
 
メモ
メモ：
  1. ステータスコードをカスタマイズし、要求にカスタムヘッダーを含めて送信できます。
  2. 最大25個のパラメーターを入力できます。
 

応答オブジェクトの定義

APIの応答形式を定義します。関数の戻り値がnullの場合、既定の応答形式はJSONです。ただし、Sprintsのスタンドアロン関数はXML、HTML、書式なしテキストなどの形式にも対応しており、これらを使用するにはオブジェクトをマッピングする必要があります。既定の応答形式を変更するには、応答形式のデータをマップ内の「sprintsAPIResponse」キーに設定します。