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

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

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

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

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

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

Этикетка

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

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

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

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

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

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

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

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

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

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

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

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

Тип этикетки

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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