REST Resource: spreadsheets.developerMetadata

Zasób: DeveloperMetadata

Metadane dewelopera powiązane z lokalizacją lub obiektem w arkuszu kalkulacyjnym. Więcej informacji znajdziesz w artykule Odczytywanie, zapisywanie i wyszukiwanie metadanych.

Metadane dewelopera mogą służyć do powiązania dowolnych danych z różnymi częściami arkusza kalkulacyjnego. Pozostaną one powiązane z tymi lokalizacjami, gdy będą się przesuwać, a arkusz kalkulacyjny będzie edytowany. Jeśli na przykład metadane dewelopera są powiązane z wierszem 5, a następnie nad tym wierszem zostanie wstawiony kolejny wiersz, pierwotne metadane nadal będą powiązane z wierszem, z którym były powiązane na początku (czyli z 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 w zakresie arkusza kalkulacyjnego, który identyfikuje metadane. Identyfikatory można określić podczas tworzenia metadanych. W przeciwnym razie zostanie wygenerowany losowy identyfikator i przypisany do metadanych. Musi być dodatnia.
metadataKey

string

Klucz metadanych. W arkuszu kalkulacyjnym może być wiele metadanych o tym samym kluczu. Metadane dewelopera muszą zawsze 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 muszą zawsze mieć określoną widoczność.

DeveloperMetadataLocation

Miejsce, w którym można powiązać metadane 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 zbiorcze location. Lokalizacja, z którą są powiązane metadane. location może mieć tylko jedną z tych wartości:
spreadsheet

boolean

Wartość „true”, jeśli 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 z wymiarem są powiązane metadane. Określony argument DimensionRange musi reprezentować pojedynczy wiersz lub pojedynczą kolumnę. Nie może być nieograniczony ani obejmować wielu wierszy lub kolumn.

DeveloperMetadataLocationType

Wyliczenie typów lokalizacji, z którymi mogą być powiązane metadane dewelopera.

Wartości w polu enum
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Wartość domyślna.
ROW Metadane dewelopera powiązane z całym wierszem.
COLUMN Metadane dewelopera powiązane z całą kolumną.
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 każdego projektu dewelopera, który ma dostęp do dokumentu.
PROJECT Metadane widoczne w projekcie są widoczne i dostępne tylko dla projektu deweloperskiego, w którym zostały utworzone.

Metody

get

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