- Ressource: Déploiement
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Méthodes
Ressource: Déploiement
Déploiement d'un module complémentaire Google Workspace
Représentation JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Champs | |
---|---|
name |
Nom de la ressource de déploiement. Exemple : |
oauthScopes[] |
Liste des champs d'application Google OAuth pour lesquels vous devez demander le consentement de l'utilisateur final avant d'exécuter un point de terminaison de module complémentaire. |
addOns |
Configuration du module complémentaire Google Workspace. |
etag |
Cette valeur est calculée par le serveur en fonction de la version du déploiement stockée. Elle peut être envoyée lors de requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de poursuivre. |
AddOns
Une configuration de module complémentaire Google Workspace.
Représentation JSON |
---|
{ "common": { object ( |
Champs | |
---|---|
common |
Configuration commune à tous les modules complémentaires Google Workspace. |
gmail |
Configuration du module complémentaire Gmail. |
drive |
Configuration du module complémentaire Drive. |
calendar |
Configuration du module complémentaire Agenda. |
docs |
Configuration du module complémentaire Docs. |
sheets |
Configuration du module complémentaire Sheets. |
slides |
Configuration du module complémentaire Slides. |
httpOptions |
Options d'envoi de requêtes aux points de terminaison HTTP de modules complémentaires |
CommonAddOnManifest
Configuration du module complémentaire partagée entre toutes les applications hôtes des modules complémentaires.
Représentation JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Champs | |
---|---|
name |
Obligatoire. Nom à afficher du module complémentaire. |
logoUrl |
Obligatoire. URL de l'image du logo affichée dans la barre d'outils du module complémentaire. |
layoutProperties |
Propriétés de mise en page courantes des fiches complémentaires. |
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 |
Indique s'il faut transmettre les informations sur les paramètres régionaux à partir de l'application hôte. |
homepageTrigger |
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 le contenu contextuel pourra éclipser le contenu lorsque ce module complémentaire déclare des déclencheurs plus ciblés. |
universalActions[] |
Définit la liste des 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 pour l'envoi d'un formulaire. |
openLinkUrlPrefixes |
Une action OpenLink ne peut utiliser qu'une URL avec un schéma |
LayoutProperties
Propriétés de mise en page des cartes partagées entre toutes les applications hôtes complémentaires.
Représentation JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Champs | |
---|---|
primaryColor |
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 |
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 de couleur secondaire n'est définie, la valeur par défaut fournie par le framework est utilisée. |
useNewMaterialDesign |
Active Material Design pour les cartes. |
AddOnWidgetSet
Sous-ensemble de widgets utilisé par un module complémentaire.
Représentation JSON |
---|
{
"usedWidgets": [
enum ( |
Champs | |
---|---|
usedWidgets[] |
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 comportent des boutons remplis et des boutons désactivés. |
PERSISTENT_FORMS |
Les formulaires persistants permettent de conserver des valeurs de formulaire pendant les actions. |
FIXED_FOOTER |
Correction du pied de page dans une fiche. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Modifiez l'objet et les destinataires d'un brouillon. |
GRID_WIDGET |
Le widget Grille |
ADDON_COMPOSE_UI_ACTION |
Action du 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 |
Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé. |
enabled |
Facultatif. Si la valeur est Si cette règle n'est pas configurée, la valeur par défaut est Si l'affichage personnalisé de la page d'accueil d'un module complémentaire est désactivé, une fiche récapitulative générique s'affiche à la place. |
UniversalActionExtensionPoint
Format permettant de déclarer un point d'extension d'élément de menu d'actions universel.
Représentation JSON |
---|
{ "label": string, // Union field |
Champs | |
---|---|
label |
Obligatoire. Texte visible par l'utilisateur qui décrit l'action entreprise en activant 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 : |
|
openLink |
URL à ouvrir par l'UniversalAction. |
runFunction |
Point de terminaison à exécuter 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 ( |
Champs | |
---|---|
homepageTrigger |
Définit un point de terminaison qui sera exécuté dans les contextes qui ne correspondent pas à un déclencheur contextuel déclaré. Toutes les fiches générées par cette fonction seront toujours disponibles pour l'utilisateur, mais le contenu contextuel pourra éclipser le contenu lorsque ce module complémentaire déclare des déclencheurs plus ciblés. Si cet attribut est présent, il remplace la configuration de |
contextualTriggers[] |
Définit l'ensemble des conditions qui déclenchent le module complémentaire. |
universalActions[] |
Définit un ensemble d'actions universelles pour le module complémentaire. L'utilisateur déclenche des actions universelles à partir du menu du module complémentaire de la barre d'outils. |
composeTrigger |
Définit le déclencheur associé à l'heure de composition d'un module complémentaire dédié. Il s'agit du déclencheur qui déclenche l'action d'un module complémentaire lorsque l'utilisateur rédige un e-mail. Tous les modules complémentaires de rédaction doivent être associés au champ d'application |
authorizationCheckFunction |
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 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 est exécuté, il exécute un point de terminaison spécifique, généralement pour créer des cartes et mettre à jour l'UI.
Représentation JSON |
---|
{ "onTriggerFunction": string, // Union field |
Champs | |
---|---|
onTriggerFunction |
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 que Gmail utilise pour afficher le module complémentaire. trigger ne peut être qu'un des éléments suivants : |
|
unconditional |
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 |
Champs | |
---|---|
text |
Obligatoire. Texte visible par l'utilisateur décrivant l'action (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 : |
|
openLink |
Lien qui est ouvert par Gmail lorsque l'utilisateur déclenche l'action. |
runFunction |
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 ( |
Champs | |
---|---|
actions[] |
Définit l'ensemble des actions pour un module complémentaire de rédaction. Il s'agit des actions que les utilisateurs peuvent déclencher sur un module complémentaire de rédaction. |
draftAccess |
Définit le niveau d'accès aux données lorsqu'un module complémentaire de rédaction est déclenché. |
MenuItemExtensionPoint
Format courant pour déclarer un élément de menu ou un bouton qui apparaît dans une application hôte.
Représentation JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Champs | |
---|---|
runFunction |
Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé. |
label |
Obligatoire. Texte visible par l'utilisateur qui décrit l'action entreprise en activant ce point d'extension. (par exemple, "Insérer une facture"). |
logoUrl |
URL de l'image du logo affichée dans la barre d'outils du module complémentaire. Si cette règle n'est pas configurée, l'URL principale du logo du module complémentaire est utilisée par défaut. |
DraftAccess
Énumération qui définit le niveau d'accès aux données requis par le déclencheur Compose.
Enums | |
---|---|
UNSPECIFIED |
Valeur par défaut lorsqu'aucun élément n'est défini pour brouillonaccess. |
NONE |
Le déclencheur de rédaction ne peut accéder à aucune donnée du brouillon lorsqu'un module complémentaire Compose est déclenché. |
METADATA |
Accorde au déclencheur de composition l'autorisation d'accéder aux métadonnées du brouillon lorsqu'un module complémentaire Compose est déclenché. Les listes d'audience, telles que les listes "À" et "Cc" d'un brouillon de message, sont également concernées. |
DriveAddOnManifest
Propriétés permettant de personnaliser l'apparence et l'exécution d'un module complémentaire Drive.
Représentation JSON |
---|
{ "homepageTrigger": { object ( |
Champs | |
---|---|
homepageTrigger |
Si cet attribut est présent, il remplace la configuration de |
onItemsSelectedTrigger |
Ce paramètre correspond au comportement qui s'exécute lorsque des éléments sont sélectionnés dans la vue Drive appropriée, telle que 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 |
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 ( |
Champs | |
---|---|
homepageTrigger |
Définit un point de terminaison qui est exécuté dans les contextes qui ne correspondent pas à un déclencheur contextuel déclaré. Toutes les fiches générées par cette fonction seront toujours disponibles pour l'utilisateur, mais le contenu contextuel pourra éclipser le contenu lorsque ce module complémentaire déclare des déclencheurs plus ciblés. Si cet attribut est présent, il remplace la configuration de |
conferenceSolution[] |
Définit les solutions de conférence fournies par ce module complémentaire. |
createSettingsUrlFunction |
Point de terminaison à exécuter qui crée une URL vers la page des paramètres du module complémentaire. |
eventOpenTrigger |
Point de terminaison qui se déclenche lorsqu'un événement est ouvert pour être affiché ou modifié. |
eventUpdateTrigger |
Point de terminaison qui se déclenche lorsque l'événement d'ouverture est mis à jour. |
currentEventAccess |
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 |
Obligatoire. Point de terminaison à appeler lorsque les données de conférence doivent être créées. |
id |
Obligatoire. Les identifiants doivent être attribués de manière unique à toutes les solutions de conférence d'un module complémentaire, sinon la mauvaise solution risque d'être utilisée lors du déclenchement du module complémentaire. Vous pouvez modifier le nom à afficher d'un module complémentaire, mais l'ID ne doit pas être modifié. |
name |
Obligatoire. Nom à afficher de la solution de conférence. |
logoUrl |
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 |
Obligatoire. Point de terminaison à exécuter lorsque ce point d'extension est activé. |
EventAccess
Énumération qui définit le niveau requis pour les déclencheurs d'événements d'accès aux données.
Enums | |
---|---|
UNSPECIFIED |
Valeur par défaut lorsqu'aucun paramètre n'est défini pour eventAccess. |
METADATA |
Accorde aux déclencheurs d'événements l'autorisation d'accéder aux métadonnées des événements, telles que l'ID et l'ID de l'agenda. |
READ |
Permet aux déclencheurs d'événement d'accéder à tous les champs d'événement fournis, y compris aux métadonnées, aux participants et aux 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, comme ajouter des participants et définir des données de conférence. |
READ_WRITE |
Permet aux déclencheurs d'événement 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 ( |
Champs | |
---|---|
homepageTrigger |
Si cet attribut est présent, il remplace la configuration de |
onFileScopeGrantedTrigger |
Point de terminaison à exécuter lorsque l'autorisation de portée fichier est accordée pour cette paire document/utilisateur. |
linkPreviewTriggers[] |
Liste des 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[] |
Liste d'extensions 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 |
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 d'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 ( |
Champs | |
---|---|
labelText |
Obligatoire. Texte d'un exemple de chip intelligent qui invite les utilisateurs à prévisualiser le lien ( |
localizedLabelText |
Facultatif. Carte de 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 Objet contenant une liste de paires |
patterns[] |
Obligatoire. Tableau de formats d'URL qui déclenchent l'envoi d'un lien d'aperçu par le module complémentaire. |
runFunction |
Obligatoire. Point de terminaison à exécuter lorsqu'un aperçu de lien est déclenché. |
logoUrl |
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 : |
UriPattern
Configuration de chaque format d'URL qui déclenche un aperçu du lien.
Représentation JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Champs | |
---|---|
hostPattern |
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, tel que Par exemple, |
pathPrefix |
Facultatif. Chemin d'accès qui ajoute le domaine de Par exemple, si le format d'URL d'hôte est Pour faire correspondre toutes les URL du domaine du format d'hôte, laissez |
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 |
Obligatoire. Identifiant unique permettant de différencier ce point d'extension. L'ID peut comporter jusqu'à 64 caractères et doit être au format |
labelText |
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 |
localizedLabelText |
Facultatif. Carte de 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 Objet contenant une liste de paires |
runFunction |
Obligatoire. Point de terminaison à exécuter lorsqu'un workflow de création de ressources est déclenché pour créer un lien. |
logoUrl |
Facultatif. Icône qui s'affiche pour le point d'entrée de création de la ressource. En cas d'omission, le menu utilise l'icône de la barre d'outils de votre module complémentaire |
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 ( |
Champs | |
---|---|
homepageTrigger |
Si cet attribut est présent, il remplace la configuration de |
onFileScopeGrantedTrigger |
Point de terminaison à exécuter lorsque l'autorisation de portée fichier est accordée pour cette paire document/utilisateur. |
linkPreviewTriggers[] |
Liste des 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 pour déclarer les déclencheurs d'un module complémentaire Sheets.
Représentation JSON |
---|
{ "runFunction": string } |
Champs | |
---|---|
runFunction |
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 ( |
Champs | |
---|---|
homepageTrigger |
Si cet attribut est présent, il remplace la configuration de |
onFileScopeGrantedTrigger |
Point de terminaison à exécuter lorsque l'autorisation de portée fichier est accordée pour cette paire document/utilisateur. |
linkPreviewTriggers[] |
Liste des points d'extension permettant de prévisualiser les liens dans un document Google Slides. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents. |
SlidesExtensionPoint
Format courant pour déclarer les déclencheurs d'un module complémentaire Slides.
Représentation JSON |
---|
{ "runFunction": string } |
Champs | |
---|---|
runFunction |
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
des modules complémentaires.
Représentation JSON |
---|
{
"authorizationHeader": enum ( |
Champs | |
---|---|
authorizationHeader |
Configuration du jeton envoyé dans l'en-tête d'autorisation |
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 |
Envoyer 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 "Authentication". |
Méthodes |
|
---|---|
|
Crée un déploiement avec le nom et la configuration spécifiés. |
|
Supprime le déploiement portant le nom indiqué. |
|
Récupère le déploiement portant le nom spécifié. |
|
Récupère l'état d'installation d'un déploiement test. |
|
Installe un déploiement sur votre compte à des fins de test. |
|
Répertorie tous les déploiements d'un projet particulier. |
|
Crée ou remplace un déploiement avec le nom spécifié. |
|
Désinstallez un déploiement test du compte de l'utilisateur. |