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

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

  • Отключить ярлык
  • Включить ярлык
  • Удалить ярлык

Отключить ярлык

Отключение метки приводит к созданию новой отключенной опубликованной версии на основе текущей опубликованной версии. Если существует черновая версия, новая отключенная черновая версия создается на основе последней черновой версии. Старые редакции проекта удаляются. Дополнительные сведения см. в разделе Жизненный цикл метки .

После отключения пользователи по-прежнему смогут применять этот ярлык через 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 , а идентификатор редакции метки увеличивается. Ярлык невозможно применить, а удаленные ярлыки в конечном итоге удаляются. Дополнительные сведения см. в разделе Жизненный цикл метки .