Omówienie interfejsu Drive Labels API

Etykiety to metadane, które definiujesz, aby ułatwić użytkownikom porządkowanie i znajdowanie elementów oraz stosowanie do nich zasad w Dysku Google. Interfejs Drive Labels API to interfejs API REST, który obsługuje procesy biznesowe przez dołączanie metadanych do plików w usłudze Dysk. Typowe zastosowania tego interfejsu API:

  • Klasyfikowanie treści w celu zachowania zgodności ze strategią zarządzania informacjami – utwórz etykietę, aby oznaczyć treści poufne lub dane wymagające specjalnego traktowania. Możesz na przykład utworzyć etykietę z plakietką (etykietę z kolorami oznaczającymi wartości opcji) o nazwie „Poziom poufności” i wartościami „Ściśle tajne”, „Poufne” i „Publiczne”.

  • Stosowanie zasad do elementów na Dysku – twórz etykiety, aby zarządzać zawartością Dysku przez cały jej cykl życia i mieć pewność, że jest ona zgodna z zasadami przechowywania danych obowiązującymi w organizacji. Etykiety możesz na przykład używać do zarządzania zasadami zapobiegania utracie danych (DLP), zgodnie z którymi pliki z etykietą „Poufność” ustawioną na „Tajne” nie mogą być pobierane na komputer.

  • Selekcjonowanie i znajdowanie plików – tworzenie etykiet, które ułatwiają wyszukiwanie treści w Twojej firmie, ponieważ pozwalają osobom z Twojej organizacji znajdować elementy na podstawie etykiet i ich pól. Na przykład użytkownik w organizacji może użyć opcji wyszukiwania na Dysku, aby znaleźć wszystkie umowy, które wymagają podpisania do określonej daty.

Oto lista typowych terminów używanych w interfejsie Drive Labels API:

Etykieta

uporządkowane metadane umieszczone w pliku na Dysku; Użytkownicy Dysku mogą przypisywać etykiety do plików i ustawiać ich wartości. Etykiety składają się z tych elementów:

Nazwa etykiety
Nazwa zasobu etykiety. Identyfikator etykiety stanowi część nazwy etykiety. W zależności od prośby nazwa ma postać: labels/{id} lub labels/{id}@{revisionId}. Więcej informacji znajdziesz w sekcji Edytowanie etykiety poniżej.
Identyfikator etykiety
Globalnie unikalny identyfikator etykiety. Identyfikator stanowi część nazwy etykiety, ale w przeciwieństwie do niej jest spójny w różnych wersjach.

Dostępne są 2 style etykiet:

Etykieta z plakietką

Etykieta z typem pola SelectionOptions zawierającym opcje, które można oznaczyć kolorami w celu wskazania ich znaczenia. Aby to zrobić, ustaw parametr badgeConfig za pomocą atrybutu Properties w tagu Choice.

Dysk wyświetla kolor wybranej opcji dla każdego pliku, aby użytkownicy mogli łatwo zrozumieć stan, klasyfikację i inne informacje o pliku. Na przykład opcja „Tajne” dla plakietki „Poziom poufności” może być wyświetlana na czerwono. Możesz mieć tylko 1 plakietkę naraz.

Etykieta standardowa

Etykieta zawierająca co najmniej 1 typ pola. Etykieta standardowa może mieć tytuł, na przykład „Projekt Moonshot”, i wskazywać wszystkie pliki związane z projektem. Etykieta standardowa może też zawierać kilka pól uporządkowanych. Etykieta o nazwie „Umowa” może zawierać pola „Firma”, „Termin”, „Stan” i „Podpisy”. Każde pole ma określony typ (tekst, data, wybór lub użytkownik).

Diagram etykiety z plakietką
Rysunek 1. Etykieta z plakietką
Schemat etykiety standardowej
Rysunek 2. Etykieta standardowa
Pole

Pojedynczy typowany, konfigurowalny komponent etykiety. Z etykietą może być powiązanych 0 lub więcej pól.

Typ pola
Typ danych wartości powiązanej z polem. Można je skonfigurować jako tekst, liczbę całkowitą, datę, użytkownika lub element wybrany przez użytkownika. Jeśli skonfigurujesz pole za pomocą funkcji ListOptions, możesz ustawić pola użytkownika i wyboru z wieloma wartościami. Wybrany typ wpływa zarówno na prawidłowe wartości stosowane w przypadku elementów w Google Drive, jak i na dostępne opcje zapytań wyszukiwania.
Wybór

Jedna z kilku opcji, które użytkownik może wybrać w polu SelectionOptions.

Typ etykiety

Wszystkie etykiety zawierają LabelType. Istnieją 2 rodzaje etykiet:

Administrator

Aby tworzyć i edytować etykiety należące do administratora, musisz mieć uprawnienia Zarządzaj etykietami.

Administratorzy mogą udostępniać etykiety administratora dowolnemu użytkownikowi, aby umożliwić mu wyświetlanie i stosowanie ich do elementów na Dysku. Aby modyfikować lub odczytywać wartości etykiet w elementach na Dysku, musisz mieć te uprawnienia:

  • Modyfikowanie – aby użytkownik mógł zmodyfikować metadane elementu Dysku powiązane z daną etykietą, musi mieć odpowiednie poziomy uprawnień:

    • Element na Dysku: EDITOR
    • Etykieta: APPLIER

  • Odczyt – aby użytkownik mógł odczytać lub wyszukać metadane elementu na Dysku powiązane z daną etykietą, musi mieć odpowiednie poziomy uprawnień:

    • Element na Dysku: READER
    • Etykieta: READER
Udostępnione

Użytkownicy, którzy nie są administratorami, mogą tworzyć etykiety współdzielone, które inni użytkownicy mogą stosować do elementów na Dysku. Zespoły mogą tworzyć i porządkować własne etykiety do użytku w zespole bez udziału administratora.

Taksonomia etykiet

Obecnie skonfigurowane pola etykiety dostępne dla użytkowników do zastosowania do plików na Dysku. Inna nazwa to schemat etykiety.

Przykładowe taksonomie etykiet:

  • Czułość – czerwony, pomarańczowy, żółty, zielony
  • Stan: Nie rozpoczęto, Wersja robocza, W trakcie sprawdzania, Wersja ostateczna
  • Typ treści: Umowa, Dokument projektowy, Podgląd
  • Departament: marketing, finanse, kadry, sprzedaż
Cykl życia etykiety

Etykiety przechodzą przez cykl życia, w którym są tworzone, publikowane, aktualizowane itd. W miarę przechodzenia przez cykl życia etykieta otrzymuje kolejną wersję. Więcej informacji znajdziesz w artykule Cykl życia etykiety.

Etykieta wersji

Występowanie etykiety. Za każdym razem, gdy etykieta jest tworzona, aktualizowana, publikowana lub wycofywana, jej wersja jest zwiększana.

Wersja robocza
Numer wersji bieżącego projektu etykiety. Możesz wprowadzić kilka zmian w etykiecie, każda z nich zwiększy numer wersji roboczej, nie wpływając na opublikowaną wersję. Umożliwia to testowanie aktualizacji etykiet przed ich opublikowaniem.
Opublikowana wersja
Numer poprawki opublikowanej wersji etykiety. Opublikowana etykieta to instancja etykiety, która jest obecnie dostępna dla użytkowników.

  • Aby dowiedzieć się więcej o programowaniu interfejsów Google Workspace API, w tym o obsługiwaniu uwierzytelniania i autoryzacji, zapoznaj się z artykułem Pierwsze kroki jako deweloper Google Workspace.

  • Aby dowiedzieć się, jak skonfigurować i uruchomić prostą aplikację korzystającą z interfejsu Labels API, skorzystaj z samouczka Pythona.