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。
commentsViewMode

enum (CommentsViewMode)

スプレッドシートに適用するコメント表示モード。これにより、コメントを省略または含めてスプレッドシートを表示できます。指定しない場合は、COMMENTS_VIEW_MODE_OMITTED が使用されます。

リクエストの本文

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

レスポンスの本文

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

詳細については、認可ガイドをご覧ください。