Class ScriptProperties

พร็อพเพอร์ตี้ของสคริปต์

เลิกใช้งานแล้ว เลิกใช้งานคลาสนี้แล้วและไม่ควรใช้ในสคริปต์ใหม่

พร็อพเพอร์ตี้ของสคริปต์คือคู่คีย์-ค่าที่สคริปต์จัดเก็บไว้ในที่เก็บข้อมูลแบบถาวร พร็อพเพอร์ตี้สคริปต์ จะกำหนดขอบเขตต่อสคริปต์ ไม่ว่าผู้ใช้รายใดจะเรียกใช้สคริปต์ก็ตาม

วิธีการที่เลิกใช้งานแล้ว

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
deleteAllProperties()	ScriptProperties	ลบพร็อพเพอร์ตี้ทั้งหมด
deleteProperty(key)	ScriptProperties	ลบพร็อพเพอร์ตี้ที่มีคีย์ที่ระบุ
getKeys()	String[]	รับคีย์ที่พร้อมใช้งานทั้งหมด
getProperties()	Object	รับพร็อพเพอร์ตี้ทั้งหมดที่ใช้ได้พร้อมกัน
getProperty(key)	String|null	แสดงค่าที่เชื่อมโยงกับคีย์ที่ระบุ หรือ null หากไม่มีค่าดังกล่าว
setProperties(properties)	ScriptProperties	ตั้งค่าพร็อพเพอร์ตี้ทั้งหมดที่ดึงมาจากออบเจ็กต์ที่ระบุ
setProperties(properties, deleteAllOthers)	ScriptProperties	ตั้งค่าพร็อพเพอร์ตี้ทั้งหมดที่ดึงมาจากออบเจ็กต์ที่ระบุ
setProperty(key, value)	ScriptProperties	คงค่าที่ระบุไว้ด้วยคีย์ที่ระบุ

วิธีการที่เลิกใช้งานแล้ว

deleteAllProperties()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

ลบพร็อพเพอร์ตี้ทั้งหมด

ScriptProperties.deleteAllProperties();

รีเทิร์น

ScriptProperties - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

ดูเพิ่มเติม

• deleteProperty(key)

---

deleteProperty(key)

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

ลบพร็อพเพอร์ตี้ที่มีคีย์ที่ระบุ

ScriptProperties.deleteProperty('special');

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
key	String	คีย์สำหรับพร็อพเพอร์ตี้ที่จะลบ

รีเทิร์น

ScriptProperties - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

ดูเพิ่มเติม

• deleteAllProperties()

---

getKeys()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

รับคีย์ที่พร้อมใช้งานทั้งหมด

รีเทิร์น

String[]

---

getProperties()

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

รับพร็อพเพอร์ตี้ทั้งหมดที่ใช้ได้พร้อมกัน

ซึ่งจะให้สำเนา ไม่ใช่มุมมองแบบเรียลไทม์ ดังนั้นการเปลี่ยนพร็อพเพอร์ตี้ในออบเจ็กต์ที่ส่งคืนจะไม่ อัปเดตพร็อพเพอร์ตี้เหล่านั้นในที่เก็บข้อมูล และในทางกลับกัน

ScriptProperties.setProperties({
  "cow"     : "moo",
  "sheep"   : "baa",
  "chicken" : "cluck"
});

// Logs "A cow goes: moo"
Logger.log("A cow goes: %s", ScriptProperties.getProperty("cow"));

// This makes a copy. Any changes that happen here will not
// be written back to properties.
var animalSounds = ScriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for(var kind in animalSounds) {
  Logger.log("A %s goes %s!", kind, animalSounds[kind]);
}

รีเทิร์น

Object - สำเนาของพร็อพเพอร์ตี้ที่มีคู่คีย์-ค่า

---

getProperty(key)

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

แสดงค่าที่เชื่อมโยงกับคีย์ที่ระบุ หรือ null หากไม่มีค่าดังกล่าว

const specialValue = ScriptProperties.getProperty('special');

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
key	String	คีย์สำหรับค่าที่จะดึงข้อมูล

รีเทิร์น

String|null — ค่าที่เชื่อมโยงกับคีย์

ดูเพิ่มเติม

• setProperty(key, value)

---

setProperties(properties)

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

ตั้งค่าพร็อพเพอร์ตี้ทั้งหมดที่ดึงมาจากออบเจ็กต์ที่ระบุ

ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
properties	Object	ออบเจ็กต์ที่มีพร็อพเพอร์ตี้ที่จะตั้งค่า

รีเทิร์น

ScriptProperties - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

ดูเพิ่มเติม

• setProperty(key, value)

---

setProperties(properties, deleteAllOthers)

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

ตั้งค่าพร็อพเพอร์ตี้ทั้งหมดที่ดึงมาจากออบเจ็กต์ที่ระบุ

// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
properties	Object	ออบเจ็กต์ที่มีพร็อพเพอร์ตี้ที่จะตั้งค่า
deleteAllOthers	Boolean	ว่าจะลบพร็อพเพอร์ตี้ที่มีอยู่ทั้งหมดหรือไม่

รีเทิร์น

ScriptProperties - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

ดูเพิ่มเติม

• setProperty(key, value)

---

setProperty(key, value)

เลิกใช้งานแล้ว ฟังก์ชันนี้เลิกใช้งานแล้วและไม่ควรใช้ในสคริปต์ใหม่

คงค่าที่ระบุไว้ด้วยคีย์ที่ระบุ ระบบจะเขียนทับค่าที่มีอยู่ซึ่งเชื่อมโยงกับ คีย์นี้

ScriptProperties.setProperty('special', 'sauce');

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
key	String	คีย์สำหรับพร็อพเพอร์ตี้
value	String	ค่าที่จะเชื่อมโยงกับคีย์

รีเทิร์น

ScriptProperties - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

ดูเพิ่มเติม

• getProperty(key)