Operações de linha e coluna

Com a API Google Sheets, você pode adicionar, remover e manipular linhas e colunas em planilhas. Os exemplos nesta página ilustram como algumas operações de linha e coluna comuns podem ser realizadas com a API Sheets.

Esses exemplos são apresentados na forma de solicitações HTTP para serem de linguagem neutra. Para saber como implementar uma atualização em lote em diferentes idiomas usando as bibliotecas de cliente da API do Google, consulte Atualizar planilhas.

Nesses exemplos, os marcadores de posição SPREADSHEET_ID e SHEET_ID indicam onde você forneceria esses IDs. O ID da planilha pode ser encontrado no URL dela. É possível conseguir o ID da planilha usando o método spreadsheets.get. Os intervalos são especificados usando a notação A1. Um exemplo de intervalo é Sheet1!A1:D5.

Ajustar a largura da coluna ou a altura da linha

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar o UpdateDimensionPropertiesRequest para atualizar a propriedade de largura da coluna A para 160 pixels. Uma segunda solicitação atualiza a propriedade de altura das três primeiras linhas para 40 pixels. O campo dimension determina se a operação se aplica às colunas ou linhas de uma planilha.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "updateDimensionProperties": {
        "range": {
          "sheetId": SHEET_ID,
          "dimension": "COLUMNS",
          "startIndex": 0,
          "endIndex": 1
        },
        "properties": {
          "pixelSize": 160
        },
        "fields": "pixelSize"
      }
    },
    {
      "updateDimensionProperties": {
        "range": {
          "sheetId": SHEET_ID,
          "dimension": "ROWS",
          "startIndex": 0,
          "endIndex": 3
        },
        "properties": {
          "pixelSize": 40
        },
        "fields": "pixelSize"
      }
    }
  ]
}

Anexar linhas ou colunas vazias

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar o AppendDimensionRequest para anexar linhas e colunas. A primeira solicitação anexa três linhas vazias ao final de uma página, enquanto a segunda anexa uma única coluna vazia. O campo dimension determina se a operação se aplica às colunas ou linhas de uma planilha.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "appendDimension": {
        "sheetId": SHEET_ID,
        "dimension": "ROWS",
        "length": 3
      }
    },
    {
      "appendDimension": {
        "sheetId": SHEET_ID,
        "dimension": "COLUMNS",
        "length": 1
      }
    }
  ]
}

Redimensionar uma coluna automaticamente

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar AutoResizeDimensionsRequest para redimensionar colunas A:C com base no tamanho do conteúdo da coluna. O campo dimension indica que a operação se aplica às colunas da página.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "autoResizeDimensions": {
        "dimensions": {
          "sheetId": SHEET_ID,
          "dimension": "COLUMNS",
          "startIndex": 0,
          "endIndex": 3
        }
      }
    }
  ]
}

Redimensionar uma linha automaticamente

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar o AutoResizeDimensionsRequest para limpar a altura das três primeiras linhas. As alturas das linhas aumentam dinamicamente com base no conteúdo das células de cada linha. O campo dimension indica que a operação se aplica às linhas da planilha.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "autoResizeDimensions": {
        "dimensions": {
          "sheetId": SHEET_ID,
          "dimension": "ROWS",
          "startIndex": 0,
          "endIndex": 3
        }
      }
    }
  ]
}

Excluir linhas ou colunas

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar o DeleteDimensionRequest para excluir as três primeiras linhas em uma página. Uma segunda solicitação exclui as colunas B:D. O campo dimension determina se a operação se aplica às colunas ou linhas de uma página.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "deleteDimension": {
        "range": {
          "sheetId": SHEET_ID,
          "dimension": "ROWS",
          "startIndex": 0,
          "endIndex": 3
        }
      }
    },
    {
      "deleteDimension": {
        "range": {
          "sheetId": SHEET_ID,
          "dimension": "COLUMNS",
          "startIndex": 1,
          "endIndex": 4
        }
      }
    },
  ],
}

Inserir uma linha ou coluna vazia

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar o InsertDimensionRequest para inserir colunas ou linhas em um índice específico (como adicionar linhas vazias na parte de cima de uma página). A primeira solicitação insere duas colunas vazias na coluna C. Uma segunda solicitação insere três linhas vazias a partir da linha 1.

O campo dimension determina se a operação se aplica às colunas ou linhas de uma página.

Se verdadeiro, o campo inheritFromBefore instrui a API Sheets a fornecer às novas colunas ou linhas as mesmas propriedades da linha ou coluna anterior e, se falso, a herdar das dimensões após as novas colunas ou linhas. inheritFromBefore não pode ser verdadeiro ao inserir uma linha na linha 1 ou uma coluna na coluna A.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "insertDimension": {
        "range": {
          "sheetId": SHEET_ID,
          "dimension": "COLUMNS",
          "startIndex": 2,
          "endIndex": 4
        },
        "inheritFromBefore": true
      }
    },
    {
      "insertDimension": {
        "range": {
          "sheetId": SHEET_ID,
          "dimension": "ROWS",
          "startIndex": 0,
          "endIndex": 3
        },
        "inheritFromBefore": false
      }
    },
  ],
}

Mover uma linha ou coluna

O exemplo de código spreadsheets.batchUpdate a seguir mostra como usar o MoveDimensionRequest para mover a coluna A para a posição da coluna D. Uma segunda solicitação move as linhas 5 a 10 para a posição da linha 20.

O campo dimension determina se a operação se aplica às colunas ou linhas de uma página. O campo destinationIndex determina para onde mover os dados de origem usando um índice inicial baseado em zero.

Confira o protocolo da solicitação abaixo.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "moveDimension": {
        "source": {
          "sheetId": SHEET_ID,
          "dimension": "COLUMNS",
          "startIndex": 0,
          "endIndex": 1
        },
        "destinationIndex": 3
      }
    },
    {
      "moveDimension": {
        "source": {
          "sheetId": SHEET_ID,
          "dimension": "ROWS",
          "startIndex": 4,
          "endIndex": 10
        },
        "destinationIndex": 19
      }
    },
  ],
}