Google Sheets API を使用すると、値や数式をセル、範囲、
スプレッドシート全体が含まれます。このページの例は、
一般的な書き込みオペレーションは、
spreadsheets.values
リソースが含まれています。
[
spreadsheet.batchUpdate
メソッドがあります。これは、セルの書式設定を同時に更新したい場合に便利です。
その他のプロパティは
spreadsheets.values
影響しません。たとえば、セルからセルの範囲をコピーする場合は、
セルの数式とセルの両方を上書きしながら、別のシートに切り替えられます。
書式なしには、
UpdateCellsRequest
メソッドを
spreadsheet.batchUpdate
。
ただし、単純な値の書き込みの場合は、
spreadsheets.values.update
メソッドまたは
spreadsheets.values.batchUpdate
メソッドを呼び出します。
これらの例は、HTTP リクエストという形式で示されています。これは、 ニュートラルです。Cloud Storage を使用してさまざまな言語で書き込みを実装する方法を Google API クライアント ライブラリについては、セルの書き込み 使用できます。
これらの例では、プレースホルダ SPREADSHEET_ID
は、
スプレッドシートを入力
ID は、
スプレッドシートの URL です。書き込み先の範囲は、A1
表記をご覧ください。範囲の例は Sheet1!A1:D5 です。
単一の範囲を書き込む
新しい空白のスプレッドシートから
spreadsheets.values.update
範囲に値を書き込むコードサンプルは、以下のとおりです。「
ValueInputOption
クエリ
パラメータが必須で、書き込まれた値を解析するかどうか(つまり、
(文字列が日付に変換されるかどうかなど)です。
リクエスト本文は、
ValueRange
書き込む範囲の値を記述するオブジェクト。「
majorDimension
フィールド
配列が行で編成された値のリストであることを示します。既存の値
上書きされます。
リクエスト プロトコルを以下に示します。
PUT https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
/values/Sheet1!A1:D5?valueInputOption=VALUE_INPUT_OPTION
{ "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", "3/20/2016"], ["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"] ], }
レスポンスは
UpdateValuesResponse
オブジェクトを作成しています。
{
"spreadsheetId": SPREADSHEET_ID
,
"updatedRange": "Sheet1!A1:D5",
"updatedRows": 5,
"updatedColumns": 4,
"updatedCells": 20,
}
結果のシートは次のようになります。
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 日 |
範囲に選択的に書き込む
値を範囲に書き込むときに、既存の一部の変更を回避するために、
対応する配列要素を null
に設定します。また、
空の文字列(""
)をセルに書き込んでセルをクリアします。
上記で生成したのと同じデータを含むシートから開始します。
例の場合、次のようになります。
spreadsheets.values.update
選択的に範囲 B1:D4 に値を書き込むコードサンプルを示しています。
一部のセルは変更せず、他のセルはクリアします。「
ValueInputOption
クエリ
パラメータが必須で、書き込まれた値を解析するかどうか(
(文字列が日付に変換されるかどうかなど)です。
リクエスト本文は、
ValueRange
書き込む範囲の値を記述するオブジェクト。「
majorDimension
フィールド
配列が列で編成された値のリストであることを示します。
リクエスト プロトコルを以下に示します。
PUT https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
/values/Sheet1!B1?valueInputOption=VALUE_INPUT_OPTION
{ "range": "Sheet1!B1", "majorDimension": "COLUMNS", "values": [ [null,"$1","$2", ""], [], [null,"4/1/2016", "4/15/2016", ""] ] }
この values
フィールドには、範囲内の各列に加えられた変更が一覧表示されます。「
最初の配列は、B1 が(null
配列により)変更されないことを示します。
B4 はクリアされます(空の文字列)。B2 と B3 にはそれぞれの値があります。
更新しました。3 番目の配列は列 D に対して同じ操作を実行しますが、
2 番目の空の配列は、列 C を変更しないことを示します。
レスポンスは
UpdateValuesResponse
次のようなオブジェクトです。
{
"spreadsheetId": SPREADSHEET_ID
,
"updatedRange": "Sheet1!B1:D5",
"updatedRows": 3,
"updatedColumns": 2,
"updatedCells": 6,
}
結果のシートは次のようになります。
A | B | C | D | |
1 | 項目 | 費用 | 在庫あり | 発送日 |
2 | ホイール | $1.00 | 4 | 2016 年 4 月 1 日 |
3 | ドア | $2 | 2 | 2016 年 4 月 15 日 |
4 | エンジン | 1 | ||
5 | 合計 | $3.00 | 7 | 2016 年 4 月 15 日 |
[合計]は行は、このリクエストによって直接変更されることはありませんが、 変更されたセルに依存する数式がセルに含まれているためです。
複数の範囲に書き込む
空白のシートから始めて
spreadsheets.values.batchUpdate
コードサンプルは、Sheet1!A1:A4 および Sheet1!A1:A4 の範囲に値を書き込む
シート 1!B1:D2.ターゲット範囲内の既存の値は上書きされます。リクエスト
本文は
ValueInputOption
オブジェクトで
は、入力データと配列の配列を解釈する方法を示しています。
ValueRange
書き込まれた各範囲に対応する
オブジェクトが作成されます「
majorDimension
フィールド
は、含まれる配列を列の配列として解釈するか、行の配列として解釈するかを決定します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
/values:batchUpdate
{ "valueInputOption": "VALUE_INPUT_OPTION", "data": [ { "range": "Sheet1!A1:A4", "majorDimension": "COLUMNS", "values": [ ["Item", "Wheel", "Door", "Engine"] ] }, { "range": "Sheet1!B1:D2", "majorDimension": "ROWS", "values": [ ["Cost", "Stocked", "Ship Date"], ["$20.50", "4", "3/1/2016"] ] } ] }
レスポンスは、更新されたセルの統計情報をリストするオブジェクトで構成されます。
および
UpdateValuesResponse
更新された範囲ごとに 1 つずつ作成されます。例:
{ "spreadsheetId":SPREADSHEET_ID
, "totalUpdatedRows": 4, "totalUpdatedColumns": 4, "totalUpdatedCells": 10, "totalUpdatedSheets": 1, "responses": [ { "spreadsheetId":SPREADSHEET_ID
, "updatedRange": "Sheet1!A1:A4", "updatedRows": 4, "updatedColumns": 1, "updatedCells": 4, }, { "spreadsheetId":SPREADSHEET_ID
, "updatedRange": "Sheet1!B1:D2", "updatedRows": 2, "updatedColumns": 3, "updatedCells": 6, } ], }
結果のシートは次のようになります。
A | B | C | D | |
1 | 項目 | 費用 | 在庫あり | 発送日 |
2 | ホイール | 20.50 ドル | 4 | 2016 年 3 月 1 日 |
3 | ドア | |||
4 | エンジン | |||
5 |
解析せずに値を書き込む
空白のシートから始めて
spreadsheets.values.update
コードサンプルは、範囲 Sheet1!A1:E1 に値を書き込む方法を示していますが、
RAW
ValueInputOption
記述された文字列が数式として解析されないようにするためのクエリ パラメータです。
ブール値、数値などです。文字列として表示され、テキストの配置が両端揃えになっている
表示されます。
リクエスト本文は、
ValueRange
書き込む範囲の値を記述するオブジェクト。「
majorDimension
フィールド
配列が行で編成された値のリストであることを示します。既存の値
上書きされます。
リクエスト プロトコルを以下に示します。
PUT https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
/values/Sheet1!A1:E1?valueInputOption=RAW
{ "range": "Sheet1!A1:E1", "majorDimension": "ROWS", "values": [ ["Data", 123.45, true, "=MAX(D2:D4)", "10"] ], }
レスポンスは
UpdateValuesResponse
次のようなオブジェクトです。
{
"spreadsheetId": SPREADSHEET_ID
,
"updatedRange": "Sheet1!A1:E1",
"updatedRows": 1,
"updatedColumns": 5,
"updatedCells": 5,
}
結果のシートは次のようになります。
A | B | C | D | E | |
1 | データ | 123.45 | TRUE | =MAX(D2:D4) | 10 |
2 |
「TRUE」は中央揃えでブール値であるのに対し、「123.45」は正しい 両端揃えになります。また、数値の「10」で両端揃えになっているのは 使用します。数式は解析されず、文字列として表示されます。
値の追加
以下の表のようなシートから始めます。
A | B | C | D | |
1 | 項目 | 費用 | 在庫あり | 発送日 |
2 | ホイール | 20.50 ドル | 4 | 2016 年 3 月 1 日 |
3 |
次の
spreadsheets.values.append
コードサンプルは、行 3 から始まる 2 つの新しい値行を追加する方法を示しています。「
ValueInputOption
クエリ
パラメータが必須で、書き込まれた値を解析するかどうか(
(文字列が日付に変換されるかどうかなど)です。
リクエスト本文は、
ValueRange
書き込む範囲の値を記述するオブジェクト。「
majorDimension
フィールド
配列が行で編成された値のリストであることを示します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
/values/Sheet1!A1:E1:append?valueInputOption=VALUE_INPUT_OPTION
{ "range": "Sheet1!A1:E1", "majorDimension": "ROWS", "values": [ ["Door", "$15", "2", "3/15/2016"], ["Engine", "$100", "1", "3/20/2016"], ], }
レスポンスは
AppendValuesResponse
次のようなオブジェクトです。
{ "spreadsheetId":SPREADSHEET_ID
, "tableRange": "Sheet1!A1:D2", "updates": { "spreadsheetId":SPREADSHEET_ID
, "updatedRange": "Sheet1!A3:D4", "updatedRows": 2, "updatedColumns": 4, "updatedCells": 8, } }
結果のシートは次のようになります。
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 |