Создать & опубликовать лейбл

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

Создать метку

Для создания метки используйте метод create коллекции labels . Метки могут содержать одно или несколько Fields .

Также необходимо указать:

• LabelType ).

• title метки, заданный методом property .

• Если useAdminAccess установлен true , используется учетная запись администратора пользователя. Сервер проверяет, является ли пользователь администратором с привилегией "Управление метками", прежде чем разрешить доступ.

В этом примере создается стандартная административная метка с указанным заголовком и одним Field SelectionOptions с двумя Choices .

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

service.labels.create({
  'resource': label,
  'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

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

Ограничения по маркировке

При создании и применении меток действуют следующие ограничения:

• Стандартные этикетки — 150
• Полей на метку — 10
• На каждый файл накладывается пользователем метки — 5

Работа с полями в метках

Field Type	Что могут делать пользователи	Вопросы форматирования и ограничения
SelectionOptions	Выберите один или несколько вариантов из списка.	Максимальное количество поддерживаемых опций — 200. Максимальное количество выделенных элементов для файла составляет 10, как указано в ListOptions
IntegerOptions	Введите числовое значение	Поддерживаются только целые числа.
DateOptions	Выберите дату в календаре	(Необязательно) Date format можно установить как «Длинный: Месяц ДД, ГГГГ» или «Краткий: ММ/ДД/ГГ».
TextOptions	Введите текст в текстовое поле	Максимальное количество поддерживаемых символов — 100.
UserOptions	Выберите одного или нескольких пользователей из списка контактов Google Workspace.	Максимальное количество пользовательских записей для файла составляет 10, как указано в ListOptions

Опубликовать этикетку

API для создания этикеток позволяет опубликовать черновой вариант этикетки после его завершения.

Для публикации метки используйте метод publish и укажите:

• Ресурс Label , представляющий каждую метку. Он содержит Name ресурса и ID , который является глобально уникальным идентификатором для метки.

• Если useAdminAccess установлен true , используется учетная запись администратора пользователя. Сервер проверяет, является ли пользователь администратором с привилегией "Управление метками", прежде чем разрешить доступ.

В этом примере ID используется для идентификации и публикации правильной метки.

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.publish({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

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

Ограничения при публикации меток

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

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

• После публикации некоторые изменения становятся недопустимыми. Как правило, это означает, что любое изменение, которое аннулирует или вводит новые ограничения на существующие метаданные, связанные с меткой, отклоняется. Например, следующие изменения метки не допускаются после ее публикации:

  • Метка удаляется автоматически. (Сначала её необходимо отключить, а затем удалить.)
  • Изменено значение Field.FieldType .
  • Внесенные изменения в параметры проверки полей отклоняют ранее принятые значения.
  • Снижение максимального количества участников.