Skip to main content
Acessar Studio

Google Sheets

O módulo Google Sheets é responsável por ações que integram a ferramenta Google Sheets. Seus métodos podem ser acessados conforme o exemplo abaixo:

const sheetsConnection = await API.Google.Sheets.Connection["v1_0_0"]({
  connectionId: "id-da-conexao-configurada-no-workspace",
});

Métodos​

Connection​

Método responsável por estabelecer uma conexão com o Google Sheets a partir de uma conexão configurada no workspace.

const sheetsConnection = await API.Google.Sheets.Connection["v1_0_0"]({
  connectionId: "id-da-conexao-configurada-no-workspace",
});

Parâmetros obrigatórios​

  • connectionId:String - espera o ID da conexão do Google configurada no workspace (Workspace → Conexões).

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Retorna a instância de conexão autenticada com o Google Sheets (uma instância do client sheets_v4.Sheets do SDK googleapis), que deve ser armazenada em uma variável (ex.: sheetsConnection) e reutilizada como parâmetro sheetsConnection nos demais métodos deste módulo.

Spreadsheets.Create​

Método responsável por criar uma nova planilha do Google Sheets.

const createSpreadsheetResult = await API.Google.Sheets.Spreadsheets.Create["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  title: "Minha planilha",
  sheets: [
    { properties: { title: "Aba2" } },
  ],
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • title:String - espera o título que a nova planilha terá.

Parâmetros opcionais​

  • sheets:Array - espera uma lista de objetos de aba (no formato Schema$Sheet da API do Google) a serem criados além da aba padrão. Cada item aceita ao menos properties.title:String, e opcionalmente properties.hidden:Boolean, properties.index:Number e properties.gridProperties:Object (com rowCount:Number, columnCount:Number e frozenRowCount:Number). Quando não informado, a planilha é criada apenas com a aba padrão.

Retorno​

actions.createSpreadsheetResult.spreadsheetId // ID da planilha recém criada (String)
actions.createSpreadsheetResult.spreadsheetUrl // URL da planilha recém criada (String)
actions.createSpreadsheetResult.title // Título da planilha recém criada (String)

Spreadsheets.Get​

Método responsável por obter os metadados de uma planilha através do seu ID.

const spreadsheetResult = await API.Google.Sheets.Spreadsheets.Get["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha a ser obtida.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.spreadsheetResult.spreadsheetId // ID da planilha obtida (String)
actions.spreadsheetResult.title // Título da planilha obtida (String)
actions.spreadsheetResult.spreadsheetUrl // URL da planilha obtida (String)
actions.spreadsheetResult.sheets // Lista com o sheetId, title e index de cada aba da planilha (Array)

Sheets.Create​

Método responsável por adicionar uma nova aba a uma planilha existente.

const createSheetResult = await API.Google.Sheets.Sheets.Create["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  title: "Aba1",
  index: 0,
  rowCount: 1000,
  columnCount: 26,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha onde a nova aba será criada.
  • title:String - espera o título da nova aba.

Parâmetros opcionais​

  • index:Number - espera a posição (index) em que a nova aba deve ser inserida entre as demais abas da planilha.
  • rowCount:Number - espera a quantidade de linhas da nova aba.
  • columnCount:Number - espera a quantidade de colunas da nova aba.

Retorno​

actions.createSheetResult.sheetId // ID da aba recém criada (Number)
actions.createSheetResult.title // Título da aba recém criada (String)
actions.createSheetResult.index // Posição (index) da aba recém criada (Number)

Sheets.Get​

Método responsável por obter os metadados de uma aba através do seu ID ou título.

const sheetResult = await API.Google.Sheets.Sheets.Get["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  title: "Aba1",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha onde está a aba desejada.

Parâmetros opcionais​

  • sheetId:Number - espera o ID numérico da aba a ser obtida.
  • title:String - espera o título da aba a ser obtida.

É obrigatório informar ao menos um dos dois campos acima (sheetId ou title) para localizar a aba; se ambos forem informados, sheetId tem prioridade na busca.

Retorno​

actions.sheetResult.sheetId // ID da aba obtida (Number)
actions.sheetResult.title // Título da aba obtida (String)
actions.sheetResult.index // Posição (index) da aba obtida (Number)
actions.sheetResult.rowCount // Quantidade de linhas da aba obtida (Number)
actions.sheetResult.columnCount // Quantidade de colunas da aba obtida (Number)

Sheets.Delete​

Método responsável por excluir uma aba de uma planilha.

await API.Google.Sheets.Sheets.Delete["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha que contém a aba a ser excluída.
  • sheet:String|Number - espera o nome ou o ID numérico da aba a ser excluída.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

Sheets.DeleteRowsOrColumns​

Método responsável por excluir um intervalo de linhas ou colunas de uma aba.

await API.Google.Sheets.Sheets.DeleteRowsOrColumns["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  toDelete: "ROWS",
  startIndex: 2,
  amount: 3,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha que contém a aba.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • toDelete:String - espera "ROWS" ou "COLUMNS", indicando o que será excluído.
  • startIndex:Number - espera a posição inicial da linha ou coluna a partir da qual a exclusão começará, considerando 1 como a primeira linha (ou coluna) da aba.

Parâmetros opcionais​

  • amount:Number - espera quantas linhas ou colunas, a partir da posição inicial, devem ser excluídas. Quando não informado, o padrão é 1.

Retorno​

Este método não possui retorno.

Values.Get​

Método responsável por obter os valores de um intervalo de células.

const valuesResult = await API.Google.Sheets.Values.Get["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  range: "Página1!A1:D10",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • range:String - espera a notação A1 do intervalo a ser lido (ex.: Página1!A1:D10). Para obter todos os valores de uma aba, informe apenas o nome dela (ex.: Página1).

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.valuesResult.range // notação A1 do intervalo que foi lido (String)
actions.valuesResult.values // valores do intervalo de células, como uma lista de linhas (Array)

Values.Update​

Método responsável por atualizar os valores de um intervalo de células.

const updateValuesResult = await API.Google.Sheets.Values.Update["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  range: "Página1!A1:B2",
  values: [
    ["Nome", "Email"],
    ["João", "joao@email.com"],
  ],
  valueInputOption: "USER_ENTERED",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • range:String - espera a notação A1 do intervalo a ser atualizado (ex.: Página1!A1:D10).
  • values:Array - espera uma lista de linhas, onde cada linha é uma lista de valores das colunas, a serem gravadas no intervalo informado.

Parâmetros opcionais​

  • valueInputOption:String - espera "USER_ENTERED" (fórmulas, datas etc. são interpretadas) ou "RAW" (sem interpretação). Quando não informado, o padrão é "USER_ENTERED".

Retorno​

actions.updateValuesResult.updatedRange // notação A1 do intervalo que foi atualizado (String)
actions.updateValuesResult.updatedRows // quantidade de linhas atualizadas (Number)
actions.updateValuesResult.updatedColumns // quantidade de colunas atualizadas (Number)
actions.updateValuesResult.updatedCells // quantidade de células atualizadas (Number)

Values.Clear​

Método responsável por limpar os valores de um intervalo de células.

const clearValuesResult = await API.Google.Sheets.Values.Clear["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  range: "Página1!A1:D10",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • range:String - espera a notação A1 do intervalo a ser limpo (ex.: Página1!A1:D10).

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.clearValuesResult.clearedRange // notação A1 do intervalo que foi limpo (String)

Rows.Append​

Método responsável por adicionar uma nova linha ao final de uma aba, relacionando os valores aos cabeçalhos das colunas.

const appendResult = await API.Google.Sheets.Rows.Append["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  values: {
    "Nome": "João",
    "Email": "joao@email.com",
  },
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • values:Object - espera um objeto relacionando o nome de cada coluna (conforme o cabeçalho da aba) ao valor desejado. Colunas do cabeçalho não informadas ficam em branco na nova linha.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.appendResult.rowNumber // número da linha adicionada (Number)
actions.appendResult.row // a linha adicionada, como objeto (Object)

Rows.Find​

Método responsável por encontrar as linhas em que uma coluna combina com um valor informado.

const findResult = await API.Google.Sheets.Rows.Find["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  column: "Email",
  value: "joao@email.com",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • column:String - espera o nome exato da coluna, como aparece no cabeçalho da aba.
  • value:Any - espera o valor a ser comparado com o conteúdo da coluna, para cada linha da aba.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Importante

Diferente da versão no-code (que exibe apenas a primeira linha encontrada), o retorno via código traz todas as linhas que combinam com o valor buscado, dentro de uma lista rows. A primeira ocorrência (menor número de linha) fica em rows[0].

actions.findResult.rows // lista de linhas encontradas, cada uma com rowNumber e row (Array)
actions.findResult.rows[0].rowNumber // número da primeira linha encontrada (Number)
actions.findResult.rows[0].row // a primeira linha encontrada, como objeto (Object)

Rows.Update​

Método responsável por encontrar a primeira linha em que uma coluna combina com um valor informado (ou uma linha por seu número) e atualizá-la.

const updateRowResult = await API.Google.Sheets.Rows.Update["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  by: "FILTER",
  column: "Email",
  value: "joao@email.com",
  values: {
    "Status": "Concluído",
  },
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • by:String - espera "FILTER" (localizar por coluna e valor) ou "ROW_NUMBER" (localizar por número da linha).
    • Quando by é "FILTER": os campos column:String e value:Any tornam-se obrigatórios, para localizar a primeira linha em que a coluna informada combina com o valor.
    • Quando by é "ROW_NUMBER": o campo rowNumber:Number torna-se obrigatório (valor mínimo 2, já que a linha 1 é o cabeçalho).
  • values:Object - espera um objeto relacionando o nome de cada coluna ao novo valor a ser gravado na linha localizada. Colunas não informadas mantêm o valor atual.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.updateRowResult.rowNumber // número da linha atualizada (Number)
actions.updateRowResult.row // a linha após a atualização, como objeto (Object)

Tables.Create​

Método responsável por criar uma tabela (intervalo nomeado) em uma aba, a partir de uma linha de cabeçalho.

const createTableResult = await API.Google.Sheets.Tables.Create["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  name: "Clientes",
  headers: ["Nome", "Email"],
  startRow: 1,
  startColumn: 1,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha onde a tabela será criada.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • name:String - espera o nome que a tabela terá, usado para referenciá-la nas próximas ações.

Parâmetros opcionais​

  • headers:Array - espera uma lista de strings com os cabeçalhos das colunas. Quando não informado, o robô utiliza o que já estiver escrito na primeira linha do intervalo como cabeçalho da tabela.
  • startRow:Number - espera o número da linha, na aba, onde o cabeçalho da tabela começa. Quando não informado, o padrão é 1.
  • startColumn:Number - espera o número da coluna, na aba, onde a tabela começa. Quando não informado, o padrão é 1.

Retorno​

actions.createTableResult.tableId // ID da tabela recém criada (String)
actions.createTableResult.name // Nome da tabela recém criada (String)
actions.createTableResult.startRow // Primeira linha da tabela (Number)
actions.createTableResult.endRow // Última linha da tabela (Number)
actions.createTableResult.startColumn // Primeira coluna da tabela (Number)
actions.createTableResult.endColumn // Última coluna da tabela (Number)
actions.createTableResult.headers // Lista com os cabeçalhos das colunas da tabela (Array)

Tables.List​

Método responsável por listar as tabelas (intervalos nomeados) existentes em uma planilha.

const tablesResult = await API.Google.Sheets.Tables.List["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha cujas tabelas serão listadas.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.tablesResult.tables // lista de tabelas, cada uma com tableId, name, sheet, startRow, endRow, startColumn e endColumn (Array)

Os campos endRow e endColumn de cada item podem não ser retornados quando a tabela não tiver um limite de linhas ou colunas definido.

Tables.Rows.Append​

Método responsável por adicionar uma nova linha ao final de uma tabela, relacionando os valores aos cabeçalhos das colunas.

const appendTableRowResult = await API.Google.Sheets.Tables.Rows.Append["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  values: {
    "Nome": "João",
    "Email": "joao@email.com",
  },
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • tableName:String - espera o nome da tabela (intervalo nomeado).
  • values:Object - espera um objeto relacionando o nome de cada coluna (conforme o cabeçalho da tabela) ao valor desejado. Colunas do cabeçalho não informadas ficam em branco na nova linha.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.appendTableRowResult.rowNumber // número da linha recém adicionada (Number)
actions.appendTableRowResult.row // a linha adicionada, como objeto (Object)

Tables.Rows.Get​

Método responsável por obter uma linha da tabela através do seu número.

const tableRowResult = await API.Google.Sheets.Tables.Rows.Get["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  rowNumber: 2,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • tableName:String - espera o nome da tabela (intervalo nomeado).
  • rowNumber:Number - espera o número da linha a ser obtida, considerando a linha de cabeçalho da tabela como linha 1 (ex.: a primeira linha de dados é a linha 2).

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.tableRowResult.rowNumber // número da linha obtida (Number)
actions.tableRowResult.row // a linha obtida, como objeto (Object)

Tables.Rows.Update​

Método responsável por atualizar uma linha da tabela, localizada pelo número da linha ou por um filtro de coluna/valor.

const updateTableRowResult = await API.Google.Sheets.Tables.Rows.Update["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  by: "FILTER",
  column: "Email",
  value: "joao@email.com",
  values: {
    "Status": "Concluído",
  },
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • tableName:String - espera o nome da tabela (intervalo nomeado).
  • by:String - espera "FILTER" (localizar por coluna e valor) ou "ROW_NUMBER" (localizar por número da linha).
    • Quando by é "FILTER": os campos column:String e value:Any tornam-se obrigatórios.
    • Quando by é "ROW_NUMBER": o campo rowNumber:Number torna-se obrigatório (valor mínimo 1, considerando a linha de cabeçalho da tabela como 1).
  • values:Object - espera um objeto relacionando o nome de cada coluna ao novo valor a ser gravado na linha localizada. Colunas não informadas mantêm o valor atual.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.updateTableRowResult.rowNumber // número da linha atualizada (Number)
actions.updateTableRowResult.row // a linha após a atualização, como objeto (Object)

Tables.Rows.Delete​

Método responsável por excluir uma linha da tabela, localizada pelo número da linha ou por um filtro de coluna/valor.

const deleteTableRowResult = await API.Google.Sheets.Tables.Rows.Delete["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  by: "FILTER",
  column: "Email",
  value: "joao@email.com",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • tableName:String - espera o nome da tabela (intervalo nomeado).
  • by:String - espera "FILTER" (localizar por coluna e valor) ou "ROW_NUMBER" (localizar por número da linha).
    • Quando by é "FILTER": os campos column:String e value:Any tornam-se obrigatórios.
    • Quando by é "ROW_NUMBER": o campo rowNumber:Number torna-se obrigatório (valor mínimo 1, considerando a linha de cabeçalho da tabela como 1).

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.deleteTableRowResult.rowNumber // número da linha excluída (Number)

Tables.Columns.Add​

Método responsável por adicionar uma nova coluna a uma tabela.

const addColumnResult = await API.Google.Sheets.Tables.Columns.Add["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  name: "Telefone",
  index: 3,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha onde a tabela está localizada.
  • tableName:String - espera o nome da tabela à qual a nova coluna será adicionada.
  • name:String - espera o nome que a nova coluna terá.

Parâmetros opcionais​

  • index:Number - espera a posição em que a nova coluna deve ser inserida na tabela (base 1). Quando não informado, ou quando maior que a quantidade atual de colunas mais um, a coluna é adicionada ao final da tabela.

Retorno​

actions.addColumnResult.name // Nome da coluna recém adicionada (String)
actions.addColumnResult.index // Posição da coluna recém adicionada (Number)

Tables.Columns.Delete​

Método responsável por excluir uma coluna de uma tabela.

await API.Google.Sheets.Tables.Columns.Delete["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  name: "Telefone",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha onde a tabela está localizada.
  • tableName:String - espera o nome da tabela da qual a coluna será excluída.
  • name:String - espera o nome exato da coluna, como aparece no cabeçalho da tabela.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

Tables.Columns.Rename​

Método responsável por renomear uma coluna de uma tabela.

const renameColumnResult = await API.Google.Sheets.Tables.Columns.Rename["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  tableName: "Clientes",
  name: "Telefone",
  newName: "Celular",
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha onde a tabela está localizada.
  • tableName:String - espera o nome da tabela que contém a coluna a ser renomeada.
  • name:String - espera o nome exato da coluna atual, como aparece no cabeçalho da tabela.
  • newName:String - espera o novo nome que a coluna terá.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

actions.renameColumnResult.name // O novo nome da coluna (String)

StyleCells​

Método responsável por definir cor de fundo/texto, negrito, itálico, alinhamento e borda de um intervalo de células.

await API.Google.Sheets.StyleCells["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  startRow: 1,
  endRow: 1,
  startColumn: 1,
  endColumn: 4,
  backgroundColor: { red: 0.9, green: 0.9, blue: 0.9 },
  textColor: { red: 0, green: 0, blue: 0 },
  bold: true,
  italic: false,
  fontSize: 12,
  horizontalAlignment: "CENTER",
  verticalAlignment: "MIDDLE",
  border: {
    style: "SOLID",
    color: { red: 0, green: 0, blue: 0 },
  },
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.

Pelo menos uma das opções de estilo abaixo deve ser informada; caso contrário, o robô interrompe a execução com erro.

Parâmetros opcionais​

  • startRow:Number - primeira linha do intervalo a ser estilizado.
  • endRow:Number - última linha do intervalo a ser estilizado (incluída no intervalo).
  • startColumn:Number - primeira coluna do intervalo a ser estilizado (1 corresponde à coluna A).
  • endColumn:Number - última coluna do intervalo a ser estilizado (incluída no intervalo).
  • backgroundColor:Object - espera um objeto com red, green e blue (Number, de 0 a 1) para a cor de fundo.
  • textColor:Object - espera um objeto com red, green e blue (Number, de 0 a 1) para a cor do texto.
  • bold:Boolean - aplica ou remove negrito do texto do intervalo.
  • italic:Boolean - aplica ou remove itálico do texto do intervalo.
  • fontSize:Number - tamanho da fonte a ser aplicado ao texto do intervalo.
  • horizontalAlignment:String - espera "LEFT", "CENTER" ou "RIGHT".
  • verticalAlignment:String - espera "TOP", "MIDDLE" ou "BOTTOM".
  • border:Object - espera um objeto para aplicar uma borda ao redor do intervalo, com style:String ("SOLID", "SOLID_MEDIUM", "SOLID_THICK", "DASHED", "DOTTED" ou "DOUBLE", padrão "SOLID") e color:Object opcional (mesmo formato de backgroundColor/textColor).

Quando startRow, endRow, startColumn e endColumn não são informados, o estilo é aplicado à aba inteira.

Retorno​

Este método não possui retorno.

CreateValidationRule​

Método responsável por criar uma regra de validação de dados (lista suspensa ou caixa de seleção) em um intervalo de células.

await API.Google.Sheets.CreateValidationRule["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  startRow: 2,
  endRow: 100,
  startColumn: 3,
  endColumn: 3,
  type: "DROPDOWN",
  options: ["Ativo", "Inativo"],
  showDropdownArrow: true,
  strict: true,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • type:String - espera "DROPDOWN" (lista suspensa) ou "CHECKBOX" (caixa de seleção).
    • Quando type é "DROPDOWN": o campo options:Array (lista de strings) torna-se obrigatório, com ao menos uma opção.

Parâmetros opcionais​

  • startRow:Number - primeira linha do intervalo a ser validado.
  • endRow:Number - última linha do intervalo a ser validado (incluída no intervalo).
  • startColumn:Number - primeira coluna do intervalo a ser validado (1 corresponde à coluna A).
  • endColumn:Number - última coluna do intervalo a ser validado (incluída no intervalo).
  • strict:Boolean - quando true, o Google Sheets rejeita valores que não atendam à regra de validação; quando false, apenas exibe um aviso, mas permite salvar o valor. Quando não informado, o padrão é true.
  • showDropdownArrow:Boolean - aplicável apenas quando type é "DROPDOWN". Define se a seta de seleção é exibida nas células do intervalo. Quando não informado, o padrão é true.

Quando startRow, endRow, startColumn e endColumn não são informados, a regra de validação é aplicada à aba inteira.

Retorno​

Este método não possui retorno.

ProtectRange​

Método responsável por proteger um intervalo de células contra edição.

const protectRangeResult = await API.Google.Sheets.ProtectRange["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  startRow: 1,
  endRow: 1,
  description: "Cabeçalho protegido",
  warningOnly: false,
  editorEmails: ["usuario@empresa.com"],
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.

Parâmetros opcionais​

  • startRow:Number - primeira linha do intervalo a ser protegido.
  • endRow:Number - última linha do intervalo a ser protegido (incluída no intervalo).
  • startColumn:Number - primeira coluna do intervalo a ser protegido (1 corresponde à coluna A).
  • endColumn:Number - última coluna do intervalo a ser protegido (incluída no intervalo).
  • description:String - descrição para identificar a proteção criada.
  • warningOnly:Boolean - quando true, a edição do intervalo não é bloqueada de fato, apenas um aviso é exibido a quem tentar editá-lo. Quando não informado, o padrão é false (bloqueia a edição).
  • editorEmails:Array - lista de emails (String, formato de email válido) que terão permissão para editar o intervalo mesmo com a proteção ativa.

Quando startRow, endRow, startColumn e endColumn não são informados, a proteção é aplicada à aba inteira.

Retorno​

actions.protectRangeResult.protectedRangeId // ID da proteção de intervalo recém criada (Number)

ApplyFilter​

Método responsável por aplicar um filtro básico a um intervalo de células.

await API.Google.Sheets.ApplyFilter["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  startRow: 1,
  startColumn: 1,
  endColumn: 4,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.

Parâmetros opcionais​

  • startRow:Number - linha inicial do intervalo (1 = primeira linha). Quando não informado, o filtro é aplicado desde a primeira linha da aba.
  • endRow:Number - linha final do intervalo. Quando não informado, o filtro é aplicado até a última linha da aba.
  • startColumn:Number - coluna inicial do intervalo (1 = primeira coluna). Quando não informado, o filtro é aplicado desde a primeira coluna da aba.
  • endColumn:Number - coluna final do intervalo. Quando não informado, o filtro é aplicado até a última coluna da aba.

Retorno​

Este método não possui retorno.

FindAndReplace​

Método responsável por localizar e substituir um texto em uma planilha, aba ou intervalo de células.

const findAndReplaceResult = await API.Google.Sheets.FindAndReplace["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  find: "Pendente",
  replacement: "Concluído",
  matchCase: false,
  matchEntireCell: true,
  searchByRegex: false,
  includeFormulas: false,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • find:String - espera o texto a ser localizado.
  • replacement:String - espera o texto que substituirá as ocorrências encontradas.

Parâmetros opcionais​

  • sheet:String|Number - espera o nome ou o ID numérico da aba. Quando não informado, a busca e substituição são feitas em toda a planilha (todas as abas).
  • startRow:Number - linha inicial do intervalo de busca. Só tem efeito quando sheet também for informado.
  • endRow:Number - linha final do intervalo de busca. Só tem efeito quando sheet também for informado.
  • startColumn:Number - coluna inicial do intervalo de busca. Só tem efeito quando sheet também for informado.
  • endColumn:Number - coluna final do intervalo de busca. Só tem efeito quando sheet também for informado.
  • matchCase:Boolean - quando true, a busca diferencia maiúsculas de minúsculas. Padrão: false.
  • matchEntireCell:Boolean - quando true, a substituição só ocorre quando o conteúdo inteiro da célula for igual ao texto buscado. Padrão: false.
  • searchByRegex:Boolean - quando true, o campo find é interpretado como uma expressão regular. Padrão: false.
  • includeFormulas:Boolean - quando true, a busca também considera o texto das fórmulas das células. Padrão: false.

Retorno​

actions.findAndReplaceResult.valuesChanged // quantidade de valores alterados (Number)
actions.findAndReplaceResult.formulasChanged // quantidade de fórmulas alteradas (Number)
actions.findAndReplaceResult.rowsChanged // quantidade de linhas alteradas (Number)
actions.findAndReplaceResult.sheetsChanged // quantidade de abas alteradas (Number)
actions.findAndReplaceResult.occurrencesChanged // quantidade de ocorrências alteradas (Number)

SetVisibility​

Método responsável por ocultar ou exibir uma aba, ou um intervalo de linhas/colunas.

await API.Google.Sheets.SetVisibility["v1_0_0"]({
  sheetsConnection: sheetsConnection,
  spreadsheetId: "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  sheet: "Página1",
  hidden: true,
  target: "ROWS",
  startIndex: 5,
  amount: 2,
});

Parâmetros obrigatórios​

  • sheetsConnection:Object - espera a instância de conexão obtida pelo método Connection.
  • spreadsheetId:String - espera o ID da planilha.
  • sheet:String|Number - espera o nome ou o ID numérico da aba.
  • hidden:Boolean - espera true para ocultar o alvo selecionado, ou false para exibi-lo (torná-lo visível).
  • target:String - espera "SHEET" (a aba inteira), "ROWS" (linhas) ou "COLUMNS" (colunas).
    • Quando target é "ROWS" ou "COLUMNS": o campo startIndex:Number torna-se obrigatório, informado em base 1 (1 = primeira linha ou coluna).

Parâmetros opcionais​

  • amount:Number - aplicável apenas quando target é "ROWS" ou "COLUMNS". Espera quantas linhas ou colunas, a partir de startIndex, terão a visibilidade alterada. Quando não informado, o padrão é 1.

Retorno​

Este método não possui retorno.