- Zasób: Deployment
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Metody
Zasób: Wdrożenie
wdrożenie dodatku do Google Workspace;
Zapis JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Pola | |
---|---|
name |
Nazwa zasobu wdrożenia. Przykład: |
oauth |
Lista zakresów OAuth Google, o które aplikacja ma prosić użytkowników o zgodę przed wykonaniem punktu końcowego dodatku. |
add |
Konfiguracja dodatku Google Workspace. |
etag |
Ta wartość jest obliczana przez serwer na podstawie wersji wdrożenia w magazynie i może być wysyłana w żądaniach aktualizacji i usunięcia, aby zapewnić klientowi aktualną wartość przed kontynuacją. |
AddOns
konfiguracja dodatku do Google Workspace;
Zapis JSON |
---|
{ "common": { object ( |
Pola | |
---|---|
common |
Konfiguracja wspólna dla wszystkich dodatków Google Workspace. |
gmail |
Konfiguracja dodatku w Gmailu. |
drive |
Konfiguracja dodatku do Dysku. |
calendar |
Konfiguracja dodatku do Kalendarza. |
docs |
Konfiguracja dodatku do Dokumentów. |
sheets |
Konfiguracja dodatku do Arkuszy. |
slides |
Konfiguracja dodatku do Prezentacji. |
http |
Opcje wysyłania żądań do punktów końcowych HTTP dodatku |
CommonAddOnManifest
Konfiguracja dodatku, która jest udostępniana wszystkim aplikacjom hosta dodatku.
Zapis JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Pola | |
---|---|
name |
Wymagane. Wyświetlana nazwa dodatku. |
logo |
Wymagane. Adres URL obrazu logo wyświetlanego na pasku narzędzi dodatku. |
layout |
Właściwości układu wspólne dla kart dodatków. |
add |
Widżety używane w dodatku. Jeśli to pole nie jest określone, używany jest zestaw domyślny. |
use |
Określa, czy informacje o lokalizacji mają być przekazywane z aplikacji hosta. |
homepage |
Określa punkt końcowy, który będzie wykonywany w dowolnym kontekście na dowolnym hoście. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać przysłonięte przez treści kontekstowe, gdy dodatek zadeklaruje bardziej ukierunkowane reguły. |
universal |
Określa listę punktów rozszerzenia w menu uniwersalnego działania, które służy jako menu ustawień dodatku. Punkt rozszerzenia może być adresem URL linku do otwarcia lub punktem końcowym do wykonania jako przesłanie formularza. |
open |
Działanie Otwórz link może używać tylko adresu URL ze schematem |
LayoutProperties
Właściwości układu karty udostępniane we wszystkich aplikacjach hosta dodatku.
Zapis JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Pola | |
---|---|
primary |
Podstawowy kolor dodatku. Ustawia kolor paska narzędzi. Jeśli nie ustawisz koloru podstawowego, zostanie użyta wartość domyślna określona przez framework. |
secondary |
Drugorzędny kolor dodatku. Określa kolor przycisków. Jeśli kolor podstawowy jest ustawiony, ale nie ma koloru dodatkowego, kolor dodatkowy jest taki sam jak kolor podstawowy. Jeśli nie ustawisz ani koloru podstawowego, ani koloru dodatkowego, zostanie użyta wartość domyślna określona przez framework. |
use |
Włącza projektowanie interfejsu Material Design dla kart. |
AddOnWidgetSet
Podzbiór widżetów używany przez dodatek.
Zapis JSON |
---|
{
"usedWidgets": [
enum ( |
Pola | |
---|---|
used |
Lista widżetów używanych w dodatku. |
WidgetType
Typ widżetu. WIDGET_TYPE_UNSPECIFIED
to podstawowy zestaw widżetów.
Wartości w polu enum | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
Domyślny zestaw widżetów. |
DATE_PICKER |
Selektor daty. |
STYLED_BUTTONS |
Do stylizowanych przycisków należą wypełnione przyciski i przyciski wyłączone. |
PERSISTENT_FORMS |
Trwałe formularze umożliwiają utrwalanie wartości formularza podczas wykonywania działań. |
FIXED_FOOTER |
Naprawiono stopkę na karcie. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Zmień temat i odbiorców wersji roboczej. |
GRID_WIDGET |
Widżet siatki. |
ADDON_COMPOSE_UI_ACTION |
Działanie dodatku w Gmailu, które dotyczy interfejsu tworzenia wiadomości. |
HomepageExtensionPoint
Współkatalogowany format deklaracji widoku strony głównej dodatku.
Zapis JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji tego punktu rozszerzenia. |
enabled |
Opcjonalnie: Jeśli ustawisz wartość Jeśli nie zostanie ustawiony, domyślnie przyjmuje się Jeśli niestandardowy widok strony głównej dodatku jest wyłączony, użytkownicy zobaczą ogólną kartę podsumowania. |
UniversalActionExtensionPoint
Format deklarowania punktu rozszerzenia elementu menu uniwersalnego działania.
Zapis JSON |
---|
{ "label": string, // Union field |
Pola | |
---|---|
label |
Wymagane. Tekst widoczny dla użytkownika opisujący działanie wykonywane po aktywowaniu tego punktu rozszerzenia, np. „Dodaj nowy kontakt”. |
Pole unii action_type . Wymagane. Typ działania obsługiwany w uniwersalnym menu działań. Może to być link do otwarcia lub punkt końcowy do wykonania. action_type może być tylko jednym z tych elementów: |
|
open |
Adres URL, który ma otworzyć akcja uniwersalna. |
run |
Punkt końcowy, który ma być wywoływany przez metodę UniversalAction. |
GmailAddOnManifest
Właściwości dostosowujące wygląd i działanie dodatku do Gmaila.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Określa punkt końcowy, który będzie wykonywany w kontekstach niezgodnych z deklarowanym wyzwalaczem kontekstowym. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać przysłonięte przez treści kontekstowe, gdy dodatek zadeklaruje bardziej ukierunkowane reguły. Jeśli jest podany, zastąpi konfigurację z ustawienia |
contextual |
Określa zestaw warunków, które powodują uruchomienie dodatku. |
universal |
Określa zestaw działań uniwersalnych dla dodatku. Użytkownik uruchamia działania uniwersalne z poziomu menu paska narzędzi dodatku. |
compose |
Definiuje czas pisania, który jest wyzwalaczem dodatku dotyczącego czasu pisania. Jest to aktywator, który powoduje, że wtyczka wykonuje działanie, gdy użytkownik tworzy e-maila. Wszystkie dodatki do tworzenia kompozycji muszą mieć zakres |
authorization |
Nazwa punktu końcowego, który weryfikuje, czy dodatek ma wszystkie wymagane autoryzacje innych firm, sprawdzając interfejsy API innych firm. Jeśli próba się nie powiedzie, funkcja powinna wywołać wyjątek, aby zainicjować przepływ danych autoryzacji. Ta funkcja jest wywoływana przed każdym wywołaniem dodatku, aby zapewnić płynne działanie. |
ContextualTrigger
Określa regułę, która uruchamia się, gdy otwarty e-mail spełnia określone kryteria. Gdy wyzwalacz zostanie uruchomiony, wykonuje określony punkt końcowy, zwykle w celu utworzenia nowych kart i zaktualizowania interfejsu użytkownika.
Zapis JSON |
---|
{ "onTriggerFunction": string, // Union field |
Pola | |
---|---|
on |
Wymagane. Nazwa punktu końcowego, który ma zostać wywołany, gdy wiadomość pasuje do reguły. |
Pole unii trigger . Typ reguły określa warunki, które Gmail musi spełnić, aby wyświetlić dodatek. trigger może być tylko jednym z tych elementów: |
|
unconditional |
Bezwarunkowe reguły są wykonywane, gdy otwierasz dowolną wiadomość e-mail. |
UnconditionalTrigger
Ten typ nie ma pól.
Aktywator, który uruchamia się, gdy otworzysz dowolną wiadomość e-mail.
UniversalAction
Działanie, które jest zawsze dostępne w menu paska narzędzi dodatku niezależnie od kontekstu wiadomości.
Zapis JSON |
---|
{ "text": string, // Union field |
Pola | |
---|---|
text |
Wymagane. Tekst widoczny dla użytkownika opisujący działanie, np. „Dodaj nowy kontakt”. |
Pole unii action_type . Typ działania określa działanie Gmaila, gdy użytkownik wywoła to działanie. action_type może być tylko jednym z tych elementów: |
|
open |
Link otwierany przez Gmaila, gdy użytkownik wykona odpowiednie działanie. |
run |
Punkt końcowy wywoływany, gdy użytkownik wykona działanie. Szczegółowe informacje znajdziesz w przewodniku po działaniach uniwersalnych. |
ComposeTrigger
Aktywator, który uruchamia się, gdy użytkownik tworzy e-maila.
Zapis JSON |
---|
{ "actions": [ { object ( |
Pola | |
---|---|
actions[] |
Definiuje zestaw działań dla dodatku do tworzenia treści. Są to działania, które użytkownicy mogą wywołać w dodatku do tworzenia wiadomości. |
draft |
Określa poziom dostępu do danych, gdy zostanie uruchomione rozszerzenie na etapie tworzenia. |
MenuItemExtensionPoint
Powszechny format deklaracji elementu menu lub przycisku, który pojawia się w aplikacji hosta.
Zapis JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji tego punktu rozszerzenia. |
label |
Wymagane. Tekst widoczny dla użytkownika, który opisuje działanie wykonywane po aktywowaniu tego punktu rozszerzenia. Na przykład „Wstaw fakturę”. |
logo |
Adres URL obrazu logo wyświetlanego na pasku narzędzi dodatku. Jeśli nie jest ustawiony, domyślnie używany jest adres URL głównego logo dodatku. |
DraftAccess
Typ enumeracji określający poziom dostępu do danych wymagany przez regułę tworzenia.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Wartość domyślna, gdy nie ustawiono żadnych wartości w przypadku draftaccess. |
NONE |
Gdy zostanie wywołany dodatek do tworzenia, wyzwalacz tworzenia nie będzie mieć dostępu do żadnych danych projektu. |
METADATA |
Daje regułom tworzenia uprawnienia do uzyskiwania dostępu do metadanych wersji roboczej, gdy zostanie uruchomione dodatki do tworzenia. Obejmuje to listę odbiorców, np. listę Do i Cc w przypadku wiadomości w postaci szkicu. |
DriveAddOnManifest
Właściwości umożliwiające dostosowywanie wyglądu i działania dodatku do Dysku.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Jeśli jest podany, zastąpi konfigurację z ustawienia |
on |
Odpowiada działaniu, które jest wykonywane po wybraniu elementów w odpowiednim widoku Dysku, np. w liście dokumentów na Dysku. |
DriveExtensionPoint
Powszechny format deklarowania wyzwalaczy dodatku do Dysku.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji punktu rozszerzenia. |
CalendarAddOnManifest
Właściwości umożliwiające dostosowywanie wyglądu i działania dodatku do Kalendarza.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Określa punkt końcowy, który jest wykonywany w kontekstach niezgodnych z deklarowanym wyzwalaczem kontekstowym. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać przysłonięte przez treści kontekstowe, gdy dodatek zadeklaruje bardziej ukierunkowane reguły. Jeśli jest podany, zastąpi konfigurację z ustawienia |
conference |
Definiuje rozwiązania konferencyjne udostępniane przez ten dodatek. Dodatki do obsługi rozmów wideo innych firm można tworzyć tylko w skryptach aplikacji. |
create |
Punkt końcowy do wykonania, który tworzy adres URL strony ustawień dodatku. |
event |
Punkt końcowy, który uruchamia się, gdy zdarzenie zostanie otwarte w celu wyświetlenia lub edycji. |
event |
Punkt końcowy, który jest wywoływany, gdy zdarzenie otwarte zostanie zaktualizowane. |
event |
Konfiguracja kontekstowego czynnika uruchamiającego, który jest uruchamiany, gdy użytkownik kliknie dostawcę załączników w menu Kalendarz. |
current |
Określa poziom dostępu do danych, gdy zostanie uruchomiony dodatek do zdarzenia. |
ConferenceSolution
Określa wartości związane z konferencją. Dodatki do obsługi rozmów wideo innych firm można tworzyć tylko w skryptach aplikacji.
Zapis JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Pola | |
---|---|
on |
Wymagane. Punkt końcowy, który należy wywołać, gdy należy utworzyć dane konferencji. |
id |
Wymagane. Identyfikatory powinny być przypisane w unikalny sposób do różnych rozwiązań do obsługi rozmów wideo w ramach jednego dodatku. W przeciwnym razie podczas uruchamiania dodatku może zostać użyte niewłaściwe rozwiązanie do obsługi rozmów wideo. Możesz zmienić nazwę wyświetlaną dodatku, ale nie jego identyfikator. |
name |
Wymagane. Wyświetlana nazwa rozwiązania konferencyjnego. |
logo |
Wymagane. Adres URL obrazu logo rozwiązania konferencyjnego. |
CalendarExtensionPoint
Powszechny format deklarowania wyzwalaczy rozszerzenia kalendarza.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji tego punktu rozszerzenia. |
EventAccess
Typ enumeracji określający poziom dostępu do danych wymaganych przez zdarzenia wyzwalające.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Wartość domyślna, gdy nie ma ustawionej wartości eventAccess. |
METADATA |
Przyznanie wyzwalaczom zdarzeń uprawnień do uzyskiwania dostępu do metadanych zdarzeń, takich jak identyfikator zdarzenia i identyfikator kalendarza. |
READ |
Daje zdarzeniom dostęp do wszystkich pól zdarzenia, w tym metadanych, listy uczestników i danych konferencji. |
WRITE |
Zapewnia regułom zdarzeń dostęp do metadanych zdarzeń oraz możliwość wykonywania wszystkich działań, w tym dodawania uczestników i ustawiania danych konferencji. |
READ_WRITE |
Umożliwia wyzwalaczom zdarzeń dostęp do wszystkich podanych pól zdarzenia, w tym metadanych, danych o uczestnikach i danych konferencji, oraz wykonywanie wszystkich działań. |
DocsAddOnManifest
Właściwości umożliwiające dostosowywanie wyglądu i działania dodatku do Dokumentów Google.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Jeśli jest podany, zastąpi konfigurację z ustawienia |
on |
Punkt końcowy do wykonania, gdy autoryzacja zakresu pliku zostanie przyznana dla pary dokument/użytkownik. |
link |
Lista punktów rozszerzenia do wyświetlania podglądu linków w dokumencie Dokumentów Google. Więcej informacji znajdziesz w artykule Wyświetlanie podgląd linku za pomocą elementów inteligentnych. |
create |
Lista punktów rozszerzeń do tworzenia zasobów innych firm z poziomu aplikacji Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm w menu @. |
DocsExtensionPoint
Typowy format deklarowania wyzwalaczy dodatku do Dokumentów.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji tego punktu rozszerzenia. |
LinkPreviewExtensionPoint
Konfiguracja reguły, która działa, gdy użytkownik wpisze lub wklei link z usługi innej firmy lub usługi innej niż Google do pliku Dokumentów, Arkuszy lub Prezentacji Google.
Zapis JSON |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Pola | |
---|---|
label |
Wymagane. Tekst przykładowego elementu inteligentnego, który zachęca użytkowników do wyświetlenia podglądu linku, np. |
localized |
Opcjonalnie: mapa Jeśli w kluczach mapy występuje lokalizacja użytkownika, zobaczy on zlokalizowaną wersję Obiekt zawierający listę par |
patterns[] |
Wymagane. Tablica wzorców adresów URL, które powodują, że dodatek wyświetla podgląd linków. |
run |
Wymagane. Punkt końcowy do wykonania, gdy zostanie wywołany podgląd linku. |
logo |
Opcjonalnie: Ikona wyświetlana na elemencie inteligentnego elementu i karcie podglądu. Jeśli nie zostanie podany, wtyczka będzie używać swojej ikony na pasku narzędzi |
UriPattern
Konfiguracja każdego wzorca adresu URL, który powoduje wyświetlenie podglądu linku.
Zapis JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Pola | |
---|---|
host |
Wymagany, aby wyświetlić podgląd każdego wzorca adresu URL. Domena wzorca adresu URL. linki w podglądzie dodatku, które zawierają tę domenę w adresie URL; Aby wyświetlić podgląd linków do konkretnej subdomeny, np. Na przykład |
path |
Opcjonalnie: Ścieżka do domeny Jeśli na przykład wzór hosta adresu URL to Aby dopasować wszystkie adresy URL w domenie wzorca hosta, pozostaw pole |
CreateActionExtensionPoint
Konfiguracja reguły, która jest uruchaniana, gdy użytkownik wywołuje przepływ pracy tworzenia zasobu w aplikacji Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm w menu @.
Zapis JSON |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Pola | |
---|---|
id |
Wymagane. Unikalny identyfikator umożliwiający odróżnienie tego punktu rozszerzenia. Identyfikator może mieć maksymalnie 64 znaki i powinien być w formacie |
label |
Wymagane. Tekst wyświetlany obok ikony punktu wejścia do tworzenia zasobów, np. |
localized |
Opcjonalnie: mapa Jeśli w kluczach mapy występuje lokalizacja użytkownika, zobaczy on zlokalizowaną wersję Obiekt zawierający listę par |
run |
Wymagane. Punkt końcowy do wykonania, gdy uruchamiane jest przepływ pracy tworzenia zasobu w celu utworzenia połączenia. |
logo |
Opcjonalnie: Ikona wyświetlana w punkcie wejścia do tworzenia zasobów. Jeśli nie zostanie podany, menu będzie używać ikony paska narzędzi dodatku |
SheetsAddOnManifest
Właściwości umożliwiające dostosowywanie wyglądu i działania dodatku do Arkuszy Google.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Jeśli jest podany, zastąpi konfigurację z ustawienia |
on |
Punkt końcowy do wykonania, gdy autoryzacja zakresu pliku zostanie przyznana dla pary dokument/użytkownik. |
link |
Lista punktów rozszerzenia do wyświetlania podglądu linków w dokumencie Arkuszy Google. Więcej informacji znajdziesz w artykule Wyświetlanie podgląd linku za pomocą elementów inteligentnych. |
SheetsExtensionPoint
Typowy format deklarowania wyzwalaczy dodatku do Arkuszy.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji tego punktu rozszerzenia. |
SlidesAddOnManifest
Właściwości umożliwiające dostosowanie wyglądu i działania dodatku do Prezentacji Google.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Jeśli jest podany, zastąpi konfigurację z ustawienia |
on |
Punkt końcowy do wykonania, gdy autoryzacja zakresu pliku zostanie przyznana dla pary dokument/użytkownik. |
link |
Lista punktów rozszerzenia do wyświetlania podglądu linków w dokumencie Prezentacji Google. Więcej informacji znajdziesz w artykule Wyświetlanie podgląd linku za pomocą elementów inteligentnych. |
SlidesExtensionPoint
Typowy format deklarowania czynników uruchamiających dodatku do Prezentacji.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonania po aktywacji tego punktu rozszerzenia. |
HttpOptions
Opcje wysyłania żądań do punktów końcowych dodatku HTTP
.
Zapis JSON |
---|
{
"authorizationHeader": enum ( |
Pola | |
---|---|
authorization |
Konfiguracja tokena wysyłanego w nagłówku autoryzacji |
HttpAuthorizationHeader
Nagłówek autoryzacji wysyłany w żądaniach dotyczących dodatku HTTP
.
Wartości w polu enum | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Wartość domyślna, która jest równoważna wartości SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Wysyłanie tokenu identyfikacyjnego na konto usługi systemowej konkretnego dodatku Google Workspace (domyślnie). |
USER_ID_TOKEN |
Wyślij token identyfikacyjny użytkownika. |
NONE |
Nie wysyłaj nagłówka uwierzytelniania. |
Metody |
|
---|---|
|
Tworzy wdrożenie o określonej nazwie i konfiguracji. |
|
Usuwa wdrożoną wersję o podanej nazwie. |
|
Pobiera wdrożenie o określonej nazwie. |
|
Pobiera stan instalacji testowego wdrożenia. |
|
Instaluje wdrożenie na Twoim koncie na potrzeby testowania. |
|
Wyświetla listę wszystkich wdrożeń w danym projekcie. |
|
Tworzy lub zastępuje wdrożenie o określonej nazwie. |
|
Odinstaluj z konta użytkownika testowe wdrożenie. |