Garoon API ドキュメント

カスタム項目（Schedule datastore）の値をセットする

目次

カスタム項目（Schedule datastore）の値をセットする

現在開いている予定のカスタム項目（Schedule datastore）をセットします。

関数

garoon.schedule.event.datastore.set(customizeName, value)

利用できるGaroonバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 5.9 以降

引数

引数 型 必須 説明
customizeName 文字列 必須 取得するカスタム項目のカスタマイズ名
128 文字以下で指定してください。
命名規則については、 カスタム項目（Schedule datastore) の命名規則 を確認してください。
value オブジェクト 必須 カスタム項目に保存する設定
キーと値を対にしたオブジェクトの形式で指定します。
80,000 文字以下で指定してください。
例：
{
  value: {
    key1: 'value1',
    key2: {key2.1: 'value2.1'},
    key3: ['value3']
  }
};

戻り値

Schedule datastore のデータを表す garoon.Promise オブジェクト が返ります。

利用できる画面

次の画面の通常予定、期間予定、繰り返し予定で利用できます。

  • 予定の登録画面または再利用画面 *1
  • 予定の変更画面 *1

*1

次のイベントでは、この API は実行できません。

^

カスタム項目（Schedule datastore) の命名規則

  • カスタム項目（Schedule datastore）のキー名で使用できる文字は、半角英数と「.（ドット）」のみです。

  • キー名には、128 文字以下の文字列を指定できます。

  • キー名が他のカスタマイズやプラグインと重複すると、他のカスタム項目の値が上書きされます。
    次の規則にしたがって、キー名を命名してください。

    1. 自社のドメイン名を反対から記述します。
      たとえば、自社のドメインが「cybozu.co.jp」の場合は、次のとおりです。

      1

      jp.co.cybozu

      ドメイン名にキー名として使用できない文字が含まれている場合は、その文字を取り除いてつなげてください。 たとえば、自社のドメインが「cybozu-demo.example.com」の場合の、キー名は次のとおりです。

      1

      com.example.cybozudemo

    2. 1. の末尾にアプリケーション名（schedule）とカスタマイズ名をつなげます。
      たとえば、カスタマイズ名が「sample」の場合は、次のとおりです。

      1

      jp.co.cybozu.schedule.sample

制限事項

  • 1 つの予定に登録できる customizeName は 10 個までです。