REST Resource: labels

Zasób: etykieta

Etykieta definiuje systematykę, którą można stosować do elementów na Dysku w celu porządkowania i wyszukiwania elementów. 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}. Zobacz id i revisionId poniżej.
id

string

Tylko dane wyjściowe. Globalnie unikalny identyfikator tej etykiety. Identyfikator jest częścią etykiety name, ale w przeciwieństwie do name jest on spójny między wersjami. 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 zmieniane są wersjonowane właściwości etykiety. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9])+.
labelType

enum (LabelType)

Wymagany. 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 wyłączenia tej etykiety. 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)

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

object (Lifecycle)

Tylko dane wyjściowe. Stan cyklu życia etykiety, w tym informacje o 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 interfejsu do renderowania etykiety.
appliedCapabilities

object (AppliedCapabilities)

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

object (SchemaCapabilities)

Tylko dane wyjściowe. Uprawnienia użytkownika w odniesieniu do tej etykiety.
appliedLabelPolicy

object (AppliedLabelPolicy)

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

object (Field)

Lista pól w kolejności malejącej według priorytetu.
learnMoreUri

string

Niestandardowy adres URL, który będzie wyświetlany użytkownikom, aby mogli 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. EnabledAppSettings tej etykiety.

LabelType

Typ tej etykiety.

Wartości w polu enum
LABEL_TYPE_UNSPECIFIED Nieznany typ etykiety.
SHARED Etykiety udostępnione można udostępniać użytkownikom, aby mogli stosować je do elementów na Dysku.
ADMIN Etykieta należąca do administratora. Mogą je tworzyć i edytować tylko administratorzy. 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ć w interfejsie 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

Wymagany. Tytuł etykiety.
description

string

Opis etykiety.

Lifecycle

Stan cyklu życia obiektu, np. etykiety, pola lub opcji. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Cykl życia wymusza 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 mają pewne charakterystyczne cechy:

  • Published: w tym stanie można wprowadzić pewne zmiany w obiekcie. W takim przypadku wartość hasUnpublishedChanges będzie równa „true” (prawda). Niektóre rodzaje zmian są niedozwolone. Zwykle odrzucane są wszelkie zmiany, które unieważniają lub powodują nowe ograniczenia w przypadku istniejących metadanych związanych z etykietą.
  • Disabled: gdy jest wyłączone, obowiązuje skonfigurowana wartość 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. Wskazuje, 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 Stan nieznany.
UNPUBLISHED_DRAFT Początkowy stan obiektu. Po opublikowaniu obiekt nie może już wrócić do tego stanu. Po opublikowaniu obiektu niektóre rodzaje zmian nie są już dozwolone.
PUBLISHED Obiekt został opublikowany. Obiekt może zawierać nieopublikowane zmiany w wersji roboczej, co jest oznaczone symbolem hasUnpublishedChanges.
DISABLED Obiekt został opublikowany, ale później wyłączony. Obiekt może zawierać nieopublikowane zmiany w wersji roboczej, co jest oznaczone symbolem hasUnpublishedChanges.
DELETED Obiekt został usunięty.

DisabledPolicy

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

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

boolean

Określa, czy wyłączony obiekt ma być wyświetlany w menu zastosowania w przypadku elementów na Dysku.

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

DisplayHints

Wskazówki dotyczące wyświetlania w interfejsie, które pomagają w renderowaniu etykiety.

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 stosowania podczas stosowania wartości do elementu na Dysku.
priority

string (int64 format)

Kolejność wyświetlania etykiet na liście.

AppliedCapabilities

Możliwości użytkownika w zakresie metadanych zastosowanych do 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 produktów.
canRemove

boolean

Czy użytkownik może usunąć tę etykietę z elementów.

SchemaCapabilities

Możliwości związane z tą etykietą podczas jej edytowania.

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

boolean

Informacja, 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 ta 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 ta etykieta musi być wyłączona.

AppliedLabelPolicy

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

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

enum (CopyMode)

Określa, jak zastosowana etykieta i wartości pól powinny być kopiowane podczas kopiowania elementu na Dysku.

CopyMode

Określa, jak zastosowana etykieta i wartości pól powinny być kopiowane 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, gdy kopiowany jest element Dysku, do którego są one zastosowane.
ALWAYS_COPY Zastosowana etykieta i wartości pól są zawsze kopiowane, gdy kopiowany jest element Dysku, do którego zostały zastosowane. Z tego trybu mogą korzystać tylko administratorzy.
COPY_APPLIABLE Zastosowana etykieta i wartości pól są kopiowane, jeśli etykieta może być zastosowana przez użytkownika, który dokonuje kopii.

Pole

Definiuje 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 przypadku elementu 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, który będzie używany podczas tworzenia zapytań wyszukiwania na Dysku w celu znajdowania plików na podstawie wartości zdefiniowanych w tym polu. Na 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 w interfejsie podczas renderowania pola.
schemaCapabilities

object (SchemaCapabilities)

Tylko dane wyjściowe. Możliwości, jakie ma użytkownik podczas edytowania tego pola.
appliedCapabilities

object (AppliedCapabilities)

Tylko dane wyjściowe. Uprawnienia użytkownika w tym polu i jego wartość, gdy etykieta jest stosowana do elementów 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 aktualizacji 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 wyłączenia tego pola. Ta wartość nie ma znaczenia, gdy pole nie jest wyłączone.
lockStatus

object (LockStatus)

Tylko dane wyjściowe. LockStatus tego pola.
Pole unii type. Typ danych i opcje tego pola. Po opublikowaniu typu danych nie można go zmienić. type może mieć tylko jedną z tych wartości:
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 pola użytkownika.

TextOptions

Opcje typu pola tekstowego.

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

integer

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

integer

Tylko dane wyjściowe. Maksymalna prawidłowa 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 formatowania daty w języku lokalnym. Wartości pól są renderowane w tym formacie zgodnie z 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

Opcje formatu daty w języku lokalnym.

Wartości w polu enum
DATE_FORMAT_UNSPECIFIED Format daty nie został określony.
LONG_DATE Zawiera pełną nazwę miesiąca. Na przykład 12 stycznia 1999 r. (MMMM d, y)
SHORT_DATE Krótka reprezentacja numeryczna. Na przykład 13.12.99 (M/d/rr)

Data

Reprezentuje całą lub częściową datę kalendarzową, np. datę urodzin. Pora dnia i strefa czasowa są określone w innym miejscu lub nie mają znaczenia. Data jest podana w kalendarzu gregoriańskim. Może to być jedna z tych wartości:

  • Pełna data z wartościami roku, miesiąca i dnia różnymi od zera.
  • Miesiąc i dzień z rokiem zerowym (np. rocznica).
  • Sam rok, z miesiącem i dniem o wartości zero.
  • 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 mieścić się w zakresie od 1 do 9999 lub wynosić 0, aby określić datę bez roku.
month

integer

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

integer

Dzień miesiąca. Musi być liczbą od 1 do 31 i być prawidłowa w przypadku danego roku i miesiąca lub liczbą od 0 do 31, jeśli chcesz podać tylko rok lub rok i miesiąc, w których 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)

Opcje dostępne w tym polu wyboru. Kolejność na liście jest stała i zmieniana za pomocą insertBeforeChoice.

ListOptions

Opcje wariantu wielowartościowego powiązanego typu pola.

Zapis JSON 
{
  "maxEntries": integer
}
Pola
maxEntries

integer

Maksymalna dozwolona liczba postó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 wyboru.
lifecycle

object (Lifecycle)

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

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki interfejsu dotyczące renderowania wyboru.
schemaCapabilities

object (SchemaCapabilities)

Tylko dane wyjściowe. Możliwości związane z tą opcją podczas jej edytowania.
appliedCapabilities

object (AppliedCapabilities)

Tylko dane wyjściowe. Możliwości 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, jeśli wybór nie jest opublikowany.
publishTime

string (Timestamp format)

Tylko dane wyjściowe. Czas opublikowania tego wyboru. Ta wartość nie ma znaczenia, jeśli wybór nie jest opublikowany.
disabler

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który wyłączył ten wybór. 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. LockStatus tego wyboru.

Właściwości

Podstawowe właściwości wyboru.

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

string

Wymagany. 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 włączona, etykieta, do której należy ten wybór, jest uznawana za „etykietę z odznaką”.
insertBeforeChoice

string

Tylko dane wejściowe. Wstaw lub przenieś tę opcję przed wskazaną opcją. Jeśli jest pusta, wybór jest umieszczany 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ślony, nie jest renderowana żadna plakietka. Kolory tła, pierwszego planu i solo (tryb jasny i ciemny) ustawione w tym miejscu są zmieniane w interfejsie Dysku na najbliższy zalecany obsługiwany kolor.
priorityOverride

string (int64 format)

Zastąp domyślny globalny priorytet tej plakietki. Jeśli ta wartość wynosi 0, używana jest domyślna heurystyka priorytetu.

Kolor

Reprezentuje kolor w przestrzeni kolorów RGBA. Ta reprezentacja została zaprojektowana z myślą o łatwości konwersji na reprezentacje kolorów w różnych językach i z nich, a nie o kompaktowości. Na przykład pola tej reprezentacji można w prosty sposób przekazać do konstruktora java.awt.Color w języku Java, do metody +colorWithRed:green:blue:alpha w iOS, a także po niewielkich modyfikacjach do ciągu znaków CSS rgba() w JavaScript.

Na tej stronie referencyjnej nie ma informacji o bezwzględnej przestrzeni kolorów, która powinna być używana do interpretowania wartości RGB, np. sRGB, Adobe RGB, DCI-P3 i BT.2020. Domyślnie aplikacje powinny zakładać przestrzeń kolorów sRGB.

Jeśli trzeba określić, czy dwa kolory są równe, implementacje, o ile nie podano inaczej, traktują dwa kolory jako równe, jeśli wszystkie ich wartości czerwieni, zieleni, niebieskiego i alfa różnią się od siebie o maksymalnie 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 / 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;
}
// ...

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ść czerwieni w kolorze jako wartość z przedziału [0, 1].
green

number

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

number

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

number

Ułamek tego koloru, który ma zostać zastosowany do piksela. Oznacza to, że ostateczny kolor piksela jest określany przez to równanie:

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. Używa to wiadomości opakowującej zamiast prostego skalaru zmiennoprzecinkowego, dzięki czemu można odróżnić wartość domyślną od wartości nieustawionej. Jeśli ten obiekt koloru zostanie pominięty, będzie renderowany jako jednolity kolor (tak jakby wartość alfa miała wartość 1,0).

DisplayHints

Wskazówki dotyczące renderowania opcji w interfejsie.

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, które mają być użyte w przypadku logo. Zmieniono na kolory Material Design od Google na podstawie wybranego properties.badge_config.color.
darkBadgeColors

object (BadgeColors)

Kolor plakietki w trybie ciemnym. Zmieniono na kolory Material Design od Google na podstawie wybranego properties.badge_config.color.
badgePriority

string (int64 format)

Priorytet tej plakietki. Służy do porównywania i sortowania wielu odznak. Niższa liczba oznacza, że plakietka powinna być wyświetlana jako pierwsza. Jeśli konfiguracja oznaczeń nie jest dostępna, wartość tego parametru wynosi 0. W przeciwnym razie zostanie ustawiona wartość BadgeConfig.priority_override lub domyślna heurystyka, która preferuje datę utworzenia etykiety oraz priorytet pola i opcji.

BadgeColors

Kolor pochodzący z BadgeConfig i 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 plakietki dopasowane do pierwszego planu.
foregroundColor

object (Color)

Tylko dane wyjściowe. Kolor pierwszego planu plakietki, który pasuje do tła.
soloColor

object (Color)

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

SchemaCapabilities

Możliwości związane z tym wyborem podczas edytowania wyboru.

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

boolean

Czy użytkownik może zmienić ten wybór.
canDelete

boolean

Czy użytkownik może usunąć ten wybór.
canDisable

boolean

Czy użytkownik może wyłączyć ten wybór.
canEnable

boolean

Czy użytkownik może włączyć tę opcję.

AppliedCapabilities

Możliwości 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 odczytywać powiązane zastosowane metadane dotyczące elementów.
canSelect

boolean

Czy użytkownik może wybrać tę opcję w przypadku elementu.

LockStatus

Zawiera informacje o tym, czy komponent etykiety powinien być uznawany za zablokowany.

Zapis JSON 
{
  "locked": boolean
}
Pola
locked

boolean

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

UserOptions

Opcje typu pola użytkownika.

Zapis JSON 
{
  "listOptions": {
    object (ListOptions)
  }
}
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ć.

Właściwości

Podstawowe właściwości pola.

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

string

Wymagany. 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 przed to pole. Jeśli jest puste, pole jest umieszczane na końcu listy.

DisplayHints

Wskazówki dotyczące wyświetlania w interfejsie podczas renderowania pola.

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

boolean

Określa, czy pole powinno być wyświetlane w interfejsie jako wymagane.
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 edytowania pola.

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

boolean

Informacja, 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

Możliwości 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 odczytywać powiązane zastosowane metadane dotyczące elementów.
canWrite

boolean

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

EnabledAppSettings

Opisuje aplikacje Google 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ę

Zbiór możliwych aplikacji Google 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 etykietę.

delete

 Trwale usuwa etykietę i powiązane z nią metadane z elementów na Dysku.

delta

 Aktualizuje pojedynczą etykietę, stosując zestaw żądań aktualizacji, co powoduje utworzenie nowej wersji roboczej.

disable

 Wyłącz opublikowaną etykietę.

enable

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

get

 Pobierz etykietę według jej nazwy zasobu.

list

 Wyświetl etykiety.

publish

 Opublikuj wszystkie zmiany w wersji roboczej etykiety.

updateLabelCopyMode

 Aktualizuje CopyMode etykiety.

updateLabelEnabledAppSettings

 Aktualizuje EnabledAppSettings etykiety.

updatePermissions

 Aktualizuje uprawnienia etykiety.