REST Resource: projects.deployments

Zasób: wdrożenie

wdrożenie dodatku do Google Workspace,

Zapis JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Pola
name

string

Nazwa zasobu wdrożenia. Przykład: projects/123/deployments/my_deployment.
oauthScopes[]

string

Lista zakresów protokołu OAuth Google, o które należy poprosić użytkownika przed wykonaniem punktu końcowego dodatku.
addOns

object (AddOns)

Konfiguracja dodatku do Google Workspace.
etag

string

Ta wartość jest obliczana przez serwer na podstawie wersji wdrożenia w pamięci masowej i może być wysyłana w żądaniach aktualizacji i usunięcia, aby klient miał aktualną wartość przed kontynuowaniem.

AddOns

Konfiguracja dodatku do Google Workspace.

Zapis JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Pola
common

object (CommonAddOnManifest)

Konfiguracja wspólna dla wszystkich dodatków do Google Workspace.
gmail

object (GmailAddOnManifest)

Konfiguracja dodatku w Gmailu.
drive

object (DriveAddOnManifest)

Konfiguracja dodatku do Dysku.
calendar

object (CalendarAddOnManifest)

Konfiguracja dodatku do Kalendarza.
docs

object (DocsAddOnManifest)

Konfiguracja dodatku do Dokumentów.
meet

object (MeetAddOnManifest)

Konfiguracja dodatku do Meet.
sheets

object (SheetsAddOnManifest)

Konfiguracja dodatku do Arkuszy.
slides

object (SlidesAddOnManifest)

Konfiguracja dodatku do Prezentacji.
httpOptions

object (HttpOptions)

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

CommonAddOnManifest

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

Zapis JSON 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
Pola
name

string

Wymagane. Wyświetlana nazwa dodatku.
logoUrl

string

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

object (LayoutProperties)

Wspólne właściwości układu kart dodatku.
addOnWidgetSet

object (AddOnWidgetSet)

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

boolean

Określa, czy przekazywać informacje o ustawieniach regionalnych z aplikacji hosta.
homepageTrigger

object (HomepageExtensionPoint)

Definiuje 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ć przesłonięte przez treści kontekstowe, gdy ten dodatek zadeklaruje bardziej ukierunkowane aktywatory.
universalActions[]

object (UniversalActionExtensionPoint)

Definiuje listę punktów rozszerzenia w menu czynności 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

array (ListValue format)

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ż być zgodny z jednym z prefiksów określonych na liście dozwolonych. Jeśli prefiks nie zawiera schematu, przyjmuje się, że jest to HTTPS. Linki HTTP są automatycznie przekształcane w linki HTTPS.

LayoutProperties

Właściwości układu karty udostępniane we wszystkich aplikacjach hostowanych dodatku.

Zapis JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Pola
primaryColor

string

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

string

Kolor drugorzędny dodatku. Ustawia 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 ustawiono koloru podstawowego ani dodatkowego, używana jest wartość domyślna podana przez platformę.
useNewMaterialDesign
(deprecated)

boolean

Włącza styl Material Design dla kart.

AddOnWidgetSet

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

Zapis JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Pola
usedWidgets[]

enum (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 Przyciski stylizowane obejmują przyciski wypełnione i dezaktywowane.
PERSISTENT_FORMS Formularze trwałe 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 dotyczy interfejsu tworzenia wiadomości.

HomepageExtensionPoint

Typowy format deklarowania widoku strony głównej dodatku.

Zapis JSON 
{
  "runFunction": string,
  "enabled": boolean
}
Pola
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu tego punktu rozszerzenia.
enabled

boolean

Opcjonalnie: Jeśli ustawisz wartość false, widok strony głównej w tym kontekście zostanie wyłączony.

Jeśli nie zostanie ustawiona, domyślnie przyjmuje wartość true.

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

UniversalActionExtensionPoint

Format deklarowania punktu rozszerzenia pozycji menu czynności uniwersalnego.

Zapis JSON 
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
Pola
label

string

Wymagane. Widoczny dla użytkownika tekst opisujący działanie podejmowane po aktywowaniu tego punktu rozszerzenia, np. „Dodaj nowy kontakt”.
Wymagane. Typ działania obsługiwany w elemencie menu czynności uniwersalnego. Może to być link do otwarcia lub punkt końcowy do wykonania. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
runFunction

string

Punkt końcowy, który ma zostać uruchomiony przez UniversalAction.
Koniec pól wykluczających się wzajemnie.

GmailAddOnManifest

Właściwości dostosowujące wygląd i działanie dodatku w Gmailu.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Definiuje punkt końcowy, który będzie wykonywany w kontekstach niezgodnych z zadeklarowanym aktywatorem kontekstowym. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać przesłonięte przez treści kontekstowe, gdy ten dodatek zadeklaruje bardziej ukierunkowane reguły.

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

Definiuje zestaw warunków, które aktywują dodatek.
universalActions[]

object (UniversalAction)

Definiuje zestaw działań uniwersalnych dodatku. Użytkownik aktywuje działania uniwersalne z menu paska narzędzi dodatku.
composeTrigger

object (ComposeTrigger)

Definiuje aktywator czasu tworzenia wiadomości dla dodatku do tworzenia wiadomości. To jest aktywator, który powoduje, że dodatek podejmuje działanie, gdy użytkownik tworzy e-maila. Wszystkie dodatki do tworzenia wiadomości muszą mieć zakres gmail.addons.current.action.compose, nawet jeśli nie edytują wersji roboczej.
authorizationCheckFunction

string

Nazwa punktu końcowego, który sprawdza, czy dodatek ma wszystkie wymagane autoryzacje innych firm, przez sondowanie interfejsów API innych firm. Jeśli próba się nie powiedzie, funkcja powinna zgłosić wyjątek, aby rozpocząć proces autoryzacji. Ta funkcja jest wywoływana przed każdym wywołaniem dodatku, aby zapewnić użytkownikom płynne działanie.

ContextualTrigger

Definiuje regułę, która uruchamia się, gdy otwarty e-mail spełnia określone kryteria. Gdy aktywuje się reguła, uruchamia określony punkt końcowy, zwykle w celu utworzenia nowych kart i zaktualizowania interfejsu.

Zapis JSON 
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Pola
onTriggerFunction

string

Wymagane. Nazwa punktu końcowego, który ma zostać wywołany, gdy wiadomość pasuje do aktywatora.
Typ aktywatora określa warunki, których Gmail używa do wyświetlania dodatku. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
unconditional

object (UnconditionalTrigger)

Reguły bezwarunkowe są wykonywane po otwarciu dowolnej wiadomości e-mail.
Koniec pól wykluczających się wzajemnie.

UnconditionalTrigger

Ten typ nie ma pól.

Aktywator uruchamiany, gdy zostanie otwarta dowolna 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,

  "openLink": string,
  "runFunction": string
}
Pola
text

string

Wymagane. Tekst widoczny dla użytkownika, który opisuje działanie, np. „Dodaj nowy kontakt”.
Typ działania określa zachowanie Gmaila, gdy użytkownik wywoła działanie. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
runFunction

string

Punkt końcowy, który jest wywoływany, gdy użytkownik wyzwala działanie. Szczegółowe informacje znajdziesz w przewodniku po działaniach uniwersalnych.
Koniec pól wykluczających się wzajemnie.

ComposeTrigger

Aktywator, który uruchamia się, gdy użytkownik tworzy e-maila.

Zapis JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Pola
actions[]

object (MenuItemExtensionPoint)

Definiuje zestaw działań dodatku do tworzenia wiadomości. Są to działania, które użytkownicy mogą wywołać w dodatku do tworzenia wiadomości.
draftAccess

enum (DraftAccess)

Określa poziom dostępu do danych, gdy dodatek do tworzenia wiadomości jest uruchamiany.

DraftAccess

Typ wyliczeniowy, który określa poziom dostępu do danych wymagany przez aktywator tworzenia wiadomości.

Wartości w polu enum
UNSPECIFIED Wartość domyślna, gdy nie ustawiono niczego dla draftaccess.
NONE Gdy aktywuje się dodatek do tworzenia wiadomości, aktywator tworzenia wiadomości nie ma dostępu do żadnych danych wersji roboczej.
METADATA Zezwala aktywatorowi tworzenia wiadomości na dostęp do metadanych wersji roboczej, gdy aktywowany jest dodatek do tworzenia wiadomości. Obejmuje to listę odbiorców, np. listę adresatów i adresatów kopii w wersji roboczej wiadomości.

DriveAddOnManifest

Właściwości dostosowujące wygląd i działanie dodatku do Dysku.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Odpowiada zachowaniu, które jest wykonywane, gdy elementy są wybierane w odpowiednim widoku Dysku, np. na liście dokumentów na Moim dysku.

DriveExtensionPoint

Typowy format deklarowania aktywatorów dodatku do Dysku.

Zapis JSON 
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu punktu rozszerzenia.

CalendarAddOnManifest

Właściwości dostosowujące wygląd i działanie dodatku do Kalendarza.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Opcjonalnie: Definiuje punkt końcowy, który jest wykonywany w kontekstach niezgodnych z zadeklarowanym aktywatorem kontekstowym. Wszystkie karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać przesłonięte przez treści kontekstowe, gdy ten dodatek zadeklaruje bardziej ukierunkowane aktywatory.

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

Opcjonalnie: Definiuje rozwiązania do obsługi rozmów wideo udostępniane przez ten dodatek.
createSettingsUrlFunction

string

Punkt końcowy do wykonania, który tworzy adres URL strony ustawień dodatku.
eventOpenTrigger

object (CalendarExtensionPoint)

Punkt końcowy, który jest wywoływany, gdy wydarzenie jest otwierane do wyświetlenia lub edycji.
eventUpdateTrigger

object (CalendarExtensionPoint)

Punkt końcowy, który jest wywoływany, gdy zdarzenie otwarcia zostanie zaktualizowane.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Opcjonalnie: Aktywowane, gdy wydarzenie zostanie utworzone lub zaktualizowane w kalendarzu, który subskrybuje użytkownik. Dotyczy tylko aktywatorów utworzonych przez HTTP endpoints za pomocą CalendarSubscriptionActionMarkup.

Aby zapobiec rekurencyjnym pętlom powiadomień, gdy dodatek modyfikuje wydarzenie w Kalendarzu Google za pomocą interfejsu Calendar API z danymi uwierzytelniającymi z tego samego projektu w chmurze Google, który hostuje wdrożenie dodatku, platforma blokuje powiadomienia o modyfikacjach. Samodzielne wywoływanie interfejsu Calendar API we własnym projekcie nie jest obsługiwane.

Nie dotyczy Apps Script add-ons i Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Konfiguracja aktywatora kontekstowego, który uruchamia się, gdy użytkownik kliknie dostawcę załączników dodatku w menu Kalendarza.
currentEventAccess

enum (EventAccess)

Określa poziom dostępu do danych po aktywowaniu dodatku do wydarzenia.

ConferenceSolution

Definiuje wartości związane z rozmową konferencyjną.

Zapis JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Pola
onCreateFunction

string

Wymagane. Punkt końcowy, który ma zostać wywołany, gdy mają zostać utworzone dane rozmowy wideo.
id

string

Wymagane. Identyfikatory powinny być przypisane do rozwiązań do obsługi rozmów wideo w ramach jednego dodatku, w przeciwnym razie po uruchomieniu 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 należy zmieniać jego identyfikatora.
name

string

Wymagane. Wyświetlana nazwa rozwiązania do obsługi rozmów wideo.
logoUrl

string

Wymagane. Adres URL obrazu logo rozwiązania do obsługi rozmów wideo.

CalendarExtensionPoint

Typowy format deklarowania aktywatorów dodatku do Kalendarza.

Zapis JSON 
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu tego punktu rozszerzenia.

EventAccess

Typ wyliczeniowy, który określa poziom dostępu do danych wymagany przez reguły wywołujące zdarzenia.

Wartości w polu enum
UNSPECIFIED Wartość domyślna, gdy nie ustawiono wartości eventAccess.
METADATA Zezwala aktywatorom wydarzeń na dostęp do metadanych wydarzeń, takich jak identyfikator wydarzenia i identyfikator kalendarza.
READ Zapewnia aktywatorom wydarzeń dostęp do wszystkich podanych pól wydarzenia, w tym metadanych, uczestników i danych konferencji.
WRITE Zapewnia aktywatorom wydarzeń dostęp do metadanych wydarzeń i możliwość wykonywania wszystkich działań, w tym dodawania uczestników i konfigurowania danych konferencji.
READ_WRITE Zapewnia aktywatorom wydarzeń dostęp do wszystkich podanych pól wydarzenia, w tym metadanych, uczestników i danych konferencji, oraz możliwość wykonywania wszystkich działań.

DocsAddOnManifest

Właściwości dostosowujące wygląd i działanie dodatku do Dokumentów Google.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Punkt końcowy, który ma zostać wykonany, gdy zostanie przyznana autoryzacja zakresu pliku dla tej pary dokumentu i użytkownika.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Lista punktów rozszerzenia do wyświetlania podglądu linków w dokumencie Google. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.
createActionTriggers[]

object (CreateActionExtensionPoint)

Lista punktów rozszerzenia do tworzenia zasobów innych firm w aplikacjach Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm za pomocą menu @.

DocsExtensionPoint

Typowy format deklarowania aktywatorów dodatku do Dokumentów.

Zapis JSON 
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu tego punktu rozszerzenia.

LinkPreviewExtensionPoint

Konfiguracja aktywatora, który uruchamia się, 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 (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
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 (key: string, value: string)

Opcjonalnie: Mapa labeltext do zlokalizowania na inne języki. Sformatuj język zgodnie ze standardem ISO 639, a kraj lub region zgodnie ze standardem ISO 3166, oddzielając je łącznikiem -. Na przykład: en-US.

Jeśli region użytkownika jest obecny w kluczach mapy, użytkownik zobaczy zlokalizowaną wersję labeltext.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }
patterns[]

object (UriPattern)

Wymagane. Tablica wzorców adresów URL, które powodują, że dodatek wyświetla podgląd linków.
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu podglądu linku.
logoUrl

string

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

UriPattern

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

Zapis JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Pola
hostPattern

string

Wymagany w przypadku każdego wzorca adresu URL do podglądu. Domena wzorca adresu URL. Dodatek wyświetla podgląd linków, które zawierają tę domenę w adresie URL. Aby wyświetlać podgląd linków do konkretnej subdomeny, np. subdomain.example.com, dodaj ją. Aby wyświetlić podgląd linków dla całej domeny, jako subdomenę podaj symbol wieloznaczny z gwiazdką (*).

Na przykład *.example.com pasuje do subdomain.example.com i another.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 zgłoszeń hostowanych na support.example.com/cases/, wpisz cases.

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

CreateActionExtensionPoint

Konfiguracja aktywatora, który uruchamia się, 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 za pomocą menu @.

Zapis JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Pola
id

string

Wymagane. Unikalny identyfikator, który odróżnia ten punkt rozszerzenia. Identyfikator może mieć maksymalnie 64 znaki i powinien być w formacie [a-zA-Z0-9-]+.
labelText

string

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

map (key: string, value: string)

Opcjonalnie: Mapa labeltext do zlokalizowania na inne języki. Sformatuj język zgodnie ze standardem ISO 639, a kraj lub region zgodnie ze standardem ISO 3166, oddzielając je łącznikiem -. Na przykład: en-US.

Jeśli region użytkownika jest obecny w kluczach mapy, użytkownik zobaczy zlokalizowaną wersję labeltext.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany, gdy zostanie aktywowany przepływ pracy tworzenia zasobu w celu utworzenia linku.
logoUrl

string

Opcjonalnie: Ikona wyświetlana w punkcie wejścia do tworzenia zasobów. Jeśli go pominiesz, menu będzie używać ikony paska narzędzi dodatku logourl.

MeetAddOnManifest

Plik manifestu dodatku do Meet.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
web

object (Web)

Szczegółowe informacje o dodatkach, które ulepszają klienta internetowego Meet.
supportsCollaboration

boolean

Czy dodatek obsługuje współpracę lub zapraszanie innych osób do korzystania z dodatku.
termsUri

string

Link do warunków korzystania z dodatku, jeśli mają być wyświetlane.

Sieć

Szczegółowe informacje o dodatkach, które ulepszają klienta internetowego Meet.

Zapis JSON 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Pola
sidePanelUri
(deprecated)

string

Identyfikator URI elementu iframe panelu bocznego.
sidePanelUrl

string

Adres URL elementu iframe panelu bocznego.
mainStageUri
(deprecated)

string

Identyfikator URI elementu iframe „etapu głównego”.
supportsScreenSharing

boolean

Określa, czy dodatek obsługuje udostępnianie ekranu na głównym obszarze.
supportsCollaboration
(deprecated)

boolean

Czy dodatek obsługuje współpracę lub zapraszanie innych osób do korzystania z dodatku. To pole jest teraz wycofane. Użyj pola najwyższego poziomu w MeetAddOnManifest.
supportsPopOut

boolean

Określa, czy dodatek obsługuje otwieranie w przeglądarce w trybie obrazu w obrazie.
hostOrigins[]
(deprecated)

string

Wycofana, starsza nazwa. Źródła, które należy dodać do właściwości frame-src elementu iframe zawierającego witrynę innej firmy. Zamiast tego użyj zasady addonorigins.
addOnOrigins[]

string

Źródła, które należy dodać do właściwości frame-src elementu iframe zawierającego witrynę innej firmy.
openState

enum (State)

Stan początkowy po otwarciu dodatku.
supportsCollaborationHostControls

boolean

Określa, czy dodatek do współpracy obsługuje ustawienia gospodarza.
logoUrl

string

Adres URL logo, które ma być wyświetlane w przypadku dodatku. Jeśli nie podasz logo, domyślnie zostanie użyte logo z sekcji wspólnej pliku manifestu.
darkModeLogoUrl

string

Wersja logourl w trybie ciemnym.
displayFlow
(deprecated)

enum (DisplayFlow)

Przepływ wyświetlania, który dodatek będzie stosować po uruchomieniu.

Stan

Typ wyliczeniowy do określania początkowego stanu otwarcia dodatku.

Wartości w polu enum
STATE_UNSPECIFIED Stan początkowy nie został określony w dodatku.
SIDE_PANEL_ONLY Dodatek otworzy się z aktywnym tylko panelem bocznym.
MAIN_STAGE_ONLY Dodatek otwiera się z aktywną tylko główną częścią ekranu.
SIDE_PANEL_AND_MAIN_STAGE Dodatek otwiera się z aktywnym panelem bocznym i główną częścią ekranu.

DisplayFlow

Typ wyliczeniowy określający proces wyświetlania, który dodatek będzie stosować po uruchomieniu

Wartości w polu enum
DISPLAY_FLOW_UNSPECIFIED Nie określono procesu wyświetlania.
FOCUS Dodatek powinien uruchamiać się w trybie „skupienia”.
AUGMENT Dodatek powinien uruchamiać się w procesie wyświetlania „augment”.

SheetsAddOnManifest

Właściwości dostosowujące wygląd i działanie dodatku do Arkuszy Google.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Punkt końcowy, który ma zostać wykonany, gdy zostanie przyznane uprawnienie do zakresu pliku dla tej pary dokumentu i użytkownika.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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 za pomocą elementów inteligentnych.

SheetsExtensionPoint

Typowy format deklarowania aktywatorów dodatku do Arkuszy.

Zapis JSON 
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu tego punktu rozszerzenia.

SlidesAddOnManifest

Właściwości dostosowujące wygląd i działanie dodatku do Prezentacji Google.

Zapis JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli ta opcja jest dostępna, zastępuje konfigurację z addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Punkt końcowy, który ma zostać wykonany, gdy zostanie przyznane uprawnienie do zakresu pliku dla tej pary dokumentu i użytkownika.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Lista punktów rozszerzenia do wyświetlania podglądu linków w dokumencie Prezentacji Google. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

SlidesExtensionPoint

Typowy format deklarowania aktywatorów dodatku do Prezentacji.

Zapis JSON 
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy, który ma zostać wykonany po aktywowaniu tego punktu rozszerzenia.

HttpOptions

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

Zapis JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Pola
authorizationHeader

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

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

HttpAuthorizationHeader

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

Wartości w polu enum
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Wartość domyślna, odpowiednik SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Wysyłanie tokena identyfikacji dla konta usługi systemowej dodatku do Google Workspace powiązanego z projektem (domyślnie).
USER_ID_TOKEN wysłać token identyfikacji użytkownika,
NONE Nie wysyłaj nagłówka uwierzytelniania.

GranularOauthPermissionSupport

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

Wartości w polu enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Wartość domyślna, nie powinna być używana.
OPT_IN Dodatek korzysta z szczegółowej zgody OAuth.
OPT_OUT Dodatek nie korzysta ze szczegółowej zgody OAuth.

Metody

create

 Tworzy wdrożenie o określonej nazwie i konfiguracji.

delete

 Usuwa wdrożenie o podanej nazwie.

get

 Pobiera wdrożenie o określonej nazwie.

getInstallStatus

 Pobiera stan instalacji wdrożenia testowego.

install

 Instaluje wdrożenie na Twoim koncie w celu przetestowania.

list

 Wyświetla listę wszystkich wdrożeń w danym projekcie.

replaceDeployment

 Tworzy lub zastępuje wdrożenie o określonej nazwie.

uninstall

 Odinstalowuje wdrożenie testowe z konta użytkownika.