Method: spreadsheets.values.batchGetByDataFilter

Renvoie une ou plusieurs plages de valeurs correspondant aux filtres de données spécifiés. Pour en savoir plus, consultez Lire, écrire et rechercher des métadonnées.

L'appelant doit spécifier l'ID de la feuille de calcul et un ou plusieurs DataFilters. Les plages correspondant à l'un des filtres de données de la requête seront 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 utiliser.

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]], tandis qu'une requête qui définit majorDimension=COLUMNS renvoie [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Indique comment les valeurs doivent être représentées dans le résultat. L'option de rendu par défaut est FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Indique comment les dates, les heures et les durées doivent être représentées dans le résultat. Cette valeur est ignorée si valueRenderOption est défini sur FORMATTED_VALUE. L'option de rendu dateTime par défaut est SERIAL_NUMBER.

Corps de la réponse

Réponse lorsque plusieurs plages de valeurs sont récupérées 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é récupérées.
valueRanges[]

object (MatchedValueRange)

Les 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 d'autorisation.

MatchedValueRange

Plage de valeurs correspondant à un ou plusieurs filtres de données.

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

object (ValueRange)

Valeurs correspondant à DataFilter.
dataFilters[]

object (DataFilter)

Le DataFilters de la requête qui correspond à la plage de valeurs.