Method: spreadsheets.get

指定された ID のスプレッドシートを返します。呼び出し元はスプレッドシート ID を指定する必要があります。

デフォルトでは、グリッド内のデータは返されません。グリッドデータを含める方法は 2 つあります。

  • HTTP の fields URL パラメータを使用して、目的のフィールドを一覧表示するフィールドマスクを指定します。

  • includeGridData URL パラメータを true に設定します。フィールド マスクが設定されている場合、includeGridData パラメータは無視されます。

大規模なスプレッドシートの場合は、必要なスプレッドシート フィールドのみを取得することをおすすめします。

スプレッドシート データのサブセットのみを取得するには、ranges URL パラメータを使用します。範囲は A1 表記を使用して指定します。単一のセル（例: A1）または複数のセル（例: A1:D5）を定義できます。また、同じスプレッドシート内の他のシートからセルを取得したり（例: Sheet2!A1:C4）、複数の範囲を一度に取得したりすることもできます（例: ?ranges=A1:D5&ranges=Sheet2!A1:C4）。範囲を制限すると、リクエストされた範囲と交差するスプレッドシートの部分のみが返されます。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
spreadsheetId

string

リクエストするスプレッドシート。

クエリ パラメータ

パラメータ
ranges[]

string

スプレッドシートから取得する範囲。
includeGridData

boolean

グリッドデータが返される必要がある場合は true です。リクエストでフィールドマスクが設定されている場合、このパラメータは無視されます。
excludeTablesInBandedRanges

boolean

バンド範囲からテーブルを除外する場合は true にします。設定されていない場合は false です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Spreadsheet のインスタンスが含まれます。

認可スコープ

以下のいずれかの 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

詳しくは、認可ガイドをご覧ください。