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

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

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

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

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

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

Этикетка

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

Название ярлыка

Имя ресурса метки. Идентификатор метки является частью имени метки. В зависимости от запроса имя имеет один из следующих форматов: labels/{id} или labels/{id}@{revisionId} . Дополнительную информацию см. в разделе «Редакция этикетки» ниже.

Идентификатор этикетки

Глобальный уникальный идентификатор метки. Идентификатор составляет часть имени метки, но, в отличие от имени, он одинаков в разных версиях.

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

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

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

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

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

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

Рисунок 1. Этикетка со значком

Рисунок 2. Стандартная этикетка

Поле

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

Тип поля

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

Выбор

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

Тип этикетки

Все метки включают LabelType . Существует 2 типа этикеток:

Админ

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

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

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

  • Объект на диске: EDITOR
  • Этикетка: APPLIER

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

  • Объект на диске: READER
  • Этикетка: READER

Общий

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

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

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

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

Пример таксономии ярлыков:

• Чувствительность: красный, оранжевый, желтый, зеленый.
• Статус: «Не начато», «Черновик», «На рассмотрении», «Окончательный».
• Тип контента: контракт, дизайн-документ, макет.
• Департамент — маркетинга, финансов, кадров, продаж.

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

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

Версия этикетки

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

Черновая версия

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

Опубликованная версия

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

Связанные темы

• Чтобы узнать о разработке с использованием API Google Workspace, включая обработку аутентификации и авторизации, ознакомьтесь со статьей «Начало работы в качестве разработчика Google Workspace» .

• Чтобы узнать, как настроить и запустить простое приложение Labels API, ознакомьтесь с кратким руководством по Python .