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

Na tej stronie opisano, jak wykonywać te czynności związane z etykietami:

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

Wyłączanie etykiety

Wyłączenie etykiety powoduje utworzenie nowej opublikowanej wersji z wyłączoną etykietą na podstawie bieżącej opublikowanej wersji. Jeśli istnieje wersja robocza, na podstawie najnowszej wersji roboczej zostanie utworzona 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 będzie widoczna w miejscach, w których została już zastosowana, oraz w wynikach wyszukiwania. Wyłączoną etykietę można usunąć.

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

Musisz też podać:

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

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

W tym przykładzie użyto tagu ID, aby wyłączyć odpowiednią 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 wartość State, która jest większa o 1 od wartości DISABLED, a jej identyfikator wersji jest zwiększany. Użytkownicy mogą zastosować etykietę za pomocą interfejsu API. Jednak wyłączona etykieta nie jest wyświetlana w interfejsie, chyba że skonfigurowano właściwość showInApply metody disabledPolicy.

Włączanie etykiety

Włączenie wyłączonej etykiety powoduje przywrócenie jej do opublikowanego stanu. W efekcie powstaje nowa opublikowana wersja oparta na bieżącej opublikowanej wersji z wyłączonym dostępem. Jeśli istnieje nieaktywna wersja robocza, na jej podstawie tworzona jest nowa wersja, która jest 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, który reprezentuje każdą etykietę. Zawiera zasób Name i ID, który jest globalnie unikalnym identyfikatorem etykiety.

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

W tym przykładzie użyto tagu ID, aby włączyć odpowiednią 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 wartość State, która jest większa o 1 od wartości PUBLISHED, a jej identyfikator wersji jest zwiększany. Użytkownicy mogą wyświetlać etykietę i stosować ją do plików za pomocą interfejsu API.

Usuwanie etykiety

Można usuwać tylko etykiety „projekt” 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, który reprezentuje każdą etykietę. Zawiera zasób Name i ID, który jest globalnie unikalnym identyfikatorem etykiety.

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

W tym przykładzie użyto elementu 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 wartość State, która jest większa o 1 od wartości DELETED, a jej identyfikator wersji jest zwiększany. Etykiety nie można zastosować, a usuwane etykiety są ostatecznie usuwane. Więcej informacji znajdziesz w artykule Cykl życia etykiety.