REST Resource: spreadsheets.developerMetadata

Zasób: DeveloperMetadata

Metadane dewelopera powiązane z lokalizacją lub obiektem w arkuszu kalkulacyjnym. Metadane dewelopera mogą służyć do dowolnego kojarzenia danych z różnymi częściami arkusza kalkulacyjnego. Powiązania te pozostaną w tych miejscach, gdy dane będą przenoszone i edytowane. Jeśli np. metadane dewelopera są powiązane z wierszem 5, a następnie zostanie wstawiony kolejny wiersz nad wierszem 5, te pierwotne metadane będą nadal powiązane z pierwotnie powiązanym wierszem (który jest teraz wierszem 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 ograniczony do arkusza kalkulacyjnego, który identyfikuje metadane. Identyfikatory można określić podczas tworzenia metadanych. W przeciwnym razie zostanie wygenerowany i przypisany losowy identyfikator. Musi być dodatni.
metadataKey

string

Klucz metadanych. W arkuszu kalkulacyjnym może być wiele metadanych z tym samym kluczem. W metadanych dewelopera musi być zawsze 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. W metadanych dewelopera musi być zawsze określona widoczność.

DeveloperMetadataLocation

Miejsce, w którym metadane mogą być powiązane w arkuszu kalkulacyjnym.

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 unii location. Lokalizacja, w której powiązano metadane. location może być tylko jednym z tych elementów:
spreadsheet

boolean

Wartość true, 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. Podana funkcja DimensionRange musi określać pojedynczy wiersz lub kolumnę. Nie może być nieograniczona ani obejmować wielu wierszy lub kolumn.

DeveloperMetadataLocationType

Wyliczenie 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 całym wymiarem 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,

DeveloperMetadataVisibility

Wyliczenie możliwych widoczności metadanych.

Wartości w polu enum
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Wartość domyślna.
DOCUMENT Metadane widoczne w dokumencie są dostępne z poziomu dowolnego projektu dewelopera, który ma dostęp do dokumentu.
PROJECT Metadane widoczne w projekcie są widoczne i dostępne tylko dla projektu dewelopera, który je utworzył.

Metody

get

 Zwraca metadane dewelopera o określonym identyfikatorze.
Zwraca wszystkie metadane dewelopera pasujące do określonego parametru DataFilter.