Method: spreadsheets.get

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

Par défaut, les données 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 listant les champs souhaités à l'aide du paramètre d'URL fields dans HTTP.

  • Définissez le paramètre d'URL 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 souhaitée.

Pour ne récupérer que des sous-ensembles de données de feuille de calcul, utilisez le paramètre d'URL ranges. Les plages sont spécifiées à l'aide de la notation A1. Vous pouvez définir une seule cellule (par exemple, A1) ou plusieurs cellules (par exemple, A1:D5). Vous pouvez également obtenir des cellules d'autres feuilles de la même feuille de calcul (par exemple, Sheet2!A1:C4) ou récupérer plusieurs plages à la fois (par exemple, ?ranges=A1:D5&ranges=Sheet2!A1:C4). La limitation de la plage ne renvoie que les parties de la feuille de calcul qui croisent les plages demandées.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
spreadsheetId

string

Feuille de calcul à demander.

Paramètres de requête

Paramètres
ranges[]

string

Plages à récupérer à partir de la feuille de calcul.
includeGridData

boolean

True si les données de grille doivent être renvoyées. Ce paramètre est ignoré si un masque de champ a été défini dans la requête.
excludeTablesInBandedRanges

boolean

True si les tables doivent être exclues dans les plages à bandes. False si non défini.
commentsViewMode

enum (CommentsViewMode)

Mode d'affichage des commentaires à appliquer à la feuille de calcul. Cela permet d'afficher la feuille de calcul avec ou sans commentaires. Si aucun mode n'est spécifié, COMMENTS_VIEW_MODE_OMITTED est utilisé.

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Spreadsheet.

Niveaux d'accès 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 sur l'autorisation.