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

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

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

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

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

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

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

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

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

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

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

Python 

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

Python 

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.

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

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

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

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

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

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

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

Python 

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