REST Resource: spreadsheets.developerMetadata

資源：DeveloperMetadata

與試算表中位置或物件相關聯的開發人員中繼資料。開發人員中繼資料可用來將任意資料與試算表不同部分建立關聯，並在試算表移動時保持編輯狀態。舉例來說，假設開發人員中繼資料與第 5 列相關聯，然後又插入了第 5 列，這時原始中繼資料仍與最初建立關聯的資料列 (現在第 6 列) 相關聯。如果相關聯的物件已刪除，其中繼資料也會一併刪除。

JSON 表示法 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
欄位
metadataId

integer

試算表範圍的專屬 ID，用於識別中繼資料。建立中繼資料時可指定 ID，否則會隨機產生並指派 ID。必須為正數。
metadataKey

string

中繼資料鍵。試算表中可能有多個中繼資料相同的中繼資料。開發人員中繼資料一律須指定一個金鑰。
metadataValue

string

與中繼資料鍵相關聯的資料。
location

object (DeveloperMetadataLocation)

與中繼資料相關聯的位置。
visibility

enum (DeveloperMetadataVisibility)

中繼資料的瀏覽權限。開發人員中繼資料必須指定瀏覽權限。

開發人員中繼資料位置

試算表中中繼資料的關聯位置。

JSON 表示法 
{
  "locationType": enum (DeveloperMetadataLocationType),

  // Union field location can be only one of the following:
  "spreadsheet": boolean,
  "sheetId": integer,
  "dimensionRange": {
    object (DimensionRange)
  }
  // End of list of possible types for union field location.
}
欄位
locationType

enum (DeveloperMetadataLocationType)

此物件代表的位置類型。這是唯讀欄位。
聯集欄位 location。中繼資料相關聯的位置。location 只能是下列其中一項：
spreadsheet

boolean

如果中繼資料與整個試算表相關聯，則傳回 True。
sheetId

integer

當中繼資料與整個工作表建立關聯時，工作表的 ID。
dimensionRange

object (DimensionRange)

代表中繼資料與維度相關聯的資料列或資料欄。指定的 DimensionRange 必須代表單一列或欄，不能是無限制的跨列或多欄。

開發人員中繼資料位置類型

列舉可能與開發人員中繼資料相關的地點類型。

列舉
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED 預設值。
ROW 與整個資料列維度相關聯的開發人員中繼資料。
COLUMN 與整個資料欄維度相關聯的開發人員中繼資料。
SHEET 與整份工作表相關聯的開發人員中繼資料。
SPREADSHEET 與整份試算表相關聯的開發人員中繼資料。

開發人員中繼資料瀏覽權限

列舉可能的中繼資料瀏覽權限。

列舉
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED 預設值。
DOCUMENT 所有可存取文件的開發人員專案都能存取文件可見的中繼資料。
PROJECT 只有具備中繼資料的開發人員專案可以存取及查看專案可見的中繼資料。

方法

get

 傳回具有指定 ID 的開發人員中繼資料。
傳回符合指定 DataFilter 的所有開發人員中繼資料。