Saltar al contenido principal
Docs
Ir al Studio
Roberty Studio
RPAGoogle

Google Sheets

Google Sheets

El módulo Google Sheets es responsable de acciones que integran la herramienta Google Sheets. Sus métodos pueden accederse conforme al ejemplo a continuación:

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

Métodos​

Connection​

Método responsable de establecer una conexión con Google Sheets a partir de una conexión configurada en el workspace.

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

Parámetros obligatorios​

  • connectionId:String - espera el ID de la conexión de Google configurada en el workspace (Workspace → Conexiones).

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Devuelve la instancia de conexión autenticada con Google Sheets (una instancia del cliente sheets_v4.Sheets del SDK googleapis), que debe almacenarse en una variable (ej.: sheetsConnection) y reutilizarse como parámetro sheetsConnection en los demás métodos de este módulo.

Spreadsheets.Create​

Método responsable de crear una nueva hoja de cálculo de Google Sheets.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • title:String - espera el título que tendrá la nueva hoja de cálculo.

Parámetros opcionales​

  • sheets:Array - espera una lista de objetos de pestaña (en el formato Schema$Sheet de la API de Google). Cuando se indica, la hoja de cálculo se crea solo con esas pestañas: Google no crea la pestaña predeterminada. Cada elemento acepta al menos properties.title:String, y opcionalmente properties.hidden:Boolean, properties.index:Number y properties.gridProperties:Object (con rowCount:Number, columnCount:Number y frozenRowCount:Number). Cuando no se indica, la hoja de cálculo se crea con una única pestaña predeterminada.

Retorno​

js
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 responsable de obtener los metadatos de una hoja de cálculo a través de su ID.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo que será obtenida.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

js
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 responsable de agregar una nueva pestaña a una hoja de cálculo existente.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo donde será creada la nueva pestaña.
  • title:String - espera el título de la nueva pestaña.

Parámetros opcionales​

  • index:Number - espera la posición (index) en la que la nueva pestaña debe insertarse entre las demás pestañas de la hoja de cálculo. Empieza en 0 (0 = primera posición).
  • rowCount:Number - espera la cantidad de filas de la nueva pestaña.
  • columnCount:Number - espera la cantidad de columnas de la nueva pestaña.

Retorno​

js
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 responsable de obtener los metadatos de una pestaña a través de su ID o título.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo donde está la pestaña deseada.

Parámetros opcionales​

  • sheetId:Number - espera el ID numérico de la pestaña que será obtenida.
  • title:String - espera el título de la pestaña que será obtenida.

Es obligatorio indicar al menos uno de los dos campos anteriores (sheetId o title) para localizar la pestaña; si se indican ambos, sheetId tiene prioridad en la búsqueda.

Retorno​

js
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 responsable de eliminar una pestaña de una hoja de cálculo.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo que contiene la pestaña que será eliminada.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña que será eliminada.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

Sheets.DeleteRowsOrColumns​

Método responsable de eliminar un intervalo de filas o columnas de una pestaña.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo que contiene la pestaña.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • toDelete:String - espera "ROWS" o "COLUMNS", indicando qué será eliminado.
  • startIndex:Number - espera la posición inicial de la fila o columna a partir de la cual comenzará la eliminación, considerando 1 como la primera fila (o columna) de la pestaña.

Parámetros opcionales​

  • amount:Number - espera cuántas filas o columnas, a partir de la posición inicial, deben eliminarse. Cuando no se indica, el valor predeterminado es 1.

Retorno​

Este método no tiene retorno.

Values.Get​

Método responsable de obtener los valores de un intervalo de celdas.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • range:String - espera la notación A1 del intervalo que será leído (ej.: Página1!A1:D10). Para obtener todos los valores de una pestaña, indica solo su nombre (ej.: Página1).

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

js
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 responsable de actualizar los valores de un intervalo de celdas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • range:String - espera la notación A1 del intervalo que será actualizado (ej.: Página1!A1:D10).
  • values:Array - espera una lista de filas, donde cada fila es una lista de valores de las columnas, que serán grabadas en el intervalo indicado.

Parámetros opcionales​

  • valueInputOption:String - espera "USER_ENTERED" (fórmulas, fechas, etc. se interpretan) o "RAW" (sin interpretación). Cuando no se indica, el valor predeterminado es "USER_ENTERED".

Retorno​

js
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 responsable de limpiar los valores de un intervalo de celdas.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • range:String - espera la notación A1 del intervalo que será limpiado (ej.: Página1!A1:D10).

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Rows.Append​

Método responsable de agregar una nueva fila al final de una pestaña, relacionando los valores con los encabezados de las columnas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • values:Object - espera un objeto que relaciona el nombre de cada columna (según el encabezado de la pestaña) con el valor deseado. Las columnas del encabezado no indicadas quedan en blanco en la nueva fila.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Rows.Find​

Método responsable de encontrar las filas en las que una columna coincide con un valor indicado.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • column:String - espera el nombre exacto de la columna, tal como aparece en el encabezado de la pestaña.
  • value:Any - espera el valor que será comparado con el contenido de la columna, para cada fila de la pestaña.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

El retorno trae todas las filas que coinciden con el valor buscado, dentro de la lista rows, en orden de número de fila (la primera ocurrencia queda en rows[0]). Si ninguna fila coincide, rows viene vacía: revisa rows.length antes de acceder a rows[0].

js
actions.findResult.rows // lista de filas encontradas, cada una con rowNumber y row (Array)
actions.findResult.rows[0].rowNumber // número de la primera fila encontrada (Number)
actions.findResult.rows[0].row // la primera fila encontrada, como objeto (Object)

Rows.Update​

Método responsable de actualizar una fila de la pestaña, localizada por una columna y un valor (que deben identificar una sola fila) o por el número de la fila.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • by:String - espera "FILTER" (localizar por columna y valor) o "ROW_NUMBER" (localizar por número de fila).
    • Cuando by es "FILTER": los campos column:String y value:Any se vuelven obligatorios. Exactamente una fila debe coincidir: si ninguna o más de una coinciden, el robot interrumpe la ejecución con error.
    • Cuando by es "ROW_NUMBER": el campo rowNumber:Number se vuelve obligatorio (valor mínimo 2, ya que la fila 1 es el encabezado).
  • values:Object - espera un objeto que relaciona el nombre de cada columna con el nuevo valor que será grabado en la fila localizada. Las columnas no indicadas mantienen el valor actual.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

js
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 responsable de crear una tabla nativa de Google Sheets en una pestaña, a partir de una fila de encabezado.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo donde será creada la tabla.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • name:String - espera el nombre que tendrá la tabla, usado para referenciarla en las próximas acciones.

Parámetros opcionales​

  • headers:Array - espera una lista de strings con los encabezados de las columnas. Cuando no se indica, el robot utiliza lo que ya esté escrito en la primera fila del intervalo como encabezado de la tabla.
  • startRow:Number - espera el número de la fila, en la pestaña, donde comienza el encabezado de la tabla. Cuando no se indica, el valor predeterminado es 1.
  • startColumn:Number - espera el número de la columna, en la pestaña, donde comienza la tabla. Cuando no se indica, el valor predeterminado es 1.

Retorno​

js
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.Get​

Método responsable de obtener todas las filas de una tabla, cada una como un objeto que relaciona el nombre de la columna con su valor.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • tableName:String - espera el nombre de la tabla.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

js
actions.tableResult.sheet // nome da aba onde a tabela está (String)
actions.tableResult.headers // nomes das colunas da tabela (Array)
actions.tableResult.rows // linhas de dados da tabela (sem o cabeçalho), cada uma como objeto (Array)
actions.tableResult.rowCount // quantidade de linhas de dados obtidas (Number)
actions.tableResult.firstRowNumber // número, na aba, da primeira linha de dados, logo abaixo do cabeçalho (Number)

El elemento en la posición N de rows (comenzando en 0) está en la fila firstRowNumber + N de la pestaña, lo que permite usarlo después en Tables.Rows.Update o Tables.Rows.Delete con by: "ROW_NUMBER". Una tabla solo con el encabezado devuelve rows vacía y rowCount igual a 0.

Tables.List​

Método responsable de listar las tablas existentes en una hoja de cálculo.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo cuyas tablas serán listadas.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Los campos endRow y endColumn de cada elemento pueden no devolverse cuando la tabla no tenga un límite de filas o columnas definido.

Tables.Rows.Append​

Método responsable de agregar una nueva fila al final de una tabla, relacionando los valores con los encabezados de las columnas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • tableName:String - espera el nombre de la tabla.
  • values:Object - espera un objeto que relaciona el nombre de cada columna (según el encabezado de la tabla) con el valor deseado. Las columnas del encabezado no indicadas quedan en blanco en la nueva fila.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

js
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 responsable de obtener una fila de la tabla a través de su número.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • tableName:String - espera el nombre de la tabla.
  • rowNumber:Number - espera el número de la fila en la hoja, el mismo que aparece en el lateral de Google Sheets (no su posición dentro de la tabla). La fila de encabezado no es una fila de datos: en una tabla con el encabezado en la fila 1, la primera fila de datos es la 2; con el encabezado en la fila 5, es la 6.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Tables.Rows.Update​

Método responsable de actualizar una fila de la tabla, localizada por el número de fila o por un filtro de columna/valor.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • tableName:String - espera el nombre de la tabla.
  • by:String - espera "FILTER" (localizar por columna y valor) o "ROW_NUMBER" (localizar por número de fila).
    • Cuando by es "FILTER": los campos column:String y value:Any se vuelven obligatorios. Exactamente una fila debe coincidir: si ninguna o más de una coinciden, el robot interrumpe la ejecución con error.
    • Cuando by es "ROW_NUMBER": el campo rowNumber:Number se vuelve obligatorio. Es el número de la fila en la hoja, el mismo que aparece en el lateral de Google Sheets (no su posición dentro de la tabla). La fila de encabezado no es una fila de datos: en una tabla con el encabezado en la fila 1, la primera fila de datos es la 2; con el encabezado en la fila 5, es la 6.
  • values:Object - espera un objeto que relaciona el nombre de cada columna con el nuevo valor que será grabado en la fila localizada. Las columnas no indicadas mantienen el valor actual.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

js
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 responsable de eliminar una fila de la tabla, localizada por el número de fila o por un filtro de columna/valor. Se elimina la fila entera de la pestaña.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • tableName:String - espera el nombre de la tabla.
  • by:String - espera "FILTER" (localizar por columna y valor) o "ROW_NUMBER" (localizar por número de fila).
    • Cuando by es "FILTER": los campos column:String y value:Any se vuelven obligatorios. Exactamente una fila debe coincidir: si ninguna o más de una coinciden, el robot interrumpe la ejecución con error.
    • Cuando by es "ROW_NUMBER": el campo rowNumber:Number se vuelve obligatorio. Es el número de la fila en la hoja, el mismo que aparece en el lateral de Google Sheets (no su posición dentro de la tabla). La fila de encabezado no es una fila de datos: en una tabla con el encabezado en la fila 1, la primera fila de datos es la 2; con el encabezado en la fila 5, es la 6.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

Tables.Columns.Add​

Método responsable de agregar una nueva columna a una tabla. La columna se inserta en toda la pestaña: el contenido a su derecha, incluso fuera de la tabla, se desplaza una columna a la derecha.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo donde está ubicada la tabla.
  • tableName:String - espera el nombre de la tabla a la cual será agregada la nueva columna.
  • name:String - espera el nombre que tendrá la nueva columna.

Parámetros opcionales​

  • index:Number - espera la posición en la que la nueva columna debe insertarse en la tabla (base 1). Cuando no se indica, o cuando es mayor que la cantidad actual de columnas más uno, la columna se agrega al final de la tabla.

Retorno​

js
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 responsable de eliminar una columna de una tabla. Se elimina la columna entera de la pestaña, incluido su contenido fuera de la tabla.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo donde está ubicada la tabla.
  • tableName:String - espera el nombre de la tabla de la cual será eliminada la columna.
  • name:String - espera el nombre exacto de la columna, tal como aparece en el encabezado de la tabla.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

Tables.Columns.Rename​

Método responsable de renombrar una columna de una tabla.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo donde está ubicada la tabla.
  • tableName:String - espera el nombre de la tabla que contiene la columna que será renombrada.
  • name:String - espera el nombre exacto de la columna actual, tal como aparece en el encabezado de la tabla.
  • newName:String - espera el nuevo nombre que tendrá la columna.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

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

StyleCells​

Método responsable de definir el color de fondo/texto, negrita, cursiva, alineación y borde de un intervalo de celdas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.

Al menos una de las opciones de estilo a continuación debe indicarse; en caso contrario, el robot interrumpe la ejecución con error.

Parámetros opcionales​

  • startRow:Number - primera fila del intervalo que será estilizado.
  • endRow:Number - última fila del intervalo que será estilizado (incluida en el intervalo).
  • startColumn:Number - primera columna del intervalo que será estilizado (1 corresponde a la columna A).
  • endColumn:Number - última columna del intervalo que será estilizado (incluida en el intervalo).
  • backgroundColor:Object - espera un objeto con red, green y blue (Number, de 0 a 1) para el color de fondo.
  • textColor:Object - espera un objeto con red, green y blue (Number, de 0 a 1) para el color del texto.
  • bold:Boolean - aplica o elimina la negrita del texto del intervalo.
  • italic:Boolean - aplica o elimina la cursiva del texto del intervalo.
  • fontSize:Number - tamaño de la fuente que será aplicado al texto del intervalo.
  • horizontalAlignment:String - espera "LEFT", "CENTER" o "RIGHT".
  • verticalAlignment:String - espera "TOP", "MIDDLE" o "BOTTOM".
  • border:Object - espera un objeto para aplicar un borde a todas las celdas del intervalo (cada celda recibe borde en los cuatro lados), con style:String ("SOLID", "SOLID_MEDIUM", "SOLID_THICK", "DASHED", "DOTTED" o "DOUBLE", predeterminado "SOLID") y color:Object opcional (mismo formato que backgroundColor/textColor).

Cuando startRow, endRow, startColumn y endColumn no se indican, el estilo se aplica a la pestaña entera.

Si endRow es menor que startRow, o endColumn es menor que startColumn, el robot interrumpe la ejecución con error.

Retorno​

Este método no tiene retorno.

CreateValidationRule​

Método responsable de crear una regla de validación de datos (lista desplegable o casilla de selección) en un intervalo de celdas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • type:String - espera "DROPDOWN" (lista desplegable) o "CHECKBOX" (casilla de selección).
    • Cuando type es "DROPDOWN": el campo options:Array (lista de strings) se vuelve obligatorio, con al menos una opción.

Parámetros opcionales​

  • startRow:Number - primera fila del intervalo que será validado.
  • endRow:Number - última fila del intervalo que será validado (incluida en el intervalo).
  • startColumn:Number - primera columna del intervalo que será validado (1 corresponde a la columna A).
  • endColumn:Number - última columna del intervalo que será validado (incluida en el intervalo).
  • strict:Boolean - cuando es true, Google Sheets rechaza los valores que no cumplen la regla de validación; cuando es false, solo muestra un aviso, pero permite guardar el valor. Cuando no se indica, el valor predeterminado es true.
  • showDropdownArrow:Boolean - aplicable solo cuando type es "DROPDOWN". Define si la flecha de selección se muestra en las celdas del intervalo. Cuando no se indica, el valor predeterminado es true.

Cuando startRow, endRow, startColumn y endColumn no se indican, la regla de validación se aplica a la pestaña entera.

Si endRow es menor que startRow, o endColumn es menor que startColumn, el robot interrumpe la ejecución con error.

Retorno​

Este método no tiene retorno.

ProtectRange​

Método responsable de proteger un intervalo de celdas contra la edición.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.

Parámetros opcionales​

  • startRow:Number - primera fila del intervalo que será protegido.
  • endRow:Number - última fila del intervalo que será protegido (incluida en el intervalo).
  • startColumn:Number - primera columna del intervalo que será protegido (1 corresponde a la columna A).
  • endColumn:Number - última columna del intervalo que será protegido (incluida en el intervalo).
  • description:String - descripción para identificar la protección creada.
  • warningOnly:Boolean - cuando es true, la edición del intervalo no se bloquea realmente, solo se muestra un aviso a quien intente editarlo. Cuando no se indica, el valor predeterminado es false (bloquea la edición).
  • editorEmails:Array - lista de correos electrónicos (String, formato de correo válido) que tendrán permiso para editar el intervalo incluso con la protección activa. Se ignora cuando warningOnly es true.

Cuando startRow, endRow, startColumn y endColumn no se indican, la protección se aplica a la pestaña entera.

Si endRow es menor que startRow, o endColumn es menor que startColumn, el robot interrumpe la ejecución con error.

Retorno​

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

ApplyFilter​

Método responsable de aplicar un filtro básico a un intervalo de celdas.

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

Parámetros obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.

Parámetros opcionales​

  • startRow:Number - fila inicial del intervalo (1 = primera fila). Cuando no se indica, el filtro se aplica desde la primera fila de la pestaña.
  • endRow:Number - fila final del intervalo. Cuando no se indica, el filtro se aplica hasta la última fila de la pestaña.
  • startColumn:Number - columna inicial del intervalo (1 = primera columna). Cuando no se indica, el filtro se aplica desde la primera columna de la pestaña.
  • endColumn:Number - columna final del intervalo. Cuando no se indica, el filtro se aplica hasta la última columna de la pestaña.

Si endRow es menor que startRow, o endColumn es menor que startColumn, el robot interrumpe la ejecución con error.

Retorno​

Este método no tiene retorno.

FindAndReplace​

Método responsable de localizar y sustituir un texto en una hoja de cálculo, pestaña o intervalo de celdas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • find:String - espera el texto que será localizado.
  • replacement:String - espera el texto que sustituirá las ocurrencias encontradas.

Parámetros opcionales​

  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña. Cuando no se indica, la búsqueda y sustitución se realizan en toda la hoja de cálculo (todas las pestañas).
  • startRow:Number - fila inicial del intervalo de búsqueda. Solo tiene efecto cuando sheet también se indica.
  • endRow:Number - fila final del intervalo de búsqueda. Solo tiene efecto cuando sheet también se indica.
  • startColumn:Number - columna inicial del intervalo de búsqueda. Solo tiene efecto cuando sheet también se indica.
  • endColumn:Number - columna final del intervalo de búsqueda. Solo tiene efecto cuando sheet también se indica.
  • matchCase:Boolean - cuando es true, la búsqueda distingue mayúsculas de minúsculas. Predeterminado: false.
  • matchEntireCell:Boolean - cuando es true, la sustitución solo ocurre cuando el contenido entero de la celda es igual al texto buscado. Predeterminado: false.
  • searchByRegex:Boolean - cuando es true, el campo find se interpreta como una expresión regular. Predeterminado: false.
  • includeFormulas:Boolean - cuando es true, la búsqueda también considera el texto de las fórmulas de las celdas. Predeterminado: false.

Si endRow es menor que startRow, o endColumn es menor que startColumn, el robot interrumpe la ejecución con error.

Retorno​

js
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 responsable de ocultar o mostrar una pestaña, o un intervalo de filas/columnas.

js
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 obligatorios​

  • sheetsConnection:Object - espera la instancia de conexión obtenida por el método Connection.
  • spreadsheetId:String - espera el ID de la hoja de cálculo.
  • sheet:String|Number - espera el nombre o el ID numérico de la pestaña.
  • hidden:Boolean - espera true para ocultar el destino seleccionado, o false para mostrarlo (hacerlo visible).
  • target:String - espera "SHEET" (la pestaña entera), "ROWS" (filas) o "COLUMNS" (columnas).
    • Cuando target es "ROWS" o "COLUMNS": el campo startIndex:Number se vuelve obligatorio, indicado en base 1 (1 = primera fila o columna).

Parámetros opcionales​

  • amount:Number - aplicable solo cuando target es "ROWS" o "COLUMNS". Espera cuántas filas o columnas, a partir de startIndex, tendrán la visibilidad modificada. Cuando no se indica, el valor predeterminado es 1.

Retorno​

Este método no tiene retorno.