Method: spreadsheets.values.batchGetByDataFilter

Renvoie une ou plusieurs plages de valeurs correspondant aux filtres de données spécifiés. L'appelant doit spécifier l'ID de la feuille de calcul et un ou plusieurs DataFilters. Les plages correspondant aux filtres de données de la requête sont renvoyées.

Requête HTTP :

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
spreadsheetId

string

ID de la feuille de calcul à partir de laquelle récupérer les données.

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)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
Champs
dataFilters[]

object (DataFilter)

Filtres de données utilisés pour faire correspondre les plages de valeurs à récupérer. Les plages correspondant à l'un des filtres de données spécifiés sont incluses dans la réponse.
majorDimension

enum (Dimension)

Dimension principale que les résultats doivent être utilisés.

Par exemple, si les données de la feuille de calcul sont A1=1,B1=2,A2=3,B2=4, une requête qui sélectionne cette plage et définit majorDimension=ROWS renvoie [[1,2],[3,4]], alors qu'une requête qui définit majorDimension=COLUMNS renvoie [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Mode de représentation des valeurs dans la sortie. L'option de rendu par défaut est FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Mode de représentation des dates, des heures et des durées dans le résultat. Cette valeur est ignorée si valueRenderOption est défini sur FORMATTED_VALUE. L'option de rendu date/heure par défaut est SERIAL_NUMBER.

Corps de la réponse

Réponse lorsque vous récupérez plusieurs plages de valeurs dans une feuille de calcul sélectionnée par DataFilters.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Champs
spreadsheetId

string

ID de la feuille de calcul à partir de laquelle les données ont été extraites.
valueRanges[]

object (MatchedValueRange)

Valeurs demandées, avec la liste des filtres de données qui leur correspondent.

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.

Plage de valeurs correspondantes

Plage de valeurs mise en correspondance par un ou plusieurs fichiers de données

Représentation JSON 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
Champs
valueRange

object (ValueRange)

Valeurs mises en correspondance par DataFilter.
dataFilters[]

object (DataFilter)

DataFilters de la requête correspondant à la plage de valeurs.