Z tej strony dowiesz się, jak utworzyć i opublikować etykietę.
Tworzenie etykiety
Aby utworzyć etykietę, użyj metody create
w kolekcji labels
. Etykiety mogą opcjonalnie zawierać co najmniej 1 Fields
.
Musisz też podać:
Etykieta
title
w metodzieproperty
.useAdminAccess
totrue
, aby używać danych logowania administratora użytkownika. Zanim przyzna dostęp, serwer sprawdza, czy użytkownik jest administratorem z uprawnieniami „Zarządzanie etykietami”.
W tym przykładzie tworzymy standardową etykietę administratora z określonym tytułem i 1 SelectionOptions
Field
z 2 Choices
.
label_body = {
'label_type': 'ADMIN',
'properties': {
'title': 'TITLE '
},
'fields': [{
'properties': {
'display_name': 'DISPLAY_NAME '
},
'selection_options': {
'list_options': {},
'choices': [{
'properties': {
'display_name': 'CHOICE_1 '
}
}, {
'properties': {
'display_name': 'CHOICE_2 '
}
}]
}
}]
}
response = service.labels().create(
body=label_body, useAdminAccess=True).execute()
var label = {
'label_type': 'ADMIN',
'properties': {
'title': 'TITLE '
},
'fields': [{
'properties': {
'display_name': 'DISPLAY_NAME '
},
'selection_options': {
'list_options': {},
'choices': [{
'properties': {
'display_name': 'CHOICE_1 '
}
}, {
'properties': {
'display_name': 'CHOICE_2 '
}
}]
}
}]
};
service.labels.create({
'resource': label,
'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
Etykieta jest tworzona w sekcji UNPUBLISHED_DRAFT
State
. Musi być PUBLISHED
do użytku w plikach i widoczny dla użytkowników. Więcej informacji znajdziesz w artykule Cykl życia etykiety.
Limity etykiet
Podczas tworzenia i stosowania etykiet obowiązują te limity:
- Etykiety standardowe – 150
- Pola na etykietę – 10
- Etykiety zastosowane przez użytkownika na plik – 5.
Praca z polami w etykietach
Field Type |
Czynności, które mogą wykonywać użytkownicy | Uwagi dotyczące formatu i ograniczenia |
---|---|---|
SelectionOptions |
Wybierz co najmniej 1 opcję z listy | Maksymalna liczba obsługiwanych opcji to 200 Maksymalna liczba opcji w pliku to 10 zgodnie z konfiguracją w ListOptions |
IntegerOptions |
Wpisz wartość liczbową | Obsługiwane są tylko liczby całkowite. |
DateOptions |
Wybierz datę kalendarzową. | (Opcjonalnie) Date format może mieć wartość „Długa: DD miesiąc RRRR” lub „Krótka: DD.MM.RR”. |
TextOptions |
Wpisywanie tekstu w polu tekstowym | Maksymalna obsługiwana liczba znaków to 100 |
UserOptions |
Wybierz co najmniej 1 użytkownika z kontaktów Google Workspace. | Maksymalna liczba wpisów użytkownika w pliku to 10, zgodnie z konfiguracją w ListOptions |
Publikowanie etykiety
Interfejs Labels API umożliwia opublikowanie wersji roboczej etykiety po jej utworzeniu.
Aby opublikować etykietę, użyj metody publish
i określ:
Zasób etykiety, który reprezentuje każdą etykietę. Zawiera zasób
Name
iID
, który jest globalnie unikalnym identyfikatorem etykiety.useAdminAccess
totrue
, aby używać danych logowania administratora użytkownika. Zanim przyzna dostęp, serwer sprawdza, czy użytkownik jest administratorem z uprawnieniami „Zarządzanie etykietami”.
W tym przykładzie użyto etykiety ID
do zidentyfikowania i opublikowania prawidłowej etykiety.
service.labels().publish(
name='labels/ID ',
body={
'use_admin_access': True
}).execute()
service.labels.publish({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID '
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
Po opublikowaniu etykieta przenosi się do poziomu PUBLISHED
State
, a jej identyfikator wersji zwiększa się o 1. Etykieta jest wtedy widoczna dla użytkowników i można ją zastosować do plików. Więcej informacji znajdziesz w artykule Cykl życia etykiety.
Ograniczenia podczas publikowania etykiet
Po opublikowaniu etykiety nie można przywrócić jej do pierwotnego stanu wersji roboczej. Więcej informacji znajdziesz w artykule Cykl życia etykiety.
Opublikowanie etykiety powoduje utworzenie nowej wersji. Wszystkie poprzednie wersje robocze zostaną usunięte. Wcześniej opublikowane wersje są zachowywane, ale w razie potrzeby mogą zostać automatycznie usunięte.
Po opublikowaniu niektórych zmian nie można już wprowadzić. Oznacza to, że każda zmiana, która unieważnia lub powoduje nowe ograniczenia dotyczące istniejących metadanych powiązanych z etykietą, jest odrzucana. Po opublikowaniu etykiety nie można wprowadzać w niej tych zmian:
- Etykieta zostanie bezpośrednio usunięta. (najpierw musisz go wyłączyć, a potem usunąć).
- Wartość
Field.FieldType
została zmieniona. - Aktualizacje opcji walidacji pola odrzucają coś, co było wcześniej akceptowane.
- zmniejszenie maksymalnej liczby wpisów.