Обзор Drive Labels API

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

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

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

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

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

Ярлык

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

Название ярлыка
Название ресурса ярлыка. Идентификатор ярлыка является частью названия ярлыка. В зависимости от запроса имя будет иметь один из следующих форматов: labels/{id} или labels/{id}@{revisionId}. Подробнее о пересмотре ярлыков…
Идентификатор ярлыка
Уникальный идентификатор ярлыка. Идентификатор входит в название ярлыка, но, в отличие от названия, не меняется при редактировании.

Существует два стиля ярлыков:

Ярлык со значком

Ярлык с полем типа SelectionOptions, содержащим варианты, которые можно выделить цветом, чтобы указать их важность. Для этого нужно задать значение badgeConfig с помощью элемента Properties в элементе Choice.

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

Стандартная метка

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

Схема ярлыка со значком.
Рисунок 1. Ярлык со значком
Схема стандартного ярлыка.
Рисунок 2. Стандартный ярлык
Поле

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

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

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

Тип ярлыка

Все ярлыки содержат LabelType. Существует два типа ярлыков:

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

Чтобы создавать и изменять ярлыки, принадлежащие администратору, у вас должна быть роль администратора аккаунта с правом Управление ярлыками.

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

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

    • Объект на Диске: EDITOR
    • Ярлык: APPLIER

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

    • Объект на Диске: READER
    • Ярлык: READER
Общие

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

Таксономия ярлыков

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

Примеры подходов к именованию полей и их вариантов

  • Чувствительность – красный, оранжевый, желтый, зеленый.
  • Статус: не запущено, черновик, на проверке, окончательная редакция.
  • Тип контента: контракт, проектный документ, макет.
  • Отдел – маркетинг, финансы, кадры, продажи
Жизненный цикл ярлыка

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

Версия ярлыка

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

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