REST Resource: spreadsheets.developerMetadata

Ressource: DeveloperMetadata

Entwicklermetadaten, die mit einem Standort oder Objekt in einer Tabelle verknüpft sind. Entwicklermetadaten können verwendet werden, um willkürliche Daten mit verschiedenen Teilen einer Tabelle zu verknüpfen. Sie bleiben an diesen Orten verknüpft, wenn sie verschoben und bearbeitet werden. Wenn beispielsweise Entwicklermetadaten mit Zeile 5 verknüpft sind und anschließend über Zeile 5 eine weitere Zeile eingefügt wird, werden diese ursprünglichen Metadaten weiterhin mit der Zeile verknüpft, der sie ursprünglich zugewiesen wurde (was jetzt Zeile 6 ist). Wenn das verknüpfte Objekt gelöscht wird, werden auch seine Metadaten gelöscht.

JSON-Darstellung 
{
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "location": {
    object (DeveloperMetadataLocation)
  },
  "visibility": enum (DeveloperMetadataVisibility)
}
Felder
metadataId

integer

Die eindeutige Tabellen-ID, die die Metadaten identifiziert. IDs können bei der Erstellung von Metadaten angegeben werden. Andernfalls werden sie nach dem Zufallsprinzip generiert und zugewiesen. Muss positiv sein.
metadataKey

string

Der Metadatenschlüssel. Eine Tabelle kann mehrere Metadaten mit demselben Schlüssel enthalten. Für Entwicklermetadaten muss immer ein Schlüssel angegeben werden.
metadataValue

string

Mit dem Metadatenschlüssel verknüpfte Daten.
location

object (DeveloperMetadataLocation)

Der Standort, an dem die Metadaten verknüpft sind.
visibility

enum (DeveloperMetadataVisibility)

Die Metadatensichtbarkeit. Für Entwicklermetadaten muss immer eine Sichtbarkeit angegeben werden.

DeveloperMetadataLocation

Ein Ort, an dem Metadaten in einer Tabelle verknüpft werden können.

JSON-Darstellung 
{
  "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.
}
Felder
locationType

enum (DeveloperMetadataLocationType)

Der Typ des Standorts, den dieses Objekt darstellt. Dieses Feld ist schreibgeschützt.
Union-Feld location. Der Standort, an dem Metadaten verknüpft sind. Für location ist nur einer der folgenden Werte zulässig:
spreadsheet

boolean

Wahr, wenn Metadaten einer ganzen Tabelle zugeordnet sind.
sheetId

integer

Die ID des Tabellenblatts, wenn Metadaten mit einem gesamten Tabellenblatt verknüpft sind.
dimensionRange

object (DimensionRange)

Stellt die Zeile oder Spalte dar, wenn Metadaten mit einer Dimension verknüpft sind. Die angegebene DimensionRange muss eine einzelne Zeile oder Spalte darstellen. Sie darf nicht unbegrenzt sein oder mehrere Zeilen oder Spalten umfassen.

DeveloperMetadataLocationType

Eine Aufzählung der Arten von Standorten, mit denen Entwicklermetadaten verknüpft werden können

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Standardwert.
ROW Entwicklermetadaten, die mit einer ganzen Zeilendimension verknüpft sind.
COLUMN Entwicklermetadaten, die einer ganzen Spaltendimension zugeordnet sind.
SHEET Entwicklermetadaten, die mit einem gesamten Tabellenblatt verknüpft sind.
SPREADSHEET Entwicklermetadaten, die mit der gesamten Tabelle verknüpft sind.

Sichtbarkeit von Entwicklermetadaten

Eine Aufzählung möglicher Sichtbarkeiten von Metadaten.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Standardwert.
DOCUMENT Auf das Dokument sichtbare Metadaten können von jedem Entwicklerprojekt mit Zugriff auf das Dokument zugegriffen werden.
PROJECT Projektbasierte Metadaten sind nur für das Entwicklerprojekt sichtbar und zugänglich, das die Metadaten erstellt hat.

Methoden

get

 Gibt die Entwicklermetadaten mit der angegebenen ID zurück
Gibt alle Entwicklermetadaten zurück, die mit dem angegebenen DataFilter übereinstimmen.