Tworzenie i publikowanie etykiety

Na tej stronie dowiesz się, jak utworzyć i opublikować etykietę.

Tworzenie etykiety

Aby utworzyć etykietę, użyj metody create w kolekcji labels. Etykiety mogą opcjonalnie zawierać 1 lub więcej właściwości Fields.

Musisz też podać:

• LabelType.

• Etykieta title za pomocą metody property.

• useAdminAccess: true, aby można było użyć danych logowania administratora. Przed zezwoleniem na dostęp serwer sprawdza, czy użytkownik jest administratorem z uprawnieniem „Zarządzanie etykietami”.

W tym przykładzie tworzymy standardową etykietę administratora z określonym tytułem i jedną SelectionOptions Field z 2 elementami 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 zadaniu UNPUBLISHED_DRAFT State. Aby można było używać go w plikach i był widoczny dla użytkowników, musi on określać status PUBLISHED. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Limity dotyczące etykiet

Podczas tworzenia i stosowania etykiet obowiązują te limity:

• Etykiety standardowe – 150
• Pola na etykietę – 10
• Etykiety zastosowane przez użytkowników na plik – 5

Praca z polami w etykietach

Field Type	Co mogą robić użytkownicy	Uwagi na temat formatu i ograniczenia
SelectionOptions	Wybierz co najmniej 1 opcję z listy	Maksymalna liczba obsługiwanych opcji to 200 Maksymalna liczba opcji dla pliku to 10 (zgodnie z konfiguracją w ListOptions)
IntegerOptions	Wpisz wartość liczbową	Obsługiwane są tylko liczby całkowite
DateOptions	Wybierz datę kalendarzową	(Opcjonalnie) Dla parametru Date format możesz ustawić wartość „Długi: DD miesiąc, RRRR” lub „Krótki: DD.MM.RR”
TextOptions	Wpisz tekst 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żytkowników w pliku to 10 (zgodnie z ustawieniami konfiguracji w ListOptions).

Publikowanie etykiety

Interfejs Etykiety 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 zasoby Name i ID, które są globalnie unikalnym identyfikatorem etykiety.

• useAdminAccess: true, aby można było użyć danych logowania administratora. Przed zezwoleniem na dostęp serwer sprawdza, czy użytkownik jest administratorem z uprawnieniem „Zarządzanie etykietami”.

W tym przykładzie użyto elementu 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 etykieta zostanie przeniesiona do jednostki PUBLISHED State, a identyfikator wersji etykiety wzrośnie. 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 wrócić do pierwotnego stanu wersji roboczej. Więcej informacji znajdziesz w artykule Cykl życia etykiet.

• Opublikowanie etykiety powoduje utworzenie nowo opublikowanej wersji. Wszystkie wcześniejsze wersje robocze są usuwane. 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ć. Ogólnie oznacza to, że każda zmiana, która powoduje unieważnienie lub powoduje nowe ograniczenia istniejących metadanych powiązanych z etykietą, jest odrzucana. Po opublikowaniu etykiety nie są dozwolone na przykład takie zmiany:

  • Etykieta zostanie usunięta bezpośrednio. (najpierw należy ją wyłączyć, a potem usunąć).
  • Zmieniono Field.FieldType.
  • Aktualizacje opcji weryfikacji pól powodują odrzucenie czegoś, co zostało wcześniej zaakceptowane.
  • Zmniejszenie maksymalnej liczby wpisów.