Manifest per i componenti aggiuntivi di Google Workspace

Un componente aggiuntivo utilizza un file manifest per configurare alcuni dettagli dell'app e del suo funzionamento.

Questa documentazione illustra i dettagli della configurazione di un manifest per un il componente aggiuntivo di Google Workspace.

Struttura manifest per i componenti aggiuntivi di Google Workspace

I componenti aggiuntivi di Google Workspace utilizzano il file manifest per definire diversi aspetti del componenti aggiuntivi aspetto e comportamento.

Le proprietà del file manifest per i componenti aggiuntivi di Google Workspace sono organizzati nella sezione addOns della struttura degli oggetti manifest.

• Per informazioni sui file manifest di Apps Script, consulta Struttura del file manifest.
• Per informazioni sui file manifest per i componenti aggiuntivi creati con Endpoint HTTP, fai riferimento a Risorsa REST: projects.deployments

Esempio di configurazione manifest del componente aggiuntivo di Google Workspace

Il seguente esempio di manifest mostra la sezione di un file manifest che definisce un componente aggiuntivo di Google Workspace, che includa i seguenti aspetti:

• addOns.common del file manifest definisce il nome, l'URL del logo, i colori e altri le impostazioni generali indipendenti dall'host per il componente aggiuntivo.
• Il file manifest definisce una home page comune, ma anche Calendar, Drive, Documenti, Home page specifiche per Fogli e Presentazioni. Gmail utilizza la home page predefinita.
• Le impostazioni di esempio per i file manifest abilitano quanto segue:
  • Trigger di calendario eventOpen e eventUpdated.
  • (Solo Apps Script) Due calendari soluzioni per conferenze.
  • Due azioni universali.
  • onItemsSelectedTrigger in Drive.
  • Un'azione di scrittura di Gmail e un attivatore contestuale.
  • Un oggetto linkPreviewTriggersDocumenti. Per saperne di più su questo trigger, consulta Visualizzare l'anteprima dei link con smart chip.
  • Un oggetto createActionTriggers Documenti. Per saperne di più su questo trigger, consulta la sezione Creare risorse di terze parti dal menu @.
  • Interfacce specifiche per i file di Documenti, Fogli e Presentazioni.
• Il campo oauthScopes gli ambiti di autorizzazione per il progetto (solitamente richiesti per componenti aggiuntivi).
• (Solo Apps Script) Il urlFetchWhitelist è un campo che assicura che tutti gli endpoint recuperati corrispondano a un dei prefissi URL HTTPS. Per ulteriori informazioni, vedi URL inclusi nella lista consentita.

I link nell'esempio indirizzano alle descrizioni di quel campo nel corrispondente documentazione di riferimento per i file manifest per Apps Script e HTTP Componenti aggiuntivi di Google Workspace.

Nota :i file manifest includono altri componenti. I campi sotto Il campo addOns è correlato direttamente ai componenti aggiuntivi di Google Workspace. Questo esempio è solo una parte di un file manifest completo e non è un funzionale.

Apps Script

{
  "addOns": {
    "calendar": {
      "createSettingsUrlFunction": "getConferenceSettingsPageUrl",
      "conferenceSolution": [{
        "id": "my-video-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Video Conference",
        "onCreateFunction": "onCreateMyVideoConference"
      }, {
        "id": "my-streamed-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Streamed Conference",
        "onCreateFunction": "onCreateMyStreamedConference"
      }],
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "selectActions": [
          {
            "text": "Add images to email",
            "runFunction": "getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
        "runFunction": "onLinkPreview",
        "patterns": [
            {
              "hostPattern": "example.com",
              "pathPrefix": "example-path"
            }
        ],
        "labelText": "Link preview",
        "localizedLabelText": {
          "es": "Link preview localized in Spanish"
        },
        "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "exampleFunction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ],
  "urlFetchWhitelist": [
    "https://www.example.com/myendpoint/"
  ]
}

HTTP

{
  "addOns": {
    "calendar": {
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "actions": [
          {
            "label": "Add images to email",
            "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "https://myownpersonaldomain.com/mypage?trigger=onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onLinkPreview",
          "patterns": [
              {
                "hostPattern": "example.com",
                "pathPrefix": "example-path"
              }
          ],
          "labelText": "Link preview",
          "localizedLabelText": {
            "es": "Link preview localized in Spanish"
          },
          "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCreateAction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ]
}

Autorizzare gli URL

Puoi utilizzare le liste consentite per designare URL specifici pre-approvati per l'accesso dallo script o dal componente aggiuntivo. Le liste consentite aiutano a proteggere l'utente data; quando definisci una lista consentita, i progetti di script non possono accedere agli URL con non è stato inserito nella lista consentita.

Questo campo è facoltativo quando installi un deployment di prova, ma è obbligatorio quando un deployment con controllo delle versioni.

Utilizzi le liste consentite quando lo script o il componente aggiuntivo vengono eseguiti le seguenti azioni:

• Recupera o recupera informazioni da una posizione esterna (come HTTPS endpoint) utilizzando Apps Script UrlFetch completamente gestito di Google Cloud. Per inserire gli URL nella lista consentita per il recupero, includi il campo urlFetchWhitelist nel file manifest.
• Apre o visualizza un URL in risposta a un'azione dell'utente (obbligatoria per Componenti aggiuntivi di Google Workspace che aprono o mostrano URL esterni a Google). Per inserire gli URL nella lista consentita per l'apertura, includi il campo addOns.common.openLinkUrlPrefixes nella manifest.

di Gemini Advanced.

Nota: la lista consentita, come usata in urlFetchWhitelist, è un termine obsoleto che è anche sinonimo di lista consentita. Per saperne di più, vedi Scrivere una documentazione inclusiva.

Aggiunta di prefissi alla lista consentita

Quando specifichi le liste consentite nel file manifest (includendo il valore addOns.common.openLinkUrlPrefixes o urlFetchWhitelist), devi includi un elenco di prefissi URL. I prefissi che aggiungi al file manifest devono devono soddisfare i seguenti requisiti:

• Ogni prefisso deve essere un URL valido.
• Ogni prefisso deve utilizzare https://, non http://.
• Ogni prefisso deve avere un dominio completo.
• Ogni prefisso deve avere un percorso non vuoto. Ad esempio, https://www.google.com/ è valido, mentre https://www.google.com non lo è.
• Puoi utilizzare caratteri jolly per trovare corrispondenze con i prefissi dei sottodomini degli URL.
• È possibile utilizzare un singolo carattere jolly * nel campo addOns.common.openLinkUrlPrefixes campo per corrispondere a tutti i link, ma ciò non è consigliato in quanto può esporre una i dati utente a rischio e può prolungare procedura di revisione dei componenti aggiuntivi. Solo utilizza un carattere jolly se la funzionalità del componente aggiuntivo lo richiede.

Per determinare se un URL corrisponde a un prefisso consentito, vengono applicate le seguenti regole applica:

• La corrispondenza del percorso è sensibile alle maiuscole.
• Se il prefisso è identico all'URL, viene considerata una corrispondenza.
• Se l'URL è uguale o secondario del prefisso, si tratta di una corrispondenza.

Ad esempio, il prefisso https://example.com/foo corrisponde ai seguenti URL:

• https://example.com/foo
• https://example.com/foo/
• https://example.com/foo/bar
• https://example.com/foo?bar
• https://example.com/foo#bar

Utilizzo di caratteri jolly

Puoi utilizzare un singolo carattere jolly (*) per trovare la corrispondenza di un sottodominio sia per il urlFetchWhitelist e addOns.common.openLinkUrlPrefixes campi. Non puoi utilizzare più caratteri jolly per trovare corrispondenze con più sottodomini e il carattere jolly deve rappresentare il prefisso iniziale dell'URL.

Ad esempio, il prefisso https://*.example.com/foo corrisponde alla seguente URL:

• https://subdomain.example.com/foo
• https://any.number.of.subdomains.example.com/foo

Il prefisso https://*.example.com/foo non corrisponde a quanto segue URL:

• https://subdomain.example.com/bar (suffisso non corrispondente)
• https://example.com/foo (deve essere presente almeno un sottodominio)

Alcune delle regole per i prefissi vengono applicate quando provi a salvare il file manifest. Per Ad esempio, i prefissi riportati di seguito causano un errore se sono presenti nel manifest quando provi a salvare:

• https://*.*.example.com/foo (sono vietati più caratteri jolly)
• https://subdomain.*.example.com/foo (i caratteri jolly devono essere utilizzati come prefisso iniziale)