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 可在建立中繼資料時指定，否則將由系統隨機產生並指派。必須為正數。
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

如果中繼資料與整份試算表建立關聯，則為「是」。
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 相符的開發人員中繼資料。