Tworzenie i publikowanie etykiety

Na tej stronie znajdziesz informacje o tym, jak utworzyć i opublikować etykietę.

Tworzenie etykiety

Aby utworzyć etykietę, użyj metody create w kolekcji labels. Etykiety mogą opcjonalnie zawierać co najmniej 1 znak Fields.

Musisz też podać:

  • A LabelType.

  • Etykietę title za pomocą metody property.

  • useAdminAccess to true, aby używać danych logowania administratora. Serwer sprawdza, czy użytkownik jest administratorem z uprawnieniem „Zarządzanie etykietami”, zanim zezwoli mu na dostęp.

W tym przykładzie tworzymy standardową etykietę administratora z określonym tytułem i jednym 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 zostanie utworzona w sekcji UNPUBLISHED_DRAFT State. Musi być PUBLISHED przeznaczony do używania 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 w pliku – 5

Praca z polami w etykietach

Field Type Czynności, które mogą wykonywać użytkownicy Uwagi dotyczące formatu i ograniczeń
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 Wybieranie daty kalendarzowej (Opcjonalnie) Date format może mieć wartość „Długa: DD miesiąc RRRR” lub „Krótka: DD.MM.RR”
TextOptions Wpisz tekst w polu tekstowym Maksymalna obsługiwana liczba znaków to 100
UserOptions Wybierz co najmniej jednego 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 ukończeniu.

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

  • 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 z uprawnieniem „Zarządzanie etykietami”, zanim zezwoli mu na dostęp.

W tym przykładzie do identyfikowania i publikowania prawidłowej etykiety użyto znaku ID.

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 etykieta zostanie przeniesiona do sekcji PUBLISHED State, a identyfikator wersji etykiety zostanie zwiększony. 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ą przechowywane, ale w razie potrzeby mogą zostać automatycznie usunięte.

  • Po opublikowaniu niektóre zmiany nie są już dozwolone. Zwykle oznacza to, że odrzucana jest każda zmiana, która unieważnia lub wywołuje nowe ograniczenia dotyczące istniejących metadanych związanych z etykietą. Na przykład po opublikowaniu etykiety nie można wprowadzać w niej tych zmian:

    • Etykieta zostanie usunięta bezpośrednio. (Najpierw musisz go wyłączyć, a potem usunąć).
    • Wartość w kolumnie Field.FieldType została zmieniona.
    • Aktualizacje opcji weryfikacji pól odrzucają coś, co wcześniej było akceptowane.
    • zmniejszenie maksymalnej liczby zgłoszeń,