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

etag

string

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 (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 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 w 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. Adres URL obrazu logo wyświetlanego na pasku narzędzi dodatku.

layoutProperties

object (LayoutProperties)

Właściwości układu wspólne dla kart dodatków.

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 mają być przekazywane informacje o lokalizacji z aplikacji hosta.

homepageTrigger

object (HomepageExtensionPoint)

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.

universalActions[]

object (UniversalActionExtensionPoint)

Określa listę punktów rozszerzenia w uniwersalnym menu działań, 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 Otwórz link 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 pomija schemat, przyjmuje się wartość HTTPS. Linki HTTP są automatycznie zastępowane linkami HTTPS.

LayoutProperties

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

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

string

Podstawowy kolor dodatku. Ustawia kolor paska narzędzi. Jeśli nie ustawisz koloru podstawowego, zostanie użyta wartość domyślna określona przez framework.

secondaryColor

string

Drugorzędny kolor 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 ustawisz ani koloru podstawowego, ani koloru dodatkowego, zostanie użyta wartość domyślna określona przez framework.

useNewMaterialDesign

boolean

Włącza projektowanie interfejsu 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 Do stylizowanych przycisków należą wypełnione przyciski i przyciski wyłączone.
PERSISTENT_FORMS Trwałe formularze umożliwiają utrwalanie wartości formularzy podczas wykonywania działań.
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
runFunction

string

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

enabled

boolean

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

Jeśli nie zostanie ustawiony, domyślnie przyjmuje się true.

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 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 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:
runFunction

string

Punkt końcowy, który ma być wywoływany przez metodę UniversalAction.

GmailAddOnManifest

Właściwości umożliwiające dostosowanie wyglądu i działania dodatku w Gmailu.

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 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 addons.common.homepageTrigger.

contextualTriggers[]

object (ContextualTrigger)

Określa zestaw warunków, które powodują uruchomienie dodatku.

universalActions[]

object (UniversalAction)

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

composeTrigger

object (ComposeTrigger)

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 gmail.addons.current.action.compose, nawet jeśli nie można edytować projektu.

authorizationCheckFunction

string

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.

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

object (UnconditionalTrigger)

Bezwarunkowe reguły są wykonywane, gdy otwierana jest dowolna 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 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 nowego 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:
runFunction

string

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 (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Pola
actions[]

object (MenuItemExtensionPoint)

Określa 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.

draftAccess

enum (DraftAccess)

Określa poziom dostępu do danych, gdy zostanie uruchomione rozszerzenie na etapie tworzenia.

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 opcji dostępu do wersji roboczej.
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 wersji roboczej wiadomości.

DriveAddOnManifest

Właściwości umożliwiające dostosowywanie wyglądu i działania dodatku do Dysku.

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

object (HomepageExtensionPoint)

Jeśli jest podany, zastąpi konfigurację z ustawienia addons.common.homepageTrigger.

onItemsSelectedTrigger

object (DriveExtensionPoint)

Odpowiada działaniu, które jest wykonywane po wybraniu elementów w odpowiednim widoku Dysku, np. na liście dokumentów na Dysku.

DriveExtensionPoint

Typowy format deklarowania wyzwalaczy dodatku do Dysku.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

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

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

conferenceSolution[]

object (ConferenceSolution)

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.

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

Punkt końcowy, który uruchamia się, gdy zdarzenie zostanie otwarte w celu wyświetlenia lub edycji.

eventUpdateTrigger

object (CalendarExtensionPoint)

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

calendarNotificationTrigger

object (CalendarExtensionPoint)

Punkt końcowy, który uruchamia się, gdy pojawi się nowe zdarzenie dla wcześniej skonfigurowanej subskrypcji kalendarza.

eventAttachmentTrigger

object (MenuItemExtensionPoint)

Konfiguracja kontekstowego czynnika uruchamiającego, który jest uruchamiany, gdy użytkownik kliknie dostawcę załączników w menu Kalendarz.

currentEventAccess

enum (EventAccess)

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
onCreateFunction

string

Wymagane. Punkt końcowy, który należy wywołać, gdy należy utworzyć dane konferencji.

id

string

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

string

Wymagane. Wyświetlana nazwa rozwiązania konferencyjnego.

logoUrl

string

Wymagane. Adres URL obrazu logo rozwiązania konferencyjnego.

CalendarExtensionPoint

Powszechny format deklarowania wyzwalaczy rozszerzenia kalendarza.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

Wymagane. Punkt końcowy do wykonania po aktywacji 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 ma ustawionej wartości eventAccess.
METADATA Przyznaje wyzwalaczom zdarzeń uprawnienia 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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli jest podany, zastąpi konfigurację z ustawienia addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Punkt końcowy do wykonania, gdy dla pary dokument/użytkownik przyznane zostanie uprawnienie do zakresu pliku.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

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.

createActionTriggers[]

object (CreateActionExtensionPoint)

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

DocsExtensionPoint

Typowy format deklarowania wyzwalaczy dodatku do Dokumentów.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

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 (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ę przed uruchomieniem dodatku.

localizedLabelText

map (key: string, value: string)

Opcjonalnie. mapa labeltext do zlokalizowania na inne języki. Formatuj język w formacie ISO 639, a kraj/region w formacie ISO 3166, rozdzielając je łącznikiem -. Na przykład: en-US.

Jeśli w kluczach mapy występuje lokalizacja użytkownika, 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ą, że dodatek wyświetla podgląd linków.

runFunction

string

Wymagane. Punkt końcowy do wykonania, gdy zostanie wywołany podgląd linku.

logoUrl

string

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

UriPattern

Konfiguracja każdego wzorca adresu URL, który powoduje wyświetlenie podglądu linku.

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

string

Wymagany, aby wyświetlić podgląd każdego wzorca adresu URL. Domena wzorca adresu URL. linki w podglądach dodatku, które zawierają tę domenę w adresie URL; Aby wyświetlić podgląd linków do konkretnej subdomeny, np. subdomain.example.com, uwzględnij tę subdomenę. Aby wyświetlić podgląd linków dla całej domeny, jako subdomeny użyj symbolu wieloznacznego, czyli gwiazdki (*).

Na przykład *.example.com jest zgodne z subdomain.example.comanother.subdomain.example.com.

pathPrefix

string

Opcjonalnie. Ścieżka do domeny hostpattern.

Jeśli na przykład wzór hosta adresu URL to support.example.com, aby dopasować adresy URL spraw hostowanych pod adresem support.example.com/cases/, wpisz cases.

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

CreateActionExtensionPoint

Konfiguracja reguły, która jest uruchamiany, gdy użytkownik wywoła przepływ pracy tworzenia zasobu w aplikacji Google Workspace. Więcej informacji znajdziesz w artykule Tworzenie zasobów zewnętrznych w menu @.

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

string

Wymagane. Unikalny identyfikator umożliwiający odróżnienie tego punktu 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 zasobu, np. Create support case. Ten tekst jest statyczny i wyświetla się przed uruchomieniem dodatku.

localizedLabelText

map (key: string, value: string)

Opcjonalnie. mapa labeltext do zlokalizowania na inne języki. Formatuj język w formacie ISO 639, a kraj/region w formacie ISO 3166, rozdzielając je łącznikiem -. Na przykład: en-US.

Jeśli w kluczach mapy występuje lokalizacja użytkownika, 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 uruchamiane jest przepływ pracy tworzenia zasobu w celu utworzenia połączenia.

logoUrl

string

Opcjonalnie. Ikona wyświetlana w przypadku punktu wejścia do tworzenia zasobów. Jeśli nie zostanie podany, 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 jest podany, zastąpi konfigurację z ustawienia addons.common.homepageTrigger.

web

object (Web)

Szczegóły dotyczące dodatków, które rozszerzają możliwości klienta internetowego Meet.

supportsCollaboration

boolean

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

termsUri

string

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

Sieć

Szczegóły dotyczące dodatków, które rozszerzają możliwości 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 „main stage”.

supportsScreenSharing

boolean

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

supportsCollaboration
(deprecated)

boolean

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

supportsPopOut

boolean

Informacja o tym, czy dodatek obsługuje otwieranie okna PiP w przeglądarce.

hostOrigins[]
(deprecated)

string

Wycofane, starsze oznaczenie. Źródła, które należy dodać do właściwości frame-src elementu iframe zawierającego witrynę zewnętrzną. 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ę zewnętrzną.

openState

enum (State)

Stan początkowy po otwarciu dodatku.

supportsCollaborationHostControls

boolean

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 adresu URL logo w wersji ciemnej.

displayFlow
(deprecated)

enum (DisplayFlow)

Sekwencja wyświetlania, której będzie się wyświetlać po uruchomieniu dodatku.

Stan

Typ enumeracji służący do określania początkowego stanu otwierania dodatku.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono początkowego stanu dodatku.
SIDE_PANEL_ONLY Dodatek otwiera się z aktywnym tylko panelem bocznym.
MAIN_STAGE_ONLY Dodatek otworzy się tylko z aktywnym widokiem głównym.
SIDE_PANEL_AND_MAIN_STAGE Dodatek otwiera się z aktywnym panelem bocznym i główną częścią ekranu.

DisplayFlow

Typ enumeracji służący do określania sposobu wyświetlania dodatku po uruchomieniu

Wartości w polu enum
DISPLAY_FLOW_UNSPECIFIED Nie określono procesu wyświetlania.
FOCUS Wtyczka powinna uruchamiać się w trybie wyświetlania „focus”.
AUGMENT Wtyczka powinna się uruchamiać w ramach procesu wyświetlania „rozszerzonego”.

SheetsAddOnManifest

Właściwości umożliwiające dostosowywanie wyglądu i działania dodatku do Arkuszy Google.

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

object (HomepageExtensionPoint)

Jeśli jest podany, zastąpi konfigurację z ustawienia addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Punkt końcowy do wykonania, gdy dla pary dokument/użytkownik przyznane zostanie uprawnienie do zakresu pliku.

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ąd 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 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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Pola
homepageTrigger

object (HomepageExtensionPoint)

Jeśli jest podany, zastąpi konfigurację z ustawienia addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Punkt końcowy do wykonania, gdy dla pary dokument/użytkownik przyznane zostanie uprawnienie do zakresu pliku.

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

SlidesExtensionPoint

Typowy format deklarowania czynników uruchamiających dodatku do Prezentacji.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

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 (HttpAuthorizationHeader)
}
Pola
authorizationHeader

enum (HttpAuthorizationHeader)

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

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ówna SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Wysyłanie tokenu identyfikacyjnego na konto usługi systemowej Google Workspace związanej z danym projektem (domyślnie).
USER_ID_TOKEN Wyślij token identyfikacyjny użytkownika.
NONE Nie wysyłaj nagłówka uwierzytelniania.

Metody

create

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

delete

Usuwa wdrożoną wersję o podanej nazwie.

get

Pobiera wdrożenie o określonej nazwie.

getInstallStatus

Pobiera stan instalacji testowego wdrożenia.

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

Odinstaluj z konta użytkownika testowe wdrożenie.