資源:DeveloperMetadata
與試算表中位置或物件相關聯的開發人員中繼資料。開發人員中繼資料可用於將任意資料與試算表的各個部分建立關聯,並在使用者移動及編輯試算表時,留在這些位置保持關聯。舉例來說,如果開發人員中繼資料與第 5 列相關聯,隨後又插入第 5 列的上方,則原始中繼資料仍會與第一個關聯的資料列建立關聯 (現在是第 6 列)。如果關聯物件遭到刪除,中繼資料也會遭到刪除。
JSON 表示法 |
---|
{ "metadataId": integer, "metadataKey": string, "metadataValue": string, "location": { object ( |
欄位 | |
---|---|
metadataId |
用於識別中繼資料的試算表範圍專屬 ID。建立中繼資料時可指定 ID,否則,系統會隨機產生並指派 ID。必須為正數。 |
metadataKey |
中繼資料鍵。試算表上可能會有多個中繼資料具有相同鍵。開發人員中繼資料必須具有指定鍵。 |
metadataValue |
與中繼資料鍵相關聯的資料。 |
location |
中繼資料的關聯位置。 |
visibility |
中繼資料瀏覽權限。開發人員中繼資料必須指定瀏覽權限。 |
DeveloperMetadataLocation
中繼資料可在試算表中建立關聯的位置。
JSON 表示法 |
---|
{ "locationType": enum ( |
欄位 | |
---|---|
locationType |
這個物件代表的位置類型。這是唯讀欄位。 |
聯集欄位 location 。中繼資料的關聯位置。location 只能是下列其中一項: |
|
spreadsheet |
如果中繼資料與整份試算表相關聯,則為「是」。 |
sheetId |
中繼資料與整份工作表建立關聯時,則為工作表 ID。 |
dimensionRange |
代表中繼資料與維度建立關聯的列或欄。指定的 |
DeveloperMetadataLocationType
列舉可能與開發人員中繼資料相關聯的位置類型。
列舉 | |
---|---|
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED |
預設值。 |
ROW |
與整個資料列維度相關聯的開發人員中繼資料。 |
COLUMN |
與整個資料欄維度相關聯的開發人員中繼資料。 |
SHEET |
與整份工作表相關聯的開發人員中繼資料。 |
SPREADSHEET |
與整份試算表相關聯的開發人員中繼資料。 |
DeveloperMetadataVisibility
可能的中繼資料瀏覽權限。
列舉 | |
---|---|
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED |
預設值。 |
DOCUMENT |
凡是具備文件存取權的開發人員專案,都能存取文件瀏覽權限中繼資料。 |
PROJECT |
只有建立中繼資料的開發人員專案,才能查看及存取專案可見的中繼資料。 |
方法 |
|
---|---|
|
傳回具有指定 ID 的開發人員中繼資料。 |
|
傳回符合指定 DataFilter 的所有開發人員中繼資料。 |