REST Resource: labels

Ressource: Label

Mit einem Label wird eine Taxonomie definiert, die auf Drive-Elemente angewendet werden kann, um sie zu organisieren und zu durchsuchen. Labels können einfache Strings sein oder Felder enthalten, die zusätzliche Metadaten beschreiben, die zum Organisieren und Suchen von Drive-Elementen verwendet werden können.

JSON-Darstellung 
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
Felder
name

string

Nur Ausgabe. Ressourcenname des Labels. Muss das Format labels/{id} oder labels/{id}@{revisionId} haben. Siehe id und revisionId unten.
id

string

Nur Ausgabe. Die global eindeutige Kennung dieses Labels. Die ID ist Teil des Labels name. Im Gegensatz zu name ist sie jedoch bei allen Versionen gleich. Stimmt mit dem regulären Ausdruck ([a-zA-Z0-9])+ überein
revisionId

string

Nur Ausgabe. Die Versions-ID des Labels. Die Revision-ID ist je nach Anfrage möglicherweise Teil des Labels name. Jedes Mal, wenn Versionseigenschaften eines Labels geändert werden, wird eine neue Version erstellt. Stimmt mit dem regulären Ausdruck ([a-zA-Z0-9])+ überein
labelType

enum (LabelType)

Erforderlich. Der Labeltyp.
creator

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Label erstellt hat.
createTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der dieses Label erstellt wurde.
revisionCreator

object (UserInfo)

Nur Ausgabe. Der Nutzer, der diese Labelversion erstellt hat.
revisionCreateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Labelversion erstellt wurde.
publisher

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Label veröffentlicht hat. Dieser Wert hat keine Bedeutung, wenn das Label nicht veröffentlicht ist.
publishTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem dieses Label veröffentlicht wurde. Dieser Wert hat keine Bedeutung, wenn das Label nicht veröffentlicht ist.
disabler

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Label deaktiviert hat. Dieser Wert hat keine Bedeutung, wenn das Label nicht deaktiviert ist.
disableTime

string (Timestamp format)

Nur Ausgabe. Das Datum und die Uhrzeit, zu dem dieses Label deaktiviert wurde. Dieser Wert hat keine Bedeutung, wenn das Label nicht deaktiviert ist.
customer

string

Nur Ausgabe. Der Kunde, zu dem dieses Label gehört. Beispiel: „Kunden/123abc789“
properties

object (Properties)

Erforderlich. Die grundlegenden Eigenschaften des Labels.
lifecycle

object (Lifecycle)

Nur Ausgabe. Der Lebenszyklusstatus des Labels, einschließlich der Informationen, ob es veröffentlicht, eingestellt oder Änderungen am Entwurf enthält.
displayHints

object (DisplayHints)

Nur Ausgabe. Auf der Benutzeroberfläche werden Hinweise zum Rendern des Labels angezeigt.
appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe. Die Funktionen, die mit diesem Label auf angewendeten Metadaten verknüpft sind.
schemaCapabilities

object (SchemaCapabilities)

Nur Ausgabe. Die Funktionen, die der Nutzer für dieses Label hat.
appliedLabelPolicy

object (AppliedLabelPolicy)

Nur Ausgabe. Verhalten dieses Labels, wenn es auf Drive-Elemente angewendet wird.
fields[]

object (Field)

Liste der Felder in absteigender Prioritätsreihenfolge.
learnMoreUri

string

Benutzerdefinierte URL, über die Nutzer mehr über dieses Label und seine Verwendung erfahren können.
lockStatus

object (LockStatus)

Nur Ausgabe. Der LockStatus dieses Labels.
enabledAppSettings

object (EnabledAppSettings)

Optional. Die EnabledAppSettings für dieses Label.

LabelType

Der Typ dieses Labels.

Enums
LABEL_TYPE_UNSPECIFIED Unbekannter Labeltyp.
SHARED Freigegebene Labels können für Nutzer freigegeben werden, damit sie diese auf Drive-Elemente anwenden können.
ADMIN Vom Administrator verwaltetes Label. Nur von Administratoren erstellt und bearbeitet werden können. Unterstützt einige zusätzliche Funktionen, die nur für Administratoren verfügbar sind.
GOOGLE_APP Ein Label, das zu einer internen Google-Anwendung und nicht zu einem Kunden gehört. Diese Labels sind schreibgeschützt.

UserInfo

Informationen zu einem Nutzer.

JSON-Darstellung 
{
  "person": string
}
Felder
person

string

Die Kennung für diesen Nutzer, die mit der People API verwendet werden kann, um weitere Informationen zu erhalten. Beispiel: „people/12345678“.

Attribute

Grundlegende Eigenschaften des Labels.

JSON-Darstellung 
{
  "title": string,
  "description": string
}
Felder
title

string

Erforderlich. Titel des Labels.
description

string

Die Beschreibung des Labels.

Lifecycle

Der Lebenszyklusstatus eines Objekts, z. B. eines Labels, Felds oder Auswahlelements. Der Lebenszyklus erzwingt die folgenden Übergänge:

  • UNPUBLISHED_DRAFT (Startstatus)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (Gelöscht)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Gelöscht)

Die Status „Veröffentlicht“ und „Deaktiviert“ haben einige unterschiedliche Merkmale:

  • Veröffentlicht: An einem Objekt in diesem Status können einige Änderungen vorgenommen werden. In diesem Fall ist hasUnpublishedChanges wahr. Außerdem sind einige Arten von Änderungen nicht zulässig. Im Allgemeinen werden alle Änderungen abgelehnt, die bestehende Metadaten im Zusammenhang mit dem Label ungültig machen oder neue Einschränkungen verursachen würden.
  • Deaktiviert: Wenn diese Option deaktiviert ist, wird die konfigurierte DisabledPolicy angewendet.
JSON-Darstellung 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Felder
state

enum (State)

Nur Ausgabe. Der Status des Objekts, der mit diesem Lebenszyklus verknüpft ist.
hasUnpublishedChanges

boolean

Nur Ausgabe. Gibt an, ob das mit diesem Lebenszyklus verknüpfte Objekt unveröffentlichte Änderungen enthält.
disabledPolicy

object (DisabledPolicy)

Die Richtlinie, die festlegt, wie ein deaktiviertes Label, Feld oder eine Auswahl angezeigt wird.

Status

Der Status des Objekts, der mit diesem Lebenszyklus verknüpft ist.

Enums
STATE_UNSPECIFIED Unbekannter Status.
UNPUBLISHED_DRAFT Der Anfangsstatus eines Objekts. Nach der Veröffentlichung kann das Objekt nicht mehr in diesen Status zurückkehren. Nach der Veröffentlichung eines Objekts sind bestimmte Änderungen nicht mehr zulässig.
PUBLISHED Das Objekt wurde veröffentlicht. Das Objekt enthält möglicherweise nicht veröffentlichte Entwurfsänderungen, die durch hasUnpublishedChanges gekennzeichnet sind.
DISABLED Das Objekt wurde veröffentlicht und inzwischen deaktiviert. Das Objekt enthält möglicherweise nicht veröffentlichte Entwurfsänderungen, die durch hasUnpublishedChanges gekennzeichnet sind.
DELETED Das Objekt wurde gelöscht.

DisabledPolicy

Die Richtlinie, die festlegt, wie ein deaktiviertes Label, Feld oder eine Auswahl in verschiedenen Kontexten behandelt wird.

JSON-Darstellung 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Felder
showInApply

boolean

Legt fest, ob dieses deaktivierte Objekt im Menü „Anwenden“ für Drive-Elemente angezeigt wird.

  • Wenn true, wird das Objekt in der Benutzeroberfläche in der Regel als deaktiviert angezeigt und kann nicht ausgewählt werden.
  • Wenn false, ist das Objekt in der Benutzeroberfläche in der Regel ausgeblendet.

DisplayHints

Auf der Benutzeroberfläche werden Hinweise zum Rendern des Labels angezeigt.

JSON-Darstellung 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Felder
disabled

boolean

Gibt an, ob das Label in der Benutzeroberfläche als deaktiviert angezeigt werden soll.
shownInApply

boolean

Dieses Label sollte im Menü „Anwenden“ angezeigt werden, wenn Werte auf ein Drive-Element angewendet werden.
priority

string (int64 format)

Reihenfolge, in der das Label in einer Liste angezeigt wird.

AppliedCapabilities

Die Funktionen, die ein Nutzer für die angewendeten Metadaten dieses Labels hat.

JSON-Darstellung 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Felder
canRead

boolean

Gibt an, ob der Nutzer angewendete Metadaten im Zusammenhang mit diesem Label lesen kann.
canApply

boolean

Gibt an, ob der Nutzer dieses Label auf Elemente anwenden kann.
canRemove

boolean

Gibt an, ob der Nutzer dieses Label von Artikeln entfernen kann.

SchemaCapabilities

Die Funktionen, die mit diesem Label verknüpft sind, wenn es bearbeitet wird.

JSON-Darstellung 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Felder
canUpdate

boolean

Gibt an, ob der Nutzer dieses Label ändern kann.
canDelete

boolean

Gibt an, ob der Nutzer dieses Label löschen kann. Der Nutzer muss die Berechtigung haben und das Label muss deaktiviert sein.
canDisable

boolean

Gibt an, ob der Nutzer dieses Label deaktivieren kann. Der Nutzer muss die Berechtigung haben und dieses Label darf nicht bereits deaktiviert sein.
canEnable

boolean

Gibt an, ob der Nutzer dieses Label aktivieren kann. Der Nutzer muss die Berechtigung haben und dieses Label muss deaktiviert sein.

AppliedLabelPolicy

Verhalten dieses Labels, wenn es auf Drive-Elemente angewendet wird.

JSON-Darstellung 
{
  "copyMode": enum (CopyMode)
}
Felder
copyMode

enum (CopyMode)

Gibt an, wie die angewendeten Label und Feldwerte kopiert werden sollen, wenn ein Drive-Element kopiert wird.

CopyMode

Gibt an, wie die angewendeten Label und Feldwerte kopiert werden sollen, wenn ein Drive-Element kopiert wird.

Enums
COPY_MODE_UNSPECIFIED Kopiermodus nicht angegeben.
DO_NOT_COPY Die angewendeten Label- und Feldwerte werden standardmäßig nicht kopiert, wenn das Drive-Element, auf das sie angewendet werden, kopiert wird.
ALWAYS_COPY Das angewendete Label und die Feldwerte werden immer kopiert, wenn das Drive-Element, auf das sie angewendet werden, kopiert wird. Nur Administratoren können diesen Modus verwenden.
COPY_APPLIABLE Das angewendete Label und die Feldwerte werden kopiert, wenn der Nutzer, der die Kopie erstellt, das Label anwenden kann.

Feld

Hiermit wird ein Feld mit einem Anzeigenamen, einem Datentyp und anderen Konfigurationsoptionen definiert. In diesem Feld wird die Art der Metadaten definiert, die für ein Drive-Element festgelegt werden können.

JSON-Darstellung 
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
Felder
id

string

Nur Ausgabe. Der Schlüssel eines Felds, der innerhalb eines Labels oder einer Bibliothek eindeutig ist.

Dieser Wert wird automatisch generiert. Stimmt mit dem regulären Ausdruck ([a-zA-Z0-9])+ überein
queryKey

string

Nur Ausgabe. Der Schlüssel, der beim Erstellen von Drive-Suchanfragen verwendet wird, um Dateien anhand der für dieses Feld definierten Werte zu finden. Beispiel: „{queryKey} > 2001-01-01“.
properties

object (Properties)

Die grundlegenden Eigenschaften des Felds.
lifecycle

object (Lifecycle)

Nur Ausgabe. Der Lebenszyklus dieses Felds.
displayHints

object (DisplayHints)

Nur Ausgabe. Auf der Benutzeroberfläche werden Hinweise zum Rendern eines Felds angezeigt.
schemaCapabilities

object (SchemaCapabilities)

Nur Ausgabe. Die Berechtigungen, die dieser Nutzer beim Bearbeiten dieses Felds hat.
appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe. Die Berechtigungen, die dieser Nutzer für dieses Feld hat, und sein Wert, wenn das Label auf Drive-Elemente angewendet wird.
creator

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Feld erstellt hat.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem dieses Feld erstellt wurde.
updater

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Feld geändert hat.
updateTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der dieses Feld aktualisiert wurde.
publisher

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Feld veröffentlicht hat. Dieser Wert hat keine Bedeutung, wenn das Feld nicht veröffentlicht ist.
disabler

object (UserInfo)

Nur Ausgabe. Der Nutzer, der dieses Feld deaktiviert hat. Dieser Wert hat keine Bedeutung, wenn das Feld nicht deaktiviert ist.
disableTime

string (Timestamp format)

Nur Ausgabe. Das Datum und die Uhrzeit, zu dem dieses Feld deaktiviert wurde. Dieser Wert hat keine Bedeutung, wenn das Feld nicht deaktiviert ist.
lockStatus

object (LockStatus)

Nur Ausgabe. Der LockStatus dieses Felds.
Union-Feld type. Der Datentyp und die Optionen dieses Felds. Nach der Veröffentlichung kann der Datentyp nicht mehr geändert werden. Für type ist nur einer der folgenden Werte zulässig:
textOptions

object (TextOptions)

Optionen für Textfelder
integerOptions

object (IntegerOptions)

Optionen für Ganzzahlfelder
dateOptions

object (DateOptions)

Optionen für Datumsfelder
selectionOptions

object (SelectionOptions)

Optionen für Auswahlfelder.
userOptions

object (UserOptions)

Optionen für Nutzerfelder

TextOptions

Optionen für den Textfeldtyp.

JSON-Darstellung 
{
  "minLength": integer,
  "maxLength": integer
}
Felder
minLength

integer

Nur Ausgabe. Die Mindestlänge gültiger Werte für das Textfeld.
maxLength

integer

Nur Ausgabe. Die maximal zulässige Länge von Werten für das Textfeld.

IntegerOptions

Optionen für den Feldtyp „Ganzzahl“.

JSON-Darstellung 
{
  "minValue": string,
  "maxValue": string
}
Felder
minValue

string (int64 format)

Nur Ausgabe. Der kleinste gültige Wert für das Ganzzahlfeld.
maxValue

string (int64 format)

Nur Ausgabe. Der maximal zulässige Wert für das Ganzzahlfeld.

DateOptions

Optionen für den Datentyp des Datumsfelds.

JSON-Darstellung 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Felder
dateFormatType

enum (DateFormat)

Option für die lokalisierte Datumsformatierung. Feldwerte werden entsprechend ihrer Sprache in diesem Format gerendert.
dateFormat

string

Nur Ausgabe. ICU-Datumsformat.
minValue

object (Date)

Nur Ausgabe. Mindestgültiger Wert (Jahr, Monat, Tag).
maxValue

object (Date)

Nur Ausgabe. Höchstgültiger Wert (Jahr, Monat, Tag).

DateFormat

Optionen für lokalisierte Datumsformate

Enums
DATE_FORMAT_UNSPECIFIED Datumsformat nicht angegeben.
LONG_DATE Der vollständige Monatsname. Beispiel: 12. Januar 1999 (TT.MM.JJ)
SHORT_DATE Kurze, numerische Darstellung. Beispiel: 13.12.99 (TT.MM.JJJJ)

Datum

Stellt ein ganzes Kalenderdatum oder einen Teil davon dar, z. B. einen Geburtstag. Die Uhrzeit und die Zeitzone werden entweder an einer anderen Stelle angegeben oder sind nicht relevant. Das Datum wird relativ zum gregorianischen Kalender angegeben. Das kann Folgendes bedeuten:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag, die nicht 0 sind.
  • Einen Monat und Tag mit dem Wert „0“ für das Jahr (z. B. ein Jahrestag).
  • Ein Jahr für sich, mit dem Wert „0“ für Monat und Tag.
  • Ein Jahr und ein Monat mit dem Wert „0“ für den Tag (z. B. das Ablaufdatum einer Kreditkarte).

Ähnliche Typen:

JSON-Darstellung 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Felder
year

integer

Das Jahr des Datums. Es muss zwischen 1 und 9999 liegen oder kann 0 sein, wenn ein Datum ohne Jahresangabe angegeben wird.
month

integer

Monat eines Jahres. Die Angabe muss zwischen 1 und 12 liegen. Sie kann auch 0 sein, wenn ein Jahr ohne Monat und Tag angegeben wird.
day

integer

Tag des Monats. Die Angabe muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein. Sie kann auch 0 sein, wenn das Jahr bzw. der Monat angegeben wird, der Tag selbst jedoch nicht von Belang ist.

SelectionOptions

Optionen für den Typ des Auswahlfelds.

JSON-Darstellung 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Felder
listOptions

object (ListOptions)

Wenn angegeben, unterstützt dieses Feld eine Liste von Werten. Nach der Veröffentlichung des Felds kann dieser Wert nicht mehr geändert werden.
choices[]

object (Choice)

Die für dieses Auswahlfeld verfügbaren Optionen. Die Listenreihenfolge ist einheitlich und wird mit insertBeforeChoice geändert.

ListOptions

Optionen für eine Variante mit mehreren Werten eines verknüpften Feldtyps.

JSON-Darstellung 
{
  "maxEntries": integer
}
Felder
maxEntries

integer

Maximale Anzahl zulässiger Einträge.

Große Auswahl

Auswahlfeldoption

JSON-Darstellung 
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
Felder
id

string

Der eindeutige Wert der Auswahl. Diese ID wird automatisch generiert. Stimmt mit dem regulären Ausdruck ([a-zA-Z0-9_])+ überein.
properties

object (Properties)

Grundlegende Eigenschaften der Auswahl.
lifecycle

object (Lifecycle)

Nur Ausgabe. Lebenszyklus der Auswahl.
displayHints

object (DisplayHints)

Nur Ausgabe. Die Benutzeroberfläche zeigt Hinweise zum Rendern einer Auswahl an.
schemaCapabilities

object (SchemaCapabilities)

Nur Ausgabe. Die Funktionen, die mit dieser Option verknüpft sind, wenn Sie sie bearbeiten.
appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe. Die Funktionen, die mit dieser Auswahl für angewendete Metadaten verbunden sind.
creator

object (UserInfo)

Nur Ausgabe. Der Nutzer, der diese Auswahl erstellt hat.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Auswahl erstellt wurde.
updater

object (UserInfo)

Nur Ausgabe. Der Nutzer, der diese Auswahl zuletzt aktualisiert hat.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Auswahl zuletzt aktualisiert wurde.
publisher

object (UserInfo)

Nur Ausgabe. Der Nutzer, der diese Auswahl veröffentlicht hat. Dieser Wert hat keine Bedeutung, wenn die Auswahl nicht veröffentlicht wird.
publishTime

string (Timestamp format)

Nur Ausgabe. Das Datum und die Uhrzeit, zu dem diese Auswahl veröffentlicht wurde. Dieser Wert hat keine Bedeutung, wenn die Auswahl nicht veröffentlicht wird.
disabler

object (UserInfo)

Nur Ausgabe. Der Nutzer, der diese Option deaktiviert hat. Dieser Wert hat keine Bedeutung, wenn die Option nicht deaktiviert ist.
disableTime

string (Timestamp format)

Nur Ausgabe. Das Datum und die Uhrzeit, zu dem diese Option deaktiviert wurde. Dieser Wert hat keine Bedeutung, wenn die Auswahl nicht deaktiviert ist.
lockStatus

object (LockStatus)

Nur Ausgabe. Der LockStatus dieser Auswahl.

Attribute

Grundlegende Eigenschaften der Auswahl.

JSON-Darstellung 
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Felder
displayName

string

Erforderlich. Der Anzeigetext, der in der Benutzeroberfläche für dieses Feld angezeigt wird.
description

string

Die Beschreibung dieses Labels.
badgeConfig

object (BadgeConfig)

Die Konfiguration des Logos für diese Auswahl. Wenn diese Option festgelegt ist, wird das Label, zu dem diese Auswahl gehört, als „Label mit Logo“ betrachtet.
insertBeforeChoice

string

Nur Eingabe. Fügen Sie diese Auswahl vor der angegebenen Auswahl ein oder verschieben Sie sie dorthin. Ist das Feld leer, wird die Auswahl am Ende der Liste platziert.

BadgeConfig

Logostatus des Labels.

JSON-Darstellung 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Felder
color

object (Color)

Die Farbe des Logos. Wenn kein Symbol angegeben ist, wird kein Symbol gerendert. Die hier festgelegten Farben für Hintergrund, Vordergrund und Solo (heller und dunkler Modus) werden in der Drive-Benutzeroberfläche in die am besten passende empfohlene unterstützte Farbe geändert.
priorityOverride

string (int64 format)

Die Standardpriorität dieses Logos überschreiben. Wenn dieser Wert auf 0 gesetzt ist, wird die Standardprioritätsheuristik verwendet.

Farbe

Ermöglicht die Darstellung einer Farbe im RGBA-Farbraum. Diese Darstellung ist kompakt und soll die Umwandlung in und aus Farbdarstellungen in verschiedenen Sprachen vereinfachen. Die Felder dieser Darstellung können beispielsweise ganz einfach dem Konstruktor von java.awt.Color in Java oder der +colorWithRed:green:blue:alpha-Methode von UIColor in iOS übergeben werden. Mit nur ein wenig Aufwand lässt sich daraus auch ein CSS-rgba()-String in JavaScript erstellen.

Diese Referenzseite enthält keine Informationen zum absoluten Farbraum, der zur Interpretation des RGB-Werts verwendet werden sollte, z. B. sRGB, Adobe RGB, DCI-P3 und BT.2020. Anwendungen sollten standardmäßig den Farbraum sRGB verwenden.

Wenn entschieden werden muss, ob zwei Farben gleich sind, behandeln Implementierungen, sofern nicht anders dokumentiert, zwei Farben als gleich, wenn sich alle Rot-, Grün-, Blau- und Alphawerte jeweils um höchstens 1e-5 unterscheiden.

Beispiel (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Beispiel (iOS/Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Beispiel (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
JSON-Darstellung 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Felder
red

number

Der Rotanteil der Farbe als Wert im Intervall [0, 1].
green

number

Der Grünanteil der Farbe als Wert im Intervall [0, 1].
blue

number

Der Blauanteil der Farbe als Wert im Intervall [0, 1].
alpha

number

Der Anteil dieser Farbe, der auf den Pixel angewendet werden soll. Die endgültige Pixelfarbe wird durch folgende Gleichung definiert:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Der Wert 1,0 entspricht einer soliden Farbdarstellung, während die Farbe bei einem Wert von 0,0 vollständig transparent ist. Dabei wird anstelle eines einfachen Float-Skalarwerts eine Wrapper-Nachricht verwendet, sodass zwischen einem Standardwert und dem zurückgesetzten Wert unterschieden werden kann. Wenn nicht angegeben, wird das Farbobjekt als Volltonfarbe dargestellt (als ob für den Alphawert explizit 1,0 angegeben worden wäre).

DisplayHints

Die Benutzeroberfläche zeigt Hinweise zum Rendern einer Option an.

JSON-Darstellung 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Felder
disabled

boolean

Gibt an, ob die Option in der Benutzeroberfläche als deaktiviert angezeigt werden soll.
shownInApply

boolean

Diese Option sollte im Menü „Übernehmen“ angezeigt werden, wenn Sie Werte auf ein Drive-Element anwenden.
badgeColors

object (BadgeColors)

Die Farben, die für das Logo verwendet werden sollen. Die Farben wurden auf Grundlage der ausgewählten properties.badge_config.color in Google Materialfarben geändert.
darkBadgeColors

object (BadgeColors)

Die Farbe für den dunklen Modus, die für das Symbol verwendet werden soll. Die Farben wurden auf Grundlage der ausgewählten properties.badge_config.color in Google Materialfarben geändert.
badgePriority

string (int64 format)

Die Priorität dieses Logos. Wird verwendet, um mehrere Badges zu vergleichen und zu sortieren. Je niedriger die Zahl, desto eher sollte das Kennzeichen angezeigt werden. Wenn keine Kennzeichnungskonfiguration vorhanden ist, ist der Wert „0“. Andernfalls wird BadgeConfig.priority_override oder die Standardheuristik festgelegt, bei der das Erstellungsdatum des Labels sowie die Feld- und Optionspriorität bevorzugt werden.

BadgeColors

Die Farbe wurde aus „BadgeConfig“ abgeleitet und in die am besten geeignete unterstützte Farbe geändert.

JSON-Darstellung 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Felder
backgroundColor

object (Color)

Nur Ausgabe. Badge-Hintergrund, der zum Vordergrund passt.
foregroundColor

object (Color)

Nur Ausgabe. Vorne im Logo, passend zum Hintergrund.
soloColor

object (Color)

Nur Ausgabe. Farbe, die für Text ohne Hintergrund verwendet werden kann.

SchemaCapabilities

Die Funktionen, die mit dieser Auswahl verknüpft sind, wenn Sie sie bearbeiten.

JSON-Darstellung 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Felder
canUpdate

boolean

Gibt an, ob der Nutzer diese Auswahl aktualisieren kann.
canDelete

boolean

Gibt an, ob der Nutzer diese Auswahl löschen kann.
canDisable

boolean

Ob der Nutzer diese Auswahl deaktivieren kann.
canEnable

boolean

Gibt an, ob der Nutzer diese Option aktivieren kann.

AppliedCapabilities

Die Funktionen, die mit dieser Auswahl für angewendete Metadaten verbunden sind.

JSON-Darstellung 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Felder
canRead

boolean

Gibt an, ob der Nutzer zugehörige angewendete Metadaten zu Elementen lesen kann.
canSelect

boolean

Gibt an, ob der Nutzer diese Option für ein Element auswählen kann.

LockStatus

Enthält Informationen dazu, ob eine Labelkomponente als gesperrt betrachtet werden soll.

JSON-Darstellung 
{
  "locked": boolean
}
Felder
locked

boolean

Nur Ausgabe. Gibt an, ob diese Labelkomponente das (direkte) Ziel einer Labelsperre ist. Eine Labelkomponente kann implizit gesperrt werden, auch wenn sie nicht das direkte Ziel einer Labelsperre ist. In diesem Fall wird dieses Feld auf „false“ gesetzt.

UserOptions

Optionen für den Nutzerfeldtyp.

JSON-Darstellung 
{
  "listOptions": {
    object (ListOptions)
  }
}
Felder
listOptions

object (ListOptions)

Wenn angegeben, gibt dies an, dass dieses Feld eine Liste von Werten unterstützt. Nach der Veröffentlichung des Felds kann dieser Wert nicht mehr geändert werden.

Attribute

Die grundlegenden Eigenschaften des Felds.

JSON-Darstellung 
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
Felder
displayName

string

Erforderlich. Der Anzeigetext, der in der Benutzeroberfläche für dieses Feld angezeigt wird.
required

boolean

Gibt an, ob das Feld als Pflichtfeld gekennzeichnet werden soll.
insertBeforeField

string

Nur Eingabe. Fügen Sie dieses Feld vor das angegebene Feld ein oder verschieben Sie es dorthin. Wenn das Feld leer ist, wird es ans Ende der Liste gesetzt.

DisplayHints

Auf der Benutzeroberfläche werden Hinweise zum Rendern eines Felds angezeigt.

JSON-Darstellung 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Felder
required

boolean

Gibt an, ob das Feld auf der Benutzeroberfläche als Pflichtfeld angezeigt werden soll.
disabled

boolean

Gibt an, ob das Feld in der Benutzeroberfläche als deaktiviert angezeigt werden soll.
shownInApply

boolean

Dieses Feld sollte im Menü „Übernehmen“ angezeigt werden, wenn Sie Werte auf ein Drive-Element anwenden.

SchemaCapabilities

Die Funktionen, die beim Bearbeiten dieses Felds verfügbar sind.

JSON-Darstellung 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Felder
canUpdate

boolean

Gibt an, ob der Nutzer dieses Feld ändern kann.
canDelete

boolean

Gibt an, ob der Nutzer dieses Feld löschen kann. Der Nutzer muss die Berechtigung haben und das Feld muss eingestellt werden.
canDisable

boolean

Gibt an, ob der Nutzer dieses Feld deaktivieren kann. Der Nutzer muss die Berechtigung haben und dieses Feld darf nicht bereits deaktiviert sein.
canEnable

boolean

Gibt an, ob der Nutzer dieses Feld aktivieren kann. Der Nutzer muss die Berechtigung haben und dieses Feld muss deaktiviert sein.

AppliedCapabilities

Die Funktionen, die sich auf dieses Feld in den angewendeten Metadaten beziehen.

JSON-Darstellung 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Felder
canRead

boolean

Gibt an, ob der Nutzer zugehörige angewendete Metadaten zu Elementen lesen kann.
canWrite

boolean

Gibt an, ob der Nutzer dieses Feld für Drive-Elemente festlegen kann.

EnabledAppSettings

Beschreibt die Workspace-Apps, in denen das Label verwendet werden kann.

JSON-Darstellung 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
Felder
enabledApps[]

object (EnabledApp)

Optional. Liste der Apps, in denen das Label verwendet werden kann.

EnabledApp

Eine App, in der das Label verwendet werden kann.

JSON-Darstellung 
{
  "app": enum (App)
}
Felder
app

enum (App)

Optional. Der Name der App.

App

Die möglichen Workspace-Apps, in denen Labels verwendet werden können.

Enums
APP_UNSPECIFIED Ohne Angabe
DRIVE Drive.
GMAIL Gmail

Methoden

create

 Erstellt ein neues Label.

delete

 Löscht ein Label und zugehörige Metadaten in Drive-Elementen endgültig.

delta

 Aktualisiert ein einzelnes Label, indem eine Reihe von Aktualisierungsanfragen angewendet wird, die zu einer neuen Entwurfsversion führen.

disable

 Deaktivieren Sie ein veröffentlichtes Label.

enable

 Aktivieren Sie ein deaktiviertes Label und stellen Sie es wieder in den veröffentlichten Zustand.

get

 Label anhand des Ressourcennamens abrufen

list

 Labels auflisten

publish

 Veröffentlichen Sie alle Änderungen am Label.

updateLabelCopyMode

 Aktualisiert den CopyMode eines Labels.

updateLabelEnabledAppSettings

 Aktualisiert die EabledAppSettings eines Labels.

updatePermissions

 Aktualisiert die Berechtigungen eines Labels.