Sample code for 30+ languages & platforms
Swift

Google Sheets Conditional Formatting - Color Gradient

See more Google Sheets Examples

Add a conditional color gradient across a row

Chilkat Swift Downloads

Swift

func chilkatTest() {
    var success: Bool = false

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!

    // Implements the following CURL command:

    // curl -H "Content-Type: application/json" \
    //    -H "Authorization: Bearer ACCESS_TOKEN" \
    //    -X POST \
    //    -d '{
    //   "requests": [
    //     {
    //       "addConditionalFormatRule": {
    //         "rule": {
    //           "ranges": [
    //             {
    //               "sheetId": sheetId,
    //               "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": sheetId,
    //               "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
    //       }
    //     },
    //   ]
    // }' https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

    // Use the following online tool to generate HTTP code from a CURL command
    // Convert a cURL Command to HTTP Source Code

    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "requests": [
    //     {
    //       "addConditionalFormatRule": {
    //         "rule": {
    //           "ranges": [
    //             {
    //               "sheetId": sheetId,
    //               "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": sheetId,
    //               "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
    //       }
    //     }
    //   ]
    // }

    var sheetId: String? = "YOUR_SHEET_ID"

    let json = CkoJsonObject()!
    json.updateString(jsonPath: "requests[0].addConditionalFormatRule.rule.ranges[0].sheetId", value: sheetId)
    json.updateInt(jsonPath: "requests[0].addConditionalFormatRule.rule.ranges[0].startRowIndex", value: 9)
    json.updateInt(jsonPath: "requests[0].addConditionalFormatRule.rule.ranges[0].endRowIndex", value: 10)
    json.updateNumber(jsonPath: "requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.color.green", numericStr: "0.2")
    json.updateNumber(jsonPath: "requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.color.red", numericStr: "0.8")
    json.updateString(jsonPath: "requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.type", value: "MIN")
    json.updateNumber(jsonPath: "requests[0].addConditionalFormatRule.rule.gradientRule.maxpoint.color.green", numericStr: "0.9")
    json.updateString(jsonPath: "requests[0].addConditionalFormatRule.rule.gradientRule.maxpoint.type", value: "MAX")
    json.updateInt(jsonPath: "requests[0].addConditionalFormatRule.index", value: 0)
    json.updateString(jsonPath: "requests[1].addConditionalFormatRule.rule.ranges[0].sheetId", value: sheetId)
    json.updateInt(jsonPath: "requests[1].addConditionalFormatRule.rule.ranges[0].startRowIndex", value: 10)
    json.updateInt(jsonPath: "requests[1].addConditionalFormatRule.rule.ranges[0].endRowIndex", value: 11)
    json.updateNumber(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.color.green", numericStr: "0.8")
    json.updateNumber(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.color.red", numericStr: "0.8")
    json.updateString(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.type", value: "NUMBER")
    json.updateString(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.value", value: "0")
    json.updateNumber(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.blue", numericStr: "0.9")
    json.updateNumber(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.green", numericStr: "0.5")
    json.updateNumber(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.red", numericStr: "0.5")
    json.updateString(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.type", value: "NUMBER")
    json.updateString(jsonPath: "requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.value", value: "256")
    json.updateInt(jsonPath: "requests[1].addConditionalFormatRule.index", value: 1)

    // Adds the "Authorization: Bearer ACCESS_TOKEN" header.
    http.authToken = "ACCESS_TOKEN"
    http.setRequestHeader(name: "Content-Type", value: "application/json")

    let resp = CkoHttpResponse()!
    success = http.httpJson(verb: "POST", url: "https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate", json: json, contentType: "application/json", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Status code: \(resp.statusCode.intValue)")
    print("Response body:")
    print("\(resp.bodyStr!)")

}