Tworzenie i publikowanie etykiety

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

Tworzenie etykiety

Aby utworzyć etykietę, użyj funkcji create na Kolekcja labels. Etykiety mogą opcjonalnie zawierają jeden lub więcej Fields

Musisz też określić:

  • LabelType.

  • Etykieta title przez tag Metoda property.

  • useAdminAccess ma wartość true, aby używać danych logowania administratora użytkownika. serwer sprawdza, czy użytkownik jest administratorem z uprawnieniem „Zarządzaj etykietami” uprawnienie zanim zezwolisz na dostęp.

W tym przykładzie tworzymy standardową etykietę administracyjną o określonym tytule i 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 Musi to być PUBLISHED do używania w plikach i w taki sposób, aby były widoczne dla użytkowników. Więcej informacji znajdziesz w sekcji Etykieta cyklu życia usługi.

Limity 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 Czynności, które mogą wykonywać 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 wyboru 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) Wartość Date format może mieć ustawienie „Długi: DD miesiąc RRRR” lub „Short: 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żytkowników dla pliku to 10, zgodnie z konfiguracją w ListOptions

Publikowanie etykiety

Interfejs Etykiety API umożliwia opublikowanie gotowej etykiety w wersji roboczej.

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

  • zasobu oznaczonego etykietami, reprezentujący każdą etykietę. Zawiera zasób Name i ID, który to globalnie unikalny identyfikator etykiety.

  • useAdminAccess ma wartość true, aby używać danych logowania administratora użytkownika. serwer sprawdza, czy użytkownik jest administratorem z uprawnieniem „Zarządzaj etykietami” uprawnienie zanim zezwolisz na dostęp.

W tym przykładzie użyto ID do identyfikacji 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 zostanie ona przeniesiona do: PUBLISHED State i wersja etykiety Identyfikator zwiększa się. Etykieta jest widoczna dla użytkowników i można ją zastosować do: . Więcej informacji znajdziesz w sekcji Etykieta cyklu życia usługi.

Ograniczenia podczas publikowania etykiet

  • Po opublikowaniu etykieta nie może wrócić do pierwotnej wersji roboczej. Więcej Więcej informacji znajdziesz w artykule Cykl życia etykiet.

  • Opublikowanie etykiety powoduje utworzenie nowo opublikowanej wersji. Cała poprzednia wersja robocza Liczba wersji została usunięta. Wcześniej opublikowane wersje zostaną zachowane, ale są mogą zostać automatycznie usunięte w razie potrzeby.

  • Po opublikowaniu niektóre zmiany nie są już dozwolone. Ogólnie oznacza to, zmiany, które unieważniają lub wywołują nowe ograniczenia metadane powiązane z etykietą zostaną odrzucone. Na przykład: po opublikowaniu etykiety nie są dozwolone zmiany w niej:

    • Etykieta zostanie bezpośrednio usunięta. (najpierw musi zostać wyłączony, a następnie deleted.)
    • Ustawienie Field.FieldType zostało zmienione.
    • Aktualizacje opcji weryfikacji pól powodują odrzucenie wcześniej wybranych danych zaakceptowano.
    • Zmniejszenie maksymalnej liczby wpisów.