Method: spreadsheets.getByDataFilter

Renvoie la feuille de calcul correspondant à l'identifiant donné. L'appelant doit spécifier l'ID de la feuille de calcul.

Elle diffère de la méthode "sheets.get", dans la mesure où 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. La spécification d'un ou de plusieurs filtres de données renvoie les parties de la feuille de calcul qui recoupent les plages correspondant à l'un des filtres.

Par défaut, les données contenues dans les grilles ne sont pas renvoyées. Vous pouvez inclure les données de la 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 feuilles de calcul volumineuses, il est recommandé de ne récupérer que les champs spécifiques de la feuille de calcul 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
}
Champs
dataFilters[]

object (DataFilter)

Le paramètre DataFilters permet de sélectionner les plages à extraire de 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.

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 relatif aux autorisations.