REST Resource: projects.deployments

Risorsa: Deployment

Un deployment di un componente aggiuntivo di Google Workspace

Rappresentazione JSON
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Campi
name

string

Il nome della risorsa di deployment. Esempio: projects/123/deployments/my_deployment.

oauthScopes[]

string

L'elenco degli ambiti OAuth di Google per i quali richiedere il consenso dell'utente finale prima di eseguire un endpoint del componente aggiuntivo.

addOns

object (AddOns)

La configurazione del componente aggiuntivo di Google Workspace.

etag

string

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 abbia un valore aggiornato prima di procedere.

AddOns

Una configurazione del componente aggiuntivo di Google Workspace.

Rappresentazione 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)
  }
}
Campi
common

object (CommonAddOnManifest)

Configurazione comune a tutti i componenti aggiuntivi di Google Workspace.

gmail

object (GmailAddOnManifest)

Configurazione del componente aggiuntivo di Gmail.

drive

object (DriveAddOnManifest)

Configurazione del componente aggiuntivo di Drive.

calendar

object (CalendarAddOnManifest)

Configurazione del componente aggiuntivo di Calendar.

docs

object (DocsAddOnManifest)

Configurazione del componente aggiuntivo di Documenti.

meet

object (MeetAddOnManifest)

Configurazione del componente aggiuntivo di Meet.

sheets

object (SheetsAddOnManifest)

Configurazione del componente aggiuntivo di Fogli.

slides

object (SlidesAddOnManifest)

Configurazione del componente aggiuntivo di Slides.

httpOptions

object (HttpOptions)

Opzioni per l'invio di richieste agli endpoint HTTP dei componenti aggiuntivi

CommonAddOnManifest

Configurazione del componente aggiuntivo condivisa tra tutte le applicazioni in hosting del componente aggiuntivo.

Rappresentazione JSON
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
Campi
name

string

Obbligatorio. Il nome visualizzato del componente aggiuntivo.

logoUrl

string

Obbligatorio. L'URL dell'immagine del logo mostrata nella barra degli strumenti del componente aggiuntivo.

layoutProperties

object (LayoutProperties)

Proprietà di layout comuni per le schede dei componenti aggiuntivi.

addOnWidgetSet

object (AddOnWidgetSet)

I widget utilizzati nel componente aggiuntivo. Se questo campo non viene specificato, viene utilizzato l'insieme predefinito.

useLocaleFromApp

boolean

Indica se trasmettere le informazioni sulle impostazioni internazionali dall'app host.

homepageTrigger

object (HomepageExtensionPoint)

Definisce un endpoint che verrà eseguito in qualsiasi contesto, 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 trigger più mirati.

universalActions[]

object (UniversalActionExtensionPoint)

Definisce un elenco di punti di estensione nel menu Azioni universali che funge da menu Impostazioni per il componente aggiuntivo. Il punto di estensione può essere un URL di link da aprire o un endpoint da eseguire come invio di un modulo.

openLinkUrlPrefixes

array (ListValue format)

Un'azione OpenLink può utilizzare solo un URL con uno schema HTTPS, MAILTO o TEL. Per i link HTTPS, l'URL deve anche corrispondere a uno dei prefissi specificati nella lista consentita. Se il prefisso omette lo schema, viene utilizzato HTTPS. I link HTTP vengono riscritti automaticamente in link HTTPS.

LayoutProperties

Proprietà del layout delle schede condivise tra tutte le applicazioni in hosting dei componenti aggiuntivi.

Rappresentazione JSON
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Campi
primaryColor

string

Il colore principale del componente aggiuntivo. Imposta il colore della barra degli strumenti. Se non viene impostato un colore principale, viene utilizzato il valore predefinito fornito dal framework.

secondaryColor

string

Il colore secondario del componente aggiuntivo. Imposta il colore dei pulsanti. Se è impostato il colore principale, ma non quello secondario, quest'ultimo è uguale al colore principale. Se non vengono impostati né il colore principale né quello secondario, viene utilizzato il valore predefinito fornito dal framework.

useNewMaterialDesign
(deprecated)

boolean

Attiva Material Design per le schede.

AddOnWidgetSet

Il sottoinsieme di widget utilizzato da un componente aggiuntivo.

Rappresentazione JSON
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Campi
usedWidgets[]

enum (WidgetType)

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 persistenti consentono di mantenere i valori dei moduli durante le azioni.
UPDATE_SUBJECT_AND_RECIPIENTS Aggiornare 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 alla UI 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
runFunction

string

Obbligatorio. L'endpoint da eseguire quando viene attivato questo punto di estensione.

enabled

boolean

Facoltativo. Se impostato su false, disattiva la visualizzazione della home page in questo contesto.

Se non viene impostato, il valore predefinito è true.

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 della voce di menu Azione universale.

Rappresentazione JSON
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
Campi
label

string

Obbligatorio. Testo visibile all'utente che descrive l'azione eseguita attivando questo punto di estensione, ad esempio "Aggiungi un nuovo contatto".

Obbligatorio. Il tipo di azione supportato su una voce di menu Azioni universali. Può essere un link da aprire o un endpoint da eseguire. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
runFunction

string

Endpoint che deve essere eseguito da UniversalAction.

Fine dei campi che si escludono a vicenda.

GmailAddOnManifest

Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Gmail.

Rappresentazione JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Campi
homepageTrigger

object (HomepageExtensionPoint)

Definisce un endpoint che verrà eseguito in contesti che non corrispondono a un trigger 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 trigger più mirati.

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

contextualTriggers[]

object (ContextualTrigger)

Definisce l'insieme di condizioni che attivano il componente aggiuntivo.

universalActions[]

object (UniversalAction)

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.

composeTrigger

object (ComposeTrigger)

Definisce il trigger del tempo di composizione per un componente aggiuntivo del tempo di composizione. Questo è il trigger che fa sì che un componente aggiuntivo intervenga quando l'utente sta scrivendo un'email. Tutti i componenti aggiuntivi per la fase di composizione devono avere l'ambito gmail.addons.current.action.compose, anche se potrebbero non modificare la bozza.

authorizationCheckFunction

string

Il nome di un endpoint che verifica che il componente aggiuntivo disponga di tutte le autorizzazioni di terze parti richieste, eseguendo il probing delle API di terze parti. Se il probe 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 ottimale.

ContextualTrigger

Definisce un attivatore che si attiva quando l'email aperta soddisfa un criterio specifico. Quando il trigger si attiva, esegue un endpoint specifico, di solito per creare nuove schede e aggiornare la UI.

Rappresentazione JSON
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Campi
onTriggerFunction

string

Obbligatorio. Il nome dell'endpoint da chiamare quando un messaggio corrisponde al trigger.

Il tipo di trigger determina le condizioni utilizzate da Gmail per mostrare il componente aggiuntivo. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
unconditional

object (UnconditionalTrigger)

Gli attivatori incondizionati vengono eseguiti quando viene aperto un messaggio di posta.

Fine dei campi che si escludono a vicenda.

UnconditionalTrigger

Questo tipo non ha 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,

  "openLink": string,
  "runFunction": string
}
Campi
text

string

Obbligatorio. Testo visibile all'utente che descrive l'azione, ad esempio "Aggiungi un nuovo contatto".

Il tipo di azione determina il comportamento di Gmail quando l'utente richiama l'azione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
runFunction

string

Un endpoint che viene chiamato quando l'utente attiva l'azione. Per maggiori dettagli, consulta la guida alle azioni universali.

Fine dei campi che si escludono a vicenda.

ComposeTrigger

Un trigger che si attiva quando l'utente sta scrivendo un'email.

Rappresentazione JSON
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Campi
actions[]

object (MenuItemExtensionPoint)

Definisce l'insieme di azioni per un componente aggiuntivo per la fase di composizione. Queste sono le azioni che gli utenti possono attivare su un componente aggiuntivo per la fase di composizione.

draftAccess

enum (DraftAccess)

Definisce il livello di accesso ai dati quando viene attivato un componente aggiuntivo per la fase di composizione.

DraftAccess

Un enum che definisce il livello di accesso ai dati richiesto dal trigger di composizione.

Enum
UNSPECIFIED Valore predefinito quando non è impostato alcun valore per draftaccess.
NONE Il trigger di composizione non può accedere ai dati della bozza quando viene attivato un componente aggiuntivo di composizione.
METADATA Concede al trigger di composizione l'autorizzazione ad accedere ai metadati della bozza quando viene attivato un componente aggiuntivo di composizione. Sono inclusi gli elenchi dei segmenti di pubblico, ad esempio l'elenco dei destinatari nei campi 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 (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Campi
homepageTrigger

object (HomepageExtensionPoint)

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

onItemsSelectedTrigger

object (DriveExtensionPoint)

Corrisponde al comportamento che viene eseguito quando gli elementi vengono selezionati nella visualizzazione di Drive pertinente, ad esempio l'elenco di documenti di Il mio Drive.

DriveExtensionPoint

Formato comune per la dichiarazione dei trigger di un componente aggiuntivo di Drive.

Rappresentazione JSON
{
  "runFunction": string
}
Campi
runFunction

string

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 (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Campi
homepageTrigger

object (HomepageExtensionPoint)

Facoltativo. Definisce un endpoint che viene eseguito in contesti che non corrispondono a un trigger 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 trigger più mirati.

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

conferenceSolution[]

object (ConferenceSolution)

Facoltativo. Definisce le soluzioni per conferenze fornite da questo componente aggiuntivo.

createSettingsUrlFunction

string

Un endpoint da eseguire che crea un URL alla pagina delle impostazioni del componente aggiuntivo.

eventOpenTrigger

object (CalendarExtensionPoint)

Un endpoint che si attiva quando un evento viene aperto per essere visualizzato o modificato.

eventUpdateTrigger

object (CalendarExtensionPoint)

Un endpoint che si attiva quando l'evento di apertura viene aggiornato.

calendarNotificationTrigger

object (CalendarExtensionPoint)

Facoltativo. Si attiva quando un evento viene creato o aggiornato per un calendario a cui l'utente è iscritto. Si applica solo ai trigger creati da HTTP endpoints utilizzando CalendarSubscriptionActionMarkup.

Per evitare loop di notifiche ricorsivi, quando un componente aggiuntivo modifica un evento di Google Calendar utilizzando l'API Calendar con credenziali di autenticazione dello stesso progetto Google Cloud che ospita il deployment del componente aggiuntivo, la piattaforma sopprime le notifiche di modifica. L'attivazione automatica delle chiamate API Calendar del tuo progetto non è supportata.

Non applicabile a Apps Script add-ons e Apps Script installable triggers.

eventAttachmentTrigger

object (MenuItemExtensionPoint)

Una configurazione per un trigger contestuale che si attiva quando l'utente fa clic sul provider di allegati del componente aggiuntivo nel menu a discesa di Calendar.

currentEventAccess

enum (EventAccess)

Definisce il livello di accesso ai dati quando viene attivato un componente aggiuntivo per gli eventi.

ConferenceSolution

Definisce i valori relativi alla conferenza.

Rappresentazione JSON
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Campi
onCreateFunction

string

Obbligatorio. L'endpoint da chiamare quando devono essere creati i dati della conferenza.

id

string

Obbligatorio. Gli ID devono essere assegnati in modo univoco alle soluzioni per conferenze all'interno di un componente aggiuntivo, altrimenti potrebbe essere utilizzata la soluzione per conferenze sbagliata quando viene attivato il componente aggiuntivo. Anche se puoi modificare il nome visualizzato di un componente aggiuntivo, l'ID non deve essere modificato.

name

string

Obbligatorio. Il nome visualizzato della soluzione per conferenze.

logoUrl

string

Obbligatorio. L'URL dell'immagine del logo della soluzione per conferenze.

CalendarExtensionPoint

Formato comune per la dichiarazione dei trigger di un componente aggiuntivo di Calendar.

Rappresentazione JSON
{
  "runFunction": string
}
Campi
runFunction

string

Obbligatorio. L'endpoint da eseguire quando viene attivato questo punto di estensione.

EventAccess

Un enum che definisce il livello di accesso ai dati richiesto dagli attivatori di eventi.

Enum
UNSPECIFIED Valore predefinito quando non è impostato alcun valore per eventAccess.
METADATA Concede ai trigger di eventi l'autorizzazione ad accedere ai metadati degli eventi, come l'ID evento e l'ID calendario.
READ Consente ai trigger di eventi di accedere a tutti i campi degli eventi forniti, inclusi i metadati, i partecipanti e i dati della conferenza.
WRITE Consente ai trigger di eventi di accedere ai metadati degli eventi e di eseguire tutte le azioni, tra cui 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 i metadati, i partecipanti e i dati della conferenza, nonché 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 (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Campi
homepageTrigger

object (HomepageExtensionPoint)

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Endpoint da eseguire quando viene concessa l'autorizzazione per l'ambito del file per questa coppia documento/utente.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Un elenco di punti di estensione per l'anteprima dei link in un documento di Documenti Google. Per maggiori dettagli, vedi Visualizza l'anteprima dei link con smart chip.

createActionTriggers[]

object (CreateActionExtensionPoint)

Un elenco di punti di estensione per la creazione di risorse di terze parti dalle applicazioni Google Workspace. Per saperne di più, consulta Creare risorse di terze parti dal menu @.

DocsExtensionPoint

Formato comune per la dichiarazione dei trigger di un componente aggiuntivo di Documenti.

Rappresentazione JSON
{
  "runFunction": string
}
Campi
runFunction

string

Obbligatorio. L'endpoint da eseguire quando viene attivato questo punto di estensione.

LinkPreviewExtensionPoint

La configurazione di un trigger 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 (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
Campi
labelText

string

Obbligatorio. Il testo di uno smart chip di esempio che invita gli utenti a visualizzare l'anteprima del link, ad esempio Example: Support case. Questo testo è statico e viene visualizzato prima che gli utenti eseguano il componente aggiuntivo.

localizedLabelText

map (key: string, value: string)

Facoltativo. Una mappa di labeltext da localizzare in altre lingue. Formatta la lingua in ISO 639 e il paese/la regione in ISO 3166, separati da un trattino -. Ad esempio, en-US.

Se le impostazioni internazionali di un utente sono presenti nelle chiavi della mappa, l'utente visualizza la versione localizzata di labeltext.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

patterns[]

object (UriPattern)

Obbligatorio. Un array di pattern URL che attivano il componente aggiuntivo per visualizzare l'anteprima dei link.

runFunction

string

Obbligatorio. Endpoint da eseguire quando viene attivata un'anteprima del link.

logoUrl

string

Facoltativo. L'icona visualizzata nello smart chip e nella scheda di anteprima. Se omesso, il componente aggiuntivo utilizza l'icona della barra degli strumenti, logourl.

UriPattern

La configurazione di ogni pattern URL che attiva un'anteprima del link.

Rappresentazione JSON
{
  "hostPattern": string,
  "pathPrefix": string
}
Campi
hostPattern

string

Obbligatorio per ogni pattern URL da visualizzare in anteprima. Il dominio del pattern URL. Il componente aggiuntivo visualizza l'anteprima dei link che contengono questo dominio nell'URL. Per visualizzare l'anteprima dei link per un sottodominio specifico, ad esempio subdomain.example.com, includi il sottodominio. Per visualizzare l'anteprima dei link per l'intero dominio, specifica un carattere jolly con un asterisco (*) come sottodominio.

Ad esempio, *.example.com corrisponde a subdomain.example.com e another.subdomain.example.com.

pathPrefix

string

Facoltativo. Il percorso che aggiunge il dominio di hostpattern.

Ad esempio, se il pattern host dell'URL è support.example.com, per trovare corrispondenze con gli URL dei casi ospitati su support.example.com/cases/, inserisci cases.

Per trovare tutti gli URL nel dominio del pattern host, lascia vuoto pathprefix.

CreateActionExtensionPoint

La configurazione di un trigger che si attiva quando un utente richiama il workflow di creazione delle risorse in un'applicazione Google Workspace. Per saperne di più, consulta Creare risorse di terze parti dal menu @.

Rappresentazione JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Campi
id

string

Obbligatorio. L'ID univoco per differenziare questo punto di estensione. L'ID può contenere fino a 64 caratteri e deve essere nel formato [a-zA-Z0-9-]+.

labelText

string

Obbligatorio. Il testo visualizzato accanto a un'icona per il punto di accesso alla creazione della risorsa, ad esempio Create support case. Questo testo è statico e viene visualizzato prima che gli utenti eseguano il componente aggiuntivo.

localizedLabelText

map (key: string, value: string)

Facoltativo. Una mappa di labeltext da localizzare in altre lingue. Formatta la lingua in ISO 639 e il paese/la regione in ISO 3166, separati da un trattino -. Ad esempio, en-US.

Se le impostazioni internazionali di un utente sono presenti nelle chiavi della mappa, l'utente visualizza la versione localizzata di labeltext.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

runFunction

string

Obbligatorio. Endpoint da eseguire quando viene attivato un workflow di creazione delle risorse per creare un link.

logoUrl

string

Facoltativo. L'icona visualizzata per il punto di accesso alla creazione della risorsa. Se omessa, il menu utilizza l'icona della barra degli strumenti del componente aggiuntivo, logourl.

MeetAddOnManifest

Manifest del componente aggiuntivo di Meet.

Rappresentazione JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Campi
homepageTrigger

object (HomepageExtensionPoint)

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

web

object (Web)

Dettagli dei componenti aggiuntivi che migliorano il client web di Meet.

supportsCollaboration

boolean

Se il componente aggiuntivo supporta la collaborazione o l'invito di altri utenti all'esperienza del componente aggiuntivo.

termsUri

string

Un link ai Termini di servizio del componente aggiuntivo, se presenti.

Web

Dettagli dei componenti aggiuntivi che migliorano il client web di Meet.

Rappresentazione 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)
}
Campi
sidePanelUri
(deprecated)

string

L'URI dell'iframe del riquadro laterale.

sidePanelUrl

string

L'URL dell'iframe del riquadro laterale.

mainStageUri
(deprecated)

string

L'URI dell'iframe "fase principale".

supportsScreenSharing

boolean

Indica se il componente aggiuntivo supporta la condivisione schermo della fase principale.

supportsCollaboration
(deprecated)

boolean

Se il componente aggiuntivo supporta la collaborazione o l'invito di altri utenti all'esperienza del componente aggiuntivo. Questo campo è ora deprecato. Utilizza il campo di primo livello in MeetAddOnManifest.

supportsPopOut

boolean

Indica se il componente aggiuntivo supporta l'apertura in un'esperienza PiP del browser.

hostOrigins[]
(deprecated)

string

Nome legacy deprecato. Origini che devono essere aggiunte alla proprietà frame-src dell'iframe contenente il sito di terze parti. Utilizza invece addonorigins.

addOnOrigins[]

string

Origini che devono essere aggiunte alla proprietà frame-src dell'iframe contenente il sito di terze parti.

openState

enum (State)

Lo stato iniziale quando viene aperto il componente aggiuntivo.

supportsCollaborationHostControls

boolean

Se il componente aggiuntivo di collaborazione supporta i controlli dell'organizzatore.

logoUrl

string

L'URL del logo da visualizzare per il componente aggiuntivo. Se non specificato, il logo predefinito è quello nella sezione comune del manifest.

darkModeLogoUrl

string

Una versione in modalità Buio del logourl.

displayFlow
(deprecated)

enum (DisplayFlow)

Il flusso di visualizzazione che il componente aggiuntivo seguirà al momento del lancio.

Stato

Enum per specificare lo stato di apertura iniziale del componente aggiuntivo.

Enum
STATE_UNSPECIFIED Lo stato iniziale non è stato specificato con il componente aggiuntivo.
SIDE_PANEL_ONLY Il componente aggiuntivo si apre con solo il riquadro laterale attivo.
MAIN_STAGE_ONLY Il componente aggiuntivo si apre con solo la schermata principale attiva.
SIDE_PANEL_AND_MAIN_STAGE Il componente aggiuntivo si apre con il riquadro laterale e la schermata principale attivi.

DisplayFlow

Enum per specificare il flusso di visualizzazione che il componente aggiuntivo seguirà al momento del lancio

Enum
DISPLAY_FLOW_UNSPECIFIED Il flusso di visualizzazione non è stato specificato.
FOCUS Il componente aggiuntivo deve essere avviato nel flusso di visualizzazione "focus".
AUGMENT Il componente aggiuntivo deve essere avviato nel flusso di visualizzazione "augment".

SheetsAddOnManifest

Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Fogli Google.

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

object (HomepageExtensionPoint)

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Endpoint da eseguire quando viene concessa l'autorizzazione per l'ambito del file per questa coppia documento/utente.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Un elenco di punti di estensione per l'anteprima dei link in un documento di Fogli Google. Per maggiori dettagli, vedi Visualizza 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

string

Obbligatorio. L'endpoint da eseguire quando viene attivato questo punto di estensione.

SlidesAddOnManifest

Proprietà che personalizzano l'aspetto e l'esecuzione di un componente aggiuntivo di Presentazioni Google.

Rappresentazione JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campi
homepageTrigger

object (HomepageExtensionPoint)

Se presente, esegue l'override della configurazione di addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Endpoint da eseguire quando viene concessa l'autorizzazione per l'ambito del file per questa coppia documento/utente.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Un elenco di punti di estensione per l'anteprima dei link in un documento di Presentazioni Google. Per maggiori dettagli, vedi Visualizza l'anteprima dei link con smart chip.

SlidesExtensionPoint

Formato comune per la dichiarazione dei trigger di un componente aggiuntivo di Presentazioni.

Rappresentazione JSON
{
  "runFunction": string
}
Campi
runFunction

string

Obbligatorio. L'endpoint da eseguire quando viene attivato questo punto di estensione.

HttpOptions

Opzioni per l'invio di richieste agli endpoint HTTP del componente aggiuntivo.

Rappresentazione JSON
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Campi
authorizationHeader

enum (HttpAuthorizationHeader)

Configurazione del token inviato nell'intestazione Authorization HTTP.

granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

Se il componente aggiuntivo ha attivato il consenso OAuth granulare.

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 (predefinito).
USER_ID_TOKEN Invia un token ID per l'utente finale.
NONE Non inviare un'intestazione di autenticazione.

GranularOauthPermissionSupport

Se il componente aggiuntivo ha attivato il consenso OAuth granulare.

Enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Valore predefinito, non deve essere utilizzato.
OPT_IN Il componente aggiuntivo ha attivato il consenso OAuth granulare.
OPT_OUT Il componente aggiuntivo ha disattivato il consenso OAuth granulare.

Metodi

create

Crea un deployment con il nome e la configurazione specificati.

delete

Elimina il deployment con il nome specificato.

get

Recupera il deployment con il nome specificato.

getInstallStatus

Recupera lo stato di installazione di un deployment di test.

install

Installa un deployment nel tuo account per i test.

list

Elenca tutti i deployment in un determinato progetto.

replaceDeployment

Crea o sostituisce un deployment con il nome specificato.

uninstall

Disinstalla un deployment di test dall'account dell'utente.