REST Resource: projects.deployments

Ressource: Deployment

Déploiement d'un 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 Google OAuth pour lesquelles il faut demander l'autorisation de l'utilisateur final avant d'exécuter un point de terminaison du 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

Une configuration de module complémentaire Google Workspace

Représentation JSON 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "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.
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 à des points de terminaison HTTP complémentaires

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 des fiches de modules complémentaires.
addOnWidgetSet

object (AddOnWidgetSet)

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

boolean

Permet de spécifier 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 et sur n'importe quel hôte. Les fiches générées par cette fonction sont toujours disponibles pour l'utilisateur, mais peuvent être éclipsées par le contenu contextuel lorsque ce module complémentaire déclare des déclencheurs plus ciblés.
universalActions[]

object (UniversalActionExtensionPoint)

Définit une liste de points d'extension dans le menu d'actions universel, 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 ayant 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 utilisé. Les liens HTTP sont automatiquement réécrits en liens HTTPS.

LayoutProperties

Propriétés de mise en page des cartes 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. Il 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. Elle définit la couleur des boutons. Si la couleur principale est définie, mais qu'aucune couleur secondaire n'est définie, la couleur secondaire est identique à la couleur principale. Si aucune couleur principale ni couleur secondaire n'est définie, la valeur par défaut fournie par le framework est utilisée.
useNewMaterialDesign

boolean

Active Material Design pour les cartes.

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 correspond à 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 pleins et les boutons désactivés.
PERSISTENT_FORMS Les formulaires persistants permettent de définir des valeurs de formulaire persistantes lors des actions.
UPDATE_SUBJECT_AND_RECIPIENTS Modifiez l'objet et les destinataires d'un brouillon.
GRID_WIDGET Widget 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 de déclaration de 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 false, désactive la page d'accueil dans ce contexte.

Si cette règle n'est pas configurée, la valeur par défaut est true.

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

UniversalActionExtensionPoint

Format à utiliser pour déclarer un point d'extension d'élément de menu d'actions universel.

Représentation JSON 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Champs
label

string

Obligatoire. Texte visible par l'utilisateur qui décrit l'action entreprise après l'activation de ce point d'extension (par exemple, "Ajouter un contact").
Champ d'union action_type. Obligatoire. Type d'action compatible avec un élément de menu d'actions universel. Il peut s'agir d'un lien à ouvrir ou d'un point de terminaison à exécuter. action_type ne peut être qu'un des éléments suivants :
runFunction

string

Point de terminaison qui sera exécuté par UniversalAction.

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 les contextes qui ne correspondent pas à un déclencheur contextuel déclaré. Les fiches générées par cette fonction sont toujours disponibles pour l'utilisateur, mais peuvent être éclipsées par le contenu contextuel lorsque ce module complémentaire déclare des déclencheurs plus ciblés.

Si cette valeur est présente, elle 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 au moment de la rédaction pour un module complémentaire au moment de la rédaction. Il s'agit du déclencheur qui oblige un module complémentaire à effectuer une action lorsque l'utilisateur rédige un e-mail. Tous les modules complémentaires au moment de la rédaction doivent avoir le champ d'application gmail.addons.current.action.compose, même s'ils ne modifient peut-être 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 vérifiant 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 d'assurer une expérience utilisateur fluide.

ContextualTrigger

Définit un déclencheur qui se déclenche lorsque l'e-mail ouvert répond à un critère spécifique. Lorsque le déclencheur est exécuté, il exécute un point de terminaison spécifique, généralement afin de créer de nouvelles cartes et de mettre à jour l'interface utilisateur.

Représentation JSON 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
Champs
onTriggerFunction

string

Obligatoire. Nom du point de terminaison à appeler lorsqu'un message correspond au déclencheur.
Champ d'union trigger. Le type de déclencheur détermine les conditions utilisées par Gmail pour afficher le module complémentaire. trigger ne peut être qu'un des éléments suivants :
unconditional

object (UnconditionalTrigger)

Les déclencheurs inconditionnels sont exécutés lorsqu'un e-mail est ouvert.

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,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Champs
text

string

Obligatoire. Texte descriptif de l'action visible par l'utilisateur (par exemple, "Ajouter un contact").
Champ d'union action_type. Le type d'action détermine le comportement de Gmail lorsque l'utilisateur appelle l'action. action_type ne peut être qu'un des éléments suivants :
runFunction

string

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

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 associées à un module complémentaire au moment de la rédaction. Les utilisateurs peuvent déclencher ces actions dans 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 au moment de la rédaction est déclenché.

DraftAccess

Énumération définissant le niveau d'accès aux données requis par le déclencheur Compose.

Enums
UNSPECIFIED Valeur par défaut lorsque rien n'est défini pour l'accès au brouillon.
NONE Le déclencheur Compose ne peut accéder à aucune donnée du brouillon lorsqu'un module complémentaire Compose est déclenché.
METADATA Accorde au déclencheur Compose l'autorisation d'accéder aux métadonnées du brouillon lorsqu'un module complémentaire Compose est déclenché. Cela inclut la liste d'audience, comme les champs "À" et "Cc" d'un brouillon.

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 cette valeur est présente, elle remplace la configuration de addons.common.homepageTrigger.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Ce paramètre 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 commun de déclaration des 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)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Champs
homepageTrigger

object (HomepageExtensionPoint)

Définit un point de terminaison qui s'exécute dans des contextes qui ne correspondent pas à un déclencheur contextuel déclaré. Les fiches générées par cette fonction sont toujours disponibles pour l'utilisateur, mais peuvent être éclipsées par le contenu contextuel lorsque ce module complémentaire déclare des déclencheurs plus ciblés.

Si cette valeur est présente, elle remplace la configuration de addons.common.homepageTrigger.
conferenceSolution[]

object (ConferenceSolution)

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

string

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 affiché ou modifié.
eventUpdateTrigger

object (CalendarExtensionPoint)

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

object (MenuItemExtensionPoint)

Configuration d'un déclencheur contextuel qui se déclenche lorsque l'utilisateur clique sur le fournisseur de pièce jointe de module complémentaire dans le menu déroulant "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 relatives à la conférence.

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

string

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

string

Obligatoire. Les ID doivent être attribués de manière unique pour toutes les solutions de conférence d'un même module complémentaire. Dans le cas contraire, la solution de conférence utilisée risque d'être incorrecte lors du déclenchement du module complémentaire. Vous pouvez modifier le nom à afficher d'un module complémentaire, mais pas l'ID.
name

string

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

string

Obligatoire. URL du logo de la solution de conférence.

CalendarExtensionPoint

Format courant pour déclarer les déclencheurs d'un module complémentaire 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 définissant le niveau requis par les déclencheurs d'événements d'accès aux données.

Enums
UNSPECIFIED Valeur par défaut lorsque rien n'est défini pour eventAccess.
METADATA Accorde au déclencheur d'événement l'autorisation d'accéder aux métadonnées des événements, telles que l'ID de l'événement et l'ID de l'agenda.
READ Permet aux déclencheurs d'événement d'accéder à tous les champs fournis pour l'événement, y compris les métadonnées, les participants et les données de la 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 ajouter des participants et définir les données de conférence.
READ_WRITE Permet aux déclencheurs d'événement d'accéder à tous les champs fournis pour l'événement, y compris aux métadonnées, aux participants et aux données de la conférence, ainsi que la possibilité 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 cette valeur est présente, elle remplace la configuration de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

Liste de points d'extension pour créer des ressources tierces à partir d'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 se déclenche lorsqu'un utilisateur saisit ou colle un lien depuis un service tiers ou autre que 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 (Example: Support case, par exemple). 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. Carte de labeltext à localiser dans d'autres langues. Indiquez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant 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, celui-ci 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 le module complémentaire pour prévisualiser les liens.
runFunction

string

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

string

Facultatif. Icône qui s'affiche dans le chip intelligent et la fiche d'aperçu. Si cette valeur est omise, le module complémentaire utilise son icône dans la barre d'outils, logourl.

UriPattern

Configuration de chaque format d'URL qui déclenche un aperçu du 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 affiche un aperçu des liens qui contiennent ce domaine dans l'URL. Pour prévisualiser les liens d'un sous-domaine spécifique (subdomain.example.com, par exemple), incluez ce sous-domaine. Pour prévisualiser les liens de l'ensemble du domaine, indiquez 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 de l'URL est support.example.com, saisissez cases pour établir une correspondance avec les URL des demandes hébergées sur support.example.com/cases/.

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

CreateActionExtensionPoint

Configuration d'un déclencheur qui se déclenche 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 la 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. Carte de labeltext à localiser dans d'autres langues. Indiquez la langue au format ISO 639 et le pays/la région au format ISO 3166, en les séparant 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, celui-ci 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 ressources est déclenché pour créer une association.
logoUrl

string

Facultatif. Icône du point d'entrée pour la création de ressources. Si cette valeur est omise, le menu utilise l'icône de la barre d'outils du module complémentaire, logourl.

SheetsAddOnManifest

Propriétés permettant de personnaliser 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 cette valeur est présente, elle remplace la configuration de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

SheetsExtensionPoint

Format courant de déclaration des 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 cette valeur est présente, elle remplace la configuration de addons.common.homepageTrigger.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

SlidesExtensionPoint

Format courant de déclaration des 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 HTTP complémentaires.

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

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

En-tête d'autorisation envoyé dans les requêtes de 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 à l'utilisateur final.
NONE N'envoyez pas d'en-tête Authentication.

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 donné.

get

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

getInstallStatus

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

install

 Installe un déploiement dans 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 portant le nom spécifié.

uninstall

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