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)

中繼資料顯示設定。開發人員中繼資料一律必須指定瀏覽權限。

DeveloperMetadataLocation

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

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 必須代表單列或單欄。且不能是無界限，或橫跨多個資料列或資料欄。

DeveloperMetadataLocationType

開發人員中繼資料可關聯的位置類型列舉。

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

DeveloperMetadataVisibility

列舉可能的中繼資料顯示設定。

列舉
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED 預設值。
DOCUMENT 只要開發人員專案有權存取文件，就能存取文件可見的中繼資料。
PROJECT 專案可見的中繼資料只會向建立該中繼資料的開發人員專案顯示，且只有該專案可以存取。

方法

get

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