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 łączenia dowolnych danych z różnymi częściami arkusza kalkulacyjnego. Pozostają one powiązane w tych lokalizacjach podczas przemieszczania się i zmieniania arkusza kalkulacyjnego. Jeśli na przykład metadane dewelopera są powiązane z wierszem 5 i kolejny wiersz zostanie wstawiony nad wierszem 5, pierwotne metadane nadal będą powiązane z wierszem, z którym po raz pierwszy zostały powiązane (obecny 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 ograniczony do arkusza kalkulacyjnego, który identyfikuje metadane. Identyfikatory można określić podczas tworzenia metadanych. W przeciwnym razie zostaną one wygenerowane i przypisane losowo. Musi być liczbą dodatnią.
metadataKey

string

Klucz metadanych. W arkuszu kalkulacyjnym może być wiele metadanych z tym samym kluczem. Metadane dewelopera muszą zawsze mieć określony klucz.
metadataValue

string

Dane powiązane z kluczem metadanych.
location

object (DeveloperMetadataLocation)

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

enum (DeveloperMetadataVisibility)

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

DeveloperMetadataLocation

Lokalizacja, w której 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 sumy location. Lokalizacja, z którą są powiązane metadane. location może być tylko jedną z tych wartości:
spreadsheet

boolean

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. Podana wartość DimensionRange musi reprezentować jeden wiersz lub jedną kolumnę – nie może być nieograniczona ani obejmować wielu wierszy lub kolumn.

DeveloperMetadataLocationType

Lista 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 wymiarem wiersza.
COLUMN Metadane dewelopera powiązane z całym wymiarem kolumny.
SHEET metadane dewelopera powiązane w całym arkuszu.
SPREADSHEET metadane dewelopera powiązane z całym arkuszem kalkulacyjnym.

DeveloperMetadataVisibility

Lista 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 każdego projektu programistycznego z dostępem do dokumentu.
PROJECT Metadane widoczne w projekcie są widoczne i dostępne tylko dla projektu programisty, który utworzył metadane.

Metody

get

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