Method: spreadsheets.values.batchGet

スプレッドシートから 1 つ以上の値の範囲を返します。呼び出し元は、スプレッドシート ID と 1 つ以上の範囲を指定する必要があります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
spreadsheetId

string

データを取得するスプレッドシートの ID。

クエリ パラメータ

パラメータ
ranges[]

string

値を取得する範囲の A1 表記または R1C1 表記。
majorDimension

enum (Dimension)

結果で使用するメジャー ディメンション。

たとえば、スプレッドシートのデータが A1=1,B1=2,A2=3,B2=4 の場合、ranges=["A1:B2"],majorDimension=ROWS をリクエストすると [[1,2],[3,4]] が返され、ranges=["A1:B2"],majorDimension=COLUMNS をリクエストすると [[1,3],[2,4]] が返されます。
valueRenderOption

enum (ValueRenderOption)

出力での値の表現方法。デフォルトのレンダリング オプションは ValueRenderOption.FORMATTED_VALUE です。
dateTimeRenderOption

enum (DateTimeRenderOption)

日付、時刻、期間を出力でどのように表現するか。valueRenderOption が FORMATTED_VALUE の場合は無視されます。デフォルトの dateTime レンダリング オプションは SERIAL_NUMBER です。

リクエスト本文

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

レスポンスの本文

スプレッドシートで複数の値の範囲を取得した場合のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
フィールド
spreadsheetId

string

データを取得したスプレッドシートの ID。
valueRanges[]

object (ValueRange)

リクエストされた値。ValueRanges の順序は、リクエストされた範囲の順序と同じです。

認可スコープ

次の 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

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