基本的な読み取り

Google Sheets API を使用すると、セル、範囲、範囲のセットから値を読み取ることができます。 スプレッドシート全体。このページの例では、一般的な読み取り オペレーションを spreadsheets.values リソースです。[ spreadsheets.get メソッドですが、 通常 spreadsheets.values.get または spreadsheets.values.batchGet より簡単です。

これらの例は、HTTP リクエストという形式で示されています。これは、 ニュートラルです。Google Cloud の API を使用してさまざまな言語で読み取りを実装する方法を API クライアント ライブラリについては、読み取りおよびセルの書き込み 使用できます。

これらの例では、プレースホルダ SPREADSHEET_ID は、 スプレッドシート ID が返されます。 スプレッドシートの URL で確認できます。読み取り元の範囲は A1 表記を使用して指定されます。 URL を入力します。範囲の例は Sheet1!A1:D5 です。

ソースデータ

これらの例では、読み取られるスプレッドシートに次のソースがあると仮定します 最初のシート (Sheet1) にあるデータを参照します。1 行目の文字列は、トレーニング データの 個別に選択できます。他のシートから読み取る方法の例については、 A1 表記をご覧ください。

A B C D
1 項目 費用 在庫あり 発送日
2 ホイール 20.50 ドル 4 2016 年 3 月 1 日
3 ドア $15 2 2016 年 3 月 15 日
4 エンジン $100 1 2016 年 3 月 20 日
5 合計 135.5 ドル 7 2016 年 3 月 20 日

単一の範囲を読み取る

次の spreadsheets.values.get このコードサンプルは、Sheet1!A1:D5 の範囲から値を読み取り、 レスポンスで返されます。空の行と列は省略されます。

リクエストのプロトコルをここに示します。

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5

レスポンスは ValueRange 範囲の値を記述するオブジェクトです。「 majorDimension フィールド 配列が行で編成された値のリストであることを示します。

{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "3/1/2016"],
    ["Door", "$15", "2", "3/15/2016"],
    ["Engine", "$100", "1", "30/20/2016"],
    ["Totals", "$135.5", "7", "3/20/2016"]
  ],
}

列でグループ化された単一の範囲を読み取る

次の spreadsheets.values.get このコードサンプルは、Sheet1!A1:D3 の範囲から値を読み取り、 グループ化されますが、列でグループ化されます。末尾の行と列は空になりますが、 省略されます。

リクエストのプロトコルをここに示します。

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D3?majorDimension=COLUMNS

レスポンスは ValueRange 範囲の値を記述するオブジェクトです。「 majorDimension フィールド 配列が列で編成された値のリストであることを示します。

{
  "range": "Sheet1!A1:D3",
  "majorDimension": "COLUMNS",
  "values": [
    ["Item", "Wheel", "Door"],
    ["Cost", "$20.50", "$15"],
    ["Stocked", "4", "2"],
    ["Ship Date", "3/1/2016", "3/15/2016"]
  ],
}

レンダリング オプションを使用して単一の範囲を読み取る

次の spreadsheets.values.get このコードサンプルは、Sheet1!A1:D5 の範囲から値を読み取り、 レスポンスで返されますが、レンダリング オプションを使用して、 返されます。「 ValueRenderOption 設定 FORMULA は、代わりに数式が返されることを示します。 計算値、 DateTimeRenderOption SERIAL_NUMBER の設定は、日付が数値として返されることを示します。 その他の設定も可能です。末尾の行と列は空になりますが、 省略されます。

リクエストのプロトコルをここに示します。

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5?
            valueRenderOption=FORMULA&dateTimeRenderOption=SERIAL_NUMBER

レスポンスは ValueRange 範囲の値を記述するオブジェクトです。「 majorDimension フィールド 配列が行で編成された値のリストであることを示します。

{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "42430"],
    ["Door", "$15", "2", "42444"],
    ["Engine", "$100", "1", "42449"],
    ["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"]
  ],
}

複数の範囲を読み取る

次の spreadsheets.values.batchGet コードサンプルは、Sheet1!B:B と Sheet1!D:D の範囲から値を読み取る方法を示しています。 レスポンスで返します。「 ValueRenderOption 設定 UNFORMATTED_VALUE は、値が計算されているが形式設定されていないことを示します 返されます。空の行と列は省略されます。

リクエストのプロトコルをここに示します。

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
            ranges=Sheet1!B:B&ranges=Sheet1!D:D&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNS

このメソッド呼び出しのレスポンスは、オブジェクトとスプレッドシート ID で構成されます。 および ValueRange リクエストされた各範囲に対応するオブジェクトが、 渡されます。「 majorDimension フィールド 配列が列で編成された値のリストであることを示します。例:

{
  "spreadsheetId": SPREADSHEET_ID,
  "valueRanges": [
    {
      "range": "Sheet1!B1:B1000",
      "majorDimension": "COLUMNS",
      "values": [
        ["Cost",20.5,15,100,135.5]
      ]
    },
    {
      "range": "Sheet1!D1:D1000",
      "majorDimension": "COLUMNS",
      "values": [
        ["Ship Date",42430,42444,42449,42449]
      ]s
    }
  ]
}

複数のシートの複数の範囲を読み取る

次の spreadsheets.values.batchGet シート 1!A1:D5、 Products!D1:D100、Sales!E4:F6 というリストを作成し、レスポンスでそれらを返します。「 ValueRenderOption 設定 UNFORMATTED_VALUE は、値が計算されているが形式設定されていないことを示します 返されます。空の行と列は省略されます。

リクエストのプロトコルをここに示します。

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
            ranges=Sheet1!A1:D5&ranges=Products!D1:D100&ranges=Sales!E4:F6&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNS

このメソッド呼び出しのレスポンスは、オブジェクトとスプレッドシート ID で構成されます。 および ValueRange リクエストされた各範囲に対応するオブジェクトが、 渡されます。「 majorDimension フィールド 配列が列で編成された値のリストであることを示します。例:

{
  "spreadsheetId": SPREADSHEET_ID,
  "valueRanges": [
    {
      "range": "Sheet1!A1:D5",
      "majorDimension": "COLUMNS",
      "values": [
        [...],
        [...]
      ]
    },
    {
      "range": "Products!D1:D100",
      "majorDimension": "COLUMNS",
      "values": [
        [...]
      ]
    },
    {
      "range": "Sales!E4:F6",
      "majorDimension": "COLUMNS",
      "values": [
        [...],
        [...]
      ]
    }
  ]
}