​

はじめに

• 必要な許可
• コードエンジンにアクセスする
• ホームページ
  • コードエンジンリポジトリリスト
• カスタムパッケージを作成する
  • 新しいパッケージバージョンを作成する
  • コードエディター
    • パッケージ情報/アクションバー
    • 権限
    • サイドナビゲーション
    • 関数設定
    • パッケージ情報

• 関数をテストする

• コードエンジンライブラリー
  • codeengine.sendRequest
  • codeengine.getAccount
  • codeengine.axios

​

必要な許可

• コードエンジンのパッケージを管理 — インスタンス内の任意のコードエンジンパッケージに対して任意のアクションを実行できます。この許可は、管理者またはコードエンジンの管理を手伝うすべてのユーザーに付与する必要があります。
• コードエンジンのパッケージを作成 — 新しいコードエンジンパッケージを作成できます。この許可は、インスタンス内のコードエンジンリポジトリに新しい関数パッケージを作成して追加する必要があるすべてのユーザーに付与する必要があります。
  注記： インスタンスに対してこれらの許可のいずれかを有効にする場合は、Domoアカウントチームにお問い合わせください。非インスタンス管理者ユーザーに付与できる権限については、この記事の「 権限 」セクションを参照してください。

​

コードエンジンにアクセスする

左側のナビゲーションで、 ［コードエンジン］ を選択します。

​

ホームページ

​

コードエンジンリポジトリリスト

• ［パッケージ名］/［説明］ — パッケージのタイトルと簡単な説明が表示されます。
• ［所有者］ — パッケージの作成者/所有者の名前とアバターが表示されます。
• ［実行時間］ — パッケージの実行時間（またはプログラム言語）が表示されます。
• ［最終保存］ — パッケージが最後に更新された日付が表示されます。
• ［作成］ — パッケージが作成された日付が表示されます。

​

カスタムパッケージを作成する

1. ［+新しいパッケージ］ を選択します。 このオプションが無効になっている場合は、 必要な許可 を持っていることを確認してください。許可を持っているにもかかわらず、新しいパッケージを作成できない場合は、Domoアカウントチームまたは Domoサポート にお問い合わせください。
   
   ［新しいパッケージを作成］ モーダルが表示されます。
   
2. （必須） ［パッケージ名］ および ［パッケージの説明］ フィールド に入力します。
3. （必須） ［言語を選択］ ドロップダウンからオプションを選択します。オプションは［JavaScript］と［Python］です。
   
4. （オプション）サムネイルをアップロードして、パッケージを見分けやすくすることができます。
   
5. ［新しいパッケージを作成］ を選択すると、 コードエディター にパッケージが表示され、 ［キャンセル］ を選択すると、ホームページに戻ります。

​

新しいパッケージバージョンを作成する

1. コードエディタでパッケージを開きます。
2. ［展開］

［新しいバージョンを作成］ を選択すると、新しいバージョンモーダルが表示されます。

3. ［コピー元のバージョン：］ ドロップダウンでパッケージの対象のバージョンを選択して、そのすべてのコンテンツを新しいバージョンにコピーします。これには、構文、変数、およびメタデータが含まれます。

4. ［バージョン］ フィールドに、「セマンティックバージョニング」に従って、必要なバージョン番号を入力します（公式の 仕様 を参照してください）。このフィールドにはデフォルトの値が含まれますが、変更することもできます。
   
5. （オプション） ［バージョンの説明］ フィールドに詳細を入力します。
6. ［新しいバージョンを作成］ を選択して変更を保存し、新しいバージョンのパッケージを作成します。 新しいバージョンがパッケージのデフォルトバージョンになりますが、以前のバージョンにアクセスする場合は、コードエディターでパッケージを開き、 バージョンリスト から別のバージョンを選択できます。

​

コードエディター

​

パッケージ情報/アクションバー

• 戻る矢印 — コードエンジン ホームページ にリダイレクトされます。
• パッケージのサムネイル — パッケージに関連付けられた画像。
• パッケージタイトル/説明 — パッケージの作成時にパッケージに指定されたタイトルと説明。
• 最終保存 — パッケージバージョンが最後に保存された日付。
• 実行時間/言語 — スクリプトの記述に使用されたプログラミング言語。
• 所有者のサムネイル — パッケージ所有者のアバター。
• ［シェア］ボタン — 権限 モーダルを開きます。
• ［ダークモード］トグル — コードエディターのダークモードを有効/無効にします。
• バージョンリスト — 表示/編集するパッケージのバージョンを選択できます。
• 保存 — コードの構文と変数が有効な場合は、パッケージへの変更を保存できます。
• 保存オプション — パッケージには、以下のオプションがあります。
  • ［新しいバージョンを作成］ — ［新しいバージョンを作成］ モーダルを開きます。詳細については、「 新しいパッケージバージョンを作成する 」を参照してください。
  • ［現在のパッケージを削除］ — パッケージを完全に削除します。
  • ［現在のバージョンを削除］ — バージョンを完全に削除します。
  • ［保存してデプロイ］ — コード構文と変数が有効な場合は、変更が保存され、新しいバージョンのパッケージが展開されます。これにより、展開されたバージョンの編集が無効になり、ワークフローなどのほかのDomo機能で使用できるようになります。
    

​

権限

• 管理者 — ユーザーがパッケージで任意のアクションを実行できるようにします。この権限は、インスタンス内のすべてのパッケージへのアクセス権がある 「コードエンジンのパッケージを管理」の許可 とは異なります。
• 削除 — パッケージまたはパッケージのバージョンを削除できます。
• 読み込む — パッケージのメタデータとそのバージョンへの閲覧専用のアクセス権を許可します。
• 書き込む — パッケージを編集できます。
• シェア — 別のユーザーに同等またはそれ以下のパッケージへのアクセス権を付与できます。
• 実行 — パッケージ内の関数を実行できます。
• コンテンツを読み込む — パッケージのコードコンテンツ、そのバージョンへの閲覧専用のアクセス権を許可します。
• コンテンツを更新 — パッケージのコードコンテンツとメタデータ、そのバージョンを編集できます。

1. パッケージ情報/アクションバーで ［シェア］ を選択すると、権限モーダルが表示されます。
   
   権限モーダルには、検索バー、パッケージへの ［アクセス権のあるユーザー］ のリスト、パッケージへの［アクセス権のないユーザー］ のリストが含まれます。デフォルトでは、パッケージの所有者は常にパッケージに対して管理者権限を持っています。
2. 権限を編集するユーザーまたはグループの名前を検索バーに入力します。インスタンス内でユーザーまたはグループが見つかった場合は、アクセス権のないユーザーのリストの一番上にその名前が表示されます。権限メニューがユーザー名またはグループ名の横に表示されます。デフォルトの権限は［アクセス権がありません］です。
3. ユーザーまたはグループに付与する権限を選択します。
4. ［保存］ を選択して変更を保存します。

​

サイドナビゲーション

• 関数設定
• パッケージ情報

​

関数設定

入力変数と戻り値のタイプ

• アカウント（このデータタイプの処理は若干異なります。後述の「 ［アカウント］データタイプ 」を参照してください）
• ブール型
• DataSet
• 日付
• 日時
• 小数
• 期間
• グループ
• 数値
• オブジェクト
• ユーザー
• テキスト
• 時間

パラメーターの高度な編集

［アカウント］データタイプ

［リスト］タイプ

［オブジェクト］タイプ

• ［オープン］ — オープンオブジェクトには任意のタイプのデータを格納できますが、オブジェクトに格納されるデータは明示的に定義されません。これは、複雑なデータを返すAPIを操作する場合に便利です。
• ［定義されたオブジェクト］ — 定義されたオブジェクトの場合は、モーダルで ［子プロパティを追加］ を選択してオブジェクトの子プロパティを定義します。
  
  子プロパティを追加すると、オブジェクトの子プロパティごとに行が開きます。ここでは、オブジェクトの各子プロパティのパラメーターの名前とデータタイプを定義できます。 例えば、州、都市、番地（これらはすべてテキストタイプ）、郵便番号（数値タイプ）の子プロパティを持つ住所オブジェクトを作成できます。
  

​

パッケージ情報

• ［名前］ — 関数名。
• ［作成］ — パッケージバージョンが作成された日付。
• ［最終導入］ — パッケージバージョンが展開された日付。
• ［言語］ — スクリプトを記述するプログラミング言語。
• ［所有者］ — パッケージ所有者の名前とアバター。
• ［説明］ — パッケージの簡単な説明。

​

関数をテストする

​

必要条件

コードエディタで ［関数を開始］ を選択して、開始モーダルを開きます。

注記： デフォルト値を永続的に変更する場合は、サイドナビゲーションの ［関数設定］ セクションでその変数の > ［高度な編集］ を選択する必要があります。

​

コードエンジンライブラリー

​

codeengine.sendRequest

const codeengine = require("codeengine"); /** * Retrieves the metadata for the specified dataset. * * @param dataSetId string The dataset id * @returns {} The dataset metadata */ function getDataSetMetadata(dataSetId) { const url = `api/data/v3/datasources/${dataSetId}?part=core,permission,status,pdp,rowcolcount,certification,functions`; return codeengine.sendRequest("get", url).catch(console.error); }

​

codeengine.getAccount

const codeengine = require("codeengine");  
  
function accountExample(twilioAccount) {  
const account = await codeengine.getAccount(twilioAccount.id);  
const {accountSID, password} = account.properties;  
}

const codeengine = require("codeengine");  
  
async function sendSMS(twilioAccount, to, from, body) {  
// get the account by account id  
const account = await codeengine.getAccount(twilioAccount.id);  
// access the properties of the account. These will vary from account type so it's   
// important to check what is returned. In this case it's `accountSID` and `password`  
const {accountSID, password} = account.properties;  
  
const url = `https://api.twilio.com/2010-04-  
01/Accounts/${accountSID}/Messages.json?To+${to}&From=${from}&Body=${encodeURIC  
omponent(body)}`;  
  
const apiBody = {  
To: to,  
From: from,  
Body: body,  
};  
  
const requestOptions = {  
headers: {  
'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8',  
Authorization:  
'Basic' + Buffer.from(`${accountSID}:${password}`).toString('base64'),  
},  
};  
  
try {  
await axios.post(url, apiBody, requestOptions)';  
  
return true;  
} catch (error) {  
console.error(error);  
throw error;  
}  
}

​

codeengine.axios

const codeengine = require(“codeengine”); async function sendTwilioSms(to, from, body) { const account = await codeengine.getAccount(“Twilio”).then(a => { return a.properties; }); const url = `https://api.twilio.com/2010-04-01/Accounts/${account.properties.SID}/Messages.json`; const data = new URLSearchParams(); data.append(‘To’, to); data.append(‘From’, from); data.append(‘Body’, body); const requestOptions = { method: ‘POST’, headers: { ‘Content-Type’: ‘application/x-www-form-urlencoded;charset=utf-8’, ‘Authorization’: ‘Basic ‘ + Buffer.from(`${SID}:${TOKEN}`).toString(‘base64’) }, data }; try { const response = await codeengine.axios(url, requestOptions); const jsonResponse = await response.data; if (response.ok) { console.log('SMS sent successfully:', jsonResponse); return jsonResponse; } else { console.error('Error sending SMS:', jsonResponse); throw new Error(jsonResponse.message); } } catch (error) { console.error('Error:', error); throw error; } return jsonResponse; }