Tworzenie i publikowanie etykiety

Ta strona opisuje, 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ż określić:

• A LabelType.

• Etykieta title za pomocą metody property.

• useAdminAccess ma wartość true, aby używać danych logowania administratora. Zanim serwer zezwoli na dostęp, sprawdzi, czy użytkownik jest administratorem z uprawnieniem „Zarządzanie etykietami”.

Ten przykład tworzy standardową etykietę administratora z określoną nazwą i 1 SelectionOptions Field z 2 Choices.

Python

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()

Node.js

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 UNPUBLISHED_DRAFT State. Aby można było jej używać w plikach i aby była widoczna dla użytkowników, musi mieć stan PUBLISHED. 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

Praca z polami w etykietach

Field Type	Co mogą robić użytkownicy	Uwagi dotyczące formatu i ograniczeń
SelectionOptions	Wybieranie co najmniej 1 opcji z listy	Maksymalna liczba obsługiwanych opcji to 200 Maksymalna liczba wyborów w przypadku pliku to 10, zgodnie z konfiguracją w ListOptions
IntegerOptions	Wpisywanie wartości liczbowej	Obsługiwane są tylko liczby całkowite.
DateOptions	Wybieranie daty w kalendarzu	(Opcjonalnie) Date format można ustawić na „Long: Month DD, YYYY” lub „Short: MM/DD/YY”.
TextOptions	Wpisywanie tekstu w polu tekstowym	Maksymalna liczba znaków to 100.
UserOptions	Wybieranie co najmniej 1 użytkownika z listy kontaktów Google Workspace.	Maksymalna liczba wpisów użytkowników w przypadku pliku to 10, zgodnie z konfiguracją w ListOptions

Publikowanie etykiety

Interfejs Labels API umożliwia opublikowanie wersji roboczej etykiety po jej ukończeniu.

Aby opublikować etykietę, użyj metody publish i określ:

• Zasób Label który reprezentuje każdą etykietę. Zawiera on Name i ID zasobu, czyli globalnie unikalny identyfikator etykiety.

• useAdminAccess ma wartość true, aby używać danych logowania administratora. Zanim serwer zezwoli na dostęp, sprawdzi, czy użytkownik jest administratorem z uprawnieniem „Zarządzanie etykietami”.

Ten przykład używa ID do zidentyfikowania i opublikowania prawidłowej etykiety.

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

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 etykiety jej PUBLISHED State zmienia się na `PUBLISHED`, a identyfikator wersji etykiety jest zwiększany. Etykieta jest wtedy widoczna dla użytkowników i można ją stosować 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 pierwotnego stanu wersji roboczej. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

• Opublikowanie etykiety powoduje utworzenie nowej opublikowanej 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óre zmiany nie są już dozwolone. Zwykle oznacza to, że odrzucane są wszelkie zmiany, które unieważniają lub powodują nowe ograniczenia dotyczące istniejących metadanych związanych z etykietą. Na przykład po opublikowaniu etykiety nie można wprowadzić tych zmian:

  • Etykieta jest bezpośrednio usuwana. (Najpierw trzeba ją wyłączyć, a potem usunąć).
  • Zmieniono Field.FieldType.
  • Aktualizacje opcji weryfikacji pola odrzucają coś, co wcześniej było akceptowane.
  • Zmniejszenie maksymalnej liczby wpisów.