REST Resource: projects.deployments

Zasób: Deployment

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, w przypadku których przed wykonaniem punktu końcowego dodatku należy poprosić użytkownika o zgodę.

addOns

object (AddOns)

Konfiguracja dodatku do Google Workspace.

etag

string

Tę wartość oblicza serwer na podstawie wersji wdrożenia w pamięci. Może ona być wysyłana w żądaniach aktualizacji i usuwania, aby mieć pewność, że klient ma 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 hosta 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. URL obrazu logo wyświetlanego na pasku narzędzi dodatku.

layoutProperties

object (LayoutProperties)

Typowe 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 domyślny zestaw.

useLocaleFromApp

boolean

Czy przekazywać informacje o ustawieniach regionalnych z aplikacji hosta.

homepageTrigger

object (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[]

object (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

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ż 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.

LayoutProperties

Właściwości układu karty są wspólne dla wszystkich aplikacji hosta 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, 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)

boolean

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

AddOnWidgetSet

Podzbiór widżetów używanych 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 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.

HomepageExtensionPoint

Typowy format deklarowania widoku strony głównej dodatku.

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

string

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

enabled

boolean

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.

UniversalActionExtensionPoint

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

Zapis JSON
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
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.

GmailAddOnManifest

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

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

object (HomepageExtensionPoint)

Określa punkt końcowy, który będzie wykonywany w kontekstach, które nie pasują do zadeklarowanego wyzwalacza kontekstowego. Karty wygenerowane przez tę funkcję będą zawsze dostępne dla użytkownika, ale mogą zostać zastąpione przez treści kontekstowe, gdy ten dodatek zadeklaruje bardziej precyzyjne wyzwalacze.

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

contextualTriggers[]

object (ContextualTrigger)

Określa zestaw warunków, które aktywują dodatek.

universalActions[]

object (UniversalAction)

Określa zestaw uniwersalnych działań dla dodatku. Użytkownik wywołuje działania uniwersalne z menu paska narzędzi dodatku.

composeTrigger

object (ComposeTrigger)

Definiuje wyzwalacz czasu tworzenia dla dodatku czasu tworzenia. Jest to aktywator, który powoduje, że dodatek podejmuje działanie, gdy użytkownik pisze 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, poprzez sondowanie interfejsów API tych firm. Jeśli test się nie powiedzie, funkcja powinna zgłosić wyjątek, aby zainicjować proces autoryzacji. Ta funkcja jest wywoływana przed każdym wywołaniem dodatku, aby zapewnić użytkownikowi jak najlepsze wrażenia.

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.

Zapis JSON
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
Pola
onTriggerFunction

string

Wymagane. Nazwa punktu końcowego, do którego należy zadzwonić, gdy wiadomość pasuje do aktywatora.

Pole zbiorcze trigger. Rodzaj wyzwalacza określa warunki, których Gmail używa do wyświetlania dodatku. trigger może mieć tylko jedną z tych wartości:
unconditional

object (UnconditionalTrigger)

Wywoływacze bezwarunkowe są wykonywane po otwarciu dowolnej wiadomości.

UnconditionalTrigger

Ten typ nie ma pól.

Aktywator, który uruchamia się po otwarciu dowolnego e-maila.

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 action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Pola
text

string

Wymagane. Tekst widoczny dla użytkownika opisujący działanie, np. „Dodaj nowy kontakt”.

Pole zbiorcze action_type. Typ działania określa zachowanie Gmaila, gdy użytkownik wywoła to działanie. action_type może mieć tylko jedną z tych wartości:
runFunction

string

Punkt końcowy wywoływany, gdy użytkownik wywoła działanie. Szczegółowe informacje znajdziesz w przewodniku po działaniach uniwersalnych.

ComposeTrigger

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

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

object (MenuItemExtensionPoint)

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

draftAccess

enum (DraftAccess)

Określa poziom dostępu do danych, gdy zostanie uruchomiony dodatek czasu tworzenia.

DraftAccess

Wyliczenie określające poziom dostępu do danych wymagany przez wyzwalacz tworzenia.

Wartości w polu enum
UNSPECIFIED Wartość domyślna, gdy dla parametru draftaccess nie ustawiono żadnej wartości.
NONE Gdy dodatek do pisania jest aktywowany, wyzwalacz pisania nie ma dostępu do żadnych danych wersji roboczej.
METADATA Udziela wyzwalaczowi tworzenia uprawnień dostępu do metadanych wersji roboczej, gdy zostanie wywołany dodatek do tworzenia. Obejmuje to listę odbiorców, np. listę Do i DW 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ąpi konfigurację z addons.common.homepageTrigger.

onItemsSelectedTrigger

object (DriveExtensionPoint)

Odpowiada działaniu, 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 wyzwalaczy dodatku do Dysku.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy do wykonania 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)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Określa punkt końcowy, który jest wykonywany w kontekstach, które nie pasują do zadeklarowanego wyzwalacza kontekstowego. 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.

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

conferenceSolution[]

object (ConferenceSolution)

Określa rozwiązania konferencyjne udostępniane przez ten dodatek. Dodatki do obsługi rozmów wideo innych firm można tworzyć tylko w Apps Script.

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

Punkt końcowy, który jest wywoływany, gdy wydarzenie zostanie otwarte w celu wyświetlenia lub edycji.

eventUpdateTrigger

object (CalendarExtensionPoint)

Punkt końcowy, który jest wywoływany po zaktualizowaniu zdarzenia otwarcia.

eventAttachmentTrigger

object (MenuItemExtensionPoint)

Konfiguracja czynnika 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 wywołaniu dodatku 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 Apps Script.

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

string

Wymagane. Punkt końcowy, do którego należy wysłać wywołanie, gdy mają zostać utworzone dane konferencji.

id

string

Wymagane. Identyfikatory powinny być przypisywane w unikalny sposób w ramach rozwiązań do obsługi rozmów wideo w jednym dodatku. W przeciwnym razie po uruchomieniu dodatku może zostać użyte nieprawidłowe rozwiązanie do obsługi rozmów wideo. Możesz zmienić nazwę wyświetlaną dodatku, ale nie jego identyfikator.

name

string

Wymagane. Wyświetlana nazwa rozwiązania konferencyjnego.

logoUrl

string

Wymagane. Adres URL obrazu logo rozwiązania konferencyjnego.

CalendarExtensionPoint

Typowy format deklarowania wyzwalaczy dodatku do Kalendarza.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

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

EventAccess

Wyliczenie określające poziom dostępu do danych, którego wymagają wyzwalacze zdarzeń.

Wartości w polu enum
UNSPECIFIED Wartość domyślna, gdy dla parametru eventAccess nie ustawiono żadnej wartości.
METADATA Umożliwia wyzwalaczom zdarzeń dostęp do metadanych zdarzeń, takich jak identyfikator zdarzenia i identyfikator kalendarza.
READ Umożliwia wyzwalaczom zdarzeń dostęp do wszystkich podanych pól zdarzeń, w tym metadanych, uczestników i danych konferencji.
WRITE Umożliwia wyzwalaczom zdarzeń dostęp do metadanych zdarzeń i wykonywanie wszystkich działań, w tym dodawanie uczestników i ustawianie danych konferencji.
READ_WRITE Umożliwia wyzwalaczom zdarzeń dostęp do wszystkich podanych pól zdarzeń, w tym metadanych, uczestników i danych konferencji, oraz wykonywanie 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ąpi konfigurację z addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Punkt końcowy do wykonania, gdy autoryzacja zakresu pliku zostanie przyznana dla tej pary dokument/użytkownik.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

createActionTriggers[]

object (CreateActionExtensionPoint)

Lista punktów rozszerzeń do tworzenia zasobów innych firm w aplikacjach Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm z menu @.

DocsExtensionPoint

Typowy format deklarowania wywołań dodatku do Dokumentów.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

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

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.

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 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.

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ą 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.

UriPattern

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

Zapis JSON
{
  "hostPattern": string,
  "pathPrefix": string
}
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.

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 @.

Zapis JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
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 (key: string, value: 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.

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

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.

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ąpi konfigurację z addons.common.homepageTrigger.

web

object (Web)

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

supportsCollaboration

boolean

czy dodatek obsługuje współpracę lub zapraszanie innych osób do korzystania z niego.

termsUri

string

Powinien być widoczny link do warunków korzystania z dodatku (jeśli takie istnieją).

Sieć

Szczegółowe informacje o dodatkach, które rozszerzają funkcje 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 ramki iFrame panelu bocznego.

sidePanelUrl

string

Adres URL elementu iframe panelu bocznego.

mainStageUri
(deprecated)

string

Identyfikator URI ramki iframe „głównej sceny”.

supportsScreenSharing

boolean

Określa, czy dodatek obsługuje udostępnianie ekranu głównego.

supportsCollaboration
(deprecated)

boolean

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

supportsPopOut

boolean

Określa, czy dodatek obsługuje wyskakujące okienko w przeglądarce.

hostOrigins[]
(deprecated)

string

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

addOnOrigins[]

string

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

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 zostanie określone, logo będzie domyślnie ustawione na logo w sekcji wspólnej pliku manifestu.

darkModeLogoUrl

string

Wersja adresu URL logo w trybie ciemnym.

displayFlow
(deprecated)

enum (DisplayFlow)

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

Stan

Wyliczenie określające początkowy stan otwarcia dodatku.

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

DisplayFlow

Wyliczenie określające sposób wyświetlania dodatku po jego uruchomieniu

Wartości w polu enum
DISPLAY_FLOW_UNSPECIFIED Nie określono sposobu wyświetlania.
FOCUS Dodatek powinien uruchamiać się w trybie wyświetlania „focus”.
AUGMENT Dodatek powinien uruchamiać się w trybie 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ąpi konfigurację z addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Punkt końcowy do wykonania, gdy autoryzacja zakresu pliku zostanie przyznana dla tej pary dokument/użytkownik.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

Typowy format deklarowania wyzwalaczy dodatku do Arkuszy.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy do wykonania 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ąpi konfigurację z addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Punkt końcowy do wykonania, gdy autoryzacja zakresu pliku zostanie przyznana dla tej pary dokument/użytkownik.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

Typowy format deklarowania wyzwalaczy dodatku do Prezentacji.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy do wykonania 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ą akceptację OAuth.

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.

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.

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 na potrzeby testowania.

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.