REST Resource: labels

Zasób: Label

Etykieta definiuje systematykę, którą można zastosować do elementów na Dysku, aby je porządkować i wyszukiwać. Etykiety mogą być prostymi ciągami znaków lub zawierać pola opisujące dodatkowe metadane, które można wykorzystać do porządkowania i wyszukiwania elementów na Dysku.

Zapis JSON 
{
  "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)
  }
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu etykiety. W zależności od prośby będzie to: labels/{id} lub labels/{id}@{revisionId}. Zapoznaj się z artykułami id i revisionId poniżej.
id

string

Tylko dane wyjściowe. Unikalny identyfikator tej etykiety na całym świecie. Identyfikator jest częścią etykiety name, ale w przeciwieństwie do name jest spójny w różnych wersjach. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9])+
revisionId

string

Tylko dane wyjściowe. Identyfikator wersji etykiety. Identyfikator wersji może być częścią etykiety name w zależności od wysłanego żądania. Nowa wersja jest tworzona za każdym razem, gdy zmieniają się właściwości wersji etykiety. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9])+
labelType

enum (LabelType)

Wymagane. Typ etykiety.
creator

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który utworzył tę etykietę.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia tej etykiety.
revisionCreator

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który utworzył tę wersję etykiety.
revisionCreateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia tej wersji etykiety.
publisher

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który opublikował tę etykietę. Ta wartość nie ma znaczenia, gdy etykieta nie jest opublikowana.
publishTime

string (Timestamp format)

Tylko dane wyjściowe. Czas opublikowania tej etykiety. Ta wartość nie ma znaczenia, gdy etykieta nie jest opublikowana.
disabler

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który wyłączył tę etykietę. Ta wartość nie ma znaczenia, gdy etykieta nie jest wyłączona.
disableTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym ta etykieta została wyłączona. Ta wartość nie ma znaczenia, gdy etykieta nie jest wyłączona.
customer

string

Tylko dane wyjściowe. Klient, do którego należy ta etykieta. Na przykład: „customers/123abc789”.
properties

object (Properties)

Wymagane. Podstawowe właściwości etykiety.
lifecycle

object (Lifecycle)

Tylko dane wyjściowe. Stan cyklu życia etykiety, w tym czy jest opublikowana, wycofana i czy zawiera zmiany w wersji roboczej.
displayHints

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki dotyczące wyświetlania etykiety w interfejsie.
appliedCapabilities

object (AppliedCapabilities)

Tylko dane wyjściowe. Możliwości związane z tą etykietą w metadanych.
schemaCapabilities

object (SchemaCapabilities)

Tylko dane wyjściowe. Możliwości użytkownika dotyczące tej etykiety.
appliedLabelPolicy

object (AppliedLabelPolicy)

Tylko dane wyjściowe. Zachowanie tej etykiety po zastosowaniu jej do elementów na Dysku.
fields[]

object (Field)

Lista pól w porządku malejącym według priorytetu.
learnMoreUri

string

niestandardowy adres URL, który możesz wyświetlić użytkownikom, aby dowiedzieć się więcej o tej etykiecie i sposobie jej używania;
lockStatus

object (LockStatus)

Tylko dane wyjściowe. LockStatus tej etykiety.
enabledAppSettings

object (EnabledAppSettings)

Opcjonalnie. Ustawienia aplikacji włączone dla tej etykiety.

LabelType

Typ tej etykiety.

Wartości w polu enum
LABEL_TYPE_UNSPECIFIED Nieznany typ etykiety.
SHARED Etykiety udostępnione mogą być udostępniane użytkownikom, aby można było stosować je do elementów na Dysku.
ADMIN Etykieta należąca do administratora. Tylko administratorzy mogą je tworzyć i edytować. Obsługuje niektóre dodatkowe funkcje dostępne tylko dla administratorów.
GOOGLE_APP Etykieta należąca do wewnętrznej aplikacji Google, a nie do klienta. Te etykiety są tylko do odczytu.

UserInfo

Informacje o użytkowniku.

Zapis JSON 
{
  "person": string
}
Pola
person

string

Identyfikator tego użytkownika, którego można użyć z People API, aby uzyskać więcej informacji. Na przykład people/12345678.

Właściwości

podstawowe właściwości etykiety;

Zapis JSON 
{
  "title": string,
  "description": string
}
Pola
title

string

Wymagane. Tytuł etykiety.
description

string

Opis etykiety.

Lifecycle

Stan cyklu życia obiektu, np. etykiety, pola lub wyboru. Cykl życia narzuca te przejścia:

  • UNPUBLISHED_DRAFT (stan początkowy)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (Usunięto)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Usunięto)

Stany opublikowany i wyłączony różnią się między sobą w następujący sposób:

  • Opublikowany – w tym stanie można wprowadzić pewne zmiany w obiekcie, w którym przypadku wartość hasUnpublishedChanges będzie prawdziwa. Niektóre zmiany są też niedozwolone. Ogólnie rzecz biorąc, odrzucamy wszelkie zmiany, które mogłyby unieważnić lub spowodować nowe ograniczenia w dotychczasowych metadanych powiązanych z etykietą.
  • Wyłączone – gdy ta opcja jest wyłączona, stosowane jest skonfigurowane ustawienie DisabledPolicy.
Zapis JSON 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Pola
state

enum (State)

Tylko dane wyjściowe. Stan obiektu powiązanego z tym cyklem życia.
hasUnpublishedChanges

boolean

Tylko dane wyjściowe. Określa, czy obiekt powiązany z tym cyklem życia zawiera nieopublikowane zmiany.
disabledPolicy

object (DisabledPolicy)

Zasady określające sposób wyświetlania wyłączonej etykiety, pola lub opcji wyboru.

Stan

Stan obiektu powiązanego z tym cyklem życia.

Wartości w polu enum
STATE_UNSPECIFIED Nieznany stan.
UNPUBLISHED_DRAFT Początkowy stan obiektu. Po opublikowaniu obiekt nie może już wrócić do tego stanu. Po opublikowaniu obiektu nie można już wprowadzać pewnych rodzajów zmian.
PUBLISHED Obiekt został opublikowany. Obiekt może zawierać niezapisane zmiany w wersji roboczej, co oznacza ikona hasUnpublishedChanges.
DISABLED Obiekt został opublikowany, a potem wyłączony. Obiekt może zawierać niezapisane zmiany w wersji roboczej, co oznacza ikona hasUnpublishedChanges.
DELETED Obiekt został usunięty.

DisabledPolicy

Zasada określająca sposób traktowania wyłączonej etykiety, pola lub wyboru w różnych kontekstach.

Zapis JSON 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Pola
showInApply

boolean

Określa, czy ten wyłączony obiekt ma być wyświetlany w menu zastosowań w elementach na Dysku.

  • Gdy true, obiekt jest zwykle wyświetlany w interfejsie jako wyłączony i nie można go wybrać.
  • Gdy false, obiekt jest zwykle ukryty w interfejsie.

DisplayHints

Wskazówki dotyczące wyświetlania etykiety w interfejsie.

Zapis JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Pola
disabled

boolean

Określa, czy etykieta ma być wyświetlana w interfejsie jako wyłączona.
shownInApply

boolean

Ta etykieta powinna być widoczna w menu „Zastosuj” podczas stosowania wartości do elementu na Dysku.
priority

string (int64 format)

kolejność wyświetlania etykiety na liście.

AppliedCapabilities

Możliwości użytkownika dotyczące zastosowanych metadanych tej etykiety.

Zapis JSON 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Pola
canRead

boolean

Określa, czy użytkownik może odczytywać zastosowane metadane powiązane z tą etykietą.
canApply

boolean

Określa, czy użytkownik może zastosować tę etykietę do elementów.
canRemove

boolean

Określa, czy użytkownik może usunąć tę etykietę z elementów.

SchemaCapabilities

Funkcje związane z tą etykietą podczas jej edytowania.

Zapis JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Pola
canUpdate

boolean

Określa, czy użytkownik może zmienić tę etykietę.
canDelete

boolean

Określa, czy użytkownik może usunąć tę etykietę. Użytkownik musi mieć uprawnienia, a etykieta musi być wyłączona.
canDisable

boolean

Określa, czy użytkownik może wyłączyć tę etykietę. Użytkownik musi mieć uprawnienia, a etykieta nie może być już wyłączona.
canEnable

boolean

Określa, czy użytkownik może włączyć tę etykietę. Użytkownik musi mieć uprawnienia, a etykieta musi być wyłączona.

AppliedLabelPolicy

Zachowanie tej etykiety po zastosowaniu jej do elementów na Dysku.

Zapis JSON 
{
  "copyMode": enum (CopyMode)
}
Pola
copyMode

enum (CopyMode)

Wskazuje, jak zastosować etykietę i wartości pól podczas kopiowania elementu na Dysku.

CopyMode

Wskazuje, jak zastosować etykietę i wartości pól podczas kopiowania elementu na Dysku.

Wartości w polu enum
COPY_MODE_UNSPECIFIED Tryb kopiowania nieokreślony.
DO_NOT_COPY Zastosowana etykieta i wartości pól nie są domyślnie kopiowane podczas kopiowania elementu Dysku, do którego zostały zastosowane.
ALWAYS_COPY Zaaplikowana etykieta i wartości pól są zawsze kopiowane podczas kopiowania elementu Dysku, do którego zostały zastosowane. Z tego trybu mogą korzystać tylko administratorzy.
COPY_APPLIABLE Zastosowane etykiety i wartości pól są kopiowane, jeśli etykieta może być zastosowana przez użytkownika dokonującego kopii.

Pole

Określa pole, które ma wyświetlaną nazwę, typ danych i inne opcje konfiguracji. To pole określa rodzaj metadanych, które można ustawić w elemencie na Dysku.

Zapis JSON 
{
  "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.
}
Pola
id

string

Tylko dane wyjściowe. Klucz pola unikalny w ramach etykiety lub biblioteki.

Ta wartość jest generowana automatycznie. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9])+
queryKey

string

Tylko dane wyjściowe. Klucz do użycia podczas tworzenia zapytań wyszukiwania na Dysku, aby znaleźć pliki na podstawie wartości zdefiniowanych dla tego pola w plikach. Przykład: „{queryKey} > 2001-01-01”.
properties

object (Properties)

podstawowe właściwości pola;
lifecycle

object (Lifecycle)

Tylko dane wyjściowe. Cykl życia tego pola.
displayHints

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki dotyczące wyświetlania interfejsu dla renderowania pola.
schemaCapabilities

object (SchemaCapabilities)

Tylko dane wyjściowe. Uprawnienia tego użytkownika podczas edytowania tego pola.
appliedCapabilities

object (AppliedCapabilities)

Tylko dane wyjściowe. Uprawnienia użytkownika dotyczące tego pola i jego wartość, gdy etykieta jest stosowana w elementach na Dysku.
creator

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który utworzył to pole.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia tego pola.
updater

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który zmodyfikował to pole.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas zaktualizowania tego pola.
publisher

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który opublikował to pole. Ta wartość nie ma znaczenia, gdy pole nie jest opublikowane.
disabler

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który wyłączył to pole. Ta wartość nie ma znaczenia, gdy pole nie jest wyłączone.
disableTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym to pole zostało wyłączone. Ta wartość nie ma znaczenia, gdy pole nie jest wyłączone.
lockStatus

object (LockStatus)

Tylko dane wyjściowe. Stan blokady tego pola.
Pole unii type. Typ danych i opcje tego pola. Po opublikowaniu nie można zmienić typu danych. type może być tylko jednym z tych elementów:
textOptions

object (TextOptions)

Opcje pola tekstowego.
integerOptions

object (IntegerOptions)

Opcje pola liczby całkowitej.
dateOptions

object (DateOptions)

Opcje pola daty.
selectionOptions

object (SelectionOptions)

Opcje pola wyboru.
userOptions

object (UserOptions)

Opcje pól użytkownika.

TextOptions

Opcje typu pola tekstowego.

Zapis JSON 
{
  "minLength": integer,
  "maxLength": integer
}
Pola
minLength

integer

Tylko dane wyjściowe. Minimalna dopuszczalna długość wartości w polu tekstowym.
maxLength

integer

Tylko dane wyjściowe. Maksymalna dopuszczalna długość wartości w polu tekstowym.

IntegerOptions

Opcje typu pola Liczba całkowita.

Zapis JSON 
{
  "minValue": string,
  "maxValue": string
}
Pola
minValue

string (int64 format)

Tylko dane wyjściowe. Minimalna prawidłowa wartość pola liczby całkowitej.
maxValue

string (int64 format)

Tylko dane wyjściowe. Maksymalna prawidłowa wartość pola liczby całkowitej.

DateOptions

Opcje typu pola daty.

Zapis JSON 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Pola
dateFormatType

enum (DateFormat)

Opcja lokalnego formatowania daty. Wartości pól są renderowane w tym formacie zgodnie z ich ustawieniami regionalnymi.
dateFormat

string

Tylko dane wyjściowe. Format daty ICU.
minValue

object (Date)

Tylko dane wyjściowe. Minimalna prawidłowa wartość (rok, miesiąc, dzień).
maxValue

object (Date)

Tylko dane wyjściowe. Maksymalna prawidłowa wartość (rok, miesiąc, dzień).

DateFormat

Lokalne opcje formatu daty.

Wartości w polu enum
DATE_FORMAT_UNSPECIFIED Nieokreślony format daty.
LONG_DATE Zawiera pełną nazwę miesiąca. Przykład: 12 stycznia 1999 r. (MMMM d, y)
SHORT_DATE Krótka, liczbowa reprezentacja. Na przykład 12/13/99 (M/d/yy)

Data

Reprezentuje całą lub częściową datę kalendarzową, np. urodziny. Godzina i strefa czasowa są określone gdzie indziej lub nie mają znaczenia. Data jest wyrażona w kalendarzu gregoriańskim. Może to być:

  • Pełna data z wartościami roku, miesiąca i dnia innymi niż 0.
  • miesiąc i dzień z zerowym rokiem (np. rocznica).
  • Rok bez miesiąca i dnia.
  • Rok i miesiąc z zerowym dniem (np. data ważności karty kredytowej).

Powiązane typy:

Zapis JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Pola
year

integer

Rok daty. Musi być liczbą z zakresu 1–9999 lub 0, jeśli chcesz podać datę bez roku.
month

integer

Miesiąc w roku. Wartość musi mieścić się w przedziale od 1 do 12, lub 0, jeśli chcesz określić rok bez miesiąca i dnia.
day

integer

Dzień miesiąca. Musi zawierać wartość od 1 do 31 i być prawidłową dla roku lub miesiąca albo 0, aby określić tylko rok lub rok i miesiąc, w których przypadku dzień nie ma znaczenia.

SelectionOptions

Opcje typu pola wyboru.

Zapis JSON 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Pola
listOptions

object (ListOptions)

Jeśli jest określone, oznacza, że to pole obsługuje listę wartości. Po opublikowaniu pola nie można go zmienić.
choices[]

object (Choice)

Dostępne opcje w tym polu wyboru. Kolejność na liście jest spójna i zmodyfikowana o element insertBeforeChoice.

ListOptions

Opcje dotyczące wariantu z wieloma wartościami powiązanego typu pola.

Zapis JSON 
{
  "maxEntries": integer
}
Pola
maxEntries

integer

Maksymalna dozwolona liczba wpisów.

Wybór

Wybranie pola wyboru.

Zapis JSON 
{
  "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)
  }
}
Pola
id

string

Unikalna wartość wyboru. Ten identyfikator jest generowany automatycznie. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9_])+.
properties

object (Properties)

Podstawowe właściwości wybranego elementu.
lifecycle

object (Lifecycle)

Tylko dane wyjściowe. Cykl życia wyboru.
displayHints

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki wyświetlane w UI dotyczące renderowania wyboru.
schemaCapabilities

object (SchemaCapabilities)

Tylko dane wyjściowe. Funkcje związane z tą opcją podczas jej edytowania.
appliedCapabilities

object (AppliedCapabilities)

Tylko dane wyjściowe. Funkcje związane z tym wyborem w przypadku zastosowanych metadanych.
creator

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który utworzył ten wybór.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia tego wyboru.
updater

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który ostatnio zaktualizował ten wybór.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji tego wyboru.
publisher

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który opublikował ten wybór. Ta wartość nie ma znaczenia, gdy wybór nie został opublikowany.
publishTime

string (Timestamp format)

Tylko dane wyjściowe. Czas opublikowania tego wyboru. Ta wartość nie ma znaczenia, gdy wybór nie został opublikowany.
disabler

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który wyłączył tę opcję. Ta wartość nie ma znaczenia, gdy opcja nie jest wyłączona.
disableTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym ta opcja została wyłączona. Ta wartość nie ma znaczenia, gdy opcja nie jest wyłączona.
lockStatus

object (LockStatus)

Tylko dane wyjściowe. Wartość LockStatus tego wyboru.

Właściwości

Podstawowe właściwości wybranego elementu.

Zapis JSON 
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Pola
displayName

string

Wymagane. Tekst wyświetlany w interfejsie, który identyfikuje to pole.
description

string

Opis tej etykiety.
badgeConfig

object (BadgeConfig)

Konfiguracja plakietki dla tego wyboru. Gdy ta opcja jest ustawiona, etykieta, która jest właścicielem tego wyboru, jest uważana za „etykietę z odznaką”.
insertBeforeChoice

string

Tylko dane wejściowe. Wstaw tę opcję przed wskazaną opcją lub przenieś ją. Jeśli jest pusta, wybrana opcja zostanie umieszczona na końcu listy.

BadgeConfig

Stan plakietki etykiety.

Zapis JSON 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Pola
color

object (Color)

Kolor plakietki. Jeśli nie jest określone, nie jest renderowany żaden znacznik. Kolory tła, pierwszego planu i solo (w trybie jasnym i ciemnym) ustawione tutaj są zmieniane w interfejsie Dysku na najbliższy zalecany obsługiwany kolor.
priorityOverride

string (int64 format)

Zastąpić domyślny globalny priorytet tej plakietki. Jeśli wartość wynosi 0, używana jest domyślna heurystyka priorytetów.

Kolor

Reprezentuje kolor w przestrzeni kolorów RGBA. Ta reprezentacja została zaprojektowana tak, aby ułatwić konwersję na reprezentacje kolorów i z nich w różnych językach, a nie na potrzeby kompresji. Na przykład pola tej reprezentacji można łatwo przekazać konstruktorowi java.awt.Color w języku Java, a także metodzie +colorWithRed:green:blue:alpha w obiekcie UIColor w iOS. Przy odrobinie pracy można je też sformatować w postać ciągu rgba() w języku JavaScript.

Ta strona informacyjna nie zawiera informacji o bezwzględnej przestrzeni kolorów, której należy użyć do interpretacji wartości RGB, np. sRGB, Adobe RGB, DCI-P3 i BT.2020. Domyślnie aplikacje powinny zakładać przestrzeń barw sRGB.

Gdy trzeba określić, czy dwa kolory są równe, implementacje, o ile nie jest to inaczej określone, traktują je jako równe, jeśli ich wartości czerwonego, zielonego, niebieskiego i alfa różnią się od siebie najwyżej o 1e-5.

Przykład (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();
 }
 // ...

Przykład (iOS / Objective-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;
}
// ...

Przykład (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('');
};

// ...
Zapis JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Pola
red

number

Ilość czerwonego w kolorze jako wartość z zakresu [0, 1].
green

number

Ilość zieleni w kolorze jako wartość z zakresu [0, 1].
blue

number

Ilość niebieskiego w kolorze jako wartość z zakresu [0, 1].
alpha

number

Ułamek tego koloru, który powinien zostać zastosowany do piksela. Oznacza to, że ostateczny kolor piksela jest określany za pomocą tej zależności:

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

Oznacza to, że wartość 1,0 odpowiada jednolitemu kolorowi, a wartość 0,0 – całkowicie przezroczystemu kolorowi. Zamiast prostego wektora liczby zmiennoprzecinkowej używa ona komunikatu opakowania, aby można było odróżnić wartość domyślną od wartości nieskonfigurowanej. Jeśli zostanie pominięty, obiekt koloru zostanie wyrenderowany jako jednolity kolor (jak gdyby wartość alfa miała wartość 1,0).

DisplayHints

Wskazówki wyświetlane w UI dotyczące renderowania opcji.

Zapis JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Pola
disabled

boolean

Określa, czy opcja ma być wyświetlana w interfejsie jako wyłączona.
shownInApply

boolean

Ta opcja powinna być widoczna w menu stosowania podczas stosowania wartości do elementu na Dysku.
badgeColors

object (BadgeColors)

Kolory użyte na plakietce. Zmieniono na kolory Google Material na podstawie wybranego properties.badge_config.color.
darkBadgeColors

object (BadgeColors)

Kolor używany w trybie ciemnym, który ma być użyty na plakietce. Zmieniono na kolory Google Material na podstawie wybranego properties.badge_config.color.
badgePriority

string (int64 format)

Priorytet tej plakietki. Służy do porównywania i sortowania różnych plakiet. Im niższa liczba, tym większa szansa, że plakietka będzie wyświetlana jako pierwsza. Jeśli konfiguracja oznaczenia jest nieobecna, parametr ma wartość 0. W przeciwnym razie zostanie ono ustawione na BadgeConfig.priority_override lub domyślną heurystyk, która preferuje datę utworzenia etykiety oraz priorytet pola i opcji.

BadgeColors

Kolor pochodzący z BadgeConfig, zmieniony na najbliższy zalecany obsługiwany kolor.

Zapis JSON 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Pola
backgroundColor

object (Color)

Tylko dane wyjściowe. Tło znaku, które pasuje do pierwszego planu.
foregroundColor

object (Color)

Tylko dane wyjściowe. Element z przodu plakietki, który pasuje do tła.
soloColor

object (Color)

Tylko dane wyjściowe. Kolor, który można użyć do tekstu bez tła.

SchemaCapabilities

Funkcje związane z tym wyborem podczas jego edytowania.

Zapis JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Pola
canUpdate

boolean

Określa, czy użytkownik może zmienić ten wybór.
canDelete

boolean

Określa, czy użytkownik może usunąć ten wybór.
canDisable

boolean

Określa, czy użytkownik może wyłączyć tę opcję.
canEnable

boolean

Określa, czy użytkownik może włączyć tę opcję.

AppliedCapabilities

Funkcje związane z tym wyborem w przypadku zastosowanych metadanych.

Zapis JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Pola
canRead

boolean

Określa, czy użytkownik może odczytać powiązane metadane zastosowane w elementach.
canSelect

boolean

Określa, czy użytkownik może wybrać tę opcję w przypadku danego elementu.

LockStatus

Zawiera informacje o tym, czy element etykiety powinien być uważany za zablokowany.

Zapis JSON 
{
  "locked": boolean
}
Pola
locked

boolean

Tylko dane wyjściowe. Wskazuje, czy ten element etykiety jest (bezpośrednim) celem blokady etykiety. Element etykiety może być zablokowany domyślnie, nawet jeśli nie jest bezpośrednim celem etykiety. W takim przypadku to pole ma wartość false.

UserOptions

Opcje typu pola użytkownika.

Zapis JSON 
{
  "listOptions": {
    object (ListOptions)
  }
}
Pola
listOptions

object (ListOptions)

Wskazuje, że to pole obsługuje listę wartości. Po opublikowaniu pola nie można go zmienić.

Właściwości

podstawowe właściwości pola;

Zapis JSON 
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
Pola
displayName

string

Wymagane. Tekst wyświetlany w interfejsie, który identyfikuje to pole.
required

boolean

Określa, czy pole ma być oznaczone jako wymagane.
insertBeforeField

string

Tylko dane wejściowe. Wstaw to pole przed wskazanym polem lub przenieś je. Jeśli jest puste, pole jest umieszczane na końcu listy.

DisplayHints

Wskazówki dotyczące wyświetlania interfejsu dla renderowania pola.

Zapis JSON 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Pola
required

boolean

Określa, czy pole powinno być wyświetlane jako wymagane w interfejsie.
disabled

boolean

Określa, czy pole ma być wyświetlane w interfejsie jako wyłączone.
shownInApply

boolean

To pole powinno być widoczne w menu stosowania podczas stosowania wartości do elementu na Dysku.

SchemaCapabilities

Możliwości związane z tym polem podczas jego edytowania.

Zapis JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Pola
canUpdate

boolean

Określa, czy użytkownik może zmienić to pole.
canDelete

boolean

Określa, czy użytkownik może usunąć to pole. Użytkownik musi mieć uprawnienia, a pole musi być wycofane.
canDisable

boolean

Określa, czy użytkownik może wyłączyć to pole. Użytkownik musi mieć uprawnienia, a to pole nie może być już wyłączone.
canEnable

boolean

Określa, czy użytkownik może włączyć to pole. Użytkownik musi mieć uprawnienia, a to pole musi być wyłączone.

AppliedCapabilities

Funkcje związane z tym polem w zastosowanych metadanych.

Zapis JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Pola
canRead

boolean

Określa, czy użytkownik może odczytać powiązane metadane zastosowane w elementach.
canWrite

boolean

Określa, czy użytkownik może ustawić to pole w elementach na Dysku.

EnabledAppSettings

Opisuje aplikacje Workspace, w których można używać etykiety.

Zapis JSON 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
Pola
enabledApps[]

object (EnabledApp)

Opcjonalnie. Lista aplikacji, w których można używać etykiety.

EnabledApp

Aplikacja, w której można używać etykiety.

Zapis JSON 
{
  "app": enum (App)
}
Pola
app

enum (App)

Opcjonalnie. Nazwa aplikacji.

Promująca aplikację

Zestaw możliwych aplikacji Workspace, w których można używać etykiet.

Wartości w polu enum
APP_UNSPECIFIED Nie określono
DRIVE Dysk.
GMAIL Gmail

Metody

create

 Tworzy nową etykietę.

delete

 Trwałe usunięcie etykiety i powiązanych z nią metadanych w elementach na Dysku.

delta

 Zaktualizuje jedną etykietę, stosując zestaw żądań aktualizacji, co spowoduje utworzenie nowej wersji roboczej.

disable

 Wyłączanie opublikowanej etykiety.

enable

 Włącz wyłączoną etykietę i przywróć ją do opublikowanego stanu.

get

 Pobierz etykietę według nazwy zasobu.

list

 Lista etykiet.

publish

 Opublikuj wszystkie zmiany w wersji roboczej etykiety.

updateLabelCopyMode

 Zmiana CopyMode etykiety.

updateLabelEnabledAppSettings

 Aktualizuje EabledAppSettings etykiety.

updatePermissions

 Aktualizuje uprawnienia etykiety.