REST Resource: spreadsheets.developerMetadata

Ressource: DeveloperMetadata

Entwicklermetadaten, die mit einem Standort oder Objekt in einer Tabelle verknüpft sind. Mithilfe von Entwicklermetadaten können beliebige Daten mit verschiedenen Teilen einer Tabelle verknüpft werden. Diese Verknüpfung bleibt an diesen Stellen erhalten, wenn die Daten verschoben und die Tabelle bearbeitet wird. Wenn Entwicklermetadaten beispielsweise mit Zeile 5 verknüpft sind und anschließend eine weitere Zeile über Zeile 5 eingefügt wird, sind die ursprünglichen Metadaten weiterhin mit der Zeile verknüpft, mit der sie ursprünglich verknüpft waren (jetzt Zeile 6). Wenn das zugehörige Objekt gelöscht wird, werden auch die zugehörigen 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 generierte ID 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, an dem die Metadaten verknüpft sind.
visibility

enum (DeveloperMetadataVisibility)

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

DeveloperMetadataLocation

Ein Ort, an dem Metadaten in einer Tabelle zugeordnet 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 Speicherort, an dem Metadaten verknüpft werden. Für location ist nur einer der folgenden Werte zulässig:
spreadsheet

boolean

„Wahr“, wenn Metadaten mit einer ganzen Tabelle verknüpft sind.
sheetId

integer

Die ID des Tabellenblatts, wenn Metadaten einem ganzen Tabellenblatt zugeordnet 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 Standorttypen, mit denen Entwicklermetadaten verknüpft werden können.

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

DeveloperMetadataVisibility

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

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Standardwert.
DOCUMENT Auf Metadaten, die im Dokument sichtbar sind, kann über jedes Entwicklerprojekt zugegriffen werden, das Zugriff auf das Dokument hat.
PROJECT Projektmetadaten sind nur für das Entwicklerprojekt sichtbar und zugänglich, in dem sie erstellt wurden.

Methoden

get

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