Method: spreadsheets.getByDataFilter

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

Cette méthode est différente de celle du service feuilles de calcul.En effet, elle permet de sélectionner les sous-ensembles de données à afficher 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 présentant une intersection avec des plages correspondantes correspondent à ces filtres.

Par défaut, les données contenues dans 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 répertoriant vos champs souhaités à l'aide du paramètre d'URL fields en 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, nous vous recommandons de ne récupérer que les champs de 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)

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

includeGridData

boolean

Défini sur "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 sur les autorisations.