Google Sheets API を使用すると、スプレッドシートで条件付き書式ルールを作成、更新できます。条件付き書式では、特定の書式タイプ（太字、斜体、取り消し線、前景色、背景色）のみを制御できます。このページの例では、Sheets API を使用して、一般的な条件付き書式操作を実行する方法を示しています。
これらの例は、言語に依存しない HTTP リクエストとして表示されます。Google API クライアント ライブラリを使用してバッチ アップデートを異なる言語で実装する方法については、スプレッドシートを更新するをご覧ください。
以下の例では、プレースホルダ SPREADSHEET_ID と SHEET_ID が、これらの ID を指定する場所を示しています。スプレッドシート ID はスプレッドシートの URL で確認できます。シート ID を取得するには、spreadsheets.get メソッドを使用します。範囲は A1 表記で指定します。範囲の例は「Sheet1!A1:D5」です。
条件付きカラー グラデーションを行全体に追加する
次の spreadsheets.batchUpdate メソッドのコードサンプルは、AddConditionalFormatRuleRequest を使用して、シートの 10 行目と 11 行目に新しいグラデーションの条件付き書式ルールを設定する方法を示しています。最初のルールは、その行のセルに、値に応じて背景色を設定するよう指定します。行の最小値は暗い赤、最大値は明るい緑色です。他の値の色は補間されます。2 番目のルールでも同じことを行いますが、特定の数値を使用してグラデーションのエンドポイント（および異なる色）を決定します。このリクエストでは、sheets.InterpolationPointType を type として使用します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"addConditionalFormatRule": {
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startRowIndex": 9,
"endRowIndex": 10,
}
],
"gradientRule": {
"minpoint": {
"color": {
"green": 0.2,
"red": 0.8
},
"type": "MIN"
},
"maxpoint": {
"color": {
"green": 0.9
},
"type": "MAX"
},
}
},
"index": 0
}
},
{
"addConditionalFormatRule": {
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startRowIndex": 10,
"endRowIndex": 11,
}
],
"gradientRule": {
"minpoint": {
"color": {
"green": 0.8,
"red": 0.8
},
"type": "NUMBER",
"value": "0"
},
"maxpoint": {
"color": {
"blue": 0.9,
"green": 0.5,
"red": 0.5
},
"type": "NUMBER",
"value": "256"
},
}
},
"index": 1
}
},
]
}
リクエストが完了すると、適用された書式ルールによってシートが更新されます。11 行目のグラデーションの maxpoint は 256 に設定されているため、それより上の値はすべて maxpoint 色になります。
一連の範囲に条件付き書式ルールを追加する
次の spreadsheets.batchUpdate メソッドのコードサンプルは、AddConditionalFormatRuleRequest を使用して、シートの列 A と C に新しい条件付き書式ルールを設定する方法を示しています。このルールでは、値が 10 以下のセルの背景色を濃い赤色に変更することを指定します。このルールはインデックス 0 で挿入されるため、他のフォーマット ルールよりも優先されます。このリクエストでは、BooleanRule の type として ConditionType を使用します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"addConditionalFormatRule": {
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startColumnIndex": 0,
"endColumnIndex": 1,
},
{
"sheetId": SHEET_ID,
"startColumnIndex": 2,
"endColumnIndex": 3,
},
],
"booleanRule": {
"condition": {
"type": "NUMBER_LESS_THAN_EQ",
"values": [
{
"userEnteredValue": "10"
}
]
},
"format": {
"backgroundColor": {
"green": 0.2,
"red": 0.8,
}
}
}
},
"index": 0
}
}
]
}
リクエストが完了すると、適用された書式ルールによってシートが更新されます。
日付とテキストの条件付き書式ルールを範囲に追加する
次の spreadsheets.batchUpdate メソッドのコードサンプルは、AddConditionalFormatRuleRequest を使用して、セルの日付とテキストの値に基づいて、シートの範囲 A1:D5 に新しい条件付き書式ルールを設定する方法を示しています。テキストに「Cost」という文字列（大文字と小文字を区別しない）が含まれている場合、最初のルールによってセルのテキストが太字に設定されます。セルに過去 1 週間より前の日付が含まれている場合は、2 番目のルールによってセルのテキストを斜体として設定し、青色にします。このリクエストでは、BooleanRule の type として ConditionType を使用します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"addConditionalFormatRule": {
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startRowIndex": 0,
"endRowIndex": 5,
"startColumnIndex": 0,
"endColumnIndex": 4,
}
],
"booleanRule": {
"condition": {
"type": "TEXT_CONTAINS",
"values": [
{
"userEnteredValue": "Cost"
}
]
},
"format": {
"textFormat": {
"bold": true
}
}
}
},
"index": 0
}
},
{
"addConditionalFormatRule": {
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startRowIndex": 0,
"endRowIndex": 5,
"startColumnIndex": 0,
"endColumnIndex": 4,
}
],
"booleanRule": {
"condition": {
"type": "DATE_BEFORE",
"values": [
{
"relativeDate": "PAST_WEEK"
}
]
},
"format": {
"textFormat": {
"italic": true,
"foregroundColor": {
"blue": 1
}
}
}
}
},
"index": 1
}
}
]
}
リクエストが完了すると、適用された書式ルールによってシートが更新されます。この例では、現在の日付は 2016 年 9 月 26 日です。
範囲にカスタム数式ルールを追加する
次の spreadsheets.batchUpdate メソッドのコードサンプルは、AddConditionalFormatRuleRequest を使用して、カスタム数式に基づいてシートの範囲 B5:B8 に対して新しい条件付き書式ルールを設定する方法を示しています。このルールでは、列 A と列 B のセルの積を計算します。積が 120 より大きい場合、セルのテキストは太字の斜体に設定されます。このリクエストでは、BooleanRule の type として ConditionType を使用します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"addConditionalFormatRule": {
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startColumnIndex": 2,
"endColumnIndex": 3,
"startRowIndex": 4,
"endRowIndex": 8
}
],
"booleanRule": {
"condition": {
"type": "CUSTOM_FORMULA",
"values": [
{
"userEnteredValue": "=GT(A5*B5,120)"
}
]
},
"format": {
"textFormat": {
"bold": true,
"italic": true
}
}
}
},
"index": 0
}
}
]
}
リクエストが完了すると、適用された書式ルールによってシートが更新されます。
条件付き書式ルールを削除する
次の spreadsheets.batchUpdate メソッドのコードサンプルは、DeleteConditionalFormatRuleRequest を使用して、SHEET_ID で指定されたシート内のインデックスが 0 の条件付き書式ルールを削除する方法を示しています。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"deleteConditionalFormatRule": {
"sheetId": SHEET_ID,
"index": 0
}
}
]
}
条件付き書式ルールのリストを読む
次の spreadsheets.get メソッドのコードサンプルは、スプレッドシートの各シートのタイトル、SHEET_ID、条件付き書式ルールのリストを取得する方法を示しています。fields クエリ パラメータは、返されるデータを決定します。
リクエスト プロトコルを以下に示します。
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?fields=sheets(properties(title,sheetId),conditionalFormats)
レスポンスは Spreadsheet リソースで構成されます。このリソースには、それぞれ SheetProperties 要素を持つ Sheet オブジェクトの配列と、ConditionalFormatRule 要素の配列が含まれます。レスポンス フィールドがデフォルト値に設定されている場合、そのフィールドはレスポンスから除外されます。このリクエストでは、BooleanRule の type として ConditionType を使用します。
{
"sheets": [
{
"properties": {
"sheetId": 0,
"title": "Sheet1"
},
"conditionalFormats": [
{
"ranges": [
{
"startRowIndex": 4,
"endRowIndex": 8,
"startColumnIndex": 2,
"endColumnIndex": 3
}
],
"booleanRule": {
"condition": {
"type": "CUSTOM_FORMULA",
"values": [
{
"userEnteredValue": "=GT(A5*B5,120)"
}
]
},
"format": {
"textFormat": {
"bold": true,
"italic": true
}
}
}
},
{
"ranges": [
{
"startRowIndex": 0,
"endRowIndex": 5,
"startColumnIndex": 0,
"endColumnIndex": 4
}
],
"booleanRule": {
"condition": {
"type": "DATE_BEFORE",
"values": [
{
"relativeDate": "PAST_WEEK"
}
]
},
"format": {
"textFormat": {
"foregroundColor": {
"blue": 1
},
"italic": true
}
}
}
},
...
]
}
]
}
条件付き書式ルールまたはその優先度を更新する
次の spreadsheets.batchUpdate メソッドのコードサンプルは、複数のリクエストで UpdateConditionalFormatRuleRequest を使用する方法を示しています。最初のリクエストでは、既存の条件付き書式ルールを高いインデックスに移動します（0 から 2 に優先度を下げます）。2 番目のリクエストでは、インデックス 0 の条件付き書式ルールが、A1:D5 の範囲内で指定されたテキスト（「Total Cost」）を含むセルを書式設定する新しいルールに置き換えられます。最初のリクエストの移動は 2 番目のリクエストが開始する前に完了するため、2 番目のリクエストによって元々インデックス 1 にあったルールが置き換えられます。このリクエストでは、ConditionType を BooleanRule の type として使用します。
リクエスト プロトコルを以下に示します。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"updateConditionalFormatRule": {
"sheetId": SHEET_ID,
"index": 0,
"newIndex": 2
},
"updateConditionalFormatRule": {
"sheetId": SHEET_ID,
"index": 0,
"rule": {
"ranges": [
{
"sheetId": SHEET_ID,
"startRowIndex": 0,
"endRowIndex": 5,
"startColumnIndex": 0,
"endColumnIndex": 4,
}
],
"booleanRule": {
"condition": {
"type": "TEXT_EQ",
"values": [
{
"userEnteredValue": "Total Cost"
}
]
},
"format": {
"textFormat": {
"bold": true
}
}
}
}
}
}
]
}