Class Logger

Logger

このクラスを使用すると、スクリプトが標準の Cloud プロジェクトに関連付けられている場合、デベロッパーは実行ログと Google Cloud Logging に書き込むことができます。このクラスは、Cloud Logging での構造化ロギングと jsonPayload サポートに適しています。時間ベースのロギングの場合は、console を使用します。

メソッド

メソッド戻り値の型概要
clear()voidログを消去します。
getLog()String現在のログ内のすべてのメッセージを返します。
log(data)Loggerデータをログに書き込みます。
log(format, values)Logger指定された形式と値を使用して、書式設定された文字列をロギング コンソールに書き込みます。

詳細なドキュメント

clear()

ログを消去します。

getLog()

現在のログ内のすべてのメッセージを返します。このメソッドを使用すると、スクリプト実行中に生成されたログ出力全体を保存またはメールで送信できます。

// Generate a log, then email it to the person who ran the script.
const files = DriveApp.getFiles();
while (files.hasNext()) {
  Logger.log(files.next().getName());
}
const recipient = Session.getActiveUser().getEmail();
const subject = 'A list of files in your Google Drive';
const body = Logger.getLog();
MailApp.sendEmail(recipient, subject, body);

戻る

String - Logging コンソールからのログ

log(data)

データをログに書き込みます。データは、文字列、JavaScript オブジェクト、または message プロパティを持つオブジェクトにできます。

Logger.log("my log message");
// Info   my logmessage
Logger.log({ key: "value" });
// Info   {key=value}
Logger.log({ message: "my log message", data: { key: "value" } })
// Info   my logmessage

オブジェクトを渡すときに、オブジェクトに message プロパティが含まれている場合、そのプロパティがログ メッセージとして使用されます。それ以外の場合、toString() メソッドが呼び出され、オブジェクトが文字列に変換されます。JSON シリアル化可能な他のすべてのプロパティは、次の例に示すように、LogEntry の jsonPayload の一部として含まれます。

{
  "insertId": "w5eib...",
  "jsonPayload": {
    "message": "my log message",
    "serviceContext": {
      "service": "AKfyc..."
    },
    "data": {
      "key": "value"
    }
  },
  "resource": {
    "type": "app_script_function",
    "labels": {
      "invocation_type": "editor",
      "function_name": "unknown",
      "project_id": "1234567890"
    }
  },
  "timestamp": "2024-11-15T23:28:19.448591Z",
  "severity": "INFO",
  "labels": {
    "script.googleapis.com/user_key": "AOX2d...",
    "script.googleapis.com/process_id": "EAEA1...",
    "script.googleapis.com/project_key": "MQXvl...",
    "script.googleapis.com/deployment_id": "AKfyc..."
  },
  "logName": "projects/[PROJECT_ID]/logs/script.googleapis.com%2Fconsole_logs",
  "receiveTimestamp": "2024-11-15T23:28:20.363790313Z"
}

パラメータ

名前型説明
dataObjectログに記録するオブジェクト

戻る

Logger - チェーン用の Logger。

log(format, values)

指定された形式と値を使用して、書式設定された文字列をロギング コンソールに書き込みます。文字列には複数の %s プレースホルダを含めることができます。これらのプレースホルダは、引数のリストから対応する値に置き換えられ、文字列に変換されます。

// Log the number of Google Groups you belong to.
const groups = GroupsApp.getGroups();
Logger.log('You are a member of %s Google Groups.', groups.length);

パラメータ

名前型説明
formatStringvalues 引数の数と同じ数の %s インスタンスを含む書式文字列
valuesObject...形式文字列に挿入する値（変数の数）

戻る

Logger - チェーン用の Logger