REST Resource: labels

{
  "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)
  }
}

string

Tylko dane wyjściowe. Nazwa zasobu etykiety. W zależności od prośby będzie on miał postać labels/{id} lub labels/{id}@{revisionId}. Zobacz id i revisionId poniżej.

string

Tylko dane wyjściowe. Unikalny globalnie identyfikator tej etykiety. Identyfikator stanowi część etykiety name, ale w przeciwieństwie do name identyfikator jest spójny między wersjami. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9])+

string

Tylko dane wyjściowe. Identyfikator wersji etykiety. W zależności od przesłanego żądania identyfikator wersji może należeć do etykiety name. Nowa wersja jest tworzona po każdej zmianie poprawionych właściwości etykiety. Pasuje do wyrażenia regularnego: ([a-zA-Z0-9])+

enum (LabelType)

To pole jest wymagane. Typ etykiety.

object (UserInfo)

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

string (Timestamp format)

Tylko dane wyjściowe. Godzina utworzenia tej etykiety.

object (UserInfo)

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

string (Timestamp format)

Tylko dane wyjściowe. Data utworzenia tej wersji etykiety.

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który opublikował tę etykietę. Ta wartość nie ma znaczenia, jeśli etykieta nie została opublikowana.

string (Timestamp format)

Tylko dane wyjściowe. Godzina opublikowania tej etykiety. Ta wartość nie ma znaczenia, jeśli etykieta nie została opublikowana.

object (UserInfo)

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

string (Timestamp format)

Tylko dane wyjściowe. Godzina wyłączenia tej etykiety. Ta wartość nie ma znaczenia, jeśli etykieta nie jest wyłączona.

string

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

object (Properties)

To pole jest wymagane. Podstawowe właściwości etykiety.

object (Lifecycle)

Tylko dane wyjściowe. Stan cyklu życia etykiety, w tym informacje o tym, czy została opublikowana, wycofana i czy zawiera zmiany w wersji roboczej.

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki dotyczące renderowania etykiety w interfejsie.

object (AppliedCapabilities)

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

object (SchemaCapabilities)

Tylko dane wyjściowe. Uprawnienia użytkownika dotyczące tej etykiety.

object (AppliedLabelPolicy)

Tylko dane wyjściowe. Działanie tej etykiety po zastosowaniu jej do elementów na Dysku.

object (Field)

Lista pól w kolejności malejącej.

string

Niestandardowy adres URL, który będzie wyświetlany użytkownikom, aby dowiedzieć się więcej o tej etykiecie i sposobie jej użycia.

object (LockStatus)

Tylko dane wyjściowe. LockStatus tej etykiety.

{
  "person": string
}

string

Identyfikator tego użytkownika, dzięki któremu można uzyskać więcej informacji za pomocą interfejsu People API. Przykład: osoby/12345678.

{
  "title": string,
  "description": string
}

string

To pole jest wymagane. Tytuł etykiety.

string

Opis etykiety.

{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}

enum (State)

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

boolean

Tylko dane wyjściowe. Wskazuje, czy obiekt powiązany z tym cyklem życia ma nieopublikowane zmiany.

object (DisabledPolicy)

Zasada określająca sposób wyświetlania wyłączonych etykiet, pól lub wyboru.

{
  "hideInSearch": boolean,
  "showInApply": boolean
}

boolean

Określa, czy ten wyłączony obiekt ma być ukryty w menu wyszukiwania elementów na Dysku.

• Gdy ustawiona jest opcja false, obiekt jest zwykle wyświetlany w interfejsie jako wyłączony, ale pojawia się w wynikach wyszukiwania podczas wyszukiwania elementów na Dysku.
• Gdy ustawiona jest wartość true, obiekt jest zwykle ukryty w interfejsie podczas wyszukiwania elementów na Dysku.

boolean

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

• Gdy ustawiona jest opcja true, obiekt jest zwykle wyświetlany w interfejsie użytkownika jako wyłączony i nie można go wybrać.
• Gdy występuje false, obiekt jest zazwyczaj ukryty w interfejsie użytkownika.

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}

boolean

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

boolean

Ta etykieta powinna być ukryta w menu wyszukiwania podczas wyszukiwania elementów na Dysku.

boolean

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

string (int64 format)

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

{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}

boolean

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

boolean

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

boolean

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

Wskazuje sposób kopiowania wartości zastosowanych etykiet i pól podczas kopiowania elementu z Dysku.

{
  "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.
}

string

Tylko dane wyjściowe. Klucz pola, unikalny w obrębie etykiety lub biblioteki.

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

string

Tylko dane wyjściowe. Klucz używany przy tworzeniu zapytań wyszukiwania na Dysku do znajdowania plików na podstawie wartości zdefiniowanych dla tego pola w plikach. Na przykład: „{queryKey} > 2001-01-01”.

object (Properties)

Podstawowe właściwości pola.

object (Lifecycle)

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

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki dotyczące wyświetlania w interfejsie użytkownika dotyczące renderowania pola.

object (SchemaCapabilities)

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

object (AppliedCapabilities)

Tylko dane wyjściowe. Uprawnienia, jakie ten użytkownik ma w przypadku tego pola, i jego wartości po zastosowaniu etykiety do elementów na Dysku.

object (UserInfo)

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

string (Timestamp format)

Tylko dane wyjściowe. Godzina utworzenia tego pola.

object (UserInfo)

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

string (Timestamp format)

Tylko dane wyjściowe. Godzina aktualizacji pola.

object (UserInfo)

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

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.

string (Timestamp format)

Tylko dane wyjściowe. Godzina wyłączenia tego pola. Ta wartość nie ma znaczenia, gdy pole nie jest wyłączone.

object (LockStatus)

Tylko dane wyjściowe. LockStatus tego pola.

object (TextOptions)

Opcje pola tekstowego.

object (IntegerOptions)

Opcje pola liczby całkowitej.

object (DateOptions)

Opcje pola daty.

object (SelectionOptions)

Opcje pola wyboru.

object (UserOptions)

Opcje pola użytkownika.

{
  "minLength": integer,
  "maxLength": integer
}

integer

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

integer

Tylko dane wyjściowe. Maksymalna prawidłowa długość wartości pola tekstowego.

{
  "minValue": string,
  "maxValue": string
}

string (int64 format)

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

string (int64 format)

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

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

enum (DateFormat)

Opcja zlokalizowanego formatowania daty. Wartości pól są renderowane w tym formacie zgodnie z ich językiem.

string

Tylko dane wyjściowe. Format daty ICU.

object (Date)

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

object (Date)

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

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

object (ListOptions)

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

object (Choice)

Opcje dostępne dla tego pola wyboru. Kolejność listy jest spójna i zmodyfikowana w wierszu insertBeforeChoice.

{
  "maxEntries": integer
}

integer

Maksymalna dozwolona liczba wpisów.

{
  "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)
  }
}

string

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

object (Properties)

Podstawowe właściwości.

object (Lifecycle)

Tylko dane wyjściowe. Cykl życia wybranego produktu.

object (DisplayHints)

Tylko dane wyjściowe. Wskazówki dotyczące wyświetlania w interfejsie podczas renderowania wyboru.

object (SchemaCapabilities)

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

object (AppliedCapabilities)

Tylko dane wyjściowe. Możliwości związane z tym wyborem w przypadku zastosowanych metadanych.

object (UserInfo)

Tylko dane wyjściowe. Użytkownik, który utworzył daną opcję.

string (Timestamp format)

Tylko dane wyjściowe. Godzina utworzenia tego wyboru.

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

Tylko dane wyjściowe. Czas, kiedy ta opcja była nieaktywna. Ta wartość nie ma znaczenia, gdy wybór nie jest wyłączony.

object (LockStatus)

Tylko dane wyjściowe. LockStatus tego wyboru.

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

string

To pole jest wymagane. Tekst wyświetlany w interfejsie identyfikujący to pole.

string

Opis tej etykiety.

object (BadgeConfig)

Konfiguracja plakietki dla tego wyboru. Po ustawieniu tej wartości etykieta, do której należy ten wybór, będzie traktowana jako „etykieta z plakietką”.

string

Tylko dane wejściowe. Wstaw lub przenieś tę opcję przed wskazaną opcją. Jeśli pole jest puste, odpowiedź znajduje się na końcu listy.

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

object (Color)

Kolor plakietki. Jeśli go nie podasz, plakietka nie będzie renderowana. Kolory tła, pierwszego planu i solo (w trybie jasnym i ciemnym) ustawione w tym miejscu są zmieniane w interfejsie Dysku na najbliższe zalecane kolory.

string (int64 format)

Zastąp domyślny priorytet globalny tej plakietki. Gdy ma wartość 0, używana jest domyślna heurystyka priorytetowa.

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

boolean

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

boolean

Ta opcja powinna być ukryta w menu wyszukiwania podczas wyszukiwania elementów na Dysku.

boolean

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

object (BadgeColors)

Kolory, których chcesz użyć w przypadku plakietki. Zmieniono kolory na Material Design na podstawie wybranego elementu properties.badge_config.color.

object (BadgeColors)

Kolor w trybie ciemnym używany na plakietki. Zmieniono kolory na Material Design na podstawie wybranego elementu properties.badge_config.color.

string (int64 format)

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

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

object (Color)

Tylko dane wyjściowe. Tło plakietki, które łączy się z pierwszym planem.

object (Color)

Tylko dane wyjściowe. Plakietka na pierwszym planie pasującym do tła.

object (Color)

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}

boolean

Określa, czy użytkownik może odczytywać powiązane metadane zastosowane do elementów.

boolean

Określa, czy użytkownik może używać tego wyboru w zapytaniach.

boolean

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

{
  "locked": boolean
}

boolean

Tylko dane wyjściowe. Wskazuje, czy ten komponent etykiety jest (bezpośrednim) celem elementu LabelLock. Komponent etykiety może zostać domyślnie zablokowany, nawet jeśli nie jest bezpośrednim celem blokady etykiety. W takim przypadku to pole ma wartość false (fałsz).

{
  "listOptions": {
    object (ListOptions)
  }
}

object (ListOptions)

Jeśli określisz wartość, będzie to oznaczać, że pole obsługuje listę wartości. Po opublikowaniu pola nie można go zmienić.

{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}

string

To pole jest wymagane. Tekst wyświetlany w interfejsie identyfikujący to pole.

boolean

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

string

Tylko dane wejściowe. Wstaw lub przenieś to pole przed wskazane pole. Jeśli pole jest puste, zostanie umieszczone na końcu listy.

{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}

boolean

Określa, czy pole powinno wyświetlać się jako wymagane w interfejsie.

boolean

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

boolean

To pole powinno być ukryte w menu wyszukiwania podczas wyszukiwania elementów na Dysku.

boolean

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}

boolean

Określa, czy użytkownik może odczytywać powiązane metadane zastosowane do elementów.

boolean

Określa, czy użytkownik może wyszukiwać elementy na Dysku odwołujące się do tego pola.

boolean

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