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"
}
},
]
}
範囲にカスタムの日時または 10 進数形式を設定する
次の spreadsheets.batchUpdate コードサンプルは、RepeatCellRequest を使用してセルを更新し、カスタムの日時形式と数値形式を設定する方法を示しています。最初のリクエストでは、範囲 A1:A10 のセルにカスタムの日時形式 hh:mm:ss am/pm,
ddd mmm dd yyyy が設定されます。この形式の日時の例: 「02:05:07 PM, Sun Apr 03 2016」
2 番目のリクエストでは、B1:B10 のセルにカスタム数値形式 #,##0.0000 を指定します。これは、数値をカンマ区切りでグループ化し、小数点以下 4 桁で先頭のゼロを除くすべてを削除することを示します。たとえば、数値「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"
}
}
]
}