Method: spreadsheets.get

Devuelve la hoja de cálculo con el ID determinado. La persona que llama debe especificar el ID de la hoja de cálculo.

De forma predeterminada, no se muestran los datos dentro de las cuadrículas. Puedes incluir datos de cuadrícula de 2 maneras:

  • Especifica una máscara de campo que enumere los campos que deseas con el parámetro de URL fields en HTTP.

  • Establece el parámetro de URL includeGridData en verdadero. Si se establece una máscara de campo, se ignora el parámetro includeGridData.

En el caso de las hojas de cálculo grandes, como práctica recomendada, recupera solo los campos específicos de la hoja de cálculo que desees.

Para recuperar solo subconjuntos de datos de la hoja de cálculo, usa el parámetro de URL ranges. Los rangos se especifican con la notación A1. Puedes definir una sola celda (por ejemplo, A1) o varias celdas (por ejemplo, A1:D5). También puedes obtener celdas de otras hojas dentro de la misma hoja de cálculo (por ejemplo, Sheet2!A1:C4) o recuperar varios rangos a la vez (por ejemplo, ?ranges=A1:D5&ranges=Sheet2!A1:C4). Si limitas el rango, solo se mostrarán las partes de la hoja de cálculo que se crucen con los rangos solicitados.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
spreadsheetId

string

Es la hoja de cálculo que se solicita.

Parámetros de consulta

Parámetros
ranges[]

string

Son los rangos que se recuperarán de la hoja de cálculo.
includeGridData

boolean

Es verdadero si se deben devolver los datos de la cuadrícula. Este parámetro se ignora si se estableció una máscara de campo en la solicitud.
excludeTablesInBandedRanges

boolean

Es verdadero si se deben excluir las tablas en los rangos agrupados. Es falso si no se configura.
commentsViewMode

enum (CommentsViewMode)

Es el modo de vista de comentarios que se aplicará a la hoja de cálculo. Esto permite ver la hoja de cálculo con los comentarios omitidos o incluidos. Si no se especifica uno, se usa COMMENTS_VIEW_MODE_OMITTED.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Spreadsheet.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • 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

Para obtener más información, consulta la Guía de autorización.