- Stampa
Connettore Google Sheets
Introduzione
L'API di Google Sheets consente agli utenti di creare, leggere e modificare i fogli di Google con il giusto accesso impostato sui loro account di Google. L'obiettivo di questo connettore è sfruttare Oauth 2.0 di Tulip per integrarsi con Google Sheets utilizzando i connettori HTTP e fornire ai nostri clienti un connettore pronto all'uso che può essere importato nella loro istanza.
Scopo
- Verranno evidenziate diverse funzioni di connettore HTTP che possono essere costruite effettuando chiamate HTTP agli endpoint delle API di Google Sheets (v4) per interagire con il foglio di calcolo di Google e provare varie azioni di lettura e scrittura sul foglio di calcolo che potrebbero essere sfruttate per vari casi d'uso.
Documento API
Prerequisiti
- Creare un account sulla Console cloud di Google e configurare le credenziali OAuth 2.0. Ulteriori informazioni sono disponibili nei documenti API di Google.
- Aggiungere l'URL di reindirizzamento delle istanze su Google Cloud Console.
Dettagli della connessione Tulip
Le seguenti informazioni devono essere configurate sui connettori di Tulip.
- In esecuzione su: Host del connettore cloud
- Host: sheets.googleapis.com
- Porta: 443
- TLS: Sì
- OAuth 2(Admin): L'autenticazione sarà trasferita a tutte le funzioni del connettore.
Funzioni del connettore
Nuovo foglio elettronico di Google
Scopo
- Gli utenti possono passare un nome di foglio di calcolo e un nome di foglio come input e Tulip creerà un nuovo foglio di calcolo con il nome del foglio fornito. La risposta dell'API sarà costituita dai metadati e dalle varie proprietà del foglio di calcolo, che possono essere ulteriormente utilizzati come filtri per recuperare e aggiornare i dati dai fogli di calcolo.
- Le informazioni estratte da Google sheets V4 API possono essere ulteriormente utilizzate all'interno delle applicazioni Tulip, delle tabelle Tulip o delle variabili Tulip che vengono convogliate in altre funzioni del connettore.
Punto finale
Chiamata HTTP POST all'endpoint https://sheets.googleapis.com/v4/spreadsheets.
Input richiesti
I parametri che vengono inviati come corpo della richiesta sono i seguenti
- Nome del foglio di calcolo - il titolo del foglio di calcolo
- Nome foglio - Titolo iniziale del foglio
Estrattore di output
- foglio di calcolo: Identificatore univoco dello SpreadSheet che verrà utilizzato per eseguire le altre attività
- URL del foglio di calcolo: L'URL del foglio di calcolo appena creato.
Google Ottieni dati del foglio di calcolo
Scopo
Questo connettore recupera i dati dallo spreadsheetId fornito entro l'intervallo indicato. I dati saranno forniti come array di righe o colonne in base ai parametri di query forniti alla funzione del connettore.
Punto finale
Chiamata HTTP GET all'endpoint -https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/valori/{range}
Input richiesti
I parametri URL da passare sono i seguenti
- Id del foglio di calcolo
- Intervallo - Una stringa nel [formato A1](https://developers.google.com/sheets/api/guides/concepts
a1_notation)
I parametri di query aggiuntivi che verranno forniti dalle funzioni del connettore sono
- majorDimension : ROWS o COLUMNS decide quale debba essere l'array interno di dati
- dateTimeRenderOption specifica il formato dei campi DateTime Valore predefinito:FORMATTED_STRING
- valueRenderOption specifica se i dati devono essere formattati o non formattati nella risposta valore predefinito: FORMATTED_VALUE
Estrattore di output
- Valori: Si tratta di un array di array, ogni riga di dati sarà un array.
Foglio elettronico di Google InserisciRiga
Scopo
Aggiunge valori a un foglio di calcolo. L'intervallo di input viene utilizzato per cercare i dati esistenti e trovare una "tabella" all'interno di tale intervallo. I valori saranno aggiunti alla riga successiva della tabella, a partire dalla prima colonna della tabella. Il connettore accetta spreadsheetId, Range e l'elenco dei valori da inserire nelle celle.
Punto finale
Chiamata HTTP POST all'endpoint -https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/valori/{range}:append
Input richiesti
I parametri di query da passare sono i seguenti
- ID foglio di calcolo
- Intervallo
- Valori: per questo connettore, abbiamo considerato 8 valori di colonna con ciascun parametro denominato in base alla colonna che verrà inserita. Questo verrà passato all'API come un array di valori.
I parametri di query aggiuntivi che verranno forniti dalle funzioni del connettore sono :
- valueInputOption: È un campo obbligatorio e sarà inviato dal connettore, valore predefinito: USER_ENTERED
Estrattore di output
- foglio di calcoloId
- Righe aggiornate: Specifica il numero di righe che sono state inserite.
Cancellazione del foglio di calcolo di Google
Scopo
Cancella i valori da un foglio di calcolo. Il chiamante deve specificare l'ID del foglio di calcolo e l'intervallo. Vengono cancellati solo i valori, mentre tutte le altre proprietà della cella (come la formattazione, la convalida dei dati, ecc.) vengono mantenute. Il connettore accetta l'ID del foglio di calcolo, l'intervallo e l'elenco dei valori da inserire nelle celle.
Punto finale
Chiamata HTTP POST all'endpoint -https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/valori/{range}:clear
Input richiesti
I parametri di query da passare sono i seguenti
- ID foglio di calcolo
- Intervallo
Google Ottieni dettagli del foglio elettronico per filtro
Scopo
Questo connettore recupera i dettagli del foglio di calcolo con lo spreadsheetId fornito e la condizione specifica specificata nel filtro dei dati.
Punto finale
Chiamata HTTP POST all'endpoint -https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getbyDataFilter
Input richiesti
I parametri di query da passare sono i seguenti
- spreadSheetId
- includeGridData: Il valore predefinito è False
I seguenti parametri vengono inviati come parte del corpo della richiesta in formato JSON
- grigliaCampo
Estrattori di output
- spreadSheetId
- Titolo
- Locale
- ricalcolo automatico
- timeZone
- ID foglio
- titolo del foglio
- tipo di foglio
- foglioConteggio righe
- foglioColonna
- spreadSheetUrl
Esistono altri parametri che possono essere inclusi come parte dell'output in base al caso d'uso dell'utente.
Google Ottieni dati batch
Scopo
Questo connettore recupera i dati dallo spreadsheetId fornito all'interno del connettore. I dati vengono forniti come array di righe o colonne in base ai parametri di query forniti al connettore.
Punto finale
Chiamata HTTP GET all'endpoint -https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet
Input richiesto
I parametri della query da passare sono i seguenti
- Id del foglio di calcolo
- Intervallo - Una stringa in [A1Format](https://developers.google.com/sheets/api/guides/concepts
a1_notation)
I parametri di query aggiuntivi che verranno forniti dalle funzioni del connettore sono
- majorDimension : ROWS o COLUMNS decide quale debba essere l'array interno di dati
- dateTimeRenderOption specifica il formato dei campi DateTime Valore predefinito:FORMATTED_STRING
- valueRenderOption specifica se i dati devono essere formattati o non formattati nella risposta Valore predefinito:FORMATTED_VALUE
Estrattore di output
- valueRanges: Si tratta di un array di oggetti. Ogni oggetto descrive un intervallo
Filtro Google Get Batch Data
Scopo
Questo connettore recupera i dati dal foglio di calcoloId fornito all'interno della condizione di filtro data come un batch di dati. I dati saranno forniti come array di righe o colonne in base ai parametri di query forniti al connettore.
Punto finale
Chiamata HTTP POST all'endpoint -https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
Input richiesto
I parametri di query da passare sono i seguenti
- Id del foglio di calcolo
I parametri aggiuntivi del corpo della richiesta che verranno forniti dalle funzioni del connettore sono
- Filtri dati
- majorDimension : ROWS o COLUMNS decide quale debba essere l'array interno di dati
- dateTimeRenderOption specifica il formato dei campi DateTime Valore predefinito:FORMATTED_STRING
- valueRenderOption specifica se i dati devono essere formattati o non formattati nella risposta valore predefinito: FORMATTED_VALUE
Estrattore di output
- valueRanges: Si tratta di un array di oggetti. Ogni oggetto dettaglia un intervallo