Отключить, включить и усилить; удалить ярлык

На этой странице описывается, как выполнять следующие задачи с использованием этикеток:

  • Отключить метку
  • Включить метку
  • Удалить метку

Отключить метку

Отключение метки приводит к созданию новой отключённой опубликованной версии на основе текущей опубликованной версии. При наличии черновой версии создаётся новая отключённая черновая версия на основе последней черновой версии. Более старые черновые версии удаляются. Подробнее см. в разделе Жизненный цикл метки .

После отключения пользователи смогут применять эту метку через API. Метка по-прежнему будет отображаться там, где она уже применена, и в результатах поиска. Отключённую метку можно удалить .

Чтобы отключить опубликованную метку, используйте метод disable в коллекции labels .

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

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

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

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

Питон 

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

Node.js 

service.labels.disable({
  '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 DISABLED , а её идентификатор версии увеличивается. Пользователи могут применить метку через API. Однако отключённая метка не отображается в пользовательском интерфейсе, если не настроено свойство showInApply метода disabledPolicy .

Включить метку

Включение отключенной метки восстанавливает её состояние публикации. Это приводит к созданию новой опубликованной версии на основе текущей отключенной опубликованной версии. Если существует отключенная черновая версия, новая версия создаётся на её основе и активируется. Подробнее см. в разделе Жизненный цикл метки .

Чтобы включить отключенную метку, используйте метод enable .

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

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

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

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

Питон 

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

Node.js 

service.labels.enable({
  '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 , а её идентификатор версии увеличивается. Пользователи могут просматривать и применять метку к файлам через API.

Удалить метку

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

Чтобы удалить метку, необходимо сначала отключить ее, а затем воспользоваться методом delete .

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

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

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

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

Питон 

response = service.labels().delete(
  name='labels/ID',
  useAdminAccess=True).execute()

Node.js 

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

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