Package google.apps.script.type

Indeks

AddOnWidgetSet

Podzbiór widżetów używanych przez dodatek.

Pola
usedWidgets[]

WidgetType

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 Przycisk stylizowany może być wypełniony lub nieaktywny.
PERSISTENT_FORMS Trwałe formularze umożliwiają zachowywanie wartości formularza podczas działań.
UPDATE_SUBJECT_AND_RECIPIENTS Zaktualizuj temat i odbiorców wersji roboczej.
GRID_WIDGET Widżet siatki.
ADDON_COMPOSE_UI_ACTION Działanie dodatku w Gmailu, które ma zastosowanie do interfejsu tworzenia dodatku.

CommonAddOnManifest

Konfiguracja dodatku, która jest udostępniana we wszystkich aplikacjach hosta dodatku.

Pola
name

string

Wymagane. Wyświetlana nazwa dodatku.

logoUrl

string

Wymagane. URL obrazu logo wyświetlanego na pasku narzędzi dodatku.

layoutProperties

LayoutProperties

Typowe właściwości układu kart dodatku.

addOnWidgetSet

AddOnWidgetSet

Widżety używane w dodatku. Jeśli to pole nie jest określone, używany jest domyślny zestaw.

useLocaleFromApp

bool

Czy przekazywać informacje o ustawieniach regionalnych z aplikacji hosta.

homepageTrigger

HomepageExtensionPoint

Określa punkt końcowy, który będzie wykonywany w dowolnym kontekście i na dowolnym hoście. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać przyćmione przez treści kontekstowe, gdy ten dodatek zadeklaruje bardziej precyzyjne wyzwalacze.

universalActions[]

UniversalActionExtensionPoint

Definiuje listę punktów rozszerzeń w menu działań uniwersalnych, 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.

openLinkUrlPrefixes

ListValue

Działanie OpenLink może używać tylko adresu URL ze schematem HTTPS, MAILTO lub TEL. W przypadku linków HTTPS adres URL musi też pasować do jednego z prefiksów określonych na liście dozwolonych. Jeśli prefiks nie zawiera schematu, przyjmuje się wartość HTTPS. Linki HTTP są automatycznie przekształcane w linki HTTPS.

CreateActionExtensionPoint

Konfiguracja wyzwalacza, który uruchamia się, gdy użytkownik wywoła proces tworzenia zasobu w aplikacji Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm z menu @.

Pola
id

string

Wymagane. Unikalny identyfikator odróżniający ten punkt rozszerzenia. Identyfikator może mieć maksymalnie 64 znaki i powinien mieć format [a-zA-Z0-9-]+.

labelText

string

Wymagane. Tekst wyświetlany obok ikony punktu wejścia tworzenia zasobu, np. Create support case. Ten tekst jest statyczny i wyświetla się, zanim użytkownicy uruchomią dodatek.

localizedLabelText

map<string, string>

Opcjonalnie: Mapa labelText do lokalizowania na inne języki. Język podaj w formacie ISO 639, a kraj lub region w formacie ISO 3166. Oddziel je myślnikiem -. Na przykład: en-US.

Jeśli język użytkownika jest obecny w kluczach mapy, zobaczy on zlokalizowaną wersję labelText.

runFunction

string

Wymagane. Punkt końcowy do wykonania, gdy proces tworzenia zasobu zostanie uruchomiony w celu utworzenia linku.

logoUrl

string

Opcjonalnie: Ikona wyświetlana w punkcie wejścia do tworzenia zasobów. Jeśli ten parametr zostanie pominięty, menu będzie używać ikony paska narzędzi dodatku logoUrl.

GranularOauthPermissionSupport

Określa, czy dodatek ma włączoną szczegółową akceptację OAuth.

Wartości w polu enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Wartość domyślna, której nie należy używać.
OPT_IN Dodatek ma włączoną szczegółową zgodę na OAuth.
OPT_OUT Dodatek nie korzysta ze szczegółowej akceptacji OAuth.

HomepageExtensionPoint

Typowy format deklarowania widoku strony głównej dodatku.

Pola
runFunction

string

Wymagane. Punkt końcowy do wykonania po aktywowaniu tego punktu rozszerzenia.

enabled

BoolValue

Opcjonalnie: Jeśli ta opcja jest ustawiona na false, widok strony głównej jest w tym kontekście dezaktywowany.

Jeśli nie zostanie ustawiony, domyślna wartość to true.

Jeśli niestandardowy widok strony głównej dodatku jest wyłączony, użytkownicy zobaczą ogólną kartę przeglądu.

HttpAuthorizationHeader

Nagłówek autoryzacji wysyłany w żądaniach dodatku HTTP.

Wartości w polu enum
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Wartość domyślna, równa SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Wysyłanie tokena tożsamości dla konta usługi systemowej dodatku Google Workspace powiązanego z projektem (domyślnie).
USER_ID_TOKEN Wysyłanie tokena identyfikacyjnego użytkownika.
NONE Nie wysyłaj nagłówka Authentication.

HttpOptions

Opcje wysyłania żądań do punktów końcowych dodatku HTTP.

Pola
authorizationHeader

HttpAuthorizationHeader

Konfiguracja tokena wysyłanego w nagłówku autoryzacji HTTP.

granularOauthPermissionSupport

GranularOauthPermissionSupport

Określa, czy dodatek ma włączoną szczegółową akceptację OAuth.

LayoutProperties

Właściwości układu karty są wspólne dla wszystkich aplikacji hosta dodatku.

Pola
primaryColor

string

Główny kolor dodatku. Ustawia kolor paska narzędzi. Jeśli nie ustawisz koloru podstawowego, użyta zostanie wartość domyślna podana przez platformę.

secondaryColor

string

Drugi kolor dodatku. Ustawia kolor przycisków. Jeśli kolor podstawowy jest ustawiony, ale kolor dodatkowy nie jest ustawiony, kolor dodatkowy jest taki sam jak kolor podstawowy. Jeśli nie ustawisz ani koloru podstawowego, ani dodatkowego, zostanie użyta wartość domyślna podana przez platformę.

useNewMaterialDesign
(deprecated)

bool

Włącza projektowanie materiałów dla kart.

LinkPreviewExtensionPoint

Konfiguracja wyzwalacza, który uruchamia się, gdy użytkownik wpisze lub wklei link z usługi innej firmy lub usługi spoza Google do pliku Dokumentów, Arkuszy lub Prezentacji Google.

Pola
labelText

string

Wymagane. Tekst przykładowego elementu inteligentnego, który zachęca użytkowników do wyświetlenia podglądu linku, np. Example: Support case. Ten tekst jest statyczny i wyświetla się, zanim użytkownicy uruchomią dodatek.

localizedLabelText

map<string, string>

Opcjonalnie: Mapa labelText do lokalizowania na inne języki. Język podaj w formacie ISO 639, a kraj lub region w formacie ISO 3166. Oddziel je myślnikiem -. Na przykład: en-US.

Jeśli język użytkownika jest obecny w kluczach mapy, zobaczy on zlokalizowaną wersję labelText.

patterns[]

UriPattern

Wymagane. Tablica wzorców adresów URL, które powodują wyświetlanie podglądu linków przez dodatek.

runFunction

string

Wymagane. Punkt końcowy do wykonania po wywołaniu podglądu linku.

logoUrl

string

Opcjonalnie: Ikona wyświetlana w inteligentnym tagu i na karcie podglądu. Jeśli zostanie pominięta, dodatek użyje ikony paska narzędzi logoUrl.

Typowy format deklarowania elementu menu lub przycisku, który pojawia się w aplikacji hostującej.

Pola
runFunction

string

Wymagane. Punkt końcowy do wykonania po aktywowaniu tego punktu rozszerzenia.

label

string

Wymagane. Tekst widoczny dla użytkownika, który opisuje działanie podjęte po aktywowaniu tego punktu rozszerzenia. Na przykład „Wstaw fakturę”.

logoUrl

string

URL obrazu logo wyświetlanego na pasku narzędzi dodatku.

Jeśli nie jest ustawiony, przyjmuje się domyślnie adres URL głównego logo dodatku.

UniversalActionExtensionPoint

Format deklarowania punktu rozszerzenia elementu menu działań uniwersalnych.

Pola
label

string

Wymagane. Tekst widoczny dla użytkownika, który opisuje działanie po aktywowaniu tego punktu rozszerzenia, np. „Dodaj nowy kontakt”.

Pole zbiorcze action_type. Wymagane. Typ działania obsługiwany w przypadku elementu menu działania uniwersalnego. Może to być link do otwarcia lub punkt końcowy do wykonania. action_type może mieć tylko jedną z tych wartości:
runFunction

string

Punkt końcowy, który ma być uruchamiany przez UniversalAction.

UriPattern

Konfiguracja każdego wzorca adresu URL, który wywołuje podgląd linku.

Pola
hostPattern

string

Wymagany w przypadku każdego wzorca adresu URL, który ma być wyświetlany w podglądzie. Domena wzorca adresu URL. Dodatek wyświetla podgląd linków, które zawierają tę domenę w adresie URL. Aby wyświetlić podgląd linków do konkretnej subdomeny, np. subdomain.example.com, uwzględnij ją. Aby wyświetlić podgląd linków do całej domeny, jako subdomenę podaj symbol wieloznaczny w postaci gwiazdki (*).

Na przykład *.example.com pasuje do subdomain.example.comanother.subdomain.example.com.

pathPrefix

string

Opcjonalnie: Ścieżka, która dołącza domenę hostPattern.

Jeśli na przykład wzorzec hosta adresu URL to support.example.com, aby dopasować adresy URL przypadków hostowanych w domenie support.example.com/cases/, wpisz cases.

Aby dopasować wszystkie adresy URL w domenie wzorca hosta, pozostaw pole pathPrefix puste.