REST Resource: labels

Ресурс: Этикетка

Ярлык определяет таксономию, которую можно применять к объектам на Диске для организации и поиска по ним. Метки могут представлять собой простые строки или содержать поля, описывающие дополнительные метаданные, которые в дальнейшем можно использовать для организации и поиска элементов на Диске.

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)
  }
}
Поля
name

string

Только вывод. Имя ресурса метки. Будет иметь форму: labels/{id} или labels/{id}@{revisionId} в зависимости от запроса. См. id и revisionId ниже.

id

string

Только вывод. Глобальный уникальный идентификатор этой метки. ID составляет часть name метки, но в отличие от name , ID одинаков в разных ревизиях. Соответствует регулярному выражению: ([a-zA-Z0-9])+

revisionId

string

Только вывод. Идентификатор версии этикетки. Идентификатор редакции может быть частью name метки в зависимости от выданного запроса. Новая редакция создается всякий раз, когда изменяются измененные свойства метки. Соответствует регулярному выражению: ([a-zA-Z0-9])+

labelType

enum ( LabelType )

Необходимый. Тип этикетки.

creator

object ( UserInfo )

Только вывод. Пользователь, создавший этот ярлык.

createTime

string ( Timestamp format)

Только вывод. Время создания этого ярлыка.

revisionCreator

object ( UserInfo )

Только вывод. Пользователь, создавший эту версию метки.

revisionCreateTime

string ( Timestamp format)

Только вывод. Время создания этой версии метки.

publisher

object ( UserInfo )

Только вывод. Пользователь, опубликовавший этот ярлык. Это значение не имеет значения, если метка не опубликована.

publishTime

string ( Timestamp format)

Только вывод. Время публикации этого ярлыка. Это значение не имеет значения, если метка не опубликована.

disabler

object ( UserInfo )

Только вывод. Пользователь, отключивший этот ярлык. Это значение не имеет значения, если метка не отключена.

disableTime

string ( Timestamp format)

Только вывод. Время, когда этот ярлык был отключен. Это значение не имеет значения, если метка не отключена.

customer

string

Только вывод. Клиент, которому принадлежит этот ярлык. Например: «клиенты/123abc789».

properties

object ( Properties )

Необходимый. Основные свойства этикетки.

lifecycle

object ( Lifecycle )

Только вывод. Состояние жизненного цикла метки, включая сведения о том, опубликована ли она, устарела или содержит ли она черновые изменения.

displayHints

object ( DisplayHints )

Только вывод. Подсказки пользовательского интерфейса для отображения метки.

appliedCapabilities

object ( AppliedCapabilities )

Только вывод. Возможности, связанные с этой меткой в ​​прикладных метаданных.

schemaCapabilities

object ( SchemaCapabilities )

Только вывод. Возможности пользователя, указанные на этой метке.

appliedLabelPolicy

object ( AppliedLabelPolicy )

Только вывод. Поведение этого ярлыка при его применении к объектам на Диске.

fields[]

object ( Field )

Список полей в порядке убывания приоритета.

learnMoreUri

string

Пользовательский URL-адрес, который будет показан пользователям, чтобы они могли узнать больше об этом ярлыке и о том, как его следует использовать.

lockStatus

object ( LockStatus )

Только вывод. LockStatus этой метки.

Тип метки

Тип этой метки.

Перечисления
LABEL_TYPE_UNSPECIFIED Неизвестный тип этикетки.
SHARED Общие ярлыки могут быть переданы пользователям для применения к объектам на Диске.
ADMIN Ярлык, принадлежащий администратору. Создается и редактируется только администраторами. Поддерживает некоторые дополнительные функции только для администратора.

Информация о пользователе

Информация о пользователе.

JSON-представление
{
  "person": string
}
Поля
person

string

Идентификатор этого пользователя, который можно использовать с API People для получения дополнительной информации. Например, люди/12345678.

Характеристики

Основные свойства этикетки.

JSON-представление
{
  "title": string,
  "description": string
}
Поля
title

string

Необходимый. Название этикетки.

description

string

Описание этикетки.

Жизненный цикл

Состояние жизненного цикла объекта, например метки, поля или выбора. Жизненный цикл обеспечивает следующие переходы:

  • UNPUBLISHED_DRAFT (начальное состояние)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (Удален)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Удалено)

Опубликованное и отключенное состояния имеют некоторые отличительные характеристики:

  • Опубликовано — в объект в этом состоянии могут быть внесены некоторые изменения, и в этом случае hasUnpublishedChanges будет иметь значение true. Кроме того, некоторые виды изменений не допускаются. Как правило, любые изменения, которые могут сделать недействительными или вызвать новые ограничения существующих метаданных, связанных с меткой, отклоняются.
  • Отключено: если отключено, вступает в силу настроенная DisabledPolicy .
JSON-представление
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Поля
state

enum ( State )

Только вывод. Состояние объекта, связанного с этим жизненным циклом.

hasUnpublishedChanges

boolean

Только вывод. Имеет ли объект, связанный с этим жизненным циклом, неопубликованные изменения.

disabledPolicy

object ( DisabledPolicy )

Политика, определяющая способ отображения отключенной метки, поля или выбора.

Состояние

Состояние объекта, связанного с этим жизненным циклом.

Перечисления
STATE_UNSPECIFIED Неизвестное государство.
UNPUBLISHED_DRAFT Исходное состояние объекта. После публикации объект никогда не сможет вернуться в это состояние. После публикации объекта некоторые виды изменений больше не допускаются.
PUBLISHED Объект опубликован. Объект может иметь неопубликованные черновые изменения, на что указывает hasUnpublishedChanges .
DISABLED Объект был опубликован и с тех пор отключен. Объект может иметь неопубликованные черновые изменения, на что указывает hasUnpublishedChanges .
DELETED Объект удален.

ИнвалидПолиси

Политика, которая определяет, как обращаться с отключенной меткой, полем или выбором выбора в различных контекстах.

JSON-представление
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Поля
showInApply

boolean

Показывать ли этот отключенный объект в меню применения элементов Диска.

  • Если true , объект обычно отображается в пользовательском интерфейсе как отключенный и его нельзя выбрать.
  • Если false , объект обычно скрыт в пользовательском интерфейсе.

Отображение подсказок

Подсказки пользовательского интерфейса для отображения метки.

JSON-представление
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Поля
disabled

boolean

Должна ли метка отображаться в пользовательском интерфейсе как отключенная.

shownInApply

boolean

Эта метка должна отображаться в меню применения при применении значений к элементу Диска.

priority

string ( int64 format)

Порядок отображения метки в списке.

Прикладные возможности

Возможности пользователя в отношении примененных метаданных этой метки.

JSON-представление
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Поля
canRead

boolean

Может ли пользователь читать прикладные метаданные, связанные с этой меткой.

canApply

boolean

Может ли пользователь применять эту метку к элементам.

canRemove

boolean

Может ли пользователь удалить эту метку с элементов.

Возможности схемы

Возможности, связанные с этой меткой при редактировании метки.

JSON-представление
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Поля
canUpdate

boolean

Может ли пользователь изменить эту метку.

canDelete

boolean

Может ли пользователь удалить эту метку. Пользователь должен иметь разрешение, а метка должна быть отключена.

canDisable

boolean

Может ли пользователь отключить эту метку. У пользователя должно быть разрешение, и эта метка еще не должна быть отключена.

canEnable

boolean

Может ли пользователь включить эту метку. Пользователь должен иметь разрешение, и эта метка должна быть отключена.

Прикладная меткаполитика

Поведение этого ярлыка при его применении к объектам на Диске.

JSON-представление
{
  "copyMode": enum (CopyMode)
}
Поля
copyMode

enum ( CopyMode )

Указывает, как следует копировать примененную метку и значения полей при копировании элемента Диска.

Режим копирования

Указывает, как следует копировать примененную метку и значения полей при копировании элемента Диска.

Перечисления
COPY_MODE_UNSPECIFIED Режим копирования не указан.
DO_NOT_COPY Примененные значения метки и поля не копируются по умолчанию при копировании элемента Диска, к которому она применена.
ALWAYS_COPY Примененные значения метки и поля всегда копируются при копировании элемента Диска, к которому она применена. Только администраторы могут использовать этот режим.
COPY_APPLIABLE Примененные значения метки и поля копируются, если метка может быть применена пользователем, создавшим копию.

Поле

Определяет поле, имеющее отображаемое имя, тип данных и другие параметры конфигурации. Это поле определяет тип метаданных, которые можно задать для элемента Диска.

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.
}
Поля
id

string

Только вывод. Ключ поля, уникальный в пределах метки или библиотеки.

Это значение генерируется автоматически. Соответствует регулярному выражению: ([a-zA-Z0-9])+

queryKey

string

Только вывод. Ключ, используемый при построении поисковых запросов на Диске для поиска файлов на основе значений, определенных для этого поля в файлах. Например, « {queryKey} > 2001-01-01».

properties

object ( Properties )

Основные свойства поля.

lifecycle

object ( Lifecycle )

Только вывод. Жизненный цикл этого поля.

displayHints

object ( DisplayHints )

Только вывод. Подсказки пользовательского интерфейса для отрисовки поля.

schemaCapabilities

object ( SchemaCapabilities )

Только вывод. Возможности этого пользователя при редактировании этого поля.

appliedCapabilities

object ( AppliedCapabilities )

Только вывод. Возможности, которые этот пользователь имеет в этом поле, и его значение, когда метка применяется к объектам на Диске.

creator

object ( UserInfo )

Только вывод. Пользователь, создавший это поле.

createTime

string ( Timestamp format)

Только вывод. Время создания этого поля.

updater

object ( UserInfo )

Только вывод. Пользователь, который изменил это поле.

updateTime

string ( Timestamp format)

Только вывод. Время обновления этого поля.

publisher

object ( UserInfo )

Только вывод. Пользователь, опубликовавший это поле. Это значение не имеет значения, если поле не опубликовано.

disabler

object ( UserInfo )

Только вывод. Пользователь, отключивший это поле. Это значение не имеет значения, если поле не отключено.

disableTime

string ( Timestamp format)

Только вывод. Время, когда это поле было отключено. Это значение не имеет значения, если поле не отключено.

lockStatus

object ( LockStatus )

Только вывод. LockStatus этого поля.

type поля объединения. Тип данных и параметры этого поля. После публикации тип данных не может быть изменен. type может быть только одним из следующих:
textOptions

object ( TextOptions )

Параметры текстового поля.

integerOptions

object ( IntegerOptions )

Параметры целочисленного поля.

dateOptions

object ( DateOptions )

Параметры поля даты.

selectionOptions

object ( SelectionOptions )

Параметры поля выбора.

userOptions

object ( UserOptions )

Параметры пользовательского поля.

Текстовые параметры

Параметры типа Текстовое поле.

JSON-представление
{
  "minLength": integer,
  "maxLength": integer
}
Поля
minLength

integer

Только вывод. Минимальная допустимая длина значений для текстового поля.

maxLength

integer

Только вывод. Максимальная допустимая длина значений для текстового поля.

Целочисленные параметры

Параметры для типа поля «Целое».

JSON-представление
{
  "minValue": string,
  "maxValue": string
}
Поля
minValue

string ( int64 format)

Только вывод. Минимальное допустимое значение для целочисленного поля.

maxValue

string ( int64 format)

Только вывод. Максимальное допустимое значение целочисленного поля.

Параметры даты

Параметры типа поля даты.

JSON-представление
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Поля
dateFormatType

enum ( DateFormat )

Локализованная опция форматирования даты. Значения полей отображаются в этом формате в соответствии с их языковыми стандартами.

dateFormat

string

Только вывод. Формат даты отделения интенсивной терапии.

minValue

object ( Date )

Только вывод. Минимальное допустимое значение (год, месяц, день).

maxValue

object ( Date )

Только вывод. Максимальное допустимое значение (год, месяц, день).

Формат даты

Локализованные параметры формата даты.

Перечисления
DATE_FORMAT_UNSPECIFIED Формат даты не указан.
LONG_DATE Включает полное название месяца. Например, 12 января 1999 г. (ММММ д, г)
SHORT_DATE Краткое, числовое представление. Например, 13.12.99 (М/д/гг)

Дата

Представляет полную или частичную календарную дату, например день рождения. Время суток и часовой пояс либо указаны в другом месте, либо не имеют значения. Дата указана по григорианскому календарю. Это может представлять собой одно из следующих действий:

  • Полная дата с ненулевыми значениями года, месяца и дня.
  • Месяц и день с нулевым годом (например, годовщина).
  • Год сам по себе, с нулевым месяцем и нулевым днем.
  • Год и месяц с нулевым днем ​​(например, дата истечения срока действия кредитной карты).

Связанные типы:

JSON-представление
{
  "year": integer,
  "month": integer,
  "day": integer
}
Поля
year

integer

Год даты. Должно быть от 1 до 9999 или 0, чтобы указать дату без года.

month

integer

Месяц года. Должно быть от 1 до 12 или 0, чтобы указать год без месяца и дня.

day

integer

День месяца. Должно быть от 1 до 31 и действительно для года и месяца, или 0, чтобы указать год отдельно или год и месяц, если день не имеет значения.

Параметры выбора

Параметры типа поля выбора.

JSON-представление
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Поля
listOptions

object ( ListOptions )

Если указано, это означает, что это поле поддерживает список значений. После публикации поля его нельзя изменить.

choices[]

object ( Choice )

Опции, доступные для этого поля выбора. Порядок списка является последовательным и изменяется с помощью insertBeforeChoice .

Список опций

Опции для многозначного варианта связанного типа поля.

JSON-представление
{
  "maxEntries": integer
}
Поля
maxEntries

integer

Разрешено максимальное количество записей.

Выбор

Выбор поля выбора.

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)
  }
}
Поля
id

string

Уникальная ценность выбора. Этот идентификатор генерируется автоматически. Соответствует регулярному выражению: ([a-zA-Z0-9_])+ .

properties

object ( Properties )

Основные свойства выбора.

lifecycle

object ( Lifecycle )

Только вывод. Жизненный цикл выбора.

displayHints

object ( DisplayHints )

Только вывод. Подсказки пользовательского интерфейса для отображения выбора.

schemaCapabilities

object ( SchemaCapabilities )

Только вывод. Возможности, связанные с этой опцией при редактировании опции.

appliedCapabilities

object ( AppliedCapabilities )

Только вывод. Возможности, связанные с этим выбором прикладных метаданных.

creator

object ( UserInfo )

Только вывод. Пользователь, создавший этот выбор.

createTime

string ( Timestamp format)

Только вывод. Время, когда был создан этот выбор.

updater

object ( UserInfo )

Только вывод. Пользователь, который обновил этот выбор последним.

updateTime

string ( Timestamp format)

Только вывод. Время последнего обновления этого выбора.

publisher

object ( UserInfo )

Только вывод. Пользователь, опубликовавший этот выбор. Это значение не имеет значения, если выбор не опубликован.

publishTime

string ( Timestamp format)

Только вывод. Время публикации этого выбора. Это значение не имеет значения, если выбор не опубликован.

disabler

object ( UserInfo )

Только вывод. Пользователь, отключивший этот выбор. Это значение не имеет значения, если опция не отключена.

disableTime

string ( Timestamp format)

Только вывод. Время, когда этот выбор был отключен. Это значение не имеет значения, если выбор не отключен.

lockStatus

object ( LockStatus )

Только вывод. LockStatus этого выбора.

Характеристики

Основные свойства выбора.

JSON-представление
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Поля
displayName

string

Необходимый. Текст, отображаемый в пользовательском интерфейсе, определяющем это поле.

description

string

Описание этой этикетки.

badgeConfig

object ( BadgeConfig )

Конфигурация значка для этого выбора. Если этот параметр установлен, метка, которой принадлежит этот выбор, считается «ярлыком со значком».

insertBeforeChoice

string

Только ввод. Вставьте или переместите этот вариант перед указанным выбором. Если пусто, выбор помещается в конец списка.

Конфигурация значка

Статус значка этикетки.

JSON-представление
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Поля
color

object ( Color )

Цвет значка. Если не указано иное, значок не отображается. Установленные здесь цвета фона, переднего плана и соло (светлый и темный режим) изменяются в пользовательском интерфейсе Диска на ближайший рекомендованный поддерживаемый цвет.

priorityOverride

string ( int64 format)

Переопределить глобальный приоритет этого значка по умолчанию. Если установлено значение 0, используется эвристика приоритета по умолчанию.

Цвет

Представляет цвет в цветовом пространстве RGBA. Это представление предназначено для простоты преобразования в цветовые представления на разных языках и обратно, а не для компактности. Например, поля этого представления можно тривиально передать конструктору java.awt.Color в Java; его также можно тривиально передать методу +colorWithRed:green:blue:alpha UIColor в iOS; и, приложив немного усилий, его можно легко отформатировать в строку CSS rgba() в JavaScript.

На этой справочной странице нет информации об абсолютном цветовом пространстве, которое следует использовать для интерпретации значения RGB, например sRGB, Adobe RGB, DCI-P3 и BT.2020. По умолчанию приложения должны использовать цветовое пространство sRGB.

Когда необходимо определить равенство цветов, реализации, если не указано иное, рассматривают два цвета как равные, если все их значения красного, зеленого, синего и альфа отличаются не более чем 1e-5 .

Пример (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();
 }
 // ...

Пример (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;
}
// ...

Пример (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('');
};

// ...
JSON-представление
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Поля
red

number

Количество красного цвета в цвете как значение в интервале [0, 1].

green

number

Количество зеленого цвета в цвете как значение в интервале [0, 1].

blue

number

Количество синего цвета в цвете как значение в интервале [0, 1].

alpha

number

Доля этого цвета, которая должна быть применена к пикселю. То есть конечный цвет пикселя определяется уравнением:

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

Это означает, что значение 1,0 соответствует сплошному цвету, тогда как значение 0,0 соответствует полностью прозрачному цвету. При этом используется сообщение-оболочка, а не простой скаляр с плавающей запятой, чтобы можно было отличить значение по умолчанию от значения, которое не установлено. Если этот параметр опущен, этот цветовой объект отображается как сплошной цвет (как если бы значению альфа было явно присвоено значение 1,0).

Отображение подсказок

Подсказки пользовательского интерфейса для отображения опции.

JSON-представление
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Поля
disabled

boolean

Должна ли опция отображаться в пользовательском интерфейсе как отключенная.

shownInApply

boolean

Этот параметр должен отображаться в меню применения при применении значений к элементу Диска.

badgeColors

object ( BadgeColors )

Цвета, используемые для значка. Цвета изменены на Google Material на основе выбранного properties.badge_config.color .

darkBadgeColors

object ( BadgeColors )

Цвет темного режима, используемый для значка. Цвета изменены на Google Material на основе выбранного properties.badge_config.color .

badgePriority

string ( int64 format)

Приоритет этого значка. Используется для сравнения и сортировки нескольких значков. Меньшее число означает, что значок должен отображаться первым. Если конфигурация бейджа отсутствует, это значение будет равно 0. В противном случае будет установлено значение BadgeConfig.priority_override или эвристика по умолчанию, которая отдает предпочтение дате создания метки, а также приоритету поля и параметра.

Цвета значков

Цвет получен из BadgeConfig и изменен на ближайший рекомендуемый поддерживаемый цвет.

JSON-представление
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Поля
backgroundColor

object ( Color )

Только вывод. Фон значка, который сочетается с передним планом.

foregroundColor

object ( Color )

Только вывод. Передний план значка, который сочетается с фоном.

soloColor

object ( Color )

Только вывод. Цвет, который можно использовать для текста без фона.

Возможности схемы

Возможности, связанные с этим выбором при редактировании выбора.

JSON-представление
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Поля
canUpdate

boolean

Может ли пользователь обновить этот выбор.

canDelete

boolean

Может ли пользователь удалить этот выбор.

canDisable

boolean

Может ли пользователь отключить этот выбор.

canEnable

boolean

Может ли пользователь включить этот выбор.

Прикладные возможности

Возможности, связанные с этим выбором прикладных метаданных.

JSON-представление
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Поля
canRead

boolean

Может ли пользователь читать связанные прикладные метаданные элементов.

canSelect

boolean

Может ли пользователь выбрать этот вариант для элемента.

Локстатус

Содержит информацию о том, следует ли считать компонент метки заблокированным.

JSON-представление
{
  "locked": boolean
}
Поля
locked

boolean

Только вывод. Указывает, является ли этот компонент метки (прямой) целью LabelLock. Компонент метки может быть неявно заблокирован, даже если он не является прямой целью LabelLock, и в этом случае для этого поля установлено значение false.

Пользовательские параметры

Параметры типа пользовательского поля.

JSON-представление
{
  "listOptions": {
    object (ListOptions)
  }
}
Поля
listOptions

object ( ListOptions )

Если указано, это означает, что это поле поддерживает список значений. После публикации поля его нельзя изменить.

Характеристики

Основные свойства поля.

JSON-представление
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
Поля
displayName

string

Необходимый. Текст, отображаемый в пользовательском интерфейсе, определяющем это поле.

required

boolean

Следует ли пометить поле как обязательное.

insertBeforeField

string

Только ввод. Вставьте или переместите это поле перед указанным полем. Если пусто, поле помещается в конец списка.

Отображение подсказок

Подсказки пользовательского интерфейса для отрисовки поля.

JSON-представление
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Поля
required

boolean

Должно ли поле отображаться в пользовательском интерфейсе так, как требуется.

disabled

boolean

Должно ли поле отображаться в пользовательском интерфейсе как отключенное.

shownInApply

boolean

Это поле должно отображаться в меню применения при применении значений к элементу Диска.

Возможности схемы

Возможности, связанные с этим полем при редактировании поля.

JSON-представление
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Поля
canUpdate

boolean

Может ли пользователь изменить это поле.

canDelete

boolean

Может ли пользователь удалить это поле. Пользователь должен иметь разрешение, а поле должно быть устаревшим.

canDisable

boolean

Может ли пользователь отключить это поле. Пользователь должен иметь разрешение, и это поле не должно быть отключено.

canEnable

boolean

Может ли пользователь включить это поле. Пользователь должен иметь разрешение, и это поле должно быть отключено.

Прикладные возможности

Возможности, связанные с этим полем прикладных метаданных.

JSON-представление
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Поля
canRead

boolean

Может ли пользователь читать связанные прикладные метаданные элементов.

canWrite

boolean

Может ли пользователь устанавливать это поле для объектов на Диске.

Методы

create

 Создает новую метку.

delete

 Безвозвратно удаляет метку и связанные с ней метаданные с объектов на Диске.

delta

 Обновляет одну метку, применяя набор запросов на обновление, в результате чего создается новая черновая версия.

disable

 Отключить опубликованную метку.

enable

 Включите отключенную метку и восстановите ее опубликованное состояние.

get

 Получите метку по имени ресурса.

list

 Перечислить ярлыки.

publish

 Опубликуйте все черновые изменения в ярлыке.

updateLabelCopyMode

 Обновляет CopyMode метки.

updatePermissions

 Обновляет разрешения метки.