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

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

Создать этикетку

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

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

• LabelType .

• title метки через метод property .

• Значение useAdminAccess равно true , чтобы использовать учетные данные администратора. Перед предоставлением доступа сервер проверяет, является ли пользователь администратором с привилегией «Управление метками».

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

Питон

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 используется для определения и публикации правильной метки.

Питон

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 .
  • Обновления параметров проверки полей отклоняют ранее принятые данные.
  • Сокращение максимального количества заявок.