REST Resource: labels

Ressource: Label

Ein Label definiert eine Taxonomie, die auf Drive-Elemente angewendet werden kann, um Elemente zu organisieren und darin zu suchen. Labels können einfache Strings sein oder Felder mit zusätzlichen Metadaten, 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. Sie haben je nach Anfrage entweder das Format labels/{id} oder labels/{id}@{revisionId}. Siehe unten: id und revisionId.
id

string

Nur Ausgabe. Global eindeutige Kennung dieses Labels. Die ID gehört zum Label name, aber im Gegensatz zu name ist die ID zwischen den Überarbeitungen konsistent. Stimmt mit dem regulären Ausdruck überein: ([a-zA-Z0-9])+
revisionId

string

Nur Ausgabe. Überarbeitungs-ID des Labels. Die Überarbeitungs-ID kann je nach erteilter Anfrage Teil des Labels name sein. Bei jeder Änderung der überarbeiteten Eigenschaften eines Labels wird eine neue Überarbeitung 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 der Erstellung dieses Labels.
revisionCreator

object (UserInfo)

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

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der Erstellung dieser Labelüberarbeitung.
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 Veröffentlichung, der Einstellung und der Entwurfsänderungen.
displayHints

object (DisplayHints)

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

object (AppliedCapabilities)

Nur Ausgabe. Die mit diesem Label verbundenen Funktionen für angewendete Metadaten.
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, die Nutzern angezeigt wird, um mehr über dieses Label und seine Verwendung zu erfahren.
lockStatus

object (LockStatus)

Nur Ausgabe. Der LockStatus dieses Labels.

Label-Typ

Der Typ dieses Labels.

Enums
LABEL_TYPE_UNSPECIFIED Unbekannter Labeltyp.
SHARED Gemeinsame Labels können mit Nutzern geteilt werden, um sie auf Drive-Elemente anzuwenden.
ADMIN Label, das Eigentum des Administrators ist. Nur von Administratoren erstellt und bearbeitbar. Unterstützt einige zusätzliche Funktionen, die nur für Administratoren zugänglich 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 zu erhalten. Beispiel: personen/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 Wahl. 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 charakteristische Eigenschaften:

  • Veröffentlicht: Es können einige Änderungen an einem Objekt in diesem Status vorgenommen werden. In diesem Fall ist hasUnpublishedChanges wahr. Außerdem sind einige Änderungen nicht zulässig. Im Allgemeinen wird jede Änderung abgelehnt, die bestehende Metadaten für das Label ungültig macht oder zu neuen Einschränkungen führt.
  • Deaktiviert: Ist die Richtlinie deaktiviert, 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 mit diesem Lebenszyklus verknüpft ist.
hasUnpublishedChanges

boolean

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

object (DisabledPolicy)

Mit dieser Richtlinie wird festgelegt, wie ein deaktiviertes Label, Feld oder eine Auswahl angezeigt wird.

Status

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

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

Deaktivierte Richtlinie

Mit dieser Richtlinie wird festgelegt, wie deaktivierte Labels, Felder oder Auswahlen in unterschiedlichen Kontexten behandelt werden.

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

boolean

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

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

Hinweise anzeigen

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ü „Übernehmen“ angezeigt werden, wenn Sie Werte auf ein Drive-Element anwenden.
priority

string (int64 format)

Anzeige des Labels in einer Liste.

Angewandte Funktionen

Die Berechtigungen eines Nutzers für die angewendeten Metadaten dieses Labels.

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 aus Elementen entfernen kann.

SchemaFunktionen

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 darf.
canDelete

boolean

Gibt an, ob der Nutzer dieses Label löschen kann. Der Nutzer muss eine 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.

AngewandteLabel-Richtlinie

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.

Kopiermodus

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 werden, nicht automatisch übernommen.
ALWAYS_COPY Die angewendeten Label- und Feldwerte werden immer kopiert, wenn das entsprechende Drive-Element kopiert wird. Nur Administratoren können diesen Modus verwenden.
COPY_APPLIABLE Die angewendeten Label- und Feldwerte werden kopiert, wenn das Label vom Nutzer, der die Kopie erstellt, angewendet werden kann.

Feld

Definiert ein Feld mit einem Anzeigenamen, einem Datentyp und anderen Konfigurationsoptionen. Dieses Feld definiert die Art von Metadaten, 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, das 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 der für dieses Feld für Dateien definierten Werte zu finden. Beispiel: „{queryKey} > 01.01.2001“.
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 des Nutzers für dieses Feld und dessen 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 der Erstellung dieses Felds.
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)

Textfeldoptionen.
integerOptions

object (IntegerOptions)

Optionen für Ganzzahlfelder.
dateOptions

object (DateOptions)

Optionen für das Datumsfeld.
selectionOptions

object (SelectionOptions)

Optionen für Auswahlfelder.
userOptions

object (UserOptions)

Optionen für Nutzerfelder

Textoptionen

Optionen für den Feldtyp „Text“.

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

integer

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

integer

Nur Ausgabe. Die maximale Länge der Werte für das Textfeld.

Ganzzahloptionen

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 Höchstwert für das Ganzzahlfeld.

Datumsoptionen

Optionen für den Datumsfeldtyp.

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

enum (DateFormat)

Lokalisierte Datumsformatierung. Feldwerte werden in der entsprechenden Sprache gerendert.
dateFormat

string

Nur Ausgabe. Datumsformat der Intensivstation.
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.

Enums
DATE_FORMAT_UNSPECIFIED Datumsformat nicht angegeben.
LONG_DATE Enthält den vollständigen Monatsnamen. Beispiel: 12. Januar 1999 (T. MMMM y)
SHORT_DATE Kurz, numerisch, Darstellung. Beispiel: 12/13/99 (M/T/JJ)

Auswahloptionen

Optionen für den Feldtyp „Auswahl“.

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

object (ListOptions)

Gibt an, dass dieses Feld eine Liste von Werten unterstützt. Nachdem das Feld veröffentlicht wurde, kann diese Einstellung nicht mehr geändert werden.
choices[]

object (Choice)

Die für dieses Auswahlfeld verfügbaren Optionen. Die Listenreihenfolge ist konsistent und wurde 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

Auswahl im 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 überein: ([a-zA-Z0-9_])+.
properties

object (Properties)

Grundlegende Eigenschaften der Wahl.
lifecycle

object (Lifecycle)

Nur Ausgabe. Lebenszyklus der 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 mit dieser Auswahl verbundenen Funktionen für angewendete Metadaten.
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. Der Zeitpunkt der Veröffentlichung dieser Auswahl. Dieser Wert hat keine Bedeutung, wenn die Auswahl nicht veröffentlicht wird.
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 Wahl.

Attribute

Grundlegende Eigenschaften der Wahl.

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 das Feld identifiziert.
description

string

Die Beschreibung dieses Labels.
badgeConfig

object (BadgeConfig)

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

string

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

Logokonfiguration

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 (hell und dunkel) werden in der Google Drive-Benutzeroberfläche in die empfohlene empfohlene Farbe geändert.
priorityOverride

string (int64 format)

Überschreibt die standardmäßige globale Priorität dieses Logos. Bei Einstellung auf 0 wird die Standardheuristik verwendet.

Hinweise anzeigen

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ü „Übernehmen“ angezeigt werden, wenn Werte auf ein Drive-Element angewendet werden.
badgeColors

object (BadgeColors)

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

object (BadgeColors)

Die Farbe des dunklen Modus für das Logo. Zu Google Material-Farben geändert basierend auf der ausgewählten properties.badge_config.color.
badgePriority

string (int64 format)

Die Priorität dieses Logos. Wird verwendet, um mehrere Logos zu vergleichen und zu sortieren. Eine niedrigere Zahl bedeutet, dass das Logo zuerst angezeigt werden sollte. Wenn keine Logokonfiguration vorhanden ist, ist der Wert „0“. Andernfalls wird BadgeConfig.priority_override oder die Standardheuristik festgelegt, bei der das Erstellungsdatum des Labels sowie die Priorität von Feldern und Optionen bevorzugt werden.

Badgefarben

Die von BadgeConfig abgeleitete Farbe, die in die nächste unterstützte unterstützte Farbe geändert wurde.

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

object (Color)

Nur Ausgabe. Badgehintergrund, der mit dem Vordergrund gekoppelt ist
foregroundColor

object (Color)

Nur Ausgabe. Badge im Vordergrund, die zum Hintergrund passt
soloColor

object (Color)

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

SchemaFunktionen

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.

Angewandte Funktionen

Die mit dieser Auswahl verbundenen Funktionen für angewendete Metadaten.

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

boolean

Gibt an, ob der Nutzer ähnliche angewendete Metadaten zu Elementen lesen kann.
canSelect

boolean

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

Sperrstatus

Enthält Informationen darüber, ob eine Labelkomponente als gesperrt betrachtet werden sollte.

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

boolean

Nur Ausgabe. Gibt an, ob diese Label-Komponente das (direkte) Ziel einer LabelLock ist. Eine Labelkomponente kann implizit gesperrt werden, auch wenn es nicht das direkte Ziel einer LabelLock ist. In diesem Fall wird dieses Feld auf "false" gesetzt.

Nutzeroptionen

Optionen für den Nutzerfeldtyp.

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

object (ListOptions)

Wenn angegeben: Gibt an, dass dieses Feld eine Liste von Werten unterstützt. Nachdem das Feld veröffentlicht wurde, kann diese Einstellung 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 das Feld identifiziert.
required

boolean

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

string

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

Hinweise anzeigen

UI-Anzeigehinweise zum Rendern eines Felds.

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

boolean

Gibt an, ob das Feld nach Bedarf auf der Benutzeroberfläche 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ü „Übernehmen“ angezeigt werden, wenn Sie Werte auf ein Drive-Element anwenden.

SchemaFunktionen

Die mit diesem Feld verknüpften 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 darf.
canDelete

boolean

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

boolean

Gibt an, ob der Nutzer dieses Feld deaktivieren kann. Der Nutzer muss über eine 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 die Berechtigung haben und dieses Feld muss deaktiviert sein.

Angewandte Funktionen

Die mit diesem Feld verknüpften Funktionen für angewendete Metadaten.

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

boolean

Gibt an, ob der Nutzer ähnliche angewendete Metadaten zu Elementen lesen kann.
canWrite

boolean

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

Methoden

create

 Erstellt ein neues Label.

delete

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

delta

 Aktualisiert ein einzelnes Label, indem mehrere Updateanfragen angewendet werden, die zu einem neuen Überarbeitungsentwurf führen.

disable

 Veröffentlichtes Label deaktivieren

enable

 Deaktivierte Labels aktivieren und den veröffentlichten Status wiederherstellen

get

 Label anhand des Ressourcennamens abrufen.

list

 Labels auflisten.

publish

 Veröffentlichen Sie alle Entwurfsänderungen im Label.

updateLabelCopyMode

 Aktualisiert die CopyMode eines Labels.

updatePermissions

 Aktualisiert die Berechtigungen eines Labels.