Method: spreadsheets.values.batchGet

Affiche une ou plusieurs plages de valeurs à partir d'une feuille de calcul. L'appelant doit spécifier l'ID de la feuille de calcul et une ou plusieurs plages.

Requête HTTP

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet

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 les données doivent être récupérées.

Paramètres de requête

Paramètres
ranges[]

string

Notation A1 ou R1C1 de la plage à partir de laquelle récupérer les valeurs.
majorDimension

enum (Dimension)

La principale dimension 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, la requête ranges=["A1:B2"],majorDimension=ROWS renvoie [[1,2],[3,4]], tandis que la requête ranges=["A1:B2"],majorDimension=COLUMNS renvoie [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

Comment les valeurs doivent être représentées dans la sortie. L'option de rendu par défaut est ValueRenderOption.FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

Comment les dates, les heures et les durées doivent être représentées dans la sortie. 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 requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse lors de la récupération de plusieurs plages de valeurs dans une feuille de calcul.

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 (ValueRange)
    }
  ]
}
Champs
spreadsheetId

string

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

object (ValueRange)

Valeurs demandées. L'ordre des valeurs ValueRanges est identique à celui des plages demandées.

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.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

Pour en savoir plus, consultez le guide relatif aux autorisations.