REST Resource: spreadsheets.developerMetadata

Zasób: DeveloperMetadata

Metadane dewelopera powiązane z lokalizacją lub obiektem w arkuszu kalkulacyjnym. Metadane programisty mogą być używane do powiązania dowolnych danych z różnymi częściami arkusza kalkulacyjnego i pozostaną w tych lokalizacjach podczas poruszania się po arkuszu oraz edytowania jego arkusza. Jeśli na przykład metadane dewelopera są powiązane z wierszem 5, a następnie wstawiono inny wiersz nad wierszem 5, pierwotne metadane nadal będą powiązane z wierszem, z którym było po raz pierwszy powiązane (jako wiersz 6). Jeśli powiązany obiekt zostanie usunięty, jego metadane również zostaną usunięte.

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

integer

Unikalny identyfikator identyfikujący metadane w arkuszu kalkulacyjnym. Identyfikatory można określić podczas tworzenia metadanych. W przeciwnym razie zostaną wygenerowane losowo i przypisane. Musi być dodatnia.
metadataKey

string

Klucz metadanych. Jeden arkusz może zawierać wiele metadanych z tym samym kluczem. Metadane dewelopera zawsze muszą mieć określony klucz.
metadataValue

string

Dane powiązane z kluczem metadanych.
location

object (DeveloperMetadataLocation)

Lokalizacja, z którą powiązane są metadane.
visibility

enum (DeveloperMetadataVisibility)

Widoczność metadanych. Metadane dewelopera zawsze muszą mieć widoczność.

Lokalizacja metadanych dewelopera

Lokalizacja, w której w arkuszu kalkulacyjnym można powiązać metadane.

Zapis 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.
}
Pola
locationType

enum (DeveloperMetadataLocationType)

Typ lokalizacji, którą reprezentuje ten obiekt. To pole jest tylko do odczytu.
Pole sumy: location. Lokalizacja, z którą powiązane są metadane. location może mieć tylko jedną z tych wartości:
spreadsheet

boolean

Wartość to „prawda”, gdy metadane są powiązane z całym arkuszem kalkulacyjnym.
sheetId

integer

Identyfikator arkusza, gdy metadane są powiązane z całym arkuszem.
dimensionRange

object (DimensionRange)

Reprezentuje wiersz lub kolumnę, gdy metadane są powiązane z wymiarem. Określony element DimensionRange musi reprezentować jeden wiersz lub jedną kolumnę. Nie może być nieograniczony ani obejmować wielu wierszy lub kolumn.

Typ lokalizacji programisty metadanych

Lista typów lokalizacji, z którymi można powiązać metadane dewelopera.

Wartości w polu enum
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Wartość domyślna.
ROW Metadane dewelopera powiązane z wymiarem całego wiersza.
COLUMN Metadane dewelopera powiązane z całym wymiarem kolumny.
SHEET Metadane dewelopera powiązane z całym arkuszem.
SPREADSHEET Metadane dewelopera powiązane z całym arkuszem kalkulacyjnym.

Widoczność metadanych dewelopera

Lista możliwych widoczności metadanych.

Wartości w polu enum
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Wartość domyślna.
DOCUMENT Widoczne dla dokumentów metadane są dostępne z każdego projektu dewelopera, który ma dostęp do dokumentu.
PROJECT Metadane widoczne w projekcie są widoczne tylko dla dewelopera, który je utworzył i ma do nich dostęp.

Metody

get

 Zwraca metadane dewelopera o podanym identyfikatorze.
Zwraca wszystkie metadane dewelopera pasujące do określonego elementu DataFilter.