本頁面由 Cloud Translation API 翻譯而成。

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