Method: spreadsheets.getByDataFilter

Renvoie la feuille de calcul à l'ID donné. L'appelant doit spécifier l'ID de la feuille de calcul. Pour en savoir plus, consultez Lire, écrire et rechercher des métadonnées.

Cette méthode diffère de spreadsheets.get, car elle permet de sélectionner les sous-ensembles de données de feuille de calcul à renvoyer en spécifiant un paramètre dataFilters. Vous pouvez spécifier plusieurs DataFilters. Si vous spécifiez un ou plusieurs filtres de données, les parties de la feuille de calcul qui croisent les plages correspondant à l'un des filtres sont renvoyées.

Par défaut, les données des grilles ne sont pas renvoyées. Vous pouvez inclure des données de grille de deux manières :

  • Spécifiez un masque de champ listant les champs souhaités à l'aide du paramètre d'URL fields dans HTTP.

  • Définissez le paramètre includeGridData sur true. Si un masque de champ est défini, le paramètre includeGridData est ignoré.

Pour les grandes feuilles de calcul, il est recommandé de n'extraire que les champs spécifiques qui vous intéressent.

Requête HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
spreadsheetId

string

Feuille de calcul à demander.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
Champs
dataFilters[]

object (DataFilter)

Le DataFilters utilisé pour sélectionner les plages à récupérer dans la feuille de calcul.
includeGridData

boolean

True si les données de la grille doivent être renvoyées. Ce paramètre est ignoré si un masque de champ a été défini dans la requête.
excludeTablesInBandedRanges

boolean

"True" si les tables doivent être exclues des plages groupées. "False" si non défini.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Spreadsheet.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Pour en savoir plus, consultez le guide d'autorisation.