L'API Fogli Google consente di creare, cancellare, copiare ed eliminare fogli, nonché controllarne le proprietà. Gli esempi in questa pagina spiegano come puoi eseguire alcune operazioni comuni di Fogli API Fogli di lavoro.
Questi esempi sono presentati sotto forma di richieste HTTP per neutri. Per scoprire come implementare un aggiornamento batch in lingue diverse utilizzando le librerie client delle API di Google, consulta l'articolo Aggiornamento fogli di lavoro.
In questi esempi, i segnaposto SPREADSHEET_ID e SHEET_ID
indica dove fornire questi ID. Puoi trovare il foglio di lavoro
ID nell'URL del foglio di lavoro. Puoi ottenere
l'ID foglio utilizzando la proprietà
spreadsheets.get. La
vengono specificati utilizzando la notazione A1. Un
di esempio è Foglio1!A1:D5.
Aggiungi un foglio
Le seguenti
spreadsheets.batchUpdate
l'esempio di codice mostra come utilizzare
AddSheetRequest
aggiungere un foglio a un foglio di lavoro, impostando al contempo il titolo, le dimensioni della griglia e
colore della scheda di stato.
La risposta è composta da un
AddSheetResponse,
che contiene un oggetto con le proprietà del foglio creato (come le
SHEET_ID).
Il protocollo di richiesta è mostrato di seguito.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"addSheet": {
"properties": {
"title": "Deposits",
"gridProperties": {
"rowCount": 20,
"columnCount": 12
},
"tabColor": {
"red": 1.0,
"green": 0.3,
"blue": 0.4
}
}
}
}
]
}
Cancella un foglio di tutti i valori mantenendo i formati
Le seguenti
spreadsheets.batchUpdate
l'esempio di codice mostra come utilizzare
UpdateCellsRequest
per rimuovere tutti i valori da un foglio senza modificare la formattazione.
Specificare i
Campo userEnteredValue
senza un valore corrispondente viene interpretata come un'istruzione per cancellare i valori
nell'intervallo. Questa impostazione può essere utilizzata anche con altri campi. Ad esempio:
modifica il valore fields in
userEnteredFormat rimuove
tutta la formattazione supportata dall'API Fogli
dal foglio, ma lascia invariati i valori delle celle.
Il protocollo di richiesta è mostrato di seguito.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"updateCells": {
"range": {
"sheetId": SHEET_ID
},
"fields": "userEnteredValue"
}
}
]
}
Copiare un foglio da un foglio di lavoro a un altro
Le seguenti
spreadsheet.sheets.copyTo
esempio di codice mostra come copiare un singolo foglio specificato da SHEET_ID
da un foglio di lavoro all'altro.
La variabile TARGET_SPREADSHEET_ID nel corpo della richiesta specifica la
foglio di lavoro di destinazione. La copia conserva tutti i valori, la formattazione, le formule e
proprietà dell'originale. Il titolo del foglio copiato è impostato su "Copia
di [titolo del foglio originale]".
La risposta è composta da un
SheetProperties
che descrive le proprietà del foglio creato.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo
{
"destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}
Eliminare un foglio
Le seguenti
spreadsheets.batchUpdate
l'esempio di codice mostra come utilizzare
DeleteSheetRequest
per eliminare un foglio specificato da SHEET_ID.
Il protocollo di richiesta è mostrato di seguito.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"deleteSheet": {
"sheetId": SHEET_ID
}
}
]
}
Lettura dei dati del foglio
Le seguenti
Esempio di codice spreadsheets.get
mostra come ottenere informazioni sulle proprietà di foglio
da un foglio di lavoro, specificato da SHEET_ID
e SPREADSHEET_ID. Questo metodo viene spesso utilizzato per determinare
metadati di fogli all'interno di un foglio di lavoro specifico, in modo che ulteriori operazioni possano
scegliere come target quei fogli. Il parametro di query fields specifica solo la proprietà del foglio
devono essere restituiti i dati (a differenza dei dati del valore della cella o dei dati relativi
l'intero foglio di lavoro).
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties
La risposta è composta da un
Spreadsheet
una risorsa che contiene un
Sheet con
SheetProperties
elementi. Se un determinato campo di risposta è impostato sul valore predefinito, viene omesso
dalla risposta.
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "Sheet1",
"index": 0,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 100,
"columnCount": 20,
"frozenRowCount": 1
}
"tabColor": {
"blue": 1.0
}
},
...
],
}