Zasób manifestu edytora

Konfiguracja zasobów, która służy do definiowania treści i zachowania dodatku do Google Workspace w edytorach. Pliki manifestu dodatków do Google Workspace muszą zawierać wszystkie komponenty oznaczone jako Wymagane, jeśli rozszerzają działanie Edytora.

Edytujący

Konfiguracja pliku manifestu dodatku Google Workspace dla rozszerzeń Edytora. Więcej informacji znajdziesz w artykule o rozszerzaniu możliwości edytorów za pomocą dodatków do Google Workspace.

Zapis JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Pola
homepageTrigger

object (HomepageTrigger)

Ta funkcja aktywatora tworzy stronę główną dodatku w aplikacji hosta. Zastępuje zasadę addOns.common.homepageTrigger.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Wymagany, jeśli dodatek obejmuje zachowanie charakterystyczne dla bieżącego dokumentu Edytora, które jest aktywowane, gdy użytkownik autoryzuje zakres drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Wymagany w przypadku podglądu linków. Lista reguł umożliwiających wyświetlenie podglądu linków w pliku Dokumentów, Arkuszy lub Prezentacji Google. Szczegółowe informacje znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

createActionTriggers[]

object (createActionTriggers)

Wymagane do tworzenia zasobów innych firm. Lista aktywatorów do tworzenia zasobów w usłudze zewnętrznej za pomocą menu @. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm za pomocą elementów inteligentnych.

OnFileScopeGrantedTrigger

Konfiguracja aktywatora kontekstowego, który jest uruchamiany, gdy okno zakresu pliku żądania z użyciem funkcji CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); zostanie uruchomione, a użytkownik przyzna autoryzację zakresu drive.file.

Zapis JSON
{
  "runFunction": string
}
Pola
runFunction

string

Nazwa funkcji do uruchomienia, gdy zostanie przyznany zakres drive.file. Jeśli funkcja jest określona, musisz ją wdrożyć, aby skompilować i zwrócić tablicę obiektów Card do wyświetlenia w interfejsie dodatku.

LinkPreviewTriggers

Konfiguracja reguły, która jest uruchamiana, gdy użytkownik wpisze lub wklei link z usługi innej firmy lub z usługi innej firmy niż Google do pliku Dokumentów, Arkuszy lub Prezentacji.

Aby skonfigurować ten aktywator dla dodatku do Google Workspace, zapoznaj się z sekcją Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

Zapis JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Pola
labelText

string

Wymagane. Tekst przykładowego elementu inteligentnego zachęcającego do wyświetlenia linku, na przykład Example: Support case. Ten tekst jest statyczny i wyświetla się, zanim użytkownik uruchomi dodatek.
localizedLabelText

map (key: string, value: string)

Opcjonalnie. Mapa labelText do przetłumaczenia na inne języki. Sformatuj język zgodnie z normą ISO 639, a kraj/region w normie ISO 3166, oddzielając go łącznikiem -. Przykład: en-US.

Jeśli język użytkownika znajduje się w kluczach mapy, użytkownik zobaczy zlokalizowaną wersję labelText.

patterns[]

object (UriPattern)

Wymagane. Tablica wzorców adresów URL, które uruchamiają dodatek, aby wyświetlać podgląd linków.
runFunction

string

Wymagane. Nazwa funkcji do uruchomienia, gdy użytkownik autoryzuje zakres https://www.googleapis.com/auth/workspace.linkpreview. Jeśli jest określona, musisz ją wdrożyć, aby zaakceptować obiekt zdarzenia zawierający jako argument EDITOR_NAME.matchedUrl.url i zwrócić pojedynczy obiekt Card, który wyświetla podgląd linku w interfejsie dodatku.
logoUrl

string

Opcjonalnie. Ikona wyświetlana na elemencie inteligentnym i na karcie podglądu. W przypadku pominięcia tej informacji dodatek używa swojej ikony na pasku narzędzi – logoUrl.

UriPattern

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

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

string

Wymagane dla każdego wzorca adresu URL do wyświetlenia. Domena wzorca adresu URL. Dodatek wyświetli podgląd linków, które zawierają tę domenę w adresie URL. Aby wyświetlić podgląd linków do określonej subdomeny, np. subdomain.example.com, dodaj ją. Aby wyświetlać podgląd linków w całej domenie, 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 dołączająca domenę hostPattern.

Jeśli na przykład wzorzec hosta adresu URL to support.example.com, to aby dopasować adresy URL w przypadku zgłoszeń hostowanych w domenie support.example.com/cases/, użyj wartości cases.

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

CreateActionTriggers

Konfiguracja aktywatora, który jest uruchamiany, gdy użytkownik wybierze pozycję menu integracji z usługą firmy zewnętrznej z menu Dokumentów Google.

Aby skonfigurować ten aktywator dla dodatku do Google Workspace, zapoznaj się z informacjami o tworzeniu zasobów innych firm za pomocą elementów inteligentnych.

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

string

Wymagane. Unikalny identyfikator umożliwiający rozróżnienie tego punktu rozszerzenia. Identyfikator może mieć do 64 znaków i powinien mieć format [a-zA-Z0-9-]+..
labelText

string

Wymagane. Tekst z menu @, na przykład Create support case.
localizedLabelText

map (key: string, value: string)

Opcjonalnie. Mapa labelText do przetłumaczenia na inne języki. Sformatuj język zgodnie z normą ISO 639, a kraj/region w normie ISO 3166, oddzielając go łącznikiem -. Przykład: en-US.

Jeśli język użytkownika znajduje się w kluczach mapy, użytkownik zobaczy zlokalizowaną wersję labelText.

runFunction

string

Wymagane. Nazwa funkcji, która ma zostać uruchomiona, gdy użytkownik wybierze punkt rozszerzenia z menu @. Funkcja powinna zwrócić kartę formularza z danymi wejściowymi do utworzenia zasobu zewnętrznego.
logoUrl

string

Opcjonalnie. Ikona, która wyświetla się w menu @. W przypadku pominięcia tej informacji dodatek używa swojej ikony na pasku narzędzi – logoUrl.