REST Resource: projects.deployments

Ressource : Deployment

Un déploiement de module complémentaire Google Workspace

Représentation JSON 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Champs
name

string

Nom de la ressource de déploiement. Exemple : projects/123/deployments/my_deployment.
oauthScopes[]

string

Liste des habilitations OAuth Google pour lesquelles demander le consentement de l'utilisateur final avant d'exécuter un point de terminaison de module complémentaire.
addOns

object (AddOns)

Configuration du module complémentaire Google Workspace.
etag

string

Cette valeur est calculée par le serveur en fonction de la version du déploiement dans l'espace de stockage. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de continuer.

AddOns

Configuration d'un module complémentaire Google Workspace.

Représentation 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)
  }
}
Champs
common

object (CommonAddOnManifest)

Configuration commune à tous les modules complémentaires Google Workspace.
gmail

object (GmailAddOnManifest)

Configuration du module complémentaire Gmail.
drive

object (DriveAddOnManifest)

Configuration du module complémentaire Drive.
calendar

object (CalendarAddOnManifest)

Configuration du module complémentaire Agenda.
docs

object (DocsAddOnManifest)

Configuration du module complémentaire Docs.
meet

object (MeetAddOnManifest)

Configuration du module complémentaire Meet.
sheets

object (SheetsAddOnManifest)

Configuration du module complémentaire Sheets.
slides

object (SlidesAddOnManifest)

Configuration du module complémentaire Slides.
httpOptions

object (HttpOptions)

Options d'envoi de requêtes aux points de terminaison HTTP du module complémentaire

CommonAddOnManifest

Configuration du module complémentaire partagée entre toutes les applications hôtes du module complémentaire.

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

string

Obligatoire. Nom à afficher du module complémentaire.
logoUrl

string

Obligatoire. URL de l'image du logo affichée dans la barre d'outils du module complémentaire.
layoutProperties

object (LayoutProperties)

Propriétés de mise en page courantes pour les fiches du module complémentaire.
addOnWidgetSet

object (AddOnWidgetSet)

Widgets utilisés dans le module complémentaire. Si ce champ n'est pas spécifié, l'ensemble par défaut est utilisé.
useLocaleFromApp

boolean

Indique si les informations sur les paramètres régionaux doivent être transmises depuis l'application hôte.
homepageTrigger

object (HomepageExtensionPoint)

Définit un point de terminaison qui sera exécuté dans n'importe quel contexte, sur n'importe quel hôte. Toutes les fiches générées par cette fonction seront toujours disponibles pour l'utilisateur, mais elles pourront être éclipsées par du contenu contextuel lorsque ce module complémentaire déclarera des déclencheurs plus ciblés.
universalActions[]

object (UniversalActionExtensionPoint)

Définit une liste de points d'extension dans le menu d'actions universelles qui sert de menu de paramètres pour le module complémentaire. Le point d'extension peut être une URL de lien à ouvrir ou un point de terminaison à exécuter en tant qu'envoi de formulaire.
openLinkUrlPrefixes

array (ListValue format)

Une action OpenLink ne peut utiliser qu'une URL avec un schéma HTTPS, MAILTO ou TEL. Pour les liens HTTPS, l'URL doit également correspondre à l'un des préfixes spécifiés dans la liste d'autorisation. Si le préfixe omet le schéma, HTTPS est supposé. Les liens HTTP sont automatiquement réécrits en liens HTTPS.

LayoutProperties

Propriétés de mise en page des fiches partagées entre toutes les applications hôtes du module complémentaire.

Représentation JSON 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Champs
primaryColor

string

Couleur principale du module complémentaire. Elle définit la couleur de la barre d'outils. Si aucune couleur principale n'est définie, la valeur par défaut fournie par le framework est utilisée.
secondaryColor

string

Couleur secondaire du module complémentaire. Il définit la couleur des boutons. Si la couleur principale est définie, mais pas la couleur secondaire, la couleur secondaire est identique à la couleur principale. Si aucune couleur principale ni secondaire n'est définie, la valeur par défaut fournie par le framework est utilisée.
useNewMaterialDesign
(deprecated)

boolean

Active Material Design pour les fiches.

AddOnWidgetSet

Sous-ensemble de widgets utilisé par un module complémentaire.

Représentation JSON 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Champs
usedWidgets[]

enum (WidgetType)

Liste des widgets utilisés dans un module complémentaire.

WidgetType

Type de widget. WIDGET_TYPE_UNSPECIFIED est l'ensemble de widgets de base.

Enums
WIDGET_TYPE_UNSPECIFIED Ensemble de widgets par défaut.
DATE_PICKER Sélecteur de date.
STYLED_BUTTONS Les boutons stylisés incluent les boutons remplis et les boutons désactivés.
PERSISTENT_FORMS Les formulaires persistants permettent de conserver les valeurs des formulaires pendant les actions.
UPDATE_SUBJECT_AND_RECIPIENTS Mettre à jour l'objet et les destinataires d'un brouillon.
GRID_WIDGET Le widget de grille.
ADDON_COMPOSE_UI_ACTION Action de module complémentaire Gmail qui s'applique à l'interface utilisateur de rédaction du module complémentaire.

HomepageExtensionPoint

Format courant pour déclarer la vue de la page d'accueil d'un module complémentaire.

Représentation JSON 
{
  "runFunction": string,
  "enabled": boolean
}
Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.
enabled

boolean

Facultatif. Si la valeur est définie sur false, la vue de la page d'accueil est désactivée dans ce contexte.

La valeur par défaut est true si elle n'est pas définie.

Si la vue personnalisée de la page d'accueil d'un module complémentaire est désactivée, une fiche de présentation générique est fournie aux utilisateurs à la place.

UniversalActionExtensionPoint

Format de déclaration d'un point d'extension d'élément de menu d'action universelle.

Représentation JSON 
{
  "label": string,

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

string

Obligatoire. Texte visible par l'utilisateur qui décrit l'action effectuée en activant ce point d'extension, par exemple "Ajouter un contact".
Obligatoire. Type d'action compatible avec un élément de menu d'action universelle. Il peut s'agir d'un lien à ouvrir ou d'un point de terminaison à exécuter. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
runFunction

string

Point de terminaison à exécuter par UniversalAction.
Fin des champs mutuellement exclusifs.

GmailAddOnManifest

Propriétés permettant de personnaliser l'apparence et l'exécution d'un module complémentaire Gmail.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Définit un point de terminaison qui sera exécuté dans des contextes ne correspondant pas à un déclencheur contextuel déclaré. Toutes les fiches générées par cette fonction seront toujours disponibles pour l'utilisateur, mais elles pourront être éclipsées par du contenu contextuel lorsque ce module complémentaire déclarera des déclencheurs plus ciblés.

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
contextualTriggers[]

object (ContextualTrigger)

Définit l'ensemble des conditions qui déclenchent le module complémentaire.
universalActions[]

object (UniversalAction)

Définit un ensemble d'actions universelles pour le module complémentaire. L'utilisateur déclenche des actions universelles à partir du menu de la barre d'outils du module complémentaire.
composeTrigger

object (ComposeTrigger)

Définit le déclencheur de l'interface de rédaction pour un module complémentaire de l'interface de rédaction. Il s'agit du déclencheur qui permet à un module complémentaire d'effectuer une action lorsque l'utilisateur rédige un e-mail. Tous les modules complémentaires de rédaction doivent disposer du champ d'application gmail.addons.current.action.compose, même s'ils ne modifient pas le brouillon.
authorizationCheckFunction

string

Nom d'un point de terminaison qui vérifie que le module complémentaire dispose de toutes les autorisations tierces requises, en sondant les API tierces. Si la vérification échoue, la fonction doit générer une exception pour lancer le flux d'autorisation. Cette fonction est appelée avant chaque appel du module complémentaire afin de garantir une expérience utilisateur fluide.

ContextualTrigger

Définit un déclencheur qui s'active lorsque l'e-mail ouvert répond à un critère spécifique. Lorsque le déclencheur s'active, il exécute un point de terminaison spécifique, généralement pour créer des fiches et mettre à jour l'UI.

Représentation JSON 
{
  "onTriggerFunction": string,

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

string

Obligatoire. Nom du point de terminaison à appeler lorsqu'un message correspond au déclencheur.
Le type de déclencheur détermine les conditions utilisées par Gmail pour afficher le module complémentaire. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
unconditional

object (UnconditionalTrigger)

Les déclencheurs inconditionnels sont exécutés lorsqu'un message est ouvert.
Fin des champs mutuellement exclusifs.

UnconditionalTrigger

Ce type ne comporte aucun champ.

Déclencheur qui s'active lorsqu'un e-mail est ouvert.

UniversalAction

Action toujours disponible dans le menu de la barre d'outils du module complémentaire, quel que soit le contexte du message.

Représentation JSON 
{
  "text": string,

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

string

Obligatoire. Texte visible par l'utilisateur décrivant l'action, par exemple "Ajouter un contact".
Le type d'action détermine le comportement de Gmail lorsque l'utilisateur l'appelle. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
runFunction

string

Point de terminaison appelé lorsque l'utilisateur déclenche l'action. Pour en savoir plus, consultez le guide sur les actions universelles.
Fin des champs mutuellement exclusifs.

ComposeTrigger

Déclencheur qui s'active lorsque l'utilisateur rédige un e-mail.

Représentation JSON 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Champs
actions[]

object (MenuItemExtensionPoint)

Définit l'ensemble des actions d'un module complémentaire de rédaction. Il s'agit d'actions que les utilisateurs peuvent déclencher sur un module complémentaire au moment de la rédaction.
draftAccess

enum (DraftAccess)

Définit le niveau d'accès aux données lorsqu'un module complémentaire de rédaction est déclenché.

DraftAccess

Énumération qui définit le niveau d'accès aux données requis par le déclencheur de rédaction.

Enums
UNSPECIFIED Valeur par défaut lorsque rien n'est défini pour draftaccess.
NONE Le déclencheur de rédaction ne peut accéder à aucune donnée du brouillon lorsqu'un module complémentaire de rédaction est déclenché.
METADATA Autorise le déclencheur de rédaction à accéder aux métadonnées du brouillon lorsqu'un module complémentaire de rédaction est déclenché. Cela inclut la liste d'audience, comme la liste des destinataires et des personnes en copie d'un brouillon de message.

DriveAddOnManifest

Propriétés permettant de personnaliser l'apparence et l'exécution d'un module complémentaire Drive.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Correspond au comportement qui s'exécute lorsque des éléments sont sélectionnés dans la vue Drive correspondante, comme la liste de documents Mon Drive.

DriveExtensionPoint

Format courant pour déclarer les déclencheurs d'un module complémentaire Drive.

Représentation JSON 
{
  "runFunction": string
}
Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque le point d'extension est activé.

CalendarAddOnManifest

Propriétés permettant de personnaliser l'apparence et l'exécution d'un module complémentaire Agenda.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Facultatif. Définit un point de terminaison qui est exécuté dans des contextes ne correspondant pas à un déclencheur contextuel déclaré. Toutes les fiches générées par cette fonction seront toujours disponibles pour l'utilisateur, mais elles pourront être éclipsées par du contenu contextuel lorsque ce module complémentaire déclarera des déclencheurs plus ciblés.

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

Facultatif. Définit les solutions de conférence fournies par ce module complémentaire.
createSettingsUrlFunction

string

Un point de terminaison à exécuter qui crée une URL vers la page des paramètres du module complémentaire.
eventOpenTrigger

object (CalendarExtensionPoint)

Point de terminaison qui se déclenche lorsqu'un événement est ouvert pour être consulté ou modifié.
eventUpdateTrigger

object (CalendarExtensionPoint)

Point de terminaison qui se déclenche lorsque l'événement d'ouverture est mis à jour.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Facultatif. Se déclenche lorsqu'un événement est créé ou mis à jour pour un agenda auquel l'utilisateur est abonné. S'applique uniquement aux déclencheurs créés par HTTP endpoints à l'aide de CalendarSubscriptionActionMarkup.

Pour éviter les boucles de notification récursives, lorsqu'un module complémentaire modifie un événement Google Agenda à l'aide de l'API Agenda avec des identifiants d'authentification provenant du même projet Google Cloud que celui qui héberge le déploiement du module complémentaire, la plate-forme supprime les notifications de modification. Le déclenchement automatique des appels d'API Calendar de votre propre projet n'est pas possible.

Non applicable à Apps Script add-ons et Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

Configuration d'un déclencheur contextuel qui se déclenche lorsque l'utilisateur clique sur le fournisseur de pièces jointes du module complémentaire dans le menu déroulant de l'agenda.
currentEventAccess

enum (EventAccess)

Définit le niveau d'accès aux données lorsqu'un module complémentaire d'événement est déclenché.

ConferenceSolution

Définit les valeurs liées à la conférence.

Représentation JSON 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Champs
onCreateFunction

string

Obligatoire. Point de terminaison à appeler lorsque des données de conférence doivent être créées.
id

string

Obligatoire. Les ID doivent être attribués de manière unique aux solutions de conférence d'un module complémentaire. Sinon, la mauvaise solution de conférence risque d'être utilisée lorsque le module complémentaire est déclenché. Vous pouvez modifier le nom à afficher d'un module complémentaire, mais pas son ID.
name

string

Obligatoire. Nom à afficher de la solution de conférence.
logoUrl

string

Obligatoire. URL de l'image du logo de la solution de conférence.

CalendarExtensionPoint

Format commun pour déclarer les déclencheurs d'un module complémentaire d'agenda.

Représentation JSON 
{
  "runFunction": string
}
Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.

EventAccess

Énumération qui définit le niveau d'accès aux données requis par les déclencheurs d'événements.

Enums
UNSPECIFIED Valeur par défaut lorsqu'aucune valeur n'est définie pour eventAccess.
METADATA Autorise les déclencheurs d'événements à accéder aux métadonnées des événements, telles que l'ID d'événement et l'ID d'agenda.
READ Permet aux déclencheurs d'événements d'accéder à tous les champs d'événement fournis, y compris les métadonnées, les participants et les données de conférence.
WRITE Permet aux déclencheurs d'événements d'accéder aux métadonnées des événements et d'effectuer toutes les actions, y compris l'ajout de participants et la définition des données de conférence.
READ_WRITE Permet aux déclencheurs d'événements d'accéder à tous les champs d'événement fournis, y compris les métadonnées, les participants et les données de conférence, et d'effectuer toutes les actions.

DocsAddOnManifest

Propriétés permettant de personnaliser l'apparence et l'exécution d'un module complémentaire Google Docs.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Point de terminaison à exécuter lorsque l'autorisation d'accès au niveau du fichier est accordée pour cette paire document/utilisateur.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Liste des points d'extension pour prévisualiser les liens dans un document Google Docs. Pour en savoir plus, consultez Prévisualiser les liens avec les chips intelligents.
createActionTriggers[]

object (CreateActionExtensionPoint)

Liste des points d'extension permettant de créer des ressources tierces à partir des applications Google Workspace. Pour en savoir plus, consultez Créer des ressources tierces à partir du menu @.

DocsExtensionPoint

Format courant pour déclarer les déclencheurs d'un module complémentaire Docs.

Représentation JSON 
{
  "runFunction": string
}
Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.

LinkPreviewExtensionPoint

Configuration d'un déclencheur qui s'active lorsqu'un utilisateur saisit ou colle un lien provenant d'un service tiers ou non Google dans un fichier Google Docs, Sheets ou Slides.

Représentation JSON 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
Champs
labelText

string

Obligatoire. Texte d'un exemple de chip intelligent qui invite les utilisateurs à prévisualiser le lien, par exemple Example: Support case. Ce texte est statique et s'affiche avant que les utilisateurs n'exécutent le module complémentaire.
localizedLabelText

map (key: string, value: string)

Facultatif. Mappage de labeltext à localiser dans d'autres langues. Mettez en forme la langue au format ISO 639 et le pays/la région au format ISO 3166, séparés par un trait d'union -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, l'utilisateur voit la version localisée de labeltext.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (UriPattern)

Obligatoire. Tableau de formats d'URL qui déclenchent l'aperçu des liens par le module complémentaire.
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsqu'un aperçu de lien est déclenché.
logoUrl

string

Facultatif. Icône qui s'affiche dans le chip intelligent et la fiche d'aperçu. En cas d'omission, le module complémentaire utilise l'icône de sa barre d'outils, logourl.

UriPattern

Configuration de chaque format d'URL qui déclenche un aperçu de lien.

Représentation JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Champs
hostPattern

string

Obligatoire pour chaque format d'URL à prévisualiser. Domaine du format d'URL. Le module complémentaire prévisualise les liens qui contiennent ce domaine dans l'URL. Pour prévisualiser les liens d'un sous-domaine spécifique, comme subdomain.example.com, incluez le sous-domaine. Pour prévisualiser les liens de l'ensemble du domaine, spécifiez un caractère générique avec un astérisque (*) comme sous-domaine.

Par exemple, *.example.com correspond à subdomain.example.com et another.subdomain.example.com.
pathPrefix

string

Facultatif. Chemin d'accès qui ajoute le domaine de hostpattern.

Par exemple, si le format d'hôte d'URL est support.example.com, pour faire correspondre les URL des demandes hébergées sur support.example.com/cases/, saisissez cases.

Pour faire correspondre toutes les URL du domaine du format d'hôte, laissez pathprefix vide.

CreateActionExtensionPoint

Configuration d'un déclencheur qui s'active lorsqu'un utilisateur appelle le workflow de création de ressources dans une application Google Workspace. Pour en savoir plus, consultez Créer des ressources tierces à partir du menu @.

Représentation JSON 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Champs
id

string

Obligatoire. Identifiant unique permettant de différencier ce point d'extension. L'ID peut comporter jusqu'à 64 caractères et doit être au format [a-zA-Z0-9-]+.
labelText

string

Obligatoire. Texte qui s'affiche à côté d'une icône pour le point d'entrée de création de ressource, par exemple Create support case. Ce texte est statique et s'affiche avant que les utilisateurs n'exécutent le module complémentaire.
localizedLabelText

map (key: string, value: string)

Facultatif. Mappage de labeltext à localiser dans d'autres langues. Mettez en forme la langue au format ISO 639 et le pays/la région au format ISO 3166, séparés par un trait d'union -. Par exemple, en-US.

Si les paramètres régionaux d'un utilisateur sont présents dans les clés de la carte, l'utilisateur voit la version localisée de labeltext.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsqu'un workflow de création de ressource est déclenché pour créer un lien.
logoUrl

string

Facultatif. Icône qui s'affiche pour le point d'entrée de création de ressource. En cas d'omission, le menu utilise l'icône de la barre d'outils de votre module complémentaire, logourl.

MeetAddOnManifest

Fichier manifeste du module complémentaire Meet.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
web

object (Web)

Détails des modules complémentaires qui améliorent le client Web Meet.
supportsCollaboration

boolean

Indique si le module complémentaire permet de collaborer ou d'inviter d'autres personnes à l'utiliser.
termsUri

string

Lien vers les conditions d'utilisation du module complémentaire, le cas échéant.

Web

Détails des modules complémentaires qui améliorent le client Web Meet.

Représentation 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)
}
Champs
sidePanelUri
(deprecated)

string

URI de l'iFrame du panneau latéral.
sidePanelUrl

string

URL de l'iFrame du panneau latéral.
mainStageUri
(deprecated)

string

URI de l'iFrame "main stage".
supportsScreenSharing

boolean

Indique si le module complémentaire est compatible avec le partage d'écran de la scène principale.
supportsCollaboration
(deprecated)

boolean

Indique si le module complémentaire permet de collaborer ou d'inviter d'autres personnes à l'utiliser. Ce champ est désormais obsolète. Veuillez utiliser le champ de premier niveau dans MeetAddOnManifest.
supportsPopOut

boolean

Indique si le module complémentaire est compatible avec l'affichage dans une fenêtre PiP du navigateur.
hostOrigins[]
(deprecated)

string

Nom obsolète. Origines à ajouter à la propriété frame-src de l'iFrame contenant le site tiers. Utilisez plutôt addonorigins.
addOnOrigins[]

string

Origines à ajouter à la propriété frame-src de l'iFrame contenant le site tiers.
openState

enum (State)

État initial à l'ouverture du module complémentaire.
supportsCollaborationHostControls

boolean

Indique si le module complémentaire de collaboration est compatible avec les commandes de l'organisateur.
logoUrl

string

URL du logo à afficher pour le module complémentaire. Si ce champ n'est pas spécifié, le logo par défaut est celui de la section commune du fichier manifeste.
darkModeLogoUrl

string

Version en mode sombre de l'URL du logo.
displayFlow
(deprecated)

enum (DisplayFlow)

Flux d'affichage que le module complémentaire suivra lors de son lancement.

État

Énumération permettant de spécifier l'état d'ouverture initial du module complémentaire.

Enums
STATE_UNSPECIFIED L'état initial n'a pas été spécifié avec le module complémentaire.
SIDE_PANEL_ONLY Le module complémentaire s'ouvre avec uniquement le panneau latéral actif.
MAIN_STAGE_ONLY Le module complémentaire s'ouvre avec uniquement l'espace principal actif.
SIDE_PANEL_AND_MAIN_STAGE Le module complémentaire s'ouvre avec le panneau latéral et l'espace principal actifs.

DisplayFlow

Énumération permettant de spécifier le flux d'affichage que le module complémentaire suivra lors de son lancement

Enums
DISPLAY_FLOW_UNSPECIFIED Le flux d'affichage n'a pas été spécifié.
FOCUS Le module complémentaire doit se lancer dans le flux d'affichage "focus".
AUGMENT Le module complémentaire doit se lancer dans le flux d'affichage "augment".

SheetsAddOnManifest

Propriétés personnalisant l'apparence et l'exécution d'un module complémentaire Google Sheets.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Point de terminaison à exécuter lorsque l'autorisation d'accès au niveau du fichier est accordée pour cette paire document/utilisateur.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Liste des points d'extension pour prévisualiser les liens dans un document Google Sheets. Pour en savoir plus, consultez Prévisualiser les liens avec les chips intelligents.

SheetsExtensionPoint

Format courant pour déclarer les déclencheurs d'un module complémentaire Sheets.

Représentation JSON 
{
  "runFunction": string
}
Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.

SlidesAddOnManifest

Propriétés permettant de personnaliser l'apparence et l'exécution d'un module complémentaire Google Slides.

Représentation JSON 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Si ce champ est présent, il remplace la configuration de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Point de terminaison à exécuter lorsque l'autorisation d'accès au niveau du fichier est accordée pour cette paire document/utilisateur.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Liste des points d'extension pour prévisualiser les liens dans un document Google Slides. Pour en savoir plus, consultez Prévisualiser les liens avec les chips intelligents.

SlidesExtensionPoint

Format courant pour déclarer les déclencheurs d'un module complémentaire Slides.

Représentation JSON 
{
  "runFunction": string
}
Champs
runFunction

string

Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé.

HttpOptions

Options d'envoi de requêtes aux points de terminaison du module complémentaire HTTP.

Représentation JSON 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Champs
authorizationHeader

enum (HttpAuthorizationHeader)

Configuration du jeton envoyé dans l'en-tête d'autorisation HTTP.
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

Indique si le module complémentaire a activé le consentement OAuth granulaire.

HttpAuthorizationHeader

En-tête d'autorisation envoyé dans les requêtes du module complémentaire HTTP.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Valeur par défaut, équivalente à SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Envoyez un jeton d'ID pour le compte de service système du module complémentaire Google Workspace spécifique au projet (par défaut).
USER_ID_TOKEN Envoyez un jeton d'ID pour l'utilisateur final.
NONE N'envoyez pas d'en-tête d'authentification.

GranularOauthPermissionSupport

Indique si le module complémentaire a activé le consentement OAuth granulaire.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Valeur par défaut, ne doit pas être utilisée.
OPT_IN Le module complémentaire a activé le consentement OAuth granulaire.
OPT_OUT Le module complémentaire n'est pas activé pour le consentement OAuth granulaire.

Méthodes

create

 Crée un déploiement avec le nom et la configuration spécifiés.

delete

 Supprime le déploiement portant le nom spécifié.

get

 Récupère le déploiement portant le nom spécifié.

getInstallStatus

 Récupère l'état d'installation d'un déploiement de test.

install

 Installe un déploiement sur votre compte à des fins de test.

list

 Répertorie tous les déploiements d'un projet particulier.

replaceDeployment

 Crée ou remplace un déploiement avec le nom spécifié.

uninstall

 Désinstalle un déploiement de test du compte de l'utilisateur.