ช่วงที่ตั้งชื่อ &ป้องกัน

Google Sheets API ให้คุณสร้าง แก้ไข และลบช่วงที่ตั้งชื่อหรือช่วงที่ป้องกันไว้ ตัวอย่างในหน้านี้จะแสดงวิธีที่คุณสามารถใช้ชีต API เพื่อทำงานบางอย่างทั่วๆ ไป

ตัวอย่างเหล่านี้แสดงในรูปแบบคำขอ HTTP โดยแสดงเป็นภาษากลาง หากต้องการดูวิธีใช้การอัปเดตแบบกลุ่มในภาษาต่างๆ โดยใช้ไลบรารีของไคลเอ็นต์ Google API โปรดดูอัปเดตสเปรดชีต

ในตัวอย่างต่อไปนี้ ตัวยึดตำแหน่ง SPREADSHEET_ID และ SHEET_ID ระบุตำแหน่งที่คุณจะระบุรหัสเหล่านั้น คุณดูรหัสของสเปรดชีตได้ใน URL ของสเปรดชีต คุณดูรหัสชีตได้โดยใช้เมธอด spreadsheets.get โดยจะระบุช่วงโดยใช้รูปแบบ A1 ช่วงตัวอย่างคือ Sheet1!A1:D5

นอกจากนี้ ตัวยึดตำแหน่ง NAMED_RANGE_ID และ PROTECTED_RANGE_ID ยังให้รหัสสำหรับช่วงที่ตั้งชื่อและป้องกันได้ด้วย ระบบจะใช้ namedRangeId และ protectedRangeId เมื่อส่งคำขอเพื่ออัปเดตหรือลบช่วงที่เชื่อมโยง รหัสจะส่งกลับมาในการตอบกลับคำขอ Sheets API ที่สร้างช่วงที่ตั้งชื่อหรือป้องกัน คุณดูรหัสของช่วงที่มีอยู่ได้ด้วยเมธอด spreadsheets.get ในเนื้อหาการตอบกลับ Spreadsheet

เพิ่มช่วงที่ตั้งชื่อหรือช่วงที่ป้องกันไว้

ตัวอย่างโค้ด spreadsheets.batchUpdate ต่อไปนี้จะแสดงวิธีใช้ออบเจ็กต์คำขอ 2 รายการ ตัวเลือกแรกจะใช้ AddNamedRangeRequest เพื่อกำหนดช่วงเป็น "จำนวน" ให้กับช่วง A1:E3 รายการที่ 2 ใช้ AddProtectedRangeRequest เพื่อแนบการปกป้องระดับคำเตือนกับช่วง A4:E4 การป้องกันระดับนี้ยังอนุญาตให้แก้ไขเซลล์ภายในช่วงได้ แต่จะแสดงคำเตือนก่อนทำการเปลี่ยนแปลง

คำขอเหล่านี้จะแสดงผล AddNamedRangeResponse และ AddProtectedRangeResponse ซึ่งมีรหัสช่วงและพร็อพเพอร์ตี้

โปรโตคอลคำขอแสดงอยู่ด้านล่าง

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "addNamedRange": {
        "namedRange": {
          "name": "Counts",
          "range": {
            "sheetId": SHEET_ID,
            "startRowIndex": 0,
            "endRowIndex": 3,
            "startColumnIndex": 0,
            "endColumnIndex": 5,
          },
        }
      }
    },
    {
      "addProtectedRange": {
        "protectedRange": {
          "range": {
            "sheetId": SHEET_ID,
            "startRowIndex": 3,
            "endRowIndex": 4,
            "startColumnIndex": 0,
            "endColumnIndex": 5,
          },
          "description": "Protecting total row",
          "warningOnly": true
        }
      }
    }
  ]
}

ลบช่วงที่ตั้งชื่อหรือช่วงที่ป้องกันไว้

ตัวอย่างโค้ด spreadsheets.batchUpdate ต่อไปนี้จะแสดงวิธีใช้ออบเจ็กต์คำขอ 2 รายการ แท็กแรกจะใช้ DeleteNamedRangeRequest เพื่อลบช่วงที่ตั้งชื่อแล้วที่มีอยู่ โดยใช้ NAMED_RANGE_ID จากการเรียก API ก่อนหน้า รายการที่ 2 ใช้ DeleteProtectedRangeRequest เพื่อลบการป้องกันช่วงที่มีอยู่ โดยใช้ PROTECTED_RANGE_ID จากการเรียก API ก่อนหน้า

โปรโตคอลคำขอแสดงอยู่ด้านล่าง

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "deleteNamedRange": {
          "namedRangeId": "NAMED_RANGE_ID",
      }
    },
    {
      "deleteProtectedRange": {
        "protectedRangeId": PROTECTED_RANGE_ID,
      }
    }
  ]
}

อัปเดตช่วงที่ตั้งชื่อหรือช่วงที่ป้องกันไว้

ตัวอย่างโค้ด spreadsheets.batchUpdate ต่อไปนี้จะแสดงวิธีใช้ออบเจ็กต์คำขอ 2 รายการ รายการแรกจะใช้ UpdateNamedRangeRequest เพื่ออัปเดตชื่อของช่วงที่ตั้งชื่อที่มีอยู่เป็น "InitialCounts" โดยใช้ NAMED_RANGE_ID จากการเรียก API ก่อนหน้า รายการที่ 2 จะใช้ UpdateProtectedRangeRequest เพื่ออัปเดตช่วงที่มีการป้องกันที่มีอยู่ เพื่อให้ป้องกันช่วงที่ใช้ชื่อเดียวกัน เมธอด Editors อนุญาตให้เฉพาะผู้ใช้ที่ระบุไว้แก้ไขเซลล์เหล่านั้นได้ คำขอนี้ใช้ NAMED_RANGE_ID และ PROTECTED_RANGE_ID จากการเรียก API ก่อนหน้านี้

โปรโตคอลคำขอแสดงอยู่ด้านล่าง

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "updateNamedRange": {
        "namedRange": {
          "namedRangeId": NAMED_RANGE_ID,
          "name": "InitialCounts",
        },
        "fields": "name",
      }
    },
    {
      "updateProtectedRange": {
        "protectedRange": {
          "protectedRangeId": PROTECTED_RANGE_ID,
          "namedRangeId": NAMED_RANGE_ID,
          "warningOnly": false,
          "editors": {
            "users": [
              "charlie@example.com",
              "sasha@example.com"
            ]
          }
        },
        "fields": "namedRangeId,warningOnly,editors"
      }
    }
  ]
}