Passa al contenuto principale

Ottieni dati da Google Sheet

L'API per l'utilizzo di Google Sheet con app.neoagent.co fornisce la funzionalità per ottenere un foglio inviando una richiesta GET all'endpoint /chat/Chatbot/GetGoogleGoolgeSheetData.

warning

Attenzione: questa API è compatibile solo con i chatbot tradizionali e non è ancora compatibile con i chatbot basati su template.

Endpoint

URL della Richiesta: https://app.neoagent.co/chat/Chatbot/GetGoogleGoolgeSheetData
Metodo: GET

Corpo della Richiesta

Il corpo della richiesta deve contenere i seguenti parametri:

{
// stringa, obbligatoria - Identificatore univoco (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// array di numeri interi, facoltativo - Elenco degli ID dati da recuperare
"ids": [
1,
2
],
// intero, facoltativo - Numero massimo di elementi da restituire per pagina, il valore predefinito è 10
"pageSize": 10,
// intero, facoltativo - Numero di pagina da recuperare, il valore predefinito è 1
"pageNumber": 1,
// booleano, facoltativo - Indica se i risultati devono essere ordinati in ordine crescente, il valore predefinito è true
"isASC": true
}

Parametri

  • serialNumber - stringa, obbligatorio - Identificatore univoco (ID) del chatbot
  • ids - array di numeri interi, facoltativo - Elenco degli ID dati da recuperare
  • pageSize - intero, facoltativo - Numero massimo di elementi da restituire per pagina, il valore predefinito è 10
  • pageNumber - intero, facoltativo - Numero di pagina da recuperare, il valore predefinito è 1
  • isASC - booleano, facoltativo - Indica se i risultati devono essere ordinati in ordine crescente, il valore predefinito è true

Headers richiesti

La richiesta API deve includere i seguenti header:

  • Authorization: <Your-Secret-Key> - string, obbligatorio - La chiave segreta per autenticare la richiesta API
  • Content-Type: application/json - string, obbligatorio - Il tipo di contenuto del payload della richiesta (deve essere application/json)

Esempi di Richiesta

const res = await fetch('https://app.neoagent.co/chat/Chatbot/GetSource', {
method: 'GET',
headers: {
"Authorization": "<Your-Secret-Key>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
})
});

const data = await res.json();
console.log(data);

Risposta

La risposta API sarà un oggetto JSON con la seguente struttura:

{
// oggetto - Rappresenta i risultati della query suddivisi in pagine.
//In ogni elemento dell'elenco, il campo ID funge da identificatore univoco per ogni riga di dati.
//È importante notare che campi come URL, nome, nome prodotto e prezzo sono campi personalizzati dinamici.
//Le loro definizioni e valori sono determinati dall'utente e possono essere modificati in base a requisiti specifici.
"Dati": {
"Elenco": [
{
"ID": 1,
"url": "XXXXX",
"nome": "xiaomi",
"nomeprodotto": "xiaomi 16",
"prezzo": 999
},
{
"ID": 2,
"url": "XXXXX",
"nome": "apple",
"nomeprodotto": "iphone 16 pro max",
"prezzo": 999
}
],
"ConteggioVirtuale": 2
},
// stringa - Versione API
"Versione": "1.0.0",
// booleano - Stato di riuscita dell'operazione
"Successo": true,
// intero - Codice di stato HTTP
"Codice": 200,
// stringa - Messaggio di errore, se presente
"Messaggio": ""
}

Gestione degli Errori

Se la richiesta fallisce, dovresti:

  1. Controllare il codice di stato HTTP per errori a livello di rete
  2. Esaminare i campi Code e Message nella risposta per errori a livello business
  3. Il campo Message conterrà informazioni dettagliate sull'errore