Wyłączanie, włączanie i usuwanie etykiety

Na tej stronie dowiesz się, jak wykonywać te zadania związane z etykietami:

  • Wyłączanie etykiety
  • Włączanie etykiety
  • Usuwanie etykiety

Wyłączanie etykiety

Wyłączenie etykiety powoduje utworzenie nowej wyłączonej opublikowanej wersji na podstawie bieżącej opublikowanej wersji. Jeśli istnieje wersja robocza, na podstawie najnowszej wersji roboczej tworzona jest nowa wyłączona wersja robocza. Starsze wersje robocze są usuwane. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Po wyłączeniu użytkownicy nadal mogą stosować tę etykietę za pomocą interfejsu API. Etykieta nadal pojawia się w wynikach wyszukiwania i tam, gdzie została już zastosowana. Wyłączoną etykietę można usunąć.

Aby wyłączyć opublikowaną etykietę, użyj metody disable w kolekcji labels.

Musisz też podać:

  • Zasób etykiety reprezentujący każdą etykietę. Zawiera zasób Name i ID, który jest globalnie unikalnym identyfikatorem wytwórni.

  • useAdminAccess to true, aby używać danych logowania administratora. Serwer sprawdza, czy użytkownik jest administratorem etykiety, zanim zezwoli na dostęp.

W tym przykładzie używamy polecenia ID, aby wyłączyć prawidłową etykietę.

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);
});

Etykieta ma State DISABLED, a identyfikator wersji etykiety jest zwiększany. Użytkownicy mogą stosować etykietę za pomocą interfejsu API. Wyłączona etykieta nie jest jednak wyświetlana w interfejsie, chyba że skonfigurowana jest właściwość showInApply metody disabledPolicy.

Włączanie etykiety

Włączenie wyłączonej etykiety przywraca ją do stanu opublikowanego. Powoduje to utworzenie nowej opublikowanej wersji na podstawie bieżącej wyłączonej opublikowanej wersji. Jeśli istnieje wyłączona wersja robocza, na jej podstawie zostanie utworzona nowa wersja, która zostanie włączona. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Aby włączyć wyłączoną etykietę, użyj metody enable.

Musisz też podać:

  • Zasób etykiety reprezentujący każdą etykietę. Zawiera zasób Name i ID, który jest globalnie unikalnym identyfikatorem wytwórni.

  • useAdminAccess to true, aby używać danych logowania administratora. Serwer sprawdza, czy użytkownik jest administratorem etykiety, zanim zezwoli na dostęp.

W tym przykładzie używamy parametru ID, aby włączyć prawidłową etykietę.

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);
});

Etykieta ma State PUBLISHED, a identyfikator wersji etykiety jest zwiększany. Użytkownicy mogą wyświetlać i stosować etykietę do plików za pomocą interfejsu API.

Usuwanie etykiety

Możesz usuwać tylko etykiety w wersji roboczej i wyłączone. Gdy etykieta zostanie usunięta, wszystkie wystąpienia, w których była ona wcześniej stosowana, łącznie z odpowiednimi wartościami pól podanymi przez użytkowników, zostaną trwale skasowane i usunięte z plików na Dysku.

Aby usunąć etykietę, musisz ją najpierw wyłączyć, a potem użyć metody delete.

Musisz też podać:

  • Zasób etykiety reprezentujący każdą etykietę. Zawiera zasób Name i ID, który jest globalnie unikalnym identyfikatorem wytwórni.

  • useAdminAccess to true, aby używać danych logowania administratora. Serwer sprawdza, czy użytkownik jest administratorem etykiety, zanim zezwoli na dostęp.

W tym przykładzie użyto znaku ID, aby usunąć prawidłową etykietę.

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);
});

Etykieta ma State DELETED, a identyfikator wersji etykiety jest zwiększany. Etykiety nie mogą być stosowane, a usunięte etykiety są ostatecznie usuwane. Więcej informacji znajdziesz w artykule Cykl życia etykiety.