- Risorsa: Deployment
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Metodi
Risorsa: Deployment
Un deployment di un componente aggiuntivo di Google Workspace
Rappresentazione JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Campi | |
---|---|
name |
Il nome della risorsa di deployment. Esempio: |
oauth |
L'elenco degli ambiti OAuth di Google per i quali richiedere il consenso dell'utente finale prima di eseguire un endpoint del componente aggiuntivo. |
add |
La configurazione del componente aggiuntivo di Google Workspace. |
etag |
Questo valore viene calcolato dal server in base alla versione del deployment nello spazio di archiviazione e può essere inviato nelle richieste di aggiornamento ed eliminazione per garantire che il client disponga di un valore aggiornato prima di procedere. |
AddOns
Una configurazione del componente aggiuntivo di Google Workspace.
Rappresentazione JSON |
---|
{ "common": { object ( |
Campi | |
---|---|
common |
Configurazione comune a tutti i componenti aggiuntivi di Google Workspace. |
gmail |
Configurazione del componente aggiuntivo di Gmail. |
drive |
Configurazione del componente aggiuntivo di Drive. |
calendar |
Configurazione del componente aggiuntivo di Calendar. |
docs |
Configurazione del componente aggiuntivo di Documenti. |
sheets |
Configurazione del componente aggiuntivo di Fogli. |
slides |
Configurazione del componente aggiuntivo di Presentazioni. |
http |
Opzioni per l'invio di richieste agli endpoint HTTP dei componenti aggiuntivi |
CommonAddOnManifest
Configurazione del componente aggiuntivo condivisa tra tutte le applicazioni host del componente aggiuntivo.
Rappresentazione JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campi | |
---|---|
name |
Obbligatorio. Il nome visualizzato del componente aggiuntivo. |
logo |
Obbligatorio. L'URL dell'immagine del logo mostrata nella barra degli strumenti del componente aggiuntivo. |
layout |
Proprietà di layout comuni per le schede dei componenti aggiuntivi. |
add |
I widget utilizzati nel componente aggiuntivo. Se questo campo non viene specificato, viene utilizzato l'insieme predefinito. |
use |
Indica se passare le informazioni sulla locale dall'app host. |
homepage |
Definisce un endpoint che verrà eseguito in qualsiasi contesto e in qualsiasi host. Le schede generate da questa funzione saranno sempre disponibili per l'utente, ma potrebbero essere eclissate dai contenuti contestuali quando questo componente aggiuntivo dichiara attivatori più mirati. |
universal |
Definisce un elenco di punti di estensione nel menu di azioni universali che funge da menu di impostazioni per il componente aggiuntivo. Il punto di estensione può essere un URL di un link da aprire o un endpoint da eseguire come invio di un modulo. |
open |
Un'azione Apri link può utilizzare solo un URL con uno schema |
LayoutProperties
Proprietà del layout delle schede condivise tra tutte le applicazioni host dei componenti aggiuntivi.
Rappresentazione JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Campi | |
---|---|
primary |
Il colore principale del componente aggiuntivo. Imposta il colore della barra degli strumenti. Se non viene impostato alcun colore principale, viene utilizzato il valore predefinito fornito dal framework. |
secondary |
Il colore secondario del componente aggiuntivo. Imposta il colore dei pulsanti. Se il colore principale è impostato, ma non è impostato alcun colore secondario, il colore secondario corrisponde a quello principale. Se non viene impostato né il colore principale né il colore secondario, viene utilizzato il valore predefinito fornito dal framework. |
use |
Attiva il Material Design per le schede. |
AddOnWidgetSet
Il sottoinsieme di widget utilizzato da un componente aggiuntivo.
Rappresentazione JSON |
---|
{
"usedWidgets": [
enum ( |
Campi | |
---|---|
used |
L'elenco dei widget utilizzati in un componente aggiuntivo. |
WidgetType
Il tipo di widget. WIDGET_TYPE_UNSPECIFIED
è il set di widget di base.
Enum | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
Il set di widget predefinito. |
DATE_PICKER |
Il selettore della data. |
STYLED_BUTTONS |
I pulsanti con stile includono pulsanti con riempimento e pulsanti disattivati. |
PERSISTENT_FORMS |
I moduli permanenti consentono di mantenere i valori dei moduli durante le azioni. |
FIXED_FOOTER |
Risolto il problema del piè di pagina in una scheda. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Aggiorna l'oggetto e i destinatari di una bozza. |
GRID_WIDGET |
Il widget griglia. |
ADDON_COMPOSE_UI_ACTION |
Un'azione del componente aggiuntivo di Gmail che si applica all'interfaccia utente di composizione del componente aggiuntivo. |
HomepageExtensionPoint
Formato comune per dichiarare la visualizzazione della home page di un componente aggiuntivo.
Rappresentazione JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione è attivato. |
enabled |
(Facoltativo) Se impostato su Se non viene impostato, il valore predefinito è Se la visualizzazione della home page personalizzata di un componente aggiuntivo è disattivata, agli utenti viene fornita una scheda di panoramica generica. |
UniversalActionExtensionPoint
Formato per la dichiarazione di un punto di estensione dell'elemento del menu di azioni universale.
Rappresentazione JSON |
---|
{ "label": string, // Union field |
Campi | |
---|---|
label |
Obbligatorio. Testo visibile all'utente che descrive l'azione intrapresa attivando questo punto di estensione, ad esempio "Aggiungi un nuovo contatto". |
Campo unione action_type . Obbligatorio. Il tipo di azione supportato in un elemento del menu di azioni universali. Può essere un link da aprire o un endpoint da eseguire. action_type può essere solo uno dei seguenti: |
|
open |
URL da aprire da UniversalAction. |
run |
Endpoint da eseguire da UniversalAction. |
GmailAddOnManifest
Proprietà che personalizza l'aspetto e l'esecuzione di un componente aggiuntivo di Gmail.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepage |
Definisce un endpoint che verrà eseguito in contesti che non corrispondono a un attivatore contestuale dichiarato. Le schede generate da questa funzione saranno sempre disponibili per l'utente, ma potrebbero essere eclissate dai contenuti contestuali quando questo componente aggiuntivo dichiara attivatori più mirati. Se presente, sostituisce la configurazione di |
contextual |
Definisce l'insieme di condizioni che attivano il componente aggiuntivo. |
universal |
Definisce un insieme di azioni universali per il componente aggiuntivo. L'utente attiva le azioni universali dal menu della barra degli strumenti del componente aggiuntivo. |
compose |
Definisce l'attivatore del momento di composizione per un componente aggiuntivo del momento di composizione. Si tratta dell'attivatore che fa sì che un componente aggiuntivo intervenga quando l'utente sta scrivendo un'email. Tutti i componenti aggiuntivi al momento della composizione devono avere l'ambito |
authorization |
Il nome di un endpoint che verifica che il componente aggiuntivo disponga di tutte le autorizzazioni di terze parti richieste, eseguendo sondaggi sulle API di terze parti. Se la verifica non va a buon fine, la funzione deve generare un'eccezione per avviare il flusso di autorizzazione. Questa funzione viene chiamata prima di ogni chiamata del componente aggiuntivo per garantire un'esperienza utente fluida. |
ContextualTrigger
Definisce un attivatore che si attiva quando l'email aperta soddisfa determinati criteri. Quando viene attivato, l'attivatore esegue un endpoint specifico, in genere per creare nuove schede e aggiornare l'interfaccia utente.
Rappresentazione JSON |
---|
{ "onTriggerFunction": string, // Union field |
Campi | |
---|---|
on |
Obbligatorio. Il nome dell'endpoint da chiamare quando un messaggio corrisponde all'attivatore. |
Campo unione trigger . Il tipo di attivatore determina le condizioni utilizzate da Gmail per mostrare il componente aggiuntivo. trigger può essere solo uno dei seguenti: |
|
unconditional |
Gli attivatori incondizionati vengono eseguiti quando viene aperto qualsiasi messaggio di posta. |
UnconditionalTrigger
Questo tipo non contiene campi.
Un trigger che si attiva quando viene aperto un messaggio email.
UniversalAction
Un'azione sempre disponibile nel menu della barra degli strumenti del componente aggiuntivo, indipendentemente dal contesto del messaggio.
Rappresentazione JSON |
---|
{ "text": string, // Union field |
Campi | |
---|---|
text |
Obbligatorio. Testo visibile all'utente che descrive l'azione, ad esempio "Aggiungi un nuovo contatto". |
Campo unione action_type . Il tipo di azione determina il comportamento di Gmail quando l'utente la richiama. action_type può essere solo uno dei seguenti: |
|
open |
Un link che viene aperto da Gmail quando l'utente attiva l'azione. |
run |
Un endpoint chiamato quando l'utente attiva l'azione. Per maggiori dettagli, consulta la guida alle azioni universali. |
ComposeTrigger
Un trigger che si attiva quando l'utente sta scrivendo un'email.
Rappresentazione JSON |
---|
{ "actions": [ { object ( |
Campi | |
---|---|
actions[] |
Definisce l'insieme di azioni per un componente aggiuntivo al momento della composizione. Si tratta di azioni che gli utenti possono attivare su un componente aggiuntivo al momento della composizione. |
draft |
Definisce il livello di accesso ai dati quando viene attivato un componente aggiuntivo al momento della compilazione. |
MenuItemExtensionPoint
Formato comune per dichiarare un elemento di menu o un pulsante visualizzato all'interno di un'app host.
Rappresentazione JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione è attivato. |
label |
Obbligatorio. Testo visibile all'utente che descrive l'azione intrapresa attivando questo punto di estensione. Ad esempio, "Inserisci fattura". |
logo |
L'URL dell'immagine del logo mostrata nella barra degli strumenti del componente aggiuntivo. Se non viene impostato, viene utilizzato l'URL del logo principale del componente aggiuntivo. |
DraftAccess
Un enum che definisce il livello di accesso ai dati richiesto dall'attivatore di composizione.
Enum | |
---|---|
UNSPECIFIED |
Valore predefinito quando non è impostato nulla per draftaccess. |
NONE |
L'attivatore di composizione non può accedere ai dati della bozza quando viene attivato un componente aggiuntivo di composizione. |
METADATA |
Conferisce all'attivatore di composizione l'autorizzazione per accedere ai metadati della bozza quando viene attivato un componente aggiuntivo di composizione. Sono inclusi l'elenco del pubblico, ad esempio l'elenco A e Cc di una bozza di messaggio. |
DriveAddOnManifest
Proprietà che personalizza l'aspetto e l'esecuzione di un componente aggiuntivo di Drive.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepage |
Se presente, sostituisce la configurazione di |
on |
Corrisponde al comportamento che viene eseguito quando gli elementi vengono selezionati nella visualizzazione di Drive pertinente, ad esempio la raccolta di documenti Il mio Drive. |
DriveExtensionPoint
Formato comune per dichiarare gli attivatori di un componente aggiuntivo di Drive.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando il punto di estensione è attivato. |
CalendarAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Calendar.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepage |
Definisce un endpoint che viene eseguito in contesti che non corrispondono a un attivatore contestuale dichiarato. Le schede generate da questa funzione saranno sempre disponibili per l'utente, ma potrebbero essere eclissate dai contenuti contestuali quando questo componente aggiuntivo dichiara attivatori più mirati. Se presente, sostituisce la configurazione di |
conference |
Definisce le soluzioni per le conferenze fornite da questo componente aggiuntivo. I componenti aggiuntivi per le conferenze di terze parti possono essere creati solo in Apps Script. |
create |
Un endpoint da eseguire che crea un URL alla pagina delle impostazioni del componente aggiuntivo. |
event |
Un endpoint che si attiva quando un evento viene aperto per essere visualizzato o modificato. |
event |
Un endpoint che si attiva quando viene aggiornato l'evento di apertura. |
event |
Una configurazione per un attivatore contestuale che si attiva quando l'utente fa clic sul provider di allegati del componente aggiuntivo nel menu a discesa di Calendar. |
current |
Definisce il livello di accesso ai dati quando viene attivato un componente aggiuntivo per gli eventi. |
ConferenceSolution
Definisce i valori relativi alla conferenza. I componenti aggiuntivi per le conferenze di terze parti possono essere creati solo in Apps Script.
Rappresentazione JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Campi | |
---|---|
on |
Obbligatorio. L'endpoint da chiamare quando devono essere creati i dati della conferenza. |
id |
Obbligatorio. Gli ID devono essere assegnati in modo univoco alle soluzioni per le conferenze all'interno di un componente aggiuntivo, altrimenti potrebbe essere utilizzata la soluzione per le conferenze sbagliata quando viene attivato il componente aggiuntivo. Sebbene sia possibile modificare il nome visualizzato di un componente aggiuntivo, l'ID non deve essere modificato. |
name |
Obbligatorio. Il nome visualizzato della soluzione per le conferenze. |
logo |
Obbligatorio. L'URL dell'immagine del logo della soluzione per le conferenze. |
CalendarExtensionPoint
Formato comune per la dichiarazione degli attivatori di un componente aggiuntivo del calendario.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione è attivato. |
EventAccess
Un enum che definisce il livello di accesso ai dati richiesto dagli attivatori di eventi.
Enum | |
---|---|
UNSPECIFIED |
Valore predefinito quando non è impostato nulla per eventAccess. |
METADATA |
Consente agli attivatori di eventi di accedere ai metadati degli eventi, ad esempio l'ID evento e l'ID calendario. |
READ |
Consente agli attivatori di eventi di accedere a tutti i campi di evento forniti, inclusi metadati, partecipanti e dati della conferenza. |
WRITE |
Consente agli attivatori di eventi di accedere ai metadati degli eventi e di eseguire tutte le azioni, inclusa l'aggiunta di partecipanti e l'impostazione dei dati della conferenza. |
READ_WRITE |
Consente agli attivatori di eventi di accedere a tutti i campi degli eventi forniti, inclusi metadati, partecipanti e dati della conferenza, nonché di eseguire tutte le azioni. |
DocsAddOnManifest
Proprietà che personalizza l'aspetto e l'esecuzione di un componente aggiuntivo di Documenti Google.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepage |
Se presente, sostituisce la configurazione di |
on |
Endpoint da eseguire quando viene concessa l'autorizzazione per l'ambito del file per questa coppia di documento/utente. |
link |
Un elenco di punti di estensione per visualizzare l'anteprima dei link in un documento di Documenti Google. Per maggiori dettagli, vedi Visualizzare l'anteprima dei link con smart chip. |
create |
Un elenco di punti di estensione per la creazione di risorse di terze parti dalle applicazioni Google Workspace. Per ulteriori informazioni, vedi Creare risorse di terze parti dal menu @. |
DocsExtensionPoint
Formato comune per dichiarare gli attivatori di un componente aggiuntivo di Documenti.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione è attivato. |
LinkPreviewExtensionPoint
La configurazione di un attivatore che si attiva quando un utente digita o incolla un link da un servizio di terze parti o non Google in un file di Documenti, Fogli o Presentazioni Google.
Rappresentazione JSON |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Campi | |
---|---|
label |
Obbligatorio. Il testo di uno smart chip di esempio che chiede agli utenti di visualizzare l'anteprima del link, ad esempio |
localized |
(Facoltativo) Una mappa di Se le impostazioni internazionali di un utente sono presenti nelle chiavi della mappa, l'utente vedrà la versione localizzata del Un oggetto contenente un elenco di coppie |
patterns[] |
Obbligatorio. Un array di pattern URL che attivano il componente aggiuntivo per visualizzare l'anteprima dei link. |
run |
Obbligatorio. Endpoint da eseguire quando viene attivata un'anteprima del link. |
logo |
(Facoltativo) L'icona visualizzata nello smart chip e nella scheda di anteprima. Se omesso, il componente aggiuntivo utilizza la relativa icona della barra degli strumenti, |
UriPattern
La configurazione per ogni pattern URL che attiva un'anteprima del link.
Rappresentazione JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campi | |
---|---|
host |
Obbligatorio per l'anteprima di ogni pattern URL. Il dominio del pattern URL. Il componente aggiuntivo mostra l'anteprima dei link che contengono questo dominio nell'URL. Per visualizzare l'anteprima dei link per un sottodominio specifico, ad esempio Ad esempio, |
path |
(Facoltativo) Il percorso che aggiunge il dominio del Ad esempio, se il pattern host dell'URL è Per trovare tutte le corrispondenze per tutti gli URL nel dominio del pattern host, lascia vuoto |
CreateActionExtensionPoint
La configurazione di un attivatore che si attiva quando un utente richiama il flusso di lavoro di creazione delle risorse in un'applicazione Google Workspace. Per ulteriori informazioni, vedi Creare risorse di terze parti dal menu @.
Rappresentazione JSON |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Campi | |
---|---|
id |
Obbligatorio. L'ID univoco per distinguere questo punto di estensione. L'ID può contenere fino a 64 caratteri e deve avere il formato |
label |
Obbligatorio. Il testo visualizzato accanto a un'icona per il punto di contatto per la creazione della risorsa, ad esempio |
localized |
(Facoltativo) Una mappa di Se le impostazioni internazionali di un utente sono presenti nelle chiavi della mappa, l'utente vedrà la versione localizzata del Un oggetto contenente un elenco di coppie |
run |
Obbligatorio. Endpoint da eseguire quando viene attivato un flusso di lavoro di creazione di risorse per creare un collegamento. |
logo |
(Facoltativo) L'icona visualizzata per il punto di contatto per la creazione della risorsa. Se omesso, il menu utilizza l'icona della barra degli strumenti del componente aggiuntivo, |
SheetsAddOnManifest
Proprietà che personalizza l'aspetto e l'esecuzione di un componente aggiuntivo di Fogli Google.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepage |
Se presente, sostituisce la configurazione di |
on |
Endpoint da eseguire quando viene concessa l'autorizzazione per l'ambito del file per questa coppia di documento/utente. |
link |
Un elenco di punti di estensione per visualizzare l'anteprima dei link in un documento di Fogli Google. Per maggiori dettagli, vedi Visualizzare l'anteprima dei link con smart chip. |
SheetsExtensionPoint
Formato comune per dichiarare gli attivatori di un componente aggiuntivo di Fogli.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione è attivato. |
SlidesAddOnManifest
Proprietà che personalizza l'aspetto e l'esecuzione di un componente aggiuntivo di Presentazioni Google.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepage |
Se presente, sostituisce la configurazione di |
on |
Endpoint da eseguire quando viene concessa l'autorizzazione per l'ambito del file per questa coppia di documento/utente. |
link |
Un elenco di punti di estensione per visualizzare l'anteprima dei link in un documento di Presentazioni Google. Per maggiori dettagli, vedi Visualizzare l'anteprima dei link con smart chip. |
SlidesExtensionPoint
Formato comune per dichiarare gli attivatori di un componente aggiuntivo di Presentazioni.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
run |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione è attivato. |
HttpOptions
Opzioni per l'invio di richieste agli endpoint HTTP
dei componenti aggiuntivi.
Rappresentazione JSON |
---|
{
"authorizationHeader": enum ( |
Campi | |
---|---|
authorization |
Configurazione del token inviato nell'intestazione |
HttpAuthorizationHeader
Intestazione di autorizzazione inviata nelle richieste del componente aggiuntivo HTTP
.
Enum | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Valore predefinito, equivalente a SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Invia un token di identità per l'account di servizio di sistema del componente aggiuntivo Google Workspace specifico del progetto (valore predefinito). |
USER_ID_TOKEN |
Invia un token di identità per l'utente finale. |
NONE |
Non inviare un'intestazione di autenticazione. |
Metodi |
|
---|---|
|
Crea un deployment con il nome e la configurazione specificati. |
|
Consente di eliminare il deployment con il nome specificato. |
|
Recupera il deployment con il nome specificato. |
|
Recupera lo stato di installazione di un deployment di test. |
|
Installa un deployment nel tuo account per i test. |
|
Elenca tutti i deployment in un determinato progetto. |
|
Crea o sostituisce un deployment con il nome specificato. |
|
Disinstalla un deployment di test dall'account dell'utente. |