Обзор API меток диска

Метки — это метаданные, которые вы определяете, чтобы помочь пользователям организовывать, находить и применять политики к файлам в Google Диск. API меток Диска — это RESTful API, который поддерживает бизнес-процессы, добавляя метаданные к вашим файлам в Диске. Типичные варианты использования этого API:

  • Классифицируйте контент в соответствии со стратегией управления информацией — создайте метку для идентификации конфиденциального контента или данных, требующих особого обращения. Например, вы можете создать метку с цветовой кодировкой значений параметров под названием «Конфиденциальность» со значениями «Совершенно секретно», «Конфиденциально» и «Общедоступно».

  • Примените политику к элементам в Google Диске — Создавайте метки для управления содержимым Google Диска на протяжении всего его жизненного цикла и обеспечения соответствия правилам ведения учета вашей организации. Например, используйте метки для управления политикой защиты от потери данных (DLP), согласно которой файлы с меткой «Конфиденциальность» со значением «Совершенно секретно» не могут быть загружены на компьютер.

  • Настраивайте и находите файлы — Создавайте метки, чтобы улучшить возможности поиска контента вашей компании, позволяя сотрудникам находить элементы на основе меток и их полей. Например, сотрудник вашей организации может использовать параметры поиска в Google Диске, чтобы найти все контракты, ожидающие подписания к определенной дате.

Ниже приведён список распространённых терминов, используемых в API меток дисков:

Этикетка

Структурированные метаданные, размещаемые на файле в Google Диска. Пользователи Диска могут назначать метки и задавать значения полей меток для файлов. Метки состоят из:

Название этикетки
Имя ресурса метки. Идентификатор метки является частью имени метки. В зависимости от запроса имя может иметь вид: labels/{id} или labels/{id}@{revisionId} . Для получения дополнительной информации см. раздел «Варианты изменений меток» ниже.
Label ID
Глобальный уникальный идентификатор для метки. Идентификатор является частью названия метки, но, в отличие от названия, он остается неизменным между версиями.

There are 2 styles of labels:

Badged label

Метка с полем типа SelectionOptions , содержащая варианты выбора , которые можно раскрасить для обозначения важности. Это делается путем установки badgeConfig через Properties варианта Choice .

Google Drive отображает цвет выбранного параметра для каждого файла, чтобы пользователи могли четко понимать статус, классификацию и т. д. файла. Например, параметр «Совершенно секретно» для метки «Конфиденциальность» может отображаться красным цветом. Одновременно можно использовать только одну метку.

Стандартная этикетка

Метка, содержащая ноль или более полей определенного типа . Стандартная метка может иметь заголовок, например, «Проект Moonshot», и указывать на все файлы, относящиеся к проекту. Стандартная метка также может содержать несколько структурированных полей. Например, метка с заголовком «Договор» может содержать поля для «Компания», «Срок выполнения», «Статус» и «Подписанты». Каждое поле имеет определенный тип (текст, дата, выделение или пользователь).

Badged label diagram.
Figure 1. Badged label
Standard label diagram.
Figure 2. Standard label
Поле

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

Тип поля
Тип данных значения, связанного с полем . Может быть настроен как текст, целое число, дата, пользовательское поле или поле выбора. Если вы настроите поле с помощью ListOptions , вы можете задать несколько значений для полей пользователя и выбора. Выбранный тип влияет как на допустимые значения, применимые к элементам Google Диска, так и на доступные параметры поискового запроса.
Выбор

One of several options a user can choose from within a SelectionOptions field.

Тип метки

All labels include a LabelType . There are 2 types of labels:

Администратор

To create and edit admin-owned labels, you must be an account administrator with the Manage Labels privilege.

Администраторы могут предоставлять доступ к административным меткам любому пользователю, позволяя ему просматривать и применять эти метки к элементам Google Диска. Для изменения или чтения значений меток элементов Google Диска требуются следующие разрешения:

  • Изменение — Для того чтобы пользователь мог изменять метаданные элемента Google Диска, относящиеся к определенной метке, он должен обладать соответствующими уровнями прав доступа:

    • Элемент диска: EDITOR
    • Label: APPLIER

  • Чтение — Для того чтобы пользователь мог читать или искать метаданные элемента Google Диска, относящиеся к определенной метке, у него должны быть соответствующие уровни прав доступа:

    • Drive item: READER
    • Label: READER
Общий

Пользователи без прав администратора могут создавать общие метки, которые другие пользователи могут применять к элементам Google Диска. Команды могут создавать и организовывать собственные метки для использования внутри команды без необходимости привлечения администратора.

Классификация меток

Текущие настроенные поля меток, доступные пользователям для применения к файлам Google Диска. Также известны как схема меток.

Example label taxonomies:

  • Sensitivity—Red, Orange, Yellow, Green
  • Status—Not Started, Draft, In Review, Final
  • Тип контента — Договор, Проектная документация, Макет
  • Отделы: маркетинг, финансы, кадры, продажи
Label lifecycle

Метки проходят жизненный цикл, в ходе которого они создаются, публикуются, обновляются и так далее. По мере прохождения меткой жизненного цикла, номер ее ревизии увеличивается. Для получения дополнительной информации см. раздел «Жизненный цикл метки» .

пересмотр этикетки

An instance of the label. Anytime a label is created, updated, published, or deprecated, the label revision increments.

Проект доработки
Номер редакции текущего чернового варианта метки. Вы можете внести несколько изменений в метку, каждое из которых увеличивает номер ее чернового варианта, без влияния на опубликованную редакцию. Возможность иметь черновые варианты меток позволяет тестировать обновления меток перед публикацией.
Published revision
The revision number of the published version of a label. The published label is the instance of the label currently available to users.