Method: spreadsheets.get

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

デフォルトでは、グリッド内のデータは返されません。グリッドデータは、次の 2 つの方法のいずれかで含めることができます。

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

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

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

スプレッドシート データのサブセットのみを取得するには、ranges URL パラメータを使用します。範囲は A1 表記で指定します。1 つのセル（例: 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 です。リクエストでフィールド マスクが設定されている場合、このパラメータは無視されます。

リクエスト本文

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

レスポンスの本文

成功した場合、レスポンスの本文には 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

詳しくは、OAuth 2.0 の概要をご覧ください。