REST Resource: spreadsheets.developerMetadata

Ressource: DeveloperMetadata

Entwicklermetadaten, die mit einem Standort oder Objekt in einer Tabelle verknüpft sind. Weitere Informationen finden Sie unter Metadaten lesen, schreiben und durchsuchen.

Entwicklermetadaten können verwendet werden, um beliebige Daten mit verschiedenen Teilen eines Tabellenblatts zu verknüpfen. Diese Verknüpfung bleibt bestehen, wenn die Teile verschoben oder das Tabellenblatt bearbeitet wird. Wenn beispielsweise Entwicklermetadaten mit Zeile 5 verknüpft sind und dann eine weitere Zeile über Zeile 5 eingefügt wird, sind die ursprünglichen Metadaten weiterhin mit der Zeile verknüpft, mit der sie zuerst verknüpft waren (jetzt Zeile 6). Wenn das zugehörige 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 ID auf Tabellenebene, die die Metadaten identifiziert. IDs können beim Erstellen von Metadaten angegeben werden. Andernfalls wird eine zufällig generiert und zugewiesen. Muss positiv sein.
metadataKey

string

Der Metadatenschlüssel. In einer Tabelle können mehrere Metadaten mit demselben Schlüssel vorhanden sein. Für Entwicklermetadaten muss immer ein Schlüssel angegeben werden.
metadataValue

string

Daten, die mit dem Schlüssel der Metadaten verknüpft sind.
location

object (DeveloperMetadataLocation)

Der Speicherort, dem die Metadaten zugeordnet sind.
visibility

enum (DeveloperMetadataVisibility)

Die Sichtbarkeit der Metadaten. Für Entwicklermetadaten muss immer die 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 Orts, den dieses Objekt darstellt. Dieses Feld ist schreibgeschützt.
Union-Feld location. Der Speicherort, dem Metadaten zugeordnet sind. Für location ist nur einer der folgenden Werte zulässig:
spreadsheet

boolean

„True“, wenn Metadaten mit einer gesamten Tabelle verknüpft sind.
sheetId

integer

Die ID des Tabellenblatts, wenn Metadaten einem gesamten Tabellenblatt zugeordnet sind.
dimensionRange

object (DimensionRange)

Stellt die Zeile oder Spalte dar, wenn Metadaten mit einer Dimension verknüpft sind. Der angegebene DimensionRange-Bereich muss eine einzelne Zeile oder Spalte darstellen. Sie darf nicht unbegrenzt sein und sich nicht über mehrere Zeilen oder Spalten erstrecken.

DeveloperMetadataLocationType

Eine Aufzählung der Arten von Standorten, denen Entwicklermetadaten zugeordnet werden können.

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

DeveloperMetadataVisibility

Eine Aufzählung der möglichen Sichtbarkeiten von Metadaten.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Standardwert.
DOCUMENT Auf dokumentbezogene Metadaten kann von jedem Entwicklerprojekt aus zugegriffen werden, das Zugriff auf das Dokument hat.
PROJECT Metadaten, die für das Projekt sichtbar sind, sind nur für das Entwicklerprojekt sichtbar und zugänglich, mit dem die Metadaten erstellt wurden.

Methoden

get

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