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 beliebige Daten mit verschiedenen Teilen einer Tabelle zu verknüpfen. Diese bleiben dabei, wenn sie sich bewegen und die Tabelle bearbeitet wird. 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 zuvor zugeordnet war (was jetzt Zeile 6 ist). 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. Eine Tabellenkalkulation kann mehrere Metadaten mit demselben Schlüssel enthalten. 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 Ort, 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 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 Ort, an dem Metadaten verknüpft 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 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 sich über mehrere Zeilen oder Spalten erstrecken.

DeveloperMetadataLocationType

Eine Aufzählung der Standorttypen, denen Entwicklermetadaten zugeordnet werden können.

Enums
DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED Standardwert.
ROW Entwicklermetadaten, die mit einer ganzen Zeilendimension verknüpft sind.
COLUMN Entwicklermetadaten, die mit einer gesamten 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 Sichtbarkeit von Metadaten.

Enums
DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED Standardwert.
DOCUMENT Für das Dokument sichtbare Metadaten sind von jedem Entwicklerprojekt aus zugänglich, das Zugriff auf das Dokument hat.
PROJECT Im Projekt sichtbare Metadaten sind nur für das Entwicklerprojekt sichtbar und zugänglich, in 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.