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

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

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

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

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

Ниже приведен список общих терминов, используемых в API Drive Labels:

Этикетка

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

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

Существует 2 стиля этикеток:

Этикетка с значком

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

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

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

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

Диаграмма этикеток с маркировкой.
Рисунок 1. Этикетка с идентификационным номером
Стандартная схема этикетки.
Рисунок 2. Стандартная этикетка
Поле

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

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

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

Тип этикетки

Все метки содержат атрибут LabelType . Существует два типа меток:

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

Для создания и редактирования меток, принадлежащих администратору, вы должны быть администратором учетной записи с привилегией «Управление метками» .

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

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

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

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

    • Элемент диска: READER
    • Метка: READER
Общий

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

Таксономия этикеток

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

Примеры таксономий меток:

  • Чувствительность — красный, оранжевый, желтый, зеленый
  • Статус — «Не начато», «Черновик», «На рассмотрении», «Финальный»
  • Тип контента — договор, проектная документация, макет
  • Отдел — маркетинг, финансы, кадры, продажи
Жизненный цикл этикетки

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

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

Экземпляр метки. Каждый раз, когда метка создается, обновляется, публикуется или становится устаревшей, номер версии метки увеличивается.

Проект пересмотра
Номер версии текущего черновика этикетки. Вы можете внести несколько изменений в этикетку, увеличивая каждый раз номер её черновика, не влияя на опубликованную версию. Возможность иметь черновики этикеток позволяет тестировать обновления этикеток перед публикацией.
Опубликованная редакция
Номер версии опубликованной версии метки. Опубликованная метка — это экземпляр метки, доступный пользователям в данный момент.