- 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 componenti aggiuntivi Google Workspace
Rappresentazione JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Campi | |
---|---|
name |
Il nome della risorsa di deployment. Esempio: |
oauthScopes[] |
L'elenco degli ambiti OAuth di Google per i quali richiedere il consenso all'utente finale prima di eseguire un endpoint aggiuntivo. |
addOns |
La configurazione del componente aggiuntivo Google Workspace. |
etag |
Questo valore viene calcolato dal server in base alla versione del deployment nello spazio di archiviazione e può essere inviato in caso di richieste di aggiornamento ed eliminazione per garantire che il client abbia un valore aggiornato prima di procedere. |
AddOns
La configurazione di un componente aggiuntivo di Google Workspace.
Rappresentazione JSON |
---|
{ "common": { object ( |
Campi | |
---|---|
common |
Configurazione comune a tutti i componenti aggiuntivi di Google Workspace. |
gmail |
Configurazione dei componenti aggiuntivi di Gmail. |
drive |
Configurazione dei componenti aggiuntivi di Drive. |
calendar |
Configurazione dei componenti aggiuntivi di Calendar. |
docs |
Configurazione dei componenti aggiuntivi di Documenti. |
sheets |
Configurazione dei componenti aggiuntivi di Fogli. |
slides |
Configurazione dei componenti aggiuntivi di Presentazioni. |
httpOptions |
Opzioni per l'invio di richieste agli endpoint HTTP dei componenti aggiuntivi |
CommonAddOnManifest
Configurazione di componenti aggiuntivi condivisa tra tutte le applicazioni host dei componenti aggiuntivi.
Rappresentazione JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campi | |
---|---|
name |
Obbligatorio. Il nome visualizzato del componente aggiuntivo. |
logoUrl |
Obbligatorio. L'URL dell'immagine del logo mostrata nella barra degli strumenti del componente aggiuntivo. |
layoutProperties |
Proprietà di layout comuni per le schede dei componenti aggiuntivi. |
addOnWidgetSet |
I widget utilizzati nel componente aggiuntivo. Se questo campo non viene specificato, viene utilizzato l'insieme predefinito. |
useLocaleFromApp |
Se trasferire informazioni sulle impostazioni internazionali dall'app host. |
homepageTrigger |
Definisce un endpoint che verrà eseguito in qualsiasi contesto, in qualsiasi host. Tutte le schede generate da questa funzione saranno sempre disponibili per l'utente, ma potrebbero essere eclissate da contenuti contestuali quando questo componente aggiuntivo dichiara attivatori più mirati. |
universalActions[] |
Definisce un elenco di punti di estensione nel menu Azioni universale che funge da menu di impostazioni per il componente aggiuntivo. Il punto di estensione può essere un URL di link da aprire o un endpoint da eseguire durante l'invio di un modulo. |
openLinkUrlPrefixes |
Un'azione OpenLink può utilizzare soltanto un URL con uno schema |
LayoutProperties
Proprietà di layout delle schede condivise tra tutte le applicazioni host dei componenti aggiuntivi.
Rappresentazione JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Campi | |
---|---|
primaryColor |
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. |
secondaryColor |
Il colore secondario del componente aggiuntivo. Consente di impostare il colore dei pulsanti. Se è impostato il colore principale, ma non è impostato alcun colore secondario, il colore secondario è lo stesso del colore principale. Se non viene impostato né il colore principale né il colore secondario, viene utilizzato il valore predefinito fornito dal framework. |
useNewMaterialDesign |
Consente di attivare il Material Design per le schede. |
AddOnWidgetSet
Il sottoinsieme del widget utilizzato da un componente aggiuntivo.
Rappresentazione JSON |
---|
{
"usedWidgets": [
enum ( |
Campi | |
---|---|
usedWidgets[] |
L'elenco di widget utilizzati in un componente aggiuntivo. |
WidgetType
Il tipo di widget. WIDGET_TYPE_UNSPECIFIED
è l'insieme di widget di base.
Enum | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
L'insieme di widget predefinito. |
DATE_PICKER |
Il selettore della data. |
STYLED_BUTTONS |
I pulsanti con stile includono pulsanti riempiti e pulsanti disattivati. |
PERSISTENT_FORMS |
I moduli permanenti consentono di mantenere i valori dei moduli durante le azioni. |
FIXED_FOOTER |
Piè di pagina fisso 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 scrittura del componente aggiuntivo. |
HomepageExtensionPoint
Formato comune per dichiarare la visualizzazione della home page di un componente aggiuntivo.
Rappresentazione JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione viene attivato. |
enabled |
Campo facoltativo. Se impostato su Se non viene configurato, il valore predefinito è Se la visualizzazione della home page personalizzata di un componente aggiuntivo è disattivata, viene fornita agli utenti una scheda Panoramica generica. |
UniversalActionExtensionPoint
Formato per la dichiarazione di un punto di estensione della voce del menu Azioni universale.
Rappresentazione JSON |
---|
{ "label": string, // Union field |
Campi | |
---|---|
label |
Obbligatorio. Testo visibile all'utente che descrive l'azione intrapresa dall'attivazione di questo punto di estensione, ad esempio "Aggiungi un nuovo contatto". |
Campo di unione action_type . Obbligatorio. Il tipo di azione supportato per una voce del menu azione universale. Può essere un link da aprire o un endpoint da eseguire. action_type può essere solo uno dei seguenti: |
|
openLink |
URL che deve essere aperto da UniversalAction. |
runFunction |
Endpoint che deve essere eseguito da UniversalAction. |
GmailAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Gmail.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepageTrigger |
Definisce un endpoint che verrà eseguito in contesti che non corrispondono a un attivatore contestuale dichiarato. Tutte le schede generate da questa funzione saranno sempre disponibili per l'utente, ma potrebbero essere eclissate da contenuti contestuali quando questo componente aggiuntivo dichiara attivatori più mirati. Se presente, sostituisce la configurazione di |
contextualTriggers[] |
Definisce l'insieme di condizioni che attivano il componente aggiuntivo. |
universalActions[] |
Definisce un insieme di azioni universali per il componente aggiuntivo. L'utente attiva azioni universali dal menu della barra degli strumenti del componente aggiuntivo. |
composeTrigger |
Definisce l'attivatore del tempo di scrittura per un componente aggiuntivo del tempo di scrittura. Questo è l'attivatore che attiva un componente aggiuntivo quando l'utente scrive un'email. Tutti i componenti aggiuntivi per la fase di scrittura devono avere l'ambito |
authorizationCheckFunction |
Il nome di un endpoint che verifica che il componente aggiuntivo disponga di tutte le autorizzazioni di terze parti necessarie, verificando le API di terze parti. Se il probe ha esito negativo, la funzione deve generare un'eccezione per avviare il flusso di autorizzazione. Questa funzione viene chiamata prima di ogni chiamata al componente aggiuntivo per garantire un'esperienza utente ottimale. |
ContextualTrigger
Definisce un attivatore che si attiva quando l'email aperta soddisfa un criterio specifico. Quando si attiva, l'attivatore esegue un endpoint specifico, di solito per creare nuove schede e aggiornare la UI.
Rappresentazione JSON |
---|
{ "onTriggerFunction": string, // Union field |
Campi | |
---|---|
onTriggerFunction |
Obbligatorio. Il nome dell'endpoint da chiamare quando un messaggio corrisponde all'attivatore. |
Campo di 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 |
I trigger incondizionati vengono eseguiti all'apertura di un messaggio di posta. |
UnconditionalTrigger
Questo tipo non contiene campi.
Un attivatore che si attiva all'apertura di 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 di unione action_type . Il tipo di azione determina il comportamento di Gmail quando l'utente richiama l'azione. action_type può essere solo uno dei seguenti: |
|
openLink |
Un link aperto da Gmail quando l'utente attiva l'azione. |
runFunction |
Un endpoint che viene chiamato quando l'utente attiva l'azione. Per informazioni dettagliate, consulta la guida universale alle azioni. |
ComposeTrigger
Attivazione che si attiva quando l'utente scrive un'email.
Rappresentazione JSON |
---|
{ "actions": [ { object ( |
Campi | |
---|---|
actions[] |
Definisce l'insieme di azioni per un componente aggiuntivo del tempo di scrittura. Si tratta di azioni che gli utenti possono attivare in un componente aggiuntivo del tempo di scrittura. |
draftAccess |
Definisce il livello di accesso ai dati quando viene attivato un componente aggiuntivo del tempo di scrittura. |
MenuItemExtensionPoint
Formato comune per la dichiarazione di una voce di menu o di un pulsante che viene visualizzato in un'app host.
Rappresentazione JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione viene attivato. |
label |
Obbligatorio. Testo visibile all'utente che descrive l'azione intrapresa dall'attivazione di questo punto di estensione. Ad esempio, "Inserisci fattura". |
logoUrl |
L'URL dell'immagine del logo mostrata nella barra degli strumenti del componente aggiuntivo. Se non viene configurato, per impostazione predefinita viene utilizzato l'URL del logo principale del componente aggiuntivo. |
DraftAccess
Un'enumerazione che definisce il livello di accesso ai dati richiesto dal trigger di scrittura.
Enum | |
---|---|
UNSPECIFIED |
Valore predefinito quando non è impostato nulla per l'accesso alla bozza. |
NONE |
L'attivatore di scrittura non può accedere ai dati della bozza quando viene attivato un componente aggiuntivo di scrittura. |
METADATA |
Concede all'attivatore di scrittura l'autorizzazione ad accedere ai metadati della bozza quando viene attivato un componente aggiuntivo per la scrittura. ad esempio l'elenco del segmento di pubblico, come gli elenchi A e Cc di una bozza di messaggio. |
DriveAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Drive.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepageTrigger |
Se presente, sostituisce la configurazione di |
onItemsSelectedTrigger |
Corrisponde al comportamento che viene eseguito quando gli elementi vengono selezionati nella visualizzazione pertinente di Drive, ad esempio l'elenco documenti di Il mio Drive. |
DriveExtensionPoint
Formato comune per la dichiarazione degli attivatori di un componente aggiuntivo di Drive.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando viene attivato il punto di estensione. |
CalendarAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Calendar.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepageTrigger |
Definisce un endpoint che viene eseguito in contesti che non corrispondono a un attivatore contestuale dichiarato. Tutte le schede generate da questa funzione saranno sempre disponibili per l'utente, ma potrebbero essere eclissate da contenuti contestuali quando questo componente aggiuntivo dichiara attivatori più mirati. Se presente, sostituisce la configurazione di |
conferenceSolution[] |
Definisce le soluzioni di conferenza fornite da questo componente aggiuntivo. |
createSettingsUrlFunction |
Un endpoint da eseguire che crea un URL alla pagina delle impostazioni del componente aggiuntivo. |
eventOpenTrigger |
Un endpoint che si attiva quando un evento viene aperto per essere visualizzato o modificato. |
eventUpdateTrigger |
Un endpoint che si attiva quando l'evento aperto viene aggiornato. |
currentEventAccess |
Definisce il livello di accesso ai dati quando viene attivato un componente aggiuntivo di un evento. |
ConferenceSolution
Definisce i valori relativi alla conferenza.
Rappresentazione JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Campi | |
---|---|
onCreateFunction |
Obbligatorio. L'endpoint da chiamare quando è necessario creare i dati della conferenza. |
id |
Obbligatorio. Gli ID devono essere assegnati in modo univoco alle soluzioni di conferenza all'interno di un componente aggiuntivo, altrimenti potrebbe essere utilizzata la soluzione di conferenza sbagliata quando viene attivato il componente aggiuntivo. Puoi modificare il nome visualizzato di un componente aggiuntivo, ma l'ID non deve essere modificato. |
name |
Obbligatorio. Il nome visualizzato della soluzione di conferenza. |
logoUrl |
Obbligatorio. L'URL dell'immagine del logo della soluzione per la conferenza. |
CalendarExtensionPoint
Formato comune per la dichiarazione degli attivatori di un componente aggiuntivo di calendario.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione viene attivato. |
EventAccess
Un'enumerazione che definisce il livello richiesto per gli attivatori di eventi di accesso ai dati.
Enum | |
---|---|
UNSPECIFIED |
Valore predefinito quando non è impostato nulla per eventAccess. |
METADATA |
Concede all'evento l'autorizzazione ad accedere ai metadati degli eventi, ad esempio ID evento e ID calendario. |
READ |
Concede agli attivatori eventi l'accesso a tutti i campi evento forniti, inclusi i metadati, i partecipanti e i dati della conferenza. |
WRITE |
Concede agli attivatori eventi l'accesso ai metadati degli eventi e la possibilità di eseguire tutte le azioni, tra cui l'aggiunta di partecipanti e l'impostazione dei dati delle conferenze. |
READ_WRITE |
Concede agli attivatori eventi l'accesso a tutti i campi evento forniti, tra cui i metadati, i partecipanti e i dati della conferenza, nonché la possibilità di eseguire tutte le azioni. |
DocsAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Documenti Google.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepageTrigger |
Se presente, sostituisce la configurazione di |
onFileScopeGrantedTrigger |
Endpoint da eseguire quando viene concessa l'autorizzazione dell'ambito file per questa coppia di documento/utente. |
linkPreviewTriggers[] |
Un elenco di punti di estensione per l'anteprima dei link in un documento di Documenti Google. Per maggiori dettagli, consulta Visualizzare l'anteprima dei link con smart chip. |
createActionTriggers[] |
Un elenco di punti di estensione per la creazione di risorse di terze parti dalle applicazioni di Google Workspace. Per ulteriori informazioni, consulta Creare risorse di terze parti dal menu @. |
DocsExtensionPoint
Formato comune per la dichiarazione degli attivatori di un componente aggiuntivo di Documenti.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione viene 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 | |
---|---|
labelText |
Obbligatorio. Il testo di uno smart chip di esempio che richiede agli utenti di visualizzare l'anteprima del link, ad esempio |
localizedLabelText |
Campo facoltativo. Una mappa di Se le impostazioni internazionali di un utente sono presenti nelle chiavi della mappa, l'utente vede la versione localizzata di Un oggetto contenente un elenco di |
patterns[] |
Obbligatorio. Un array di pattern URL che attivano il componente aggiuntivo per visualizzare i link di anteprima. |
runFunction |
Obbligatorio. Endpoint da eseguire quando viene attivata un'anteprima del link. |
logoUrl |
Campo facoltativo. L'icona visualizzata nello smart chip e nella scheda di anteprima. Se omesso, il componente aggiuntivo utilizza la propria icona della barra degli strumenti, |
UriPattern
La configurazione di ogni pattern URL che attiva un'anteprima del link.
Rappresentazione JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campi | |
---|---|
hostPattern |
Obbligatorio per ogni pattern URL da visualizzare in anteprima. Il dominio del pattern URL. Il componente aggiuntivo mostra in anteprima i link che contengono questo dominio nell'URL. Per visualizzare l'anteprima dei link per un sottodominio specifico, come Ad esempio, |
pathPrefix |
Campo facoltativo. Il percorso che aggiunge il dominio del Ad esempio, se il pattern host dell'URL è Per trovare la corrispondenza con tutti gli URL nel dominio dei pattern host, lascia vuoto il campo |
CreateActionExtensionPoint
La configurazione di un trigger che si attiva quando un utente richiama il flusso di lavoro di creazione delle risorse in un'applicazione Google Workspace. Per ulteriori informazioni, consulta 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 differenziare questo punto di estensione. L'ID può contenere fino a 64 caratteri e deve essere nel formato |
labelText |
Obbligatorio. Il testo visualizzato accanto all'icona per il punto di ingresso per la creazione della risorsa, ad esempio |
localizedLabelText |
Campo facoltativo. Una mappa di Se le impostazioni internazionali di un utente sono presenti nelle chiavi della mappa, l'utente vede la versione localizzata di Un oggetto contenente un elenco di |
runFunction |
Obbligatorio. Endpoint da eseguire quando viene attivato un flusso di lavoro di creazione di risorse per creare un collegamento. |
logoUrl |
Campo facoltativo. L'icona visualizzata per il punto di ingresso per la creazione della risorsa. Se omesso, il menu utilizza l'icona della barra degli strumenti del componente aggiuntivo, |
SheetsAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Fogli Google.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepageTrigger |
Se presente, sostituisce la configurazione di |
onFileScopeGrantedTrigger |
Endpoint da eseguire quando viene concessa l'autorizzazione dell'ambito file per questa coppia di documento/utente. |
linkPreviewTriggers[] |
Un elenco di punti di estensione per l'anteprima dei link in un documento di Fogli Google. Per maggiori dettagli, consulta Visualizzare l'anteprima dei link con smart chip. |
SheetsExtensionPoint
Formato comune per la dichiarazione degli attivatori di un componente aggiuntivo di Fogli.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione viene attivato. |
SlidesAddOnManifest
Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Presentazioni Google.
Rappresentazione JSON |
---|
{ "homepageTrigger": { object ( |
Campi | |
---|---|
homepageTrigger |
Se presente, sostituisce la configurazione di |
onFileScopeGrantedTrigger |
Endpoint da eseguire quando viene concessa l'autorizzazione dell'ambito file per questa coppia di documento/utente. |
linkPreviewTriggers[] |
Un elenco di punti di estensione per l'anteprima dei link in un documento di Presentazioni Google. Per maggiori dettagli, consulta Visualizzare l'anteprima dei link con smart chip. |
SlidesExtensionPoint
Formato comune per la dichiarazione degli attivatori di un componente aggiuntivo di Presentazioni.
Rappresentazione JSON |
---|
{ "runFunction": string } |
Campi | |
---|---|
runFunction |
Obbligatorio. L'endpoint da eseguire quando questo punto di estensione viene attivato. |
HttpOptions
Opzioni per l'invio di richieste agli endpoint HTTP
dei componenti aggiuntivi.
Rappresentazione JSON |
---|
{
"authorizationHeader": enum ( |
Campi | |
---|---|
authorizationHeader |
Configurazione del token inviato nell'intestazione di autorizzazione |
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 ID per l'account di servizio di sistema del componente aggiuntivo Google Workspace specifico del progetto (impostazione predefinita). |
USER_ID_TOKEN |
Invia un token ID per l'utente finale. |
NONE |
Non inviare un'intestazione di autenticazione. |
Metodi |
|
---|---|
|
Crea un deployment con il nome e la configurazione specificati. |
|
Elimina il deployment con il nome specificato. |
|
Restituisce il deployment con il nome specificato. |
|
Restituisce 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'implementazione di test dall'account dell'utente. |