Usar máscaras de campo

As máscaras de campo são uma maneira de os autores de chamadas de API listarem os campos que uma solicitação deve retornar ou atualizar. Usar um FieldMask permite que a API evite trabalho desnecessário e melhore a performance. Uma máscara de campo é usada nos métodos de leitura e atualização da API Google Sheets.

Ler com uma máscara de campo

As planilhas podem ser grandes, e muitas vezes você não precisa de todas as partes do recurso Spreadsheet retornado por uma solicitação de leitura. É possível limitar o que é retornado em uma resposta da API Sheets usando o parâmetro de URL fields. Para ter o melhor desempenho, liste explicitamente apenas os campos de que você precisa na resposta.

O formato do parâmetro "fields" é o mesmo da codificação JSON de um FieldMask. Em resumo, vários campos diferentes são separados por vírgulas, e subcampos são separados por pontos. Os nomes dos campos podem ser especificados em camelCase ou separados_por_sublinhados. Para facilitar, vários subcampos do mesmo tipo podem ser listados entre parênteses.

O exemplo de solicitação spreadsheets.get a seguir usa uma máscara de campo de sheets.properties(sheetId,title,sheetType,gridProperties) para buscar apenas o ID da planilha, o título, SheetType, e GridProperties de um objeto SheetProperties em todas as planilhas:

GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)

A resposta a essa chamada de método é um objeto Spreadsheet que contém os componentes solicitados na máscara de campo. Observe que sheetType=OBJECT não contém gridProperties:

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 1000,
          "columnCount": 25
        }
      }
    },
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "OBJECT"
      }
    }
  ]
}

Atualizar com uma máscara de campo

Às vezes, é necessário atualizar apenas alguns campos em um objeto e deixar os outros inalterados. As solicitações de atualização em uma operação spreadsheets.batchUpdate usam máscaras de campo para informar à API quais campos estão sendo alterados. A solicitação de atualização ignora todos os campos que não estão especificados na máscara de campo, deixando-os com os valores atuais.

Também é possível remover a definição de um campo não especificando-o na mensagem atualizada, mas adicionando o campo à máscara. Isso limpa qualquer valor que o campo tinha antes.

A sintaxe das máscaras de campo de atualização é a mesma das máscaras de campo de leitura.

O exemplo a seguir usa o AddSheetRequest para adicionar uma nova página do tipo Grid, congelar a primeira linha e colorir a guia da nova página de vermelho:

POST https://sheets.googleapis.com/v1/spreadsheets/spreadsheetId:batchUpdate

{
  "spreadsheetId": "SPREADSHEET_ID",
  "replies": [
    {
      "addSheet": {
        "properties": {
          "sheetId": SHEET_ID,
          "title": "TITLE",
          "index": 6,
          "sheetType": "GRID",
          "gridProperties": {
            "rowCount": 1000,
            "columnCount": 26,
            "frozenRowCount": 1
          },
          "tabColor": {
            "red": 0.003921569
          },
          "tabColorStyle": {
            "rgbColor": {
              "red": 0.003921569
            }
          }
        }
      }
    }
  ]
}