การอ่านพื้นฐาน

Google Sheets API อนุญาตให้คุณอ่านค่าจากเซลล์ ช่วง ชุดของช่วง และทั้งชีต ตัวอย่างในหน้านี้แสดงการอ่านทั่วไป ที่มี spreadsheets.values ทรัพยากร นอกจากนี้ คุณยังสามารถอ่านค่าเซลล์โดยใช้ spreadsheets.get แต่ โดยปกติ spreadsheets.values.get หรือ spreadsheets.values.batchGet นั้นง่ายกว่า

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

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

ข้อมูลต้นฉบับ

สำหรับตัวอย่างต่อไปนี้ ให้สมมติว่าสเปรดชีตที่อ่านมีแหล่งที่มาต่อไปนี้ ในชีตแรก ("Sheet1") สตริงในแถวแรกคือป้ายกำกับสำหรับ แต่ละคอลัมน์ หากต้องการดูตัวอย่างวิธีการอ่านจากชีตอื่นๆ ใน สเปรดชีตของคุณ โปรดดูรูปแบบ A1

A C D
1 รายการ ค่าใช้จ่าย มีสินค้าพร้อมจำหน่าย วันที่จัดส่ง
2 ตั๋วขึ้นชิงช้าสวรรค์ ฿600.00 4 1/3/2016
3 ประตู $15 2 15/3/2016
4 เครื่องยนต์ $100 1 20/3/2016
5 ผลรวม ฿135.5 7 20/3/2016

อ่านช่วงเดียว

ดังต่อไปนี้ spreadsheets.values.get ตัวอย่างโค้ดแสดงวิธีอ่านค่าจากช่วง Sheet1!A1:D5 และผลลัพธ์ พวกเขาในการตอบกลับ และละเว้นแถวและคอลัมน์ปิดท้ายที่ว่างเปล่า

โปรโตคอลคำขอจะแสดงที่นี่

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5

คำตอบจะประกอบด้วย ValueRange ที่อธิบายค่าของช่วง ช่อง majorDimension ระบุว่าอาร์เรย์เป็นรายการค่าที่จัดระเบียบตามแถว

{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "3/1/2016"],
    ["Door", "$15", "2", "3/15/2016"],
    ["Engine", "$100", "1", "30/20/2016"],
    ["Totals", "$135.5", "7", "3/20/2016"]
  ],
}

อ่านช่วงเดียวที่จัดกลุ่มตามคอลัมน์

ดังต่อไปนี้ spreadsheets.values.get ตัวอย่างโค้ดแสดงวิธีอ่านค่าจากช่วง Sheet1!A1:D3 และผลลัพธ์ ในคำตอบ แต่จัดกลุ่มตามคอลัมน์ แถวและคอลัมน์ต่อท้ายที่ว่างเปล่า ละเว้น

โปรโตคอลคำขอจะแสดงที่นี่

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D3?majorDimension=COLUMNS

คำตอบจะประกอบด้วย ValueRange ที่อธิบายค่าของช่วง ช่อง majorDimension ระบุว่าอาร์เรย์เป็นรายการค่าที่จัดเรียงตามคอลัมน์

{
  "range": "Sheet1!A1:D3",
  "majorDimension": "COLUMNS",
  "values": [
    ["Item", "Wheel", "Door"],
    ["Cost", "$20.50", "$15"],
    ["Stocked", "4", "2"],
    ["Ship Date", "3/1/2016", "3/15/2016"]
  ],
}

อ่านช่วงเดียวพร้อมตัวเลือกการแสดงผล

ดังต่อไปนี้ spreadsheets.values.get ตัวอย่างโค้ดแสดงวิธีอ่านค่าจากช่วง Sheet1!A1:D5 และผลลัพธ์ ในการตอบกลับ แต่ใช้ตัวเลือกการแสดงผลเพื่อจัดการวิธีที่ข้อมูลนั้น การตั้งค่า ValueRenderOption ของ FORMULA หมายความว่าระบบจะส่งคืนสูตรแทนฟังก์ชัน และฟังก์ชัน DateTimeRenderOption การตั้งค่าของ SERIAL_NUMBER ระบุว่าระบบจะแสดงผลวันที่เป็นตัวเลข การตั้งค่าอื่นๆ ก็เป็นไปได้เช่นกัน แถวและคอลัมน์ต่อท้ายที่ว่างเปล่า ละเว้น

โปรโตคอลคำขอจะแสดงที่นี่

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5?
            valueRenderOption=FORMULA&dateTimeRenderOption=SERIAL_NUMBER

คำตอบจะประกอบด้วย ValueRange ที่อธิบายค่าของช่วง ช่อง majorDimension ระบุว่าอาร์เรย์เป็นรายการค่าที่จัดระเบียบตามแถว

{
  "range": "Sheet1!A1:D5",
  "majorDimension": "ROWS",
  "values": [
    ["Item", "Cost", "Stocked", "Ship Date"],
    ["Wheel", "$20.50", "4", "42430"],
    ["Door", "$15", "2", "42444"],
    ["Engine", "$100", "1", "42449"],
    ["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"]
  ],
}

อ่านหลายช่วง

ดังต่อไปนี้ spreadsheets.values.batchGet ตัวอย่างโค้ดแสดงวิธีอ่านค่าจากช่วง Sheet1!B:B และ Sheet1!D:D และ จะแสดงผลลัพธ์เหล่านั้นในการตอบกลับ การตั้งค่า ValueRenderOption ของ UNFORMATTED_VALUE บ่งชี้ว่าค่าได้รับการคำนวณ แต่ไม่ได้จัดรูปแบบ ในการตอบกลับ และละเว้นแถวและคอลัมน์ปิดท้ายที่ว่างเปล่า

โปรโตคอลคำขอจะแสดงที่นี่

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
            ranges=Sheet1!B:B&ranges=Sheet1!D:D&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNS

การตอบกลับการเรียกเมธอดนี้ประกอบด้วยออบเจ็กต์ที่มีรหัสสเปรดชีต และอาร์เรย์ของ ValueRange แต่ละช่วงที่ขอ ซึ่งแสดงตามลำดับ ที่ขอ ช่อง majorDimension ระบุว่าอาร์เรย์เป็นรายการค่าที่จัดเรียงตามคอลัมน์ เช่น

{
  "spreadsheetId": SPREADSHEET_ID,
  "valueRanges": [
    {
      "range": "Sheet1!B1:B1000",
      "majorDimension": "COLUMNS",
      "values": [
        ["Cost",20.5,15,100,135.5]
      ]
    },
    {
      "range": "Sheet1!D1:D1000",
      "majorDimension": "COLUMNS",
      "values": [
        ["Ship Date",42430,42444,42449,42449]
      ]s
    }
  ]
}

อ่านหลายช่วงในชีตหลายรายการ

ดังต่อไปนี้ spreadsheets.values.batchGet ตัวอย่างโค้ดแสดงวิธีอ่านค่าจากช่วงในชีต Sheet1!A1:D5, Products!D1:D100 และ Sales!E4:F6 แล้วส่งคืนผลิตภัณฑ์เหล่านั้นในการตอบกลับ การตั้งค่า ValueRenderOption ของ UNFORMATTED_VALUE บ่งชี้ว่าค่าได้รับการคำนวณ แต่ไม่ได้จัดรูปแบบ ในการตอบกลับ และละเว้นแถวและคอลัมน์ปิดท้ายที่ว่างเปล่า

โปรโตคอลคำขอจะแสดงที่นี่

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
            ranges=Sheet1!A1:D5&ranges=Products!D1:D100&ranges=Sales!E4:F6&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNS

การตอบกลับการเรียกเมธอดนี้ประกอบด้วยออบเจ็กต์ที่มีรหัสสเปรดชีต และอาร์เรย์ของ ValueRange แต่ละช่วงที่ขอ ซึ่งแสดงตามลำดับ ที่ขอ ช่อง majorDimension ระบุว่าอาร์เรย์เป็นรายการค่าที่จัดเรียงตามคอลัมน์ เช่น

{
  "spreadsheetId": SPREADSHEET_ID,
  "valueRanges": [
    {
      "range": "Sheet1!A1:D5",
      "majorDimension": "COLUMNS",
      "values": [
        [...],
        [...]
      ]
    },
    {
      "range": "Products!D1:D100",
      "majorDimension": "COLUMNS",
      "values": [
        [...]
      ]
    },
    {
      "range": "Sales!E4:F6",
      "majorDimension": "COLUMNS",
      "values": [
        [...],
        [...]
      ]
    }
  ]
}