- Zasób: Deployment
- Dodatki
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- Bezwarunkowany element reguły
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- Nagłówek HTTPAuthorization
- 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 protokołu OAuth Google, w przypadku których należy zażądać zgody od użytkownika przed wykonaniem dodatku w punkcie końcowym. |
add |
Konfiguracja dodatku do Google Workspace. |
etag |
Ta wartość jest obliczana przez serwer na podstawie wersji wdrożenia w magazynie i może być wysyłana w prośbach o aktualizację lub usunięcie, aby zapewnić klientowi aktualną wartość przed kontynuacją. |
Dodatki
Konfiguracja dodatku do Google Workspace.
Zapis JSON |
---|
{ "common": { object ( |
Pola | |
---|---|
common |
Konfiguracja wspólna dla wszystkich dodatków do 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 w 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 widocznego na pasku narzędzi dodatku. |
layout |
Typowe właściwości układu kart dodatkowych. |
add |
Widżety używane w dodatku. Jeśli to pole nie jest określone, używane jest ustawienie domyślne. |
use |
Określa, czy informacje o lokalizacji mają być przekazywane z aplikacji hosta. |
homepage |
Definiuje 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żytkowników, ale mogą zostać przysłonięte przez treści kontekstowe, gdy dodatek zadeklaruje bardziej ukierunkowane reguły. |
universal |
Definiuje listę punktów rozszerzenia w menu czynności uniwersalnej, które pełni rolę 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 OpenLink 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. Określa kolor paska narzędzi. Jeśli nie ustawisz koloru podstawowego, zostanie użyta wartość domyślna podana przez platformę. |
secondary |
Kolor drugorzędny dodatku. Ustawia kolor przycisków. Jeśli ustawiono kolor podstawowy, ale nie ustawiono koloru dodatkowego, jest on 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 interfejs Material Design na kartach. |
AddOnWidgetSet
Podzbiór widżetu 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 |
Stylizowane przyciski obejmują przyciski wypełnione i nieaktywne. |
PERSISTENT_FORMS |
Trwałe formularze umożliwiają utrwalanie wartości formularzy podczas wykonywania działań. |
FIXED_FOOTER |
Poprawiono 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 ma zastosowanie do interfejsu tworzenia dodatku. |
HomepageExtensionPoint
Popularny format deklarowania 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żytkowników, który opisuje działanie wykonane przez aktywację 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
Dostosowywanie wyglądu i działania dodatku w Gmailu.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Definiuje punkt końcowy, który będzie wykonywany w kontekstach, które nie pasują do zadeklarowanego aktywatora kontekstowego. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkowników, ale mogą zostać przysłonięte przez treści kontekstowe, gdy dodatek zadeklaruje bardziej ukierunkowane reguły. Jeśli występuje, zastępuje to konfigurację z |
contextual |
Określa zestaw warunków, które powodują uruchomienie dodatku. |
universal |
Określa zestaw działań uniwersalnych dla dodatku. Użytkownik aktywuje działania uniwersalne z menu dodatku na pasku narzędzi. |
compose |
Definiuje wyzwalacz czasu tworzenia dla dodatku czasu tworzenia. Jest to aktywator, który powoduje, że wtyczka wykonuje działanie, gdy użytkownik tworzy e-maila. Wszystkie dodatki podczas tworzenia wiadomości 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 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 stosuje do wyświetlania dodatku. trigger może być tylko jednym z tych elementów: |
|
unconditional |
Aktywatory bezwarunkowe są wykonywane po otwarciu dowolnej wiadomości. |
UnconditionalTrigger
Ten typ nie zawiera 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żytkowników opisujący działanie, na przykład „Dodaj nowy kontakt”. |
Pole sumy 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 uruchomi określone 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[] |
Określa zestaw działań dla dodatku dotyczącego czasu tworzenia. 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
Typowy format deklarowania pozycji menu lub przycisku wyświetlanego w aplikacji hostującej.
Zapis JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonywania po aktywowaniu tego punktu rozszerzenia. |
label |
Wymagane. Tekst widoczny dla użytkowników, który opisuje działanie wykonane przez aktywację 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 dodatek do tworzenia wiadomości został aktywowany, aktywator tworzenia wiadomości nie ma dostępu do żadnych danych wersji roboczej. |
METADATA |
Przyznaje aktywatorowi tworzenia wiadomości uprawnienia dostępu do metadanych wersji roboczej po aktywowaniu dodatku do tworzenia wiadomości. Obejmuje to listę odbiorców, np. listę Do i DW w wersji roboczej wiadomości. |
DriveAddOnManifest
Właściwości do dostosowywania wyglądu i działania dodatku do Dysku.
Zapis JSON |
---|
{ "homepageTrigger": { object ( |
Pola | |
---|---|
homepage |
Jeśli występuje, zastępuje to konfigurację z |
on |
Odpowiada to działaniu, które jest wykonywane po zaznaczeniu elementów w odpowiednim widoku Dysku, takim jak lista dokumentów na Moim dysku. |
DriveExtensionPoint
Typowy format deklarowania aktywatorów dodatku do Dysku.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonywania po aktywowaniu punktu rozszerzenia. |
CalendarAddOnManifest
Właściwości do dostosowywania 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żytkowników, ale mogą zostać przysłonięte przez treści kontekstowe, gdy dodatek zadeklaruje bardziej ukierunkowane reguły. Jeśli występuje, zastępuje to konfigurację z |
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 jest otwarte, aby można było je wyświetlić lub edytować. |
event |
Punkt końcowy, który jest wyzwalany po zaktualizowaniu zdarzenia otwartego. |
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 po aktywowaniu dodatku do zdarzenia. |
ConferenceSolution
Określa wartości związane z konferencją. Dodatki do rozmów wideo innych firm można tworzyć tylko w Apps Script.
Zapis JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Pola | |
---|---|
on |
Wymagane. Punkt końcowy, który należy wywołać, gdy mają zostać utworzone 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ć wyświetlaną nazwę dodatku, ale nie zmieniaj identyfikatora. |
name |
Wymagane. Wyświetlana nazwa rozwiązania konferencyjnego. |
logo |
Wymagane. Adres URL obrazu logo rozwiązania konferencyjnego. |
CalendarExtensionPoint
Typowy format deklarowania aktywatorów dodatku do kalendarza.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonywania po aktywowaniu tego punktu rozszerzenia. |
EventAccess
Typ enumeracji określający poziom dostępu do danych wymaganych przez wyzwalacze zdarzeń.
Wartości w polu enum | |
---|---|
UNSPECIFIED |
Wartość domyślna, gdy nie ustawiono wartości eventAccess. |
METADATA |
Przyznaje wydarzeniu uprawnienia dostępu do metadanych wydarzeń, takich jak identyfikator wydarzenia i identyfikator kalendarza. |
READ |
Daje wyzwalaczom zdarzeń dostęp do wszystkich podanych pól zdarzenia, w tym metadanych, list 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 ustawienia danych konferencji. |
READ_WRITE |
Przyznaje aktywatorom zdarzeń dostęp do wszystkich podanych pól wydarzeń, w tym metadanych, uczestników i danych konferencji, oraz możliwość wykonywania 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, który ma być uruchamiany po przyznaniu autoryzacji zakresu plików dla tej pary dokumentu/użytkownika. |
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 linków za pomocą elementów inteligentnych. |
create |
Lista punktów rozszerzeń umożliwiających tworzenie 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 aktywatorów 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 uruchamianej, gdy użytkownik wpisze lub wklej link z usługi innej firmy lub usługi innej firmy 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 prosi użytkowników o wyświetlenie podglądu linku, np. |
localized |
Opcjonalnie: Mapa: Jeśli w kluczach mapy znajduje się język użytkownika, użytkownik widzi zlokalizowaną wersję interfejsu 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 z określonej 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 aktywatora, która jest uruchamiana, gdy użytkownik wywoła przepływ pracy tworzenia zasobów w aplikacji Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm za pomocą menu @.
Zapis JSON |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Pola | |
---|---|
id |
Wymagane. Unikalny identyfikator do rozróżniania 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 zasobu, np. |
localized |
Opcjonalnie: Mapa: Jeśli w kluczach mapy znajduje się język użytkownika, użytkownik widzi zlokalizowaną wersję interfejsu Obiekt zawierający listę par |
run |
Wymagane. Punkt końcowy, który ma być wykonywany po aktywowaniu przepływu pracy tworzenia zasobów w celu utworzenia połączenia. |
logo |
Opcjonalnie: Ikona wyświetlana dla punktu wejścia tworzenia zasobu. Jeśli nie zostanie podany, menu będzie używać ikony paska narzędzi dodatku |
SheetsAddOnManifest
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, który ma być uruchamiany po przyznaniu autoryzacji zakresu plików dla tej pary dokumentu/użytkownika. |
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ądu linków z elementami inteligentnymi. |
SheetsExtensionPoint
Typowy format deklarowania aktywatorów dodatku do Arkuszy.
Zapis JSON |
---|
{ "runFunction": string } |
Pola | |
---|---|
run |
Wymagane. Punkt końcowy do wykonywania po aktywowaniu 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, który ma być uruchamiany po przyznaniu autoryzacji zakresu plików dla tej pary dokumentu/użytkownika. |
link |
Lista punktów rozszerzeń umożliwiających wyświetlanie 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 dodatkowych punktów końcowych HTTP
.
Zapis JSON |
---|
{
"authorizationHeader": enum ( |
Pola | |
---|---|
authorization |
Konfiguracja tokena wysłanego w nagłówku autoryzacji |
HttpAuthorizationHeader
Nagłówek autoryzacji wysłany w żądaniach dodatku HTTP
.
Wartości w polu enum | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Wartość domyślna odpowiadająca wartości SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Wysyłanie tokenu identyfikacyjnego na konto usługi systemowej Google Workspace powiązane z danym projektem (domyślnie). |
USER_ID_TOKEN |
Wyślij token identyfikatora użytkownika. |
NONE |
Nie wysyłaj nagłówka uwierzytelniania. |
Metody |
|
---|---|
|
Tworzy wdrożenie o określonej nazwie i konfiguracji. |
|
Usuwa wdrożenie o danej 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 podanej nazwie. |
|
Odinstaluj z konta użytkownika testowe wdrożenie. |