Essa classe permite que o desenvolvedor grave no registro de execução e no Google Cloud Logging se o script estiver associado a um projeto
padrão do Cloud. Essa classe é a preferida para registro estruturado e suporte a jsonPayload
no Cloud Logging. Para registros baseados em tempo, use console
.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
clear() | void | Limpa o registro. |
getLog() | String | Retorna uma lista completa de mensagens no registro atual. |
log(data) | Logger | Grava os dados no registro. |
log(format, values) | Logger | Grava uma string formatada no console de registro usando o formato e os valores fornecidos. |
Documentação detalhada
clear()
Limpa o registro.
getLog()
Retorna uma lista completa de mensagens no registro atual. Esse método pode ser usado para salvar ou enviar por e-mail toda a saída de registro gerada durante a execução do script.
// 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);
Retornar
String
: o registro do console de registro
log(data)
Grava os dados no registro. Os dados podem ser uma string, um objeto JavaScript ou um objeto com uma propriedade 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
Ao transmitir um objeto, se ele contiver uma propriedade message
, essa propriedade será
usada como a mensagem de registro. Caso contrário, o método toString()
é chamado para converter o
objeto em uma string. Todas as outras propriedades que são serializáveis em JSON são incluídas como parte de
jsonPayload
no LogEntry
, semelhante ao exemplo abaixo:
{ "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" }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
data | Object | o objeto a ser registrado |
Retornar
Logger
: o registrador para encadeamento.
log(format, values)
Grava uma string formatada no console de registro usando o formato e os valores fornecidos. A
string pode incluir vários marcadores de posição %s
, que são substituídos por valores
correspondentes da lista de argumentos, convertidos em strings.
// 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);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
format | String | uma string de formato que contém tantas instâncias de %s quanto o número de
argumentos values |
values | Object... | um número variável de valores a serem inseridos na string de formatação |
Retornar
Logger
: o Logger, para encadeamento