속성 객체는 사용자, 문서 또는 스크립트 속성에 액세스하기 위한 인터페이스 역할을 합니다. 특정 속성 유형은 스크립트가 호출한 PropertiesService
의 세 가지 메서드(PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
, PropertiesService.getScriptProperties()
)에 따라 다릅니다.
스크립트 간에 속성을 공유할 수 없습니다. 속성 유형에 대한 자세한 내용은 속성 서비스 가이드를 참고하세요.
방법
메서드 | 반환 유형 | 간략한 설명 |
---|---|---|
deleteAllProperties() | Properties | 현재 Properties 저장소에 있는 모든 속성을 삭제합니다. |
deleteProperty(key) | Properties | 현재 Properties 저장소에서 지정된 키가 있는 속성을 삭제합니다. |
getKeys() | String[] | 현재 Properties 저장소의 모든 키를 가져옵니다. |
getProperties() | Object | 현재 Properties 저장소에 있는 모든 키-값 쌍의 사본을 가져옵니다. |
getProperty(key) | String | 현재 Properties 저장소에서 지정된 키와 연결된 값을 가져오거나 이러한 키가 없으면 null 을 가져옵니다. |
setProperties(properties) | Properties | 현재 Properties 저장소에 있는 지정된 객체의 모든 키-값 쌍을 설정합니다. |
setProperties(properties, deleteAllOthers) | Properties | 현재 Properties 저장소에 있는 지정된 객체의 모든 키-값 쌍을 설정하고 선택적으로 저장소에 있는 다른 모든 속성을 삭제합니다. |
setProperty(key, value) | Properties | 현재 Properties 저장소에 지정된 키-값 쌍을 설정합니다. |
자세한 문서
deleteAllProperties()
현재 Properties
저장소에 있는 모든 속성을 삭제합니다.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
리턴
Properties
: 체인을 위한 Properties
저장소입니다.
deleteProperty(key)
현재 Properties
저장소에서 지정된 키가 있는 속성을 삭제합니다.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
매개변수
이름 | 유형 | 설명 |
---|---|---|
key | String | 삭제할 속성의 키 |
리턴
Properties
: 체인을 위한 Properties
저장소입니다.
getKeys()
현재 Properties
저장소의 모든 키를 가져옵니다.
// Sets several properties, then logs the value of each key. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var keys = scriptProperties.getKeys(); Logger.log('Animals known:'); for (var i = 0; i < keys.length; i++) { Logger.log(keys[i]); }
리턴
String[]
- 현재 Properties
저장소에 있는 모든 키의 배열
getProperties()
현재 Properties
저장소에 있는 모든 키-값 쌍의 사본을 가져옵니다. 반환된 객체는 매장의 실시간 뷰가 아닙니다. 따라서 반환된 객체의 속성을 변경해도 저장소에서 속성이 자동으로 업데이트되지 않으며 반대의 경우도 마찬가지입니다.
// Sets several script properties, then retrieves them and logs them. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); 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
- 현재 Properties
저장소에 있는 모든 키-값 쌍의 사본
getProperty(key)
현재 Properties
저장소에서 지정된 키와 연결된 값을 가져오거나 이러한 키가 없으면 null
을 가져옵니다.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
매개변수
이름 | 유형 | 설명 |
---|---|---|
key | String | 검색할 속성 값의 키 |
리턴
String
: 현재 Properties
저장소의 지정된 키와 연결된 값입니다.
setProperties(properties)
현재 Properties
저장소에 있는 지정된 객체의 모든 키-값 쌍을 설정합니다.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
매개변수
이름 | 유형 | 설명 |
---|---|---|
properties | Object | 설정할 키-값 쌍이 포함된 객체 |
리턴
Properties
: 체인을 위한 Properties
저장소입니다.
setProperties(properties, deleteAllOthers)
현재 Properties
저장소에 있는 지정된 객체의 모든 키-값 쌍을 설정하고 선택적으로 저장소에 있는 다른 모든 속성을 삭제합니다.
// Sets multiple user properties at once while deleting all other user properties. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties, true);
매개변수
이름 | 유형 | 설명 |
---|---|---|
properties | Object | 설정할 키-값 쌍이 포함된 객체 |
deleteAllOthers | Boolean | true : 속성 객체의 다른 모든 키-값 쌍을 삭제하고 false : 삭제하지 않음 |
리턴
Properties
: 체인을 위한 Properties
저장소입니다.
setProperty(key, value)
현재 Properties
저장소에 지정된 키-값 쌍을 설정합니다.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
매개변수
이름 | 유형 | 설명 |
---|---|---|
key | String | 속성의 키 |
value | String | 키와 연결할 값 |
리턴
Properties
: 체인을 위한 Properties
저장소입니다.