บริการอสังหาริมทรัพย์

บริการพร็อพเพอร์ตี้ช่วยให้คุณเก็บข้อมูลแบบง่ายในคู่คีย์-ค่าที่มีขอบเขตอยู่ที่สคริปต์ 1 รายการ ผู้ใช้สคริปต์ 1 ราย หรือเอกสาร 1 ฉบับที่ใช้ส่วนเสริม โดยปกติมักใช้เพื่อจัดเก็บการกำหนดค่าของนักพัฒนาซอฟต์แวร์หรือค่ากำหนดของผู้ใช้ โดยจะไม่มีการแชร์พร็อพเพอร์ตี้ระหว่างสคริปต์ต่างๆ

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

การเปรียบเทียบร้านค้าอสังหาริมทรัพย์

ออบเจ็กต์ส่วนกลาง PropertiesService มี 3 วิธี ซึ่งแต่ละวิธีจะแสดงผลออบเจ็กต์ Properties ที่คล้ายกันแต่มีสิทธิ์การเข้าถึงแตกต่างกัน ดังที่แสดงในตารางต่อไปนี้

	คุณสมบัติของสคริปต์	พร็อพเพอร์ตี้ผู้ใช้	คุณสมบัติของเอกสาร
วิธีเข้าถึง	getScriptProperties()	getUserProperties()	getDocumentProperties()
ข้อมูลที่แชร์ระหว่าง	ผู้ใช้ทั้งหมดของสคริปต์ ส่วนเสริม หรือเว็บแอป	ผู้ใช้ปัจจุบันของสคริปต์ ส่วนเสริม หรือเว็บแอป	ผู้ใช้ทั้งหมดของส่วนเสริมในเอกสารที่เปิดอยู่
ปกติแล้วใช้สำหรับ	ข้อมูลการกำหนดค่าทั่วทั้งแอป เช่น ชื่อผู้ใช้และรหัสผ่านสำหรับฐานข้อมูลภายนอกของนักพัฒนาซอฟต์แวร์	การตั้งค่าเฉพาะผู้ใช้ เช่น หน่วยเมตริกหรือหน่วยอิมพีเรียล	ข้อมูลเฉพาะเอกสาร เช่น URL แหล่งที่มาของแผนภูมิที่ฝัง

รูปแบบข้อมูล

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

กำลังบันทึกข้อมูล

หากต้องการบันทึกค่าเดียว ให้เรียกเมธอด Properties.setProperty(key, value) ของ Store ที่เหมาะสม ดังที่แสดงในตัวอย่างต่อไปนี้

service/propertyService.gs

ดูใน GitHub

try {
  // Set a property in each of the three property stores.
  const scriptProperties = PropertiesService.getScriptProperties();
  const userProperties = PropertiesService.getUserProperties();
  const documentProperties = PropertiesService.getDocumentProperties();

  scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/');
  userProperties.setProperty('DISPLAY_UNITS', 'metric');
  documentProperties.setProperty('SOURCE_DATA_ID',
      '1j3GgabZvXUF177W0Zs_2v--H6SPCQb4pmZ6HsTZYT5k');
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

หากต้องการบันทึกข้อมูลจำนวนมาก ให้ส่งการแมปคู่คีย์-ค่าไปยัง Properties.setProperties(properties) คู่คีย์-ค่าแต่ละคู่ของออบเจ็กต์ในพารามิเตอร์จะจัดเก็บเป็นพร็อพเพอร์ตี้แยกกัน

service/propertyService.gs

ดูใน GitHub

try {
  // Set multiple script properties in one call.
  const scriptProperties = PropertiesService.getScriptProperties();
  scriptProperties.setProperties({
    'cow': 'moo',
    'sheep': 'baa',
    'chicken': 'cluck'
  });
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

กำลังอ่านข้อมูล

หากต้องการดึงค่าเดียวที่คุณบันทึกไว้ก่อนหน้านี้ ให้เรียกใช้ Properties.getProperty(key) ดังนี้

service/propertyService.gs

ดูใน GitHub

try {
  // Get the value for the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  const units = userProperties.getProperty('DISPLAY_UNITS');
  console.log('values of units %s', units);
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

หากต้องการดึงข้อมูลค่าทั้งหมดในพื้นที่เก็บข้อมูลพร็อพเพอร์ตี้ปัจจุบัน ให้เรียกใช้ Properties.getProperties() ดังนี้

service/propertyService.gs

ดูใน GitHub

try {
  // Get multiple script properties in one call, then log them all.
  const scriptProperties = PropertiesService.getScriptProperties();
  const data = scriptProperties.getProperties();
  for (const key in data) {
    console.log('Key: %s, Value: %s', key, data[key]);
  }
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

การแก้ไขข้อมูล

เมธอด getProperty() และ getProperties() จะแสดงสำเนาของข้อมูลที่จัดเก็บไว้ ไม่ใช่มุมมองจริง ดังนั้นการเปลี่ยนออบเจ็กต์ที่แสดงผลจะไม่อัปเดตค่าในที่เก็บพร็อพเพอร์ตี้ หากต้องการอัปเดตข้อมูลในสโตร์ ให้บันทึกอีกครั้ง:

service/propertyService.gs

ดูใน GitHub

try {
  // Change the unit type in the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  let units = userProperties.getProperty('DISPLAY_UNITS');
  units = 'imperial'; // Only changes local value, not stored value.
  userProperties.setProperty('DISPLAY_UNITS', units); // Updates stored value.
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

การลบข้อมูล

หากต้องการลบค่าเดียว ให้เรียกใช้ Properties.deleteProperty(key) โดยทำดังนี้

service/propertyService.gs

ดูใน GitHub

try {
  // Delete the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('DISPLAY_UNITS');
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

หากต้องการลบพร็อพเพอร์ตี้ทั้งหมดใน Store ปัจจุบัน ให้เรียกใช้ Properties.deleteAllProperties() โดยทำดังนี้

service/propertyService.gs

ดูใน GitHub

try {
  // Get user properties in the current script.
  const userProperties = PropertiesService.getUserProperties();
  // Delete all user properties in the current script.
  userProperties.deleteAllProperties();
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

จัดการพร็อพเพอร์ตี้ของสคริปต์ด้วยตนเอง

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

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

1. เปิดโปรเจ็กต์ Apps Script
2. คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย
3. หากต้องการเพิ่มพร็อพเพอร์ตี้แรก ให้คลิกเพิ่มพร็อพเพอร์ตี้ของสคริปต์ในส่วนคุณสมบัติของสคริปต์
4. หากต้องการเพิ่มพร็อพเพอร์ตี้ที่ 2 และพร็อพเพอร์ตี้ต่อมา ใต้คุณสมบัติของสคริปต์ ให้คลิกแก้ไขพร็อพเพอร์ตี้ของสคริปต์ > เพิ่มพร็อพเพอร์ตี้ของสคริปต์
5. สําหรับพร็อพเพอร์ตี้ ให้ป้อนชื่อคีย์
6. สำหรับค่า ให้ป้อนค่าของคีย์
7. (ไม่บังคับ) หากต้องการเพิ่มพร็อพเพอร์ตี้อีก ให้คลิกเพิ่มพร็อพเพอร์ตี้ของสคริปต์
8. คลิกบันทึกคุณสมบัติของสคริปต์

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

1. เปิดโปรเจ็กต์ Apps Script
2. คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย
3. ในส่วนคุณสมบัติของสคริปต์ ให้คลิกแก้ไขคุณสมบัติของสคริปต์
4. เปลี่ยนชื่อคีย์และคีย์-ค่าสำหรับแต่ละพร็อพเพอร์ตี้ที่ต้องการเปลี่ยนแปลง
5. คลิกบันทึกคุณสมบัติของสคริปต์

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

1. เปิดโปรเจ็กต์ Apps Script
2. คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย
3. ในส่วนคุณสมบัติของสคริปต์ ให้คลิกแก้ไขคุณสมบัติของสคริปต์
4. คลิก "นำออก" ข้างพร็อพเพอร์ตี้ที่คุณต้องการลบ
5. คลิกบันทึกคุณสมบัติของสคริปต์