Usa le maschere di campo

Le maschere di campo consentono ai chiamanti API di elencare i campi che una richiesta deve restituire o aggiornare. L'utilizzo di un FieldMask consente all'API di evitare lavoro non necessario e migliora il rendimento. Una maschera di campo viene utilizzata sia per i metodi di lettura che di aggiornamento nell'API Google Sheets.

Lettura con una maschera dei campi

I fogli di lavoro possono essere grandi e spesso non hai bisogno di ogni parte della Spreadsheet risorsa restituita da una richiesta di lettura. Puoi limitare i dati restituiti in una risposta dell'API Sheets utilizzando il parametro URL fields. Per ottenere le migliori prestazioni, elenca esplicitamente solo i campi di cui hai bisogno nella risposta.

Il formato del parametro fields è lo stesso della codifica JSON di un FieldMask. In breve, più campi diversi sono separati da virgole e i sottocampi sono separati da punti. I nomi dei campi possono essere specificati in camelCase o separated_by_underscores. Per comodità, più campi secondari dello stesso tipo possono essere elencati tra parentesi.

L'esempio di richiesta spreadsheets.get seguente utilizza una maschera di campo sheets.properties(sheetId,title,sheetType,gridProperties) per recuperare solo l'ID foglio, il titolo, SheetType, e GridProperties di un oggetto SheetProperties in tutti i fogli di un foglio di lavoro:

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

La risposta a questa chiamata al metodo è un oggetto Spreadsheet contenente i componenti richiesti nella maschera del campo. Tieni presente che sheetType=OBJECT non contiene gridProperties:

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

Aggiornamento con una maschera dei campi

A volte devi aggiornare solo determinati campi in un oggetto lasciando invariati gli altri. Le richieste di aggiornamento all'interno di un'operazione spreadsheets.batchUpdate utilizzano le maschere di campo per indicare all'API quali campi vengono modificati. La richiesta di aggiornamento ignora i campi non specificati nella maschera di campo, mantenendo i valori correnti.

Puoi anche annullare l'impostazione di un campo non specificandolo nel messaggio aggiornato, ma aggiungendolo alla maschera. In questo modo viene cancellato qualsiasi valore precedentemente presente nel campo.

La sintassi per le maschere di campo di aggiornamento è la stessa delle maschere di campo di lettura.

Il seguente esempio utilizza AddSheetRequest per aggiungere un nuovo foglio di tipo Grid, bloccare la prima riga e colorare di rosso la scheda del nuovo foglio:

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
            }
          }
        }
      }
    }
  ]
}