REST Resource: labels

Ressource: Label

Mit einem Label wird eine Taxonomie definiert, die auf Drive-Elemente angewendet werden kann, um Elemente übergreifend zu organisieren und zu suchen. Labels können einfache Strings sein oder Felder mit zusätzlichen Metadaten enthalten, die zum Organisieren und Durchsuchen 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)
  }
}
Felder
name

string

Nur Ausgabe. Ressourcenname des Labels. Hat je nach Anfrage das Format labels/{id} oder labels/{id}@{revisionId}. Siehe id und revisionId unten.
id

string

Nur Ausgabe. Die global eindeutige Kennung dieses Labels. Die ID ist Teil des Labels name, aber im Gegensatz zu name ist die ID zwischen den Überarbeitungen einheitlich. Stimmt mit dem regulären Ausdruck überein: ([a-zA-Z0-9])+
revisionId

string

Nur Ausgabe. Versions-ID des Labels. Die Versions-ID kann je nach gesendeter Anfrage Teil des Labels name sein. Jedes Mal, wenn überarbeitete Eigenschaften eines Labels geändert werden, wird eine neue Version erstellt. Stimmt mit dem regulären Ausdruck überein: ([a-zA-Z0-9])+
labelType

enum (LabelType)

Erforderlich. Der Typ des Labels.
creator

object (UserInfo)

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

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem dieses Label erstellt wurde.
revisionCreator

object (UserInfo)

Nur Ausgabe. Der Nutzer, der diese Labelüberarbeitung erstellt hat.
revisionCreateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Labelüberarbeitung 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 der Veröffentlichung dieses Labels. 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. Der Zeitpunkt, 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: „customers/123abc789“.
properties

object (Properties)

Erforderlich. Die grundlegenden Eigenschaften des Labels.
lifecycle

object (Lifecycle)

Nur Ausgabe. Der Lebenszyklusstatus des Labels, einschließlich der Angabe, ob es veröffentlicht oder veraltet ist oder Entwurfsänderungen enthält.
displayHints

object (DisplayHints)

Nur Ausgabe. UI-Anzeigehinweise zum Rendern des Labels.
appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe. Die Funktionen, die sich auf dieses Label in angewendeten Metadaten beziehen.
schemaCapabilities

object (SchemaCapabilities)

Nur Ausgabe. Die Rechte des Nutzers für dieses Label.
appliedLabelPolicy

object (AppliedLabelPolicy)

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

object (Field)

Liste der Felder in absteigender Prioritätsreihenfolge.
learnMoreUri

string

Benutzerdefinierte URL, die Nutzern angezeigt wird, damit sie mehr über dieses Label und seine Verwendung erfahren können.
lockStatus

object (LockStatus)

Nur Ausgabe. Der LockStatus dieses Labels.

LabelType

Der Typ dieses Labels.

Enums
LABEL_TYPE_UNSPECIFIED Unbekannter Labeltyp
SHARED Freigegebene Labels können für Nutzer freigegeben werden, um sie auf Drive-Elemente anzuwenden.
ADMIN Administratorrechtes Label. Kann nur von Administratoren erstellt und bearbeitet werden. Unterstützt einige zusätzliche Funktionen, die nur für Administratoren verfügbar sind.

UserInfo

Informationen zu einem Nutzer.

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

string

Die ID für diesen Nutzer, die mit der People API verwendet werden kann, um weitere Informationen abzurufen. Beispiel: people/12345678.

Attribute

Grundlegende Eigenschaften des Labels.

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

string

Erforderlich. Der Titel des Labels.
description

string

Die Beschreibung des Labels.

Lifecycle

Der Lebenszyklusstatus eines Objekts, z. B. Label, Feld oder Auswahl. Der Lebenszyklus erzwingt folgende Übergänge:

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

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

  • Veröffentlicht: An einem Objekt mit diesem Status können verschiedene Änderungen vorgenommen werden. In diesem Fall ist hasUnpublishedChanges „true“. Außerdem sind einige Änderungen nicht zulässig. Im Allgemeinen werden alle Änderungen abgelehnt, die bestehende Metadaten, die mit dem Label verknüpft sind, ungültig machen oder zu neuen Einschränkungen führen würden.
  • Deaktiviert: Wenn diese Option deaktiviert ist, wird die konfigurierte DisabledPolicy wirksam.
JSON-Darstellung 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Felder
state

enum (State)

Nur Ausgabe. Der Status des Objekts, das diesem Lebenszyklus zugeordnet 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, das diesem Lebenszyklus zugeordnet ist.

Enums
STATE_UNSPECIFIED Unbekannter Status.
UNPUBLISHED_DRAFT Anfänglicher Zustand eines Objekts. Nach der Veröffentlichung kann das Objekt nicht mehr zu diesem 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, wie von hasUnpublishedChanges angegeben.
DISABLED Das Objekt wurde veröffentlicht und inzwischen deaktiviert. Das Objekt enthält möglicherweise nicht veröffentlichte Entwurfsänderungen, wie von hasUnpublishedChanges angegeben.
DELETED Das Objekt wurde gelöscht.

DisabledPolicy

Die Richtlinie, die festlegt, wie mit einem deaktivierten Label, Feld oder einer Auswahl in verschiedenen Kontexten umgegangen wird.

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

boolean

Gibt an, ob dieses deaktivierte Objekt im Menü „Anwenden“ der Drive-Elemente angezeigt werden soll.

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

DisplayHints

UI-Anzeigehinweise zum Rendern des Labels.

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

boolean

Gibt an, ob das Label in der UI 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, um das Label in einer Liste anzuzeigen.

AppliedCapabilities

Die Rechte, die ein Nutzer für die auf dieses Label angewendeten Metadaten hat.

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

boolean

Gibt an, ob der Nutzer angewendete Metadaten für dieses 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 Elementen entfernen kann.

SchemaCapabilities

Die mit diesem Label verbundenen Funktionen, wenn das Label 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 dazu berechtigt sein und das Label muss deaktiviert sein.
canDisable

boolean

Gibt an, ob der Nutzer dieses Label deaktivieren kann. Der Nutzer muss über eine entsprechende Berechtigung verfügen und dieses Label darf nicht bereits deaktiviert sein.
canEnable

boolean

Gibt an, ob der Nutzer dieses Label aktivieren kann. Der Nutzer muss über eine entsprechende Berechtigung verfügen und dieses Label muss deaktiviert sein.

AppliedLabelPolicy

Das 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 beim Kopieren eines Drive-Elements kopiert werden sollen.

CopyMode

Gibt an, wie die angewendeten Label- und Feldwerte beim Kopieren eines Drive-Elements kopiert werden sollen.

Enums
COPY_MODE_UNSPECIFIED Kopiermodus nicht angegeben.
DO_NOT_COPY Das angewendete Label und die Feldwerte werden nicht standardmäßig kopiert, wenn das Drive-Element, auf das es angewendet wird, kopiert wird.
ALWAYS_COPY Das angewendete Label und die Feldwerte werden immer zusammen mit dem Drive-Element kopiert, auf das es angewendet wird. Nur Administratoren können diesen Modus verwenden.
COPY_APPLIABLE Das angewendete Label und die Feldwerte werden kopiert, wenn das Label für den Nutzer, der die Kopie erstellt, zutreffend ist.

Feld

Definiert ein Feld mit einem Anzeigenamen, einem Datentyp und anderen Konfigurationsoptionen. 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 überein: ([a-zA-Z0-9])+
queryKey

string

Nur Ausgabe. Der Schlüssel, der beim Erstellen von Drive-Suchanfragen verwendet wird, um Dateien anhand von Werten zu finden, die für dieses Feld für Dateien definiert sind. 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. UI-Anzeigehinweise zum Rendern eines Felds
schemaCapabilities

object (SchemaCapabilities)

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

object (AppliedCapabilities)

Nur Ausgabe. Die Berechtigungen des Nutzers für dieses Feld 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 das Feld erstellt wurde.
updater

object (UserInfo)

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

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem 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. Der Zeitpunkt, 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 Datumsfeld
selectionOptions

object (SelectionOptions)

Optionen für Auswahlfelder.
userOptions

object (UserOptions)

Optionen für Nutzerfelder.

TextOptions

Optionen für den Feldtyp „Text“.

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

integer

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

integer

Nur Ausgabe. Die maximal zulässige Länge der Werte 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 gültige Mindestwert für das Ganzzahlfeld.
maxValue

string (int64 format)

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

DateOptions

Optionen für den Feldtyp „Datum“.

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

enum (DateFormat)

Lokalisierte Datumsformatierungsoption. Feldwerte werden entsprechend ihrer Sprache in diesem Format gerendert.
dateFormat

string

Nur Ausgabe. ICU-Datumsformat.
minValue

object (Date)

Nur Ausgabe. Gültiger Mindestwert (Jahr, Monat, Tag).
maxValue

object (Date)

Nur Ausgabe. Gültiger Höchstwert (Jahr, Monat, Tag).

DateFormat

Lokalisierte Datumsformate.

Enums
DATE_FORMAT_UNSPECIFIED Datumsformat nicht angegeben.
LONG_DATE Enthält den vollständigen Monatsnamen. Beispiel: 12. Januar 1999 (d. MMMM y)
SHORT_DATE Kurze, numerische Darstellung. Beispiel: 12/13/99 (M/d/yy)

Datum

Stellt ein ganzes Kalenderdatum oder einen Teil davon dar, z. B. einen Geburtstag. Tageszeit und Zeitzone werden entweder an anderer Stelle angegeben oder sind unbedeutend. Das Datum bezieht sich auf den gregorianischen Kalender. Dies kann Folgendes darstellen:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag ungleich null.
  • Ein Monat und ein Tag mit einem Jahr von 0 (z. B. ein Jahrestag).
  • Ein Jahr für sich alleine, mit einem Monat und einem Tag von null.
  • Ein Jahr und ein Monat mit 0 Tag (z. B. dem Ablaufdatum einer Kreditkarte).

Ähnliche Typen:

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

integer

Jahr des Datums. Muss zwischen 1 und 9999 liegen oder 0, um ein Datum ohne Jahr anzugeben.
month

integer

Monat eines Jahres. Muss zwischen 1 und 12 liegen oder 0, um ein Jahr ohne Monat und Tag anzugeben.
day

integer

Tag im Monat. Muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein, oder 0, um ein Jahr allein oder ein Jahr und Monat anzugeben, wenn der Tag nicht von Bedeutung ist.

SelectionOptions

Optionen für den Auswahlfeldtyp.

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

object (ListOptions)

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

object (Choice)

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

ListOptions

Optionen für eine mehrwertige Variante eines verknüpften Feldtyps.

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

integer

Maximal zulässige Anzahl von Einträgen.

Große Auswahl

Auswahlfeld

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 Wahl. Diese ID wird automatisch generiert. Stimmt mit dem regulären Ausdruck ([a-zA-Z0-9_])+ überein.
properties

object (Properties)

Grundlegende Eigenschaften Ihrer Wahl.
lifecycle

object (Lifecycle)

Nur Ausgabe. Lebenszyklus Ihrer Wahl.
displayHints

object (DisplayHints)

Nur Ausgabe. UI-Anzeigehinweise zum Rendern einer Auswahl
schemaCapabilities

object (SchemaCapabilities)

Nur Ausgabe. Die mit dieser Option verbundenen Funktionen beim Bearbeiten der Option.
appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe. Die Fähigkeiten, die sich auf diese Auswahl bei angewendeten Metadaten beziehen.
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 ist.
publishTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der Veröffentlichung dieser Auswahl. Dieser Wert hat keine Bedeutung, wenn die Auswahl nicht veröffentlicht ist.
disabler

object (UserInfo)

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

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem diese Auswahl 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 Ihrer Wahl.

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

string

Erforderlich. Der Anzeigetext, der in der Benutzeroberfläche zur Identifizierung dieses Felds angezeigt wird.
description

string

Die Beschreibung dieses Labels.
badgeConfig

object (BadgeConfig)

Die Badge-Konfiguration für diese Auswahl. Wenn das Label festgelegt ist, zu dem diese Auswahl gehört, wird es als „Badge-Label“ betrachtet.
insertBeforeChoice

string

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

BadgeConfig

Logostatus des Labels.

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

object (Color)

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

string (int64 format)

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

Farbe

Ermöglicht die Darstellung einer Farbe im RGBA-Farbraum. Diese Darstellung ist auf die einfache Konvertierung in und aus Farbdarstellungen in verschiedenen Sprachen statt auf Kompaktheit ausgelegt. Die Felder dieser Darstellung können beispielsweise einfach dem Konstruktor von java.awt.Color in Java bereitgestellt werden. Sie kann auch einfach über die Methode +colorWithRed:green:blue:alpha von UIColor in iOS bereitgestellt werden. Außerdem lässt er sich mit wenig Aufwand in JavaScript als CSS-String rgba() formatieren.

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. Standardmäßig sollte in Anwendungen der sRGB-Farbraum verwendet werden.

Wenn die Farbgleichheit beschlossen werden muss, werden Implementierungen, sofern nicht anders angegeben, zwei Farben als gleich behandelt, wenn sich alle ihre Rot-, Grün-, Blau- und Alphawerte 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 keine Angabe gemacht wird, wird dieses Farbobjekt als Volltonfarbe gerendert, so als ob dem Alphawert explizit der Wert 1,0 zugewiesen worden wäre.

DisplayHints

UI-Anzeigehinweise zum Rendern einer Option

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

boolean

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

boolean

Diese Option sollte im Menü „Anwenden“ angezeigt werden, wenn Werte auf ein Drive-Element angewendet werden.
badgeColors

object (BadgeColors)

Die für das Logo zu verwendenden Farben. Basierend auf den ausgewählten properties.badge_config.color zu Google Material-Farben geändert.
darkBadgeColors

object (BadgeColors)

Die für das Logo zu verwendende Farbe im dunklen Modus. Basierend auf den ausgewählten properties.badge_config.color zu Google Material-Farben geändert.
badgePriority

string (int64 format)

Die Priorität dieses Logos. Wird zum Vergleichen und Sortieren mehrerer Logos verwendet. Eine niedrigere Zahl bedeutet, dass das Logo zuerst angezeigt werden sollte. Wenn keine Kennzeichenkonfiguration vorhanden ist, lautet der Wert 0. Andernfalls wird BadgeConfig.priority_override oder die Standardheuristik verwendet, die das Erstellungsdatum des Labels sowie die Feld- und Optionspriorität bevorzugt.

BadgeColors

Die aus BadgeConfig abgeleitete und empfohlene unterstützte Farbe.

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

object (Color)

Nur Ausgabe. Badge-Hintergrund, der mit dem Vordergrund gekoppelt ist.
foregroundColor

object (Color)

Nur Ausgabe. Badge-Vordergrund, der mit dem Hintergrund gekoppelt ist.
soloColor

object (Color)

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

SchemaCapabilities

Die Funktionen, die sich auf diese Auswahl beziehen, wenn sie bearbeitet wird.

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

Gibt an, ob der Nutzer diese Auswahl deaktivieren kann.
canEnable

boolean

Gibt an, ob der Nutzer diese Auswahl aktivieren kann.

AppliedCapabilities

Die Fähigkeiten, die sich auf diese Auswahl bei angewendeten Metadaten beziehen.

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

boolean

Gibt an, ob der Nutzer zugehörige angewendete Metadaten für Elemente lesen kann.
canSelect

boolean

Gibt an, ob der Nutzer bei einem Artikel diese Auswahl treffen kann.

LockStatus

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

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

boolean

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

UserOptions

Optionen für den Nutzerfeldtyp.

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

object (ListOptions)

Wenn angegeben, gibt es an, dass dieses Feld eine Liste von Werten unterstützt. Nach der Veröffentlichung des Felds kann dies 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 zur Identifizierung dieses Felds angezeigt wird.
required

boolean

Gibt an, ob das Feld als erforderlich markiert werden soll.
insertBeforeField

string

Nur Eingabe. Fügen oder verschieben Sie dieses Feld vor das angegebene Feld. Ist das Feld leer, wird es am Ende der Liste platziert.

DisplayHints

UI-Anzeigehinweise zum Rendern eines Felds

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

boolean

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

boolean

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

boolean

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

SchemaCapabilities

Die mit diesem Feld verbundenen Funktionen, wenn das Feld bearbeitet wird.

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 über die entsprechende Berechtigung verfügen und das Feld muss veraltet sein.
canDisable

boolean

Gibt an, ob der Nutzer dieses Feld deaktivieren kann. Der Nutzer muss über eine entsprechende Berechtigung verfügen und dieses Feld darf nicht bereits deaktiviert sein.
canEnable

boolean

Gibt an, ob der Nutzer dieses Feld aktivieren kann. Der Nutzer muss über eine entsprechende Berechtigung verfügen und dieses Feld muss deaktiviert sein.

AppliedCapabilities

Die Fähigkeiten, die sich auf dieses Feld bei angewendeten Metadaten beziehen.

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

boolean

Gibt an, ob der Nutzer zugehörige angewendete Metadaten für Elemente lesen kann.
canWrite

boolean

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

Methoden

create

 Erstellt ein neues Label.

delete

 Dadurch werden ein Label und die zugehörigen Metadaten von Drive-Elementen endgültig gelöscht.

delta

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

disable

 Veröffentlichtes Label deaktivieren

enable

 Ein deaktiviertes Label aktivieren und seinen Veröffentlichungsstatus wiederherstellen.

get

 Rufen Sie ein Label anhand seines Ressourcennamens ab.

list

 Labels auflisten.

publish

 Alle Entwurfsänderungen für das Label veröffentlichen.

updateLabelCopyMode

 Aktualisiert die CopyMode eines Labels.

updatePermissions

 Aktualisiert die Berechtigungen eines Labels.