หน้านี้ได้รับการแปลโดย Cloud Translation API

Class UserProperties

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

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

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

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

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

`deleteAllProperties()`

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

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

UserProperties.deleteAllProperties();

รีเทิร์น

UserProperties — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

ดูเพิ่มเติม

deleteProperty(key)

`deleteProperty(key)`

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

UserProperties.deleteProperty('special');

พารามิเตอร์

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

รีเทิร์น

UserProperties — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

ดูเพิ่มเติม

deleteAllProperties()

`getKeys()`

รับคีย์ที่ใช้ได้ทั้งหมด

รีเทิร์น

String[]

`getProperties()`

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

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

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

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

// This makes a copy. Any changes that happen here will not
// be written back to properties.
var animalSounds = UserProperties.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)`

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

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

พารามิเตอร์

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

รีเทิร์น

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

ดูเพิ่มเติม

setProperty(key, value)

`setProperties(properties)`

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

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

พารามิเตอร์

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

รีเทิร์น

UserProperties — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

ดูเพิ่มเติม

setProperty(key, value)

`setProperties(properties, deleteAllOthers)`

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

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

พารามิเตอร์

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

รีเทิร์น

UserProperties — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

ดูเพิ่มเติม

setProperty(key, value)

`setProperty(key, value)`

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

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

พารามิเตอร์

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

รีเทิร์น

UserProperties — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

ดูเพิ่มเติม

getProperty(key)