Class DeveloperMetadata

开发者元数据

访问和修改开发者元数据。如需创建新的开发者元数据，请使用 Range.addDeveloperMetadata(key)、Sheet.addDeveloperMetadata(key) 或 Spreadsheet.addDeveloperMetadata(key)。

方法

方法	返回类型	简介
getId()	Integer	返回与此开发者元数据相关联的唯一 ID。
getKey()	String	返回与此开发者元数据关联的键。
getLocation()	DeveloperMetadataLocation	返回此开发者元数据的位置。
getValue()	String	返回与此开发者元数据关联的值；如果此元数据没有值，则返回 null。
getVisibility()	DeveloperMetadataVisibility	返回此开发者元数据的可见性。
moveToColumn(column)	DeveloperMetadata	将此开发者元数据移至指定列。
moveToRow(row)	DeveloperMetadata	将此开发者元数据移至指定行。
moveToSheet(sheet)	DeveloperMetadata	将此开发者元数据移至指定的工作表。
moveToSpreadsheet()	DeveloperMetadata	将此开发者元数据移至顶级电子表格。
remove()	void	删除此元数据。
setKey(key)	DeveloperMetadata	将此开发者元数据的键设置为指定的值。
setValue(value)	DeveloperMetadata	将与此开发者元数据关联的值设为指定值。
setVisibility(visibility)	DeveloperMetadata	将此开发者元数据的公开范围设置为指定的公开范围。

详细文档

getId()

返回与此开发者元数据相关联的唯一 ID。

返回

Integer - 与此开发者元数据相关联的唯一 ID。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getKey()

返回与此开发者元数据关联的键。

返回

String - 与此开发者元数据关联的键。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getLocation()

返回此开发者元数据的位置。

返回

DeveloperMetadataLocation - 此开发者元数据的位置。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getValue()

返回与此开发者元数据关联的值；如果此元数据没有值，则返回 null。

返回

String - 与此开发者元数据关联的值；如果此元数据没有值，则为 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getVisibility()

返回此开发者元数据的可见性。

返回

DeveloperMetadataVisibility - 此开发者元数据的公开范围。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

moveToColumn(column)

将此开发者元数据移至指定列。如果指定范围不代表单个列，则会抛出异常。

参数

名称	类型	说明
column	Range	表示此开发者元数据的新位置的列的范围。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

moveToRow(row)

将此开发者元数据移至指定行。如果指定范围不代表单行，则会抛出异常。

参数

名称	类型	说明
row	Range	表示此开发者元数据的新位置的行。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

moveToSheet(sheet)

将此开发者元数据移至指定的工作表。

参数

名称	类型	说明
sheet	Sheet	此开发者元数据的新位置所在的工作表。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

moveToSpreadsheet()

将此开发者元数据移至顶级电子表格。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

remove()

删除此元数据。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setKey(key)

将此开发者元数据的键设置为指定的值。

参数

名称	类型	说明
key	String	要为此元数据设置的新键。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setValue(value)

将与此开发者元数据关联的值设为指定值。

参数

名称	类型	说明
value	String	要为此元数据设置的新值。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setVisibility(visibility)

将此开发者元数据的公开范围设置为指定的公开范围。

参数

名称	类型	说明
visibility	DeveloperMetadataVisibility	要为此元数据设置的新公开范围。

返回

DeveloperMetadata - 开发者元数据，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets