Dodatki do Google Workspace mogą udostępniać dostosowane interfejsy, gdy użytkownik korzysta z Dysku Google. Dzięki temu możesz przekazywać użytkownikowi dodatkowe, przydatne informacje, automatyzować zadania i łączyć systemy innych firm z Dyskiem Google.
Otwieranie interfejsu dodatku
Dodatek do Google Workspace możesz otworzyć na Dysku Google, jeśli jego ikona pojawi się w kolumnie ikon po prawej stronie interfejsu Dysku. Dodatek do Google Workspace może zdefiniować interfejs strony głównej, interfejs wyboru elementu lub oba te interfejsy:
- Jeśli użytkownik kliknie ikonę dodatku na Dysku Google, dodatek wykona odpowiednią funkcję
drive.homepageTrigger(jeśli jest dostępna). Ta funkcja tworzy i zwraca kartę strony głównej do wyświetlenia w Google Drive. Jeśli nie zdefiniowano funkcjidrive.homepageTrigger, wyświetli się ogólna karta strony głównej. - Jeśli użytkownik wybierze co najmniej 1 element na Dysku Google, a następnie kliknie ikonę dodatku lub wybierze elementy, gdy dodatek jest otwarty, dodatek wykona odpowiednią funkcję kontekstową
drive.onItemsSelectedTrigger(jeśli jest dostępna). Ta funkcja tworzy kontekstowy interfejs „wybrane elementy” dodatku w Google Drive i zwraca go do Google Drive w celu wyświetlenia.
Tworzenie interfejsu dodatku do Dysku
Aby tworzyć interfejsy rozszerzające Dysk Google, wykonaj te ogólne czynności:
- Zdecyduj, czy chcesz, aby Twój dodatek miał stronę główną w Dysk Google. Zdecyduj też, czy chcesz udostępniać interfejs kontekstowy, gdy użytkownik wybierze elementy Dysku.
- Dodaj odpowiednie pola
addOns.commoniaddOns.drivedo pliku manifestu projektu skryptu dodatku, w tym wszelkie wymagane zakresy Dysku. - Jeśli udostępniasz stronę główną przeznaczoną specjalnie dla Dysku, zaimplementuj funkcję
drive.homepageTrigger, aby utworzyć ten interfejs. Możesz też użyć interfejsucommon.homepageTriggerw przypadku wielu hostów Google Workspace. - Jeśli udostępniasz interfejs wyboru elementu kontekstowego na Dysku, musisz zaimplementować funkcję aktywatora kontekstowego
drive.onItemsSelectedTrigger, aby go utworzyć. Więcej informacji znajdziesz w artykule Interfejs kontekstowy Dysku dla wybranych elementów. - Zaimplementuj powiązane funkcje wywołania zwrotnego potrzebne do reagowania na interakcje użytkownika z interfejsem, takie jak kliknięcia przycisków.
Strony główne Dysku
Dysk Google obsługuje wyświetlanie stron głównych dodatków do Google Workspace.
Aby wyświetlić wspólną stronę główną dodatku na Dysku Google, upewnij się, że w pliku manifestu dodatku znajduje się pole addOns.drive.
Możesz też dodać element drive.homepageTrigger do pliku manifestu dodatku, aby udostępnić stronę główną przeznaczoną dla Dysku.
W obu przypadkach musisz podać nazwę funkcji wywołującej stronę główną w projekcie skryptu dodatku. Ta funkcja jest wywoływana automatycznie w razie potrzeby, aby utworzyć stronę główną Dysku. Musisz zaimplementować tę funkcję, aby utworzyć i zwrócić pojedynczy obiekt Card lub tablicę obiektów Card, które składają się na stronę główną. Funkcja wywołująca na stronie głównej otrzymuje jako parametr obiekt zdarzenia, który zawiera ogólne informacje, takie jak platforma klienta. Dane obiektu zdarzenia możesz wykorzystać do dostosowania konstrukcji strony głównej.
Interfejs kontekstowy Dysku dla wybranych elementów
Dysk Google korzysta z wyzwalacza kontekstowego, aby określić, jaki interfejs (jeśli w ogóle) ma być wyświetlany, gdy użytkownik wybierze co najmniej 1 element Dysku Google. Gdy wywoła się warunek, zostanie wykonana funkcja wywołania kontekstowego określona w polu drive.onItemsSelectedTrigger.runFunction manifestu dodatku.
Aby utworzyć interfejs wyboru elementów kontekstowych w Drive, musisz wykonać te czynności:
Upewnij się, że plik manifestu dodatku zawiera pole
https://www.googleapis.com/auth/drive.addons.metadata.readonlyscope.Upewnij się, że plik manifestu zawiera sekcję
drive.onItemsSelectedTrigger.Zaimplementuj funkcję o nazwie podanej w polu
drive.onItemsSelectedTrigger. Ta funkcja przyjmuje jako argument obiekt zdarzenia i musi zwracać pojedynczy obiektCardlub tablicę obiektówCard.Podobnie jak w przypadku każdej karty musisz zaimplementować wszystkie funkcje wywołania zwrotnego używane do zapewnienia interaktywności widżetu w interfejsie. Jeśli na przykład w interfejsie umieścisz przycisk, powinien on mieć dołączoną akcję i zastosowaną funkcję wywołania zwrotnego, która będzie uruchamiana po kliknięciu przycisku.
Obiekty zdarzeń
Podczas wywoływania funkcji aktywatora drive.homepageTrigger lub drive.onItemsSelectedTrigger tworzony jest obiekt zdarzenia, który jest przekazywany do tych funkcji. Funkcja wywołująca może używać informacji z tego obiektu zdarzenia do określania sposobu tworzenia kart dodatku lub kontrolowania jego działania.
Pełna struktura obiektów zdarzeń jest opisana w sekcji Obiekty zdarzeń. Gdy Dysk jest aplikacją hostującą dodatek, obiekty zdarzeń kontekstowych zawierają pole obiektu zdarzenia Dysku, które zawiera informacje o kliencie specyficzne dla Dysku.
Obiekty zdarzeń kontekstowych na Dysku w przypadku reguł wyboru elementu zawierają informacje o elementach wybranych przez użytkownika w momencie wywołania reguły. Gdy użytkownik wybierze więcej niż 1 element na Dysku, jeden z nich jest uznawany za element o największym znaczeniu. Ten element jest nazywany aktywnym elementem kursora.
Poniższy przykład pokazuje obiekt zdarzenia Drive przekazywany do funkcji drive.onItemsSelectedTrigger:
{
"commonEventObject": { ... },
"drive": {
"activeCursorItem":{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl": "https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
"selectedItems": [
{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl":"https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
...
]
},
...
}