REST Resource: spreadsheets.developerMetadata

Resource: DeveloperMetadata

Metadata developer yang terkait dengan lokasi atau objek dalam spreadsheet. Metadata developer dapat digunakan untuk mengaitkan data arbitrer dengan berbagai bagian spreadsheet dan akan tetap dikaitkan di lokasi tersebut saat berpindah dan spreadsheet diedit. Misalnya, jika metadata developer dikaitkan dengan baris 5 dan baris lain selanjutnya disisipkan di atas baris 5, metadata asli tersebut akan tetap dikaitkan dengan baris yang pertama kali dikaitkan dengannya (sekarang menjadi baris 6). Jika objek terkait dihapus, metadatanya juga akan dihapus.

Representasi JSON 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Kolom
metadataId

integer

ID unik cakupan spreadsheet yang mengidentifikasi metadata. ID dapat ditentukan saat metadata dibuat. Jika tidak, ID akan dibuat dan ditetapkan secara acak. Harus positif.
metadataKey

string

Kunci metadata. Mungkin ada beberapa metadata dalam spreadsheet dengan kunci yang sama. Metadata developer harus selalu memiliki kunci yang ditentukan.
metadataValue

string

Data yang terkait dengan kunci metadata.
location

object (DeveloperMetadataLocation)

Lokasi tempat metadata dikaitkan.
visibility

enum (DeveloperMetadataVisibility)

Visibilitas metadata. Metadata developer harus selalu memiliki visibilitas yang ditentukan.

DeveloperMetadataLocation

Lokasi tempat metadata mungkin dikaitkan dalam spreadsheet.

Representasi 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.
}
Kolom
locationType

enum (DeveloperMetadataLocationType)

Jenis lokasi yang diwakili oleh objek ini. Kolom ini bersifat hanya baca.
Kolom union location. Lokasi tempat metadata dikaitkan. location hanya dapat berupa salah satu dari berikut:
spreadsheet

boolean

Benar jika metadata dikaitkan dengan seluruh spreadsheet.
sheetId

integer

ID sheet saat metadata dikaitkan dengan seluruh sheet.
dimensionRange

object (DimensionRange)

Mewakili baris atau kolom saat metadata dikaitkan dengan dimensi. DimensionRange yang ditentukan harus mewakili satu baris atau kolom; tidak boleh tidak terbatas atau mencakup beberapa baris atau kolom.

DeveloperMetadataLocationType

Enumerasi jenis lokasi yang mungkin dikaitkan dengan metadata developer.

Enum
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Nilai default.
ROW Metadata developer yang dikaitkan di seluruh dimensi baris.
COLUMN Metadata developer yang terkait di seluruh dimensi kolom.
SHEET Metadata developer yang terkait di seluruh sheet.
SPREADSHEET Metadata developer yang terkait di seluruh spreadsheet.

DeveloperMetadataVisibility

Enumerasi kemungkinan visibilitas metadata.

Enum
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Nilai default.
DOCUMENT Metadata yang terlihat dokumen dapat diakses dari project developer apa pun yang memiliki akses ke dokumen.
PROJECT Metadata yang terlihat project hanya dapat dilihat dan diakses oleh project developer yang membuat metadata.

Metode

get

 Menampilkan metadata developer dengan ID yang ditentukan.
Menampilkan semua metadata developer yang cocok dengan DataFilter yang ditentukan.