Google Sheets API を使用すると、スプレッドシート内のセルや範囲の書式設定を更新できます。このページの例では、Sheets API を使用して一般的な書式設定オペレーションを行う方法を示します。条件付き書式のその他の例については、条件付き書式のレシピ ページをご覧ください。
スプレッドシートを更新するときに、一部のリクエストでレスポンスが返されることがあります。これらは配列で返され、各レスポンスは対応するリクエストと同じインデックスを占有します。リクエストによってはレスポンスがない場合があり、その場合はレスポンスが空になります。これらの例のレスポンス構造は spreadsheets.batchUpdate にあります。
これらの例は、言語に依存しない HTTP リクエストの形式で示されています。Google API クライアント ライブラリを使用してさまざまな言語でバッチ更新を実装する方法については、スプレッドシートを更新するをご覧ください。
以下の例では、SPREADSHEET_ID と SHEET_ID というプレースホルダを使用して、これらの ID をどこで指定するかを示しています。スプレッドシート ID はスプレッドシートの URL で確認できます。シート ID は、spreadsheets.get メソッドを使用して取得できます。範囲は A1 表記を使用して指定します。範囲の例は Sheet1!A1:D5 です。
上の動画では、固定行の作成、セルの太字化、通貨の表示形式の実装、セルの検証の実行、セル値の制限など、スプレッドシートのセルに対してさまざまな方法で書式を設定する方法について説明します。
セルの枠線を編集する
次の spreadsheets.batchUpdate コードサンプルは、UpdateBordersRequest を使用して、A1 ～ F10 の範囲内の各セルの上下の境界線に青い破線を付ける方法を示しています。innerHorizontal フィールドを使用すると、範囲の内部に水平の境界線が作成されます。このフィールドを省略すると、範囲全体の上部と下部にのみ境界線が追加されます。
リクエスト プロトコルは次のとおりです。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"updateBorders": {
"range": {
"sheetId": SHEET_ID,
"startRowIndex": 0,
"endRowIndex": 10,
"startColumnIndex": 0,
"endColumnIndex": 6
},
"top": {
"style": "DASHED",
"width": 1,
"color": {
"blue": 1.0
},
},
"bottom": {
"style": "DASHED",
"width": 1,
"color": {
"blue": 1.0
},
},
"innerHorizontal": {
"style": "DASHED",
"width": 1,
"color": {
"blue": 1.0
},
},
}
}
]
}ヘッダー行の書式を設定する
次の spreadsheets.batchUpdate コードサンプルは、RepeatCellRequest を使用してシートのヘッダー行をフォーマットする方法を示しています。最初のリクエストでは、テキストの色、背景色、テキストのフォントサイズ、テキストの配置を更新し、テキストを太字にします。range フィールドで列番号を省略すると、行全体がフォーマットされます。2 つ目のリクエストでは、ヘッダー行が固定されるようにシート プロパティを調整します。
リクエスト プロトコルは次のとおりです。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{ "requests": [ { "repeatCell": { "range": { "sheetId": SHEET_ID, "startRowIndex": 0, "endRowIndex": 1 }, "cell": { "userEnteredFormat": { "backgroundColor": { "red": 0.0, "green": 0.0, "blue": 0.0 }, "horizontalAlignment" : "CENTER", "textFormat": { "foregroundColor": { "red": 1.0, "green": 1.0, "blue": 1.0 }, "fontSize": 12, "bold": true } } }, "fields": "userEnteredFormat(backgroundColor,textFormat,horizontalAlignment)" } }, { "updateSheetProperties": { "properties": { "sheetId": SHEET_ID, "gridProperties": { "frozenRowCount": 1 } }, "fields": "gridProperties.frozenRowCount" } } ] }
セルを結合
次の spreadsheets.batchUpdate コードサンプルは、MergeCellsRequest を使用してセルを結合する方法を示しています。最初のリクエストは、A1:B2 範囲を 1 つのセルに結合します。2 番目のリクエストでは、行は分離したまま、A3:B6 の列を結合します。
リクエスト プロトコルは次のとおりです。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"mergeCells": {
"range": {
"sheetId": SHEET_ID,
"startRowIndex": 0,
"endRowIndex": 2,
"startColumnIndex": 0,
"endColumnIndex": 2
},
"mergeType": "MERGE_ALL"
}
},
{
"mergeCells": {
"range": {
"sheetId": SHEET_ID,
"startRowIndex": 2,
"endRowIndex": 6,
"startColumnIndex": 0,
"endColumnIndex": 2
},
"mergeType": "MERGE_COLUMNS"
}
},
]
}期間にカスタムの日時形式または小数点形式を設定する
次の spreadsheets.batchUpdate コードサンプルは、RepeatCellRequest を使用してセルを更新し、カスタムの日時形式と数値形式を適用する方法を示しています。最初のリクエストでは、A1 ～ A10 の範囲のセルにはカスタム日時形式 hh:mm:ss am/pm,
ddd mmm dd yyyy が適用されます。この形式の日時の例は、「2016 年 4 月 3 日（日）午後 2 時 5 分 7 秒」です。
2 つ目のリクエストでは、B1 ～ B10 のセルにカスタム数値形式 #,##0.0000 を指定します。これは、数値をカンマ区切りでグループ化し、小数点以下に 4 桁を表示し、先頭のゼロを 1 桁以外削除することを示します。たとえば、数値「3.14」は「3.1400」と表示されますが、「12345.12345」は「12,345.1235」と表示されます。
リクエスト プロトコルは次のとおりです。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{ "requests": [ { "repeatCell": { "range": { "sheetId": SHEET_ID, "startRowIndex": 0, "endRowIndex": 10, "startColumnIndex": 0, "endColumnIndex": 1 }, "cell": { "userEnteredFormat": { "numberFormat": { "type": "DATE", "pattern": "hh:mm:ss am/pm, ddd mmm dd yyyy" } } }, "fields": "userEnteredFormat.numberFormat" } }, { "repeatCell": { "range": { "sheetId": SHEET_ID, "startRowIndex": 0, "endRowIndex": 10, "startColumnIndex": 1, "endColumnIndex": 2 }, "cell": { "userEnteredFormat": { "numberFormat": { "type": "NUMBER", "pattern": "#,##0.0000" } } }, "fields": "userEnteredFormat.numberFormat" } } ] }