Google Sheets API ช่วยให้คุณอ่านค่าจากเซลล์ ช่วง เซตของช่วง และชีตทั้งหมดได้ ตัวอย่างในหน้านี้แสดงการดำเนินการ
อ่านที่พบบ่อยด้วย
spreadsheets.values
ทรัพยากร นอกจากนี้ คุณยังอ่านค่าเซลล์ได้โดยใช้วิธี
spreadsheets.get แต่มักจะ
ใช้วิธี
spreadsheets.values.get
หรือ
spreadsheets.values.batchGet
ได้ง่ายกว่า
ตัวอย่างเหล่านี้แสดงในรูปแบบคำขอ HTTP เพื่อให้เป็นกลางทางภาษา ดูวิธีอ่านข้อมูลในภาษาต่างๆ โดยใช้ไลบรารีของไคลเอ็นต์ Google API ได้ที่อ่านและเขียนค่าเซลล์ values
ในตัวอย่างเหล่านี้ ตัวยึดตำแหน่ง SPREADSHEET_ID จะระบุตำแหน่งที่คุณ จะระบุรหัสของสเปรดชีต, ซึ่งดูได้จาก URL ของสเปรดชีต ระบบจะระบุช่วงที่จะอ่านโดยใช้สัญลักษณ์ A1 ใน URL ของคำขอ ตัวอย่างช่วงคือ Sheet1!A1:D5
ข้อมูลต้นฉบับ
สำหรับตัวอย่างเหล่านี้ ให้สมมติว่าสเปรดชีตที่จะอ่านมีข้อมูลต้นฉบับต่อไปนี้ในชีตแรก ("Sheet1") สตริงในแถวแรกเป็นป้ายกำกับสำหรับคอลัมน์แต่ละคอลัมน์ หากต้องการดูตัวอย่างวิธีอ่านจากชีตอื่นๆ ใน สเปรดชีต ให้ดูสัญลักษณ์ A1
| A | ข | C | D | |
| 1 | รายการ | ค่าใช้จ่าย | มีในสต็อก | วันที่จัดส่ง |
| 2 | ตั๋วขึ้นชิงช้าสวรรค์ | $20.50 | 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": [
[...],
[...]
]
}
]
}