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)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
Поля
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

Только вывод. Клиент, которому принадлежит эта метка. Например: customers/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 этой метки.

enabledAppSettings

object ( EnabledAppSettings )

Необязательно. EnabledAppSettings для этой метки.

Тип метки

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

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

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

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

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

string

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

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

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

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

string

Обязательно. Название этикетки.

description

string

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

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

Состояние жизненного цикла объекта, например метки, поля или варианта выбора. Подробнее см. в разделе Жизненный цикл метки .

Жизненный цикл предусматривает следующие переходы:

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

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

  • Published : в объект в этом состоянии могут быть внесены некоторые изменения, и в этом случае hasUnpublishedChanges будет иметь значение true. Кроме того, некоторые изменения не допускаются. Как правило, любые изменения, которые могут сделать существующие метаданные, связанные с меткой, недействительными или создать новые ограничения для них, отклоняются.
  • Disabled : при отключении вступает в силу настроенная 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 Объект был удален.

DisabledPolicy

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

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

boolean

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

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

DisplayHints

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

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

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

AppliedLabelPolicy

Поведение этой метки при ее применении к элементам Диска.

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

enum ( CopyMode )

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

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 )

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

TextOptions

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

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

integer

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

maxLength

integer

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

IntegerOptions

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

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

string ( int64 format)

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

maxValue

string ( int64 format)

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

DateOptions

Варианты типа поля даты.

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

enum ( DateFormat )

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

dateFormat

string

Только вывод. Формат даты ICU.

minValue

object ( Date )

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

maxValue

object ( Date )

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

Формат даты

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

Перечисления
DATE_FORMAT_UNSPECIFIED Формат даты не указан.
LONG_DATE Включает полное название месяца. Например, 12 января 1999 г. (MMMM d, y).
SHORT_DATE Короткое числовое представление. Например, 12/13/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 .

ListOptions

Варианты многозначного варианта связанного типа поля.

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

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

BadgeConfig

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

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).

DisplayHints

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

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

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

LockStatus

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

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

boolean

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

Параметры пользователя

Варианты типа поля пользователя.

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

object ( ListOptions )

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

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

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

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

string

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

required

boolean

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

insertBeforeField

string

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

DisplayHints

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

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

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

EnabledAppSettings

Описывает приложения Google Workspace, в которых можно использовать метку.

JSON-представление 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
Поля
enabledApps[]

object ( EnabledApp )

Необязательно. Список приложений, в которых можно использовать метку.

EnabledApp

Приложение, в котором можно использовать этикетку.

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

enum ( App )

Необязательно. Название приложения.

Приложение

Набор возможных приложений Google Workspace, в которых можно использовать метки.

Перечисления
APP_UNSPECIFIED Не указано
DRIVE Водить машину
GMAIL Gmail

Методы

create

 Создает метку.

delete

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

delta

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

disable

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

enable

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

get

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

list

 Список меток.

publish

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

updateLabelCopyMode

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

updateLabelEnabledAppSettings

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

updatePermissions

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