Migliorare le prestazioni

Questo documento illustra alcune tecniche che puoi utilizzare per migliorare le prestazioni dell'applicazione. In alcuni casi, per illustrare le idee presentate si utilizzano esempi di altre API o di API generiche. Tuttavia, gli stessi concetti si applicano anche all'API di Documenti Google.

Compressione usando gzip

Un modo semplice e comodo per ridurre la larghezza di banda necessaria per ogni richiesta è abilitare la compressione gzip. Anche se ciò richiede più tempo di CPU per decomprimere i risultati, in genere il ritorno sulla spesa pubblicitaria è vantaggioso.

Per ricevere una risposta con codifica gzip, devi eseguire due operazioni: impostare un'intestazione Accept-Encoding e modificare lo user agent in modo che contenga la stringa gzip. Di seguito è riportato un esempio di intestazioni HTTP formattate correttamente per consentire la compressione gzip:

Accept-Encoding: gzip
User-Agent: my program (gzip)

Utilizzo di risorse parziali

Un altro modo per migliorare le prestazioni delle chiamate API è richiedere solo la parte dei dati di tuo interesse. Ciò consente alla tua applicazione di evitare di trasferire, analizzare e archiviare i campi non necessari, in modo da utilizzare risorse come rete, CPU e memoria in modo più efficiente.

Risposta parziale

Per impostazione predefinita, il server restituisce la rappresentazione completa di una risorsa dopo l'elaborazione delle richieste. Per ottenere prestazioni migliori, puoi chiedere al server di inviare solo i campi di cui hai veramente bisogno e ottenere una risposta parziale.

Per richiedere una risposta parziale, utilizza il parametro di richiesta fields per specificare i campi da restituire. Puoi utilizzare questo parametro con qualsiasi richiesta che restituisca dati di risposta.

Esempio

L'esempio seguente mostra l'utilizzo del parametro fields con un'API "Demo" generica (fittizia).

Richiesta semplice: questa richiesta HTTP GET omette il parametro fields e restituisce la risorsa completa.

https://www.googleapis.com/demo/v1

Risposta completa alle risorse: i dati completi sulle risorse includono i seguenti campi, insieme a molti altri che sono stati omessi per brevità.

{
  "kind": "demo",
  ...
  "items": [
  {
    "title": "First title",
    "comment": "First comment.",
    "characteristics": {
      "length": "short",
      "accuracy": "high",
      "followers": ["Jo", "Will"],
    },
    "status": "active",
    ...
  },
  {
    "title": "Second title",
    "comment": "Second comment.",
    "characteristics": {
      "length": "long",
      "accuracy": "medium"
      "followers": [ ],
    },
    "status": "pending",
    ...
  },
  ...
  ]
}

Richiesta di una risposta parziale: la seguente richiesta per la stessa risorsa utilizza il parametro fields per ridurre in modo significativo la quantità di dati restituiti.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

Risposta parziale: in risposta alla richiesta precedente, il server invia una risposta contenente solo le informazioni relative al tipo, oltre a un array di elementi essenziali che include solo il titolo HTML e le informazioni sulla lunghezza della caratteristica in ogni elemento.

200 OK
{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Tieni presente che la risposta è un oggetto JSON che include solo i campi selezionati e i relativi oggetti principali.

Trovi ulteriori dettagli sul formato del parametro fields, seguito da ulteriori dettagli su ciò che viene restituito esattamente nella risposta.

Riepilogo della sintassi del parametro Campi

Il formato del valore del parametro di richiesta fields è vagamente basato sulla sintassi XPath. La sintassi supportata è riepilogata di seguito. Ulteriori esempi sono riportati nella sezione seguente.

  • Utilizza un elenco separato da virgole per selezionare più campi.
  • Utilizza a/b per selezionare un campo b nidificato all'interno del campo a. Utilizza a/b/c per selezionare un campo c nidificato all'interno di b.

    Eccezione: per le risposte API che utilizzano wrapper "data", in cui la risposta è nidificata all'interno di un oggetto data simile a data: { ... }, non includere "data" nella specifica fields. Se includi l'oggetto dati con una specifica dei campi come data/a/b, si verifica un errore. È sufficiente utilizzare una specifica fields come a/b.

  • Utilizza un selettore secondario per richiedere un insieme di sottocampi specifici di matrici o oggetti inserendo le espressioni tra parentesi "( )".

    Ad esempio, fields=items(id,author/email) restituisce solo l'ID elemento e l'email dell'autore per ogni elemento nell'array di articoli. Puoi anche specificare un singolo sottocampo, dove fields=items(id) equivale a fields=items/id.

  • Utilizza i caratteri jolly nelle selezioni dei campi, se necessario.

    Ad esempio, fields=items/pagemap/* seleziona tutti gli oggetti in una mappa di pagina.

Altri esempi di utilizzo del parametro campi

Gli esempi riportati di seguito includono descrizioni di come il valore del parametro fields influisce sulla risposta.

Nota: come per tutti i valori dei parametri di ricerca, il valore del parametro fields deve essere codificato tramite URL. Per una migliore leggibilità, gli esempi in questo documento omettono la codifica.

Identifica i campi da restituire o selezionali.
Il valore del parametro di richiesta fields è un elenco di campi separato da virgole e ogni campo è specificato in base alla radice della risposta. Pertanto, se esegui un'operazione list, la risposta è una raccolta e in genere include un array di risorse. Se stai eseguendo un'operazione che restituisce una singola risorsa, i campi sono specificati in base alla risorsa. Se il campo selezionato è (o fa parte) di un array, il server restituisce la parte selezionata di tutti gli elementi nell'array.

Ecco alcuni esempi a livello di raccolta:
Esempi Effetto
items Restituisce tutti gli elementi nell'array di elementi, inclusi tutti i campi di ogni elemento, ma nessun altro campo.
etag,items Restituisce sia il campo etag sia tutti gli elementi nell'array di elementi.
items/title Restituisce solo il campo title per tutti gli elementi nella matrice degli elementi.

Ogni volta che viene restituito un campo nidificato, la risposta include gli oggetti principali che lo includono. I campi principali non includono altri campi secondari, a meno che non siano selezionati esplicitamente.
context/facets/label Restituisce solo il campo label per tutti i membri dell'array facets, che è a sua volta nidificato sotto l'oggetto context.
items/pagemap/*/title Per ogni elemento dell'array di articoli, restituisce solo il campo title (se presente) di tutti gli oggetti che sono figli di pagemap.

Ecco alcuni esempi a livello di risorsa:
Esempi Effetto
title Restituisce il campo title della risorsa richiesta.
author/uri Restituisce il sottocampo uri dell'oggetto author nella risorsa richiesta.
links/*/href
 Restituisce il campo href di tutti gli oggetti secondari di links.
Richiedi solo parti di campi specifici utilizzando le selezionazioni secondarie.
Per impostazione predefinita, se la richiesta specifica campi specifici, il server restituisce gli oggetti o gli elementi dell'array nella loro interezza. Puoi specificare una risposta che includa solo alcuni sottocampi. A tale scopo, utilizza la sintassi di "( )" per la selezione secondaria, come nell'esempio seguente.
Esempio Effetto
items(title,author/uri) Restituisce solo i valori di title e di uri dell'autore per ogni elemento nella matrice di elementi.

Gestione delle risposte parziali

Dopo aver elaborato una richiesta valida che include il parametro di ricerca fields, un server restituisce un codice di stato HTTP 200 OK insieme ai dati richiesti. Se il parametro di ricerca fields contiene un errore o non è valido, il server restituisce un codice di stato HTTP 400 Bad Request e un messaggio di errore che segnala all'utente i problemi relativi alla selezione dei campi (ad esempio "Invalid field selection a/b").

Ecco l'esempio di risposta parziale mostrato nella sezione introduttiva riportata sopra. La richiesta utilizza il parametro fields per specificare i campi da restituire.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

La risposta parziale ha il seguente aspetto:

200 OK
{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Nota: per le API che supportano i parametri di ricerca per l'impaginazione dei dati (ad esempio maxResults e nextPageToken), utilizza questi parametri per ridurre i risultati di ogni query a una dimensione gestibile. In caso contrario, il miglioramento delle prestazioni possibile con una risposta parziale potrebbe non essere realizzato.