REST Resource: labels

Ressource: Label

Ein Label definiert eine Taxonomie, die auf Drive-Elemente angewendet werden kann, um Elemente zu organisieren und zu suchen. Labels können einfache Strings sein oder Felder enthalten, in denen zusätzliche Metadaten beschrieben werden, 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 entweder das Format labels/{id} oder labels/{id}@{revisionId}. Siehe id und revisionId unten.

id

string

Nur Ausgabe Global eindeutige Kennung dieses Labels. Die ID ist Teil des Labels name. Im Gegensatz zu name ist sie jedoch in allen Überarbeitungen einheitlich. Stimmt mit dem regulären Ausdruck überein: ([a-zA-Z0-9])+

revisionId

string

Nur Ausgabe Überarbeitungs-ID des Labels. Abhängig von der gesendeten Anfrage kann die Überarbeitungs-ID Teil des Labels name sein. Eine neue Überarbeitung wird erstellt, wenn überarbeitete Eigenschaften eines Labels geändert werden. 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, 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 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 Angaben dazu, ob es veröffentlicht oder verworfen wurde und 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 bei angewendeten Metadaten beziehen.

schemaCapabilities

object (SchemaCapabilities)

Nur Ausgabe Die Berechtigungen, 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, die Nutzern präsentiert werden soll, 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 und auf Drive-Elemente angewendet werden.
ADMIN Label des Administrators. 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 Kennung 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. Titel des Labels

description

string

Die Beschreibung des Labels.

Lifecycle

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

  • UNPUBLISHED_DRAFT (Ausgangsstatus)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (gelöscht)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (gelöscht)

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

  • Veröffentlicht: Mit diesem Status können einige Arten von Änderungen an einem Objekt vorgenommen werden. In diesem Fall ist hasUnpublishedChanges „true“. Außerdem sind einige Arten von Änderungen nicht zulässig. Im Allgemeinen wird jede Änderung abgelehnt, die vorhandene Metadaten, die sich auf das Label beziehen, ungültig machen oder neue Einschränkungen verursachen würde.
  • 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 für das mit diesem Lebenszyklus verknüpfte Objekt nicht veröffentlichte Änderungen vorliegen.

disabledPolicy

object (DisabledPolicy)

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

Status

Der Status des Objekts, das diesem Lebenszyklus zugeordnet ist.

Enums
STATE_UNSPECIFIED Unbekannter Status.
UNPUBLISHED_DRAFT Der Anfangszustand eines Objekts. Nach der Veröffentlichung kann das Objekt nicht mehr zu diesem Status zurückkehren. Nachdem ein Objekt veröffentlicht wurde, sind bestimmte Arten von Änderungen nicht mehr zulässig.
PUBLISHED Das Objekt wurde veröffentlicht. Das Objekt enthält möglicherweise nicht veröffentlichte Entwurfsänderungen, wie durch hasUnpublishedChanges angegeben.
DISABLED Das Objekt wurde veröffentlicht und inzwischen deaktiviert. Das Objekt enthält möglicherweise nicht veröffentlichte Entwurfsänderungen, wie durch hasUnpublishedChanges angegeben.
DELETED Das Objekt wurde gelöscht.

DisabledPolicy

Die Richtlinie, die regelt, wie ein deaktiviertes Label, ein Feld oder eine Auswahloption in verschiedenen Kontexten behandelt werden soll.

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

boolean

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

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

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 auf 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 ein Label in einer Liste angezeigt wird.

AppliedCapabilities

Die Rechte, die ein Nutzer in Bezug auf die angewendeten Metadaten dieses Labels hat.

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

boolean

Gibt an, ob der Nutzer die angewendeten 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 Artikeln entfernen kann.

SchemaCapabilities

Die mit diesem Label verbundenen Funktionen beim Bearbeiten des Labels.

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 eine entsprechende Berechtigung haben und das Label muss deaktiviert sein.

canDisable

boolean

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

canEnable

boolean

Gibt an, ob der Nutzer dieses Label aktivieren kann. Der Nutzer muss eine entsprechende 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 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 Die angewendeten Label- und Feldwerte werden beim Kopieren des Drive-Elements, auf das sie angewendet wurden, nicht automatisch kopiert.
ALWAYS_COPY Die angewendeten Label- und Feldwerte werden beim Kopieren des Drive-Elements, auf das es angewendet wurde, immer kopiert. Nur Administratoren können diesen Modus verwenden.
COPY_APPLIABLE Das angewendete Label und die Feldwerte werden kopiert, wenn das Label vom Nutzer verwendet werden kann, der die Kopie erstellt.

Feld

Definiert ein Feld, das einen Anzeigenamen, einen Datentyp und andere Konfigurationsoptionen enthält. 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 Schlüssel, der beim Erstellen von Drive-Suchanfragen verwendet werden soll, um Dateien anhand der Werte zu finden, die für dieses Feld festgelegt wurden. 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 Berechtigungen, die dieser Nutzer beim Bearbeiten dieses Felds hat.

appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe Die Berechtigungen, die dieser Nutzer für dieses Feld und seinen Wert hat, 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 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 das Datumsfeld.

selectionOptions

object (SelectionOptions)

Optionen für Auswahlfeld.

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 gültige 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 gültige 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 in diesem Format entsprechend ihrer Sprache gerendert.

dateFormat

string

Nur Ausgabe ICU-Datumsformat.

minValue

object (Date)

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

maxValue

object (Date)

Nur Ausgabe Maximal gültiger Wert (Jahr, Monat, Tag)

DateFormat

Lokalisierte Formatoptionen für 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 Kurz, numerisch, Darstellung. Beispiel: 12/13/99 (M/T/JJ)

SelectionOptions

Optionen für den Auswahlfeldtyp.

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

object (ListOptions)

Gibt an, dass dieses Feld eine Liste von Werten unterstützt. Sobald das Feld veröffentlicht ist, kann dies nicht mehr geändert werden.

choices[]

object (Choice)

Die für dieses Auswahlfeld verfügbaren Optionen. Die Listenreihenfolge ist konsistent 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 Auswahl. Diese ID wird automatisch generiert. Stimmt mit dem regulären Ausdruck überein: ([a-zA-Z0-9_])+.

properties

object (Properties)

Grundlegende Eigenschaften der Auswahl.

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 Funktionen, die sich auf diese Option beim Bearbeiten der Option beziehen.

appliedCapabilities

object (AppliedCapabilities)

Nur Ausgabe Die Funktionen, die sich auf diese Auswahl in Bezug auf angewendete 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, zu dem diese Auswahl veröffentlicht wurde. 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 der Auswahl.

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

string

Erforderlich. Der Anzeigetext, der auf der Benutzeroberfläche angezeigt wird und dieses Feld identifiziert.

description

string

Die Beschreibung dieses Labels.

badgeConfig

object (BadgeConfig)

Die Badge-Konfiguration für diese Auswahl. Wenn diese Option festgelegt ist, wird das Label, das dieser Auswahl unterliegt, als „Badge-Label“ betrachtet.

insertBeforeChoice

string

Nur Eingabe. Fügen Sie dieses Auswahlfeld vor der angegebenen Auswahl ein oder verschieben Sie es. Ist das Feld leer, wird die Auswahl an das Ende der Liste gesetzt.

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 Logo 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 empfohlene unterstützte Farbe geändert.

priorityOverride

string (int64 format)

Überschreibe die globale Standardpriorität dieses Abzeichens. Ist der Wert auf 0 gesetzt, wird die standardmäßige Prioritätsheuristik verwendet.

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 in der Benutzeroberfläche als deaktiviert angezeigt werden soll.

shownInApply

boolean

Diese Option sollte im Menü „Anwenden“ angezeigt werden, wenn Werte auf ein Google 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-Materialfarben geändert.

darkBadgeColors

object (BadgeColors)

Die Farbe im dunklen Modus, die für das Badge verwendet werden soll. Basierend auf den ausgewählten properties.badge_config.color zu Google-Materialfarben 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 an erster Stelle angezeigt werden sollte. Wenn keine Badging-Konfiguration vorhanden ist, ist dieser Wert 0. Andernfalls wird er auf BadgeConfig.priority_override oder die Standardheuristik festgelegt, bei der das Erstellungsdatum des Labels und die Priorität von Feldern und Optionen bevorzugt wird.

BadgeColors

Die aus BadgeConfig abgeleitete Farbe wurde in die am besten empfohlene unterstützte Farbe geändert.

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

object (Color)

Nur Ausgabe Kennzeichenhintergrund, der zum Vordergrund passt

foregroundColor

object (Color)

Nur Ausgabe Vordergrund des Abzeichens, das zum Hintergrund passt.

soloColor

object (Color)

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

SchemaCapabilities

Die mit dieser Auswahl verbundenen Funktionen beim Bearbeiten der Auswahl.

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 Funktionen, die sich auf diese Auswahl in Bezug auf angewendete Metadaten beziehen.

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

boolean

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

canSelect

boolean

Gibt an, ob der Nutzer diese Auswahl bei einem Element auswählen kann.

LockStatus

Enthält Informationen darüber, 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 eines LabelLock ist. Eine Labelkomponente kann implizit gesperrt werden, auch wenn sie nicht das direkte Ziel eines LabelLock 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)

Gibt an, dass dieses Feld eine Liste von Werten unterstützt. Sobald das Feld veröffentlicht ist, 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 auf der Benutzeroberfläche angezeigt wird und dieses Feld identifiziert.

required

boolean

Gibt an, ob das Feld als erforderlich gekennzeichnet werden soll.

insertBeforeField

string

Nur Eingabe. Fügen Sie dieses Feld vor das entsprechende Feld ein oder verschieben Sie es. Ist das Feld leer, wird das Feld an das Ende der Liste gesetzt.

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 wie erforderlich 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ü „Anwenden“ angezeigt werden, wenn Werte auf ein Drive-Element angewendet werden.

SchemaCapabilities

Die mit diesem Feld verbundenen Funktionen beim Bearbeiten des Felds.

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 eine entsprechende Berechtigung haben 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 eine entsprechende Berechtigung haben und dieses Feld muss deaktiviert sein.

AppliedCapabilities

Die mit diesem Feld verbundenen Funktionen für angewendete Metadaten.

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

boolean

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

canWrite

boolean

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

Methoden

create

Erstellt ein neues Label.

delete

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

delta

Aktualisiert ein einzelnes Label durch Anwenden einer Reihe von Aktualisierungsanfragen, was zu einem neuen Entwurf der Überarbeitung führt.

disable

Veröffentlichte Labels deaktivieren

enable

Aktiviert ein deaktiviertes Label und stellt den veröffentlichten Status wieder her.

get

Rufen Sie ein Label anhand seines Ressourcennamens ab.

list

Labels auflisten.

publish

Alle Entwurfsänderungen unter dem Label veröffentlichen

updateLabelCopyMode

Aktualisiert die CopyMode eines Labels.

updatePermissions

Aktualisiert die Berechtigungen eines Labels.