Outil : list_apps
Liste les applications du projet et de l'emplacement spécifiés.
L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP list_apps.
| Requête curl |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "list_apps", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Schéma d'entrée
Message de requête pour AgentService.ListApps.
ListAppsRequest
| Représentation JSON |
|---|
{ "parent": string, "pageSize": integer, "pageToken": string, "filter": string, "orderBy": string } |
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'établissement à partir duquel lister les applications. |
pageSize |
Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée. |
pageToken |
Facultatif. Valeur |
filter |
Facultatif. Filtre à appliquer lors de la liste des applications. Pour en savoir plus, consultez https://google.aip.dev/160. |
orderBy |
Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering. |
Schéma de sortie
Message de réponse pour AgentService.ListApps.
ListAppsResponse
| Représentation JSON |
|---|
{
"apps": [
{
object ( |
| Champs | |
|---|---|
apps[] |
Liste des applications. |
nextPageToken |
Jeton pouvant être envoyé en tant que |
unreachable[] |
Liste non triée. Emplacements inaccessibles. |
Application
| Représentation JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Champs | |
|---|---|
name |
Identifiant. Identifiant unique de l'application. Format : |
displayName |
Obligatoire. Nom à afficher de l'application. |
description |
Facultatif. Description de l'application dans un format lisible. |
pinned |
Facultatif. Indique si l'application est épinglée dans la liste des applications. |
rootAgent |
Facultatif. L'agent racine est le point d'entrée de l'application. Format : |
languageSettings |
Facultatif. Paramètres de langue de l'application. |
timeZoneSettings |
Facultatif. Paramètres de fuseau horaire de l'application. |
audioProcessingConfig |
Facultatif. Configuration du traitement audio de l'application. |
loggingSettings |
Facultatif. Paramètres de journalisation de l'application. |
errorHandlingSettings |
Facultatif. Paramètres de gestion des erreurs de l'application. |
modelSettings |
Facultatif. Paramètres de modèle LLM par défaut pour l'application. Les ressources individuelles (par exemple, les agents et les garde-fous) peuvent remplacer ces configurations si nécessaire. |
toolExecutionMode |
Facultatif. Mode d'exécution de l'outil pour l'application. Si aucune valeur n'est fournie, la valeur par défaut est PARALLEL. |
evaluationMetricsThresholds |
Facultatif. Seuils d'évaluation de l'application. |
variableDeclarations[] |
Facultatif. Déclarations des variables. |
predefinedVariableDeclarations[] |
Uniquement en sortie. Déclarations des variables prédéfinies pour l'application. |
globalInstruction |
Facultatif. Instructions pour tous les agents de l'application. Vous pouvez utiliser ces instructions pour configurer une identité ou une personnalité stable pour tous les agents. |
guardrails[] |
Facultatif. Liste des garde-fous pour l'application. Format : |
dataStoreSettings |
Facultatif. Paramètres du data store pour l'application. |
defaultChannelProfile |
Facultatif. Profil de chaîne par défaut utilisé par l'application. |
metadata |
Facultatif. Métadonnées sur l'application. Ce champ peut être utilisé pour stocker des informations supplémentaires concernant les détails ou les utilisations prévues de l'application. Objet contenant une liste de paires |
createTime |
Uniquement en sortie. Code temporel de la création de l'application. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
updateTime |
Uniquement en sortie. Code temporel de la dernière mise à jour de l'application. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
etag |
Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture/modification/écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées. |
deploymentCount |
Uniquement en sortie. Nombre de déploiements dans l'application. |
clientCertificateSettings |
Facultatif. Paramètres par défaut du certificat client pour l'application. |
locked |
Facultatif. Indique si l'application est verrouillée pour les modifications. Si l'application est verrouillée, les modifications apportées à ses ressources seront refusées. |
LanguageSettings
| Représentation JSON |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| Champs | |
|---|---|
defaultLanguageCode |
Facultatif. Code de langue par défaut de l'application. |
supportedLanguageCodes[] |
Facultatif. Liste des codes de langue acceptés par l'application, en plus de |
enableMultilingualSupport |
Facultatif. Active la compatibilité multilingue. Si la valeur est "true", les agents de l'application utiliseront des instructions prédéfinies pour mieux gérer les entrées multilingues. |
fallbackAction |
Facultatif. Action à effectuer lorsqu'un agent reçoit une entrée dans une langue non acceptée. Il peut s'agir d'une action prédéfinie ou d'un appel d'outil personnalisé. Les valeurs valides sont les suivantes : - Nom complet de la ressource d'un outil, qui déclenche l'exécution d'un outil spécifique. - Une action système prédéfinie, telle que "escalate" ou "exit", qui déclenche un signal |
TimeZoneSettings
| Représentation JSON |
|---|
{ "timeZone": string } |
| Champs | |
|---|---|
timeZone |
Facultatif. Fuseau horaire de l'application à partir de la base de données de fuseaux horaires, par exemple, America/Los_Angeles, Europe/Paris. |
AudioProcessingConfig
| Représentation JSON |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| Champs | |
|---|---|
synthesizeSpeechConfigs |
Facultatif. Configuration de la synthèse de la réponse de l'agent, mappant le code de langue à Si la configuration pour le code de langue spécifié est introuvable, celle du code de langue racine sera utilisée. Par exemple, si la carte contient "en-us" et "en", et que le code de langue spécifié est "en-gb", la configuration "en" sera utilisée. Remarque : Le code de langue n'est pas sensible à la casse. Objet contenant une liste de paires |
bargeInConfig |
Facultatif. Configure le comportement de l'agent pour les activités d'interruption par l'utilisateur. |
inactivityTimeout |
Facultatif. Durée d'inactivité de l'utilisateur (aucune parole ni interaction) avant que l'agent ne l'invite à réagir. Si ce paramètre n'est pas défini, l'agent ne demandera pas à l'utilisateur de réengager la conversation. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
ambientSoundConfig |
Facultatif. Configuration du son ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle. |
SynthesizeSpeechConfigsEntry
| Représentation JSON |
|---|
{
"key": string,
"value": {
object ( |
| Champs | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| Représentation JSON |
|---|
{ "voice": string, "speakingRate": number } |
| Champs | |
|---|---|
voice |
Facultatif. Nom de la voix. Si ce paramètre n'est pas défini, le service choisit une voix en fonction des autres paramètres, tels que language_code. Pour obtenir la liste des voix disponibles, veuillez consulter Voix et langues disponibles dans Cloud Text-to-Speech. |
speakingRate |
Facultatif. Taux/vitesse de l'énoncé. Valeur comprise dans la plage [0,25, 2,0]. La valeur 1,0 correspond à la vitesse native normale compatible avec la voix spécifique. La valeur 2,0 est deux fois plus rapide et la valeur 0,5 est deux fois moins rapide. Les valeurs en dehors de la plage [0,25, 2,0] renvoient une erreur. |
BargeInConfig
| Représentation JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Champs | |
|---|---|
disableBargeIn |
Facultatif. Désactive l'interruption par l'utilisateur pendant que l'agent parle. Si la valeur est "true", les saisies utilisateur pendant la lecture de la réponse de l'agent seront ignorées. Obsolète : |
bargeInAwareness |
Facultatif. Si cette option est activée, l'agent adaptera sa prochaine réponse en partant du principe que l'utilisateur n'a pas entendu l'intégralité du message précédent de l'agent. Cette méthode ne doit pas être utilisée dans les scénarios où les réponses de l'agent sont affichées visuellement. |
Durée
| Représentation JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Champs | |
|---|---|
seconds |
Secondes signées de la période. La valeur doit être comprise entre -315 576 000 000 et +315 576 000 000 (inclus). Remarque : Ces limites sont calculées à partir de : 60 s/min * 60 min/h * 24 h/jour * 365,25 jours/an * 10 000 ans |
nanos |
Fractions de secondes signées avec une précision de l'ordre de la nanoseconde pour la durée. Les durées inférieures à une seconde sont représentées par un champ |
AmbientSoundConfig
| Représentation JSON |
|---|
{ "volumeGainDb": number, // Union field |
| Champs | |
|---|---|
volumeGainDb |
Facultatif. Gain de volume (en dB) du volume natif normal pris en charge par le bruit ambiant, dans la plage [-96, 16]. Si la valeur n'est pas définie ou si elle est définie sur une valeur de zéro (dB), elle est lue à une amplitude de signal natif normal. Une valeur de -6 (dB) est lue avec environ la moitié de l'amplitude du signal natif normal. Une valeur de +6 (dB) est lue avec environ deux fois plus d'amplitude que le signal natif normal. Nous vous recommandons vivement de ne pas dépasser +10 (dB), car il n'y a généralement pas d'augmentation efficace du volume pour une valeur supérieure à cette valeur. |
Champ d'union source. Bruit ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle. source ne peut être qu'un des éléments suivants : |
|
prebuiltAmbientNoise |
Facultatif. Obsolète : |
gcsUri |
Facultatif. Bruit ambiant sous forme de fichier WAV monophonique à 16 kHz stocké dans Cloud Storage. Remarque : Veuillez vous assurer que l'agent de service CES |
prebuiltAmbientSound |
Facultatif. Nom du son ambiant prédéfini. Les valeurs valides sont les suivantes : - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner" |
LoggingSettings
| Représentation JSON |
|---|
{ "redactionConfig": { object ( |
| Champs | |
|---|---|
redactionConfig |
Facultatif. Configuration du masquage des données sensibles. |
audioRecordingConfig |
Facultatif. Configuration de l'enregistrement des interactions audio. |
bigqueryExportSettings |
Facultatif. Paramètres permettant de décrire les comportements d'exportation BigQuery pour l'application. Les données de conversation seront exportées vers des tables BigQuery si cette option est activée. |
cloudLoggingSettings |
Facultatif. Paramètres permettant de décrire les comportements de Cloud Logging pour l'application. |
conversationLoggingSettings |
Facultatif. Paramètres permettant de décrire les comportements de journalisation des conversations pour l'application. |
evaluationAudioRecordingConfig |
Facultatif. Configuration de l'enregistrement des interactions audio pour l'évaluation. Par défaut, l'enregistrement audio n'est pas activé pour les sessions d'évaluation. |
metricAnalysisSettings |
Facultatif. Paramètres permettant de décrire les comportements de collecte des données de conversation pour le pipeline d'analyse LLM de l'application. |
RedactionConfig
| Représentation JSON |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| Champs | |
|---|---|
enableRedaction |
Facultatif. Si la valeur est "true", le masquage sera appliqué dans différents scénarios de journalisation, y compris l'historique des conversations, Cloud Logging et l'enregistrement audio. |
inspectTemplate |
Facultatif. Nom du modèle d'inspection DLP permettant de configurer la détection des types de données sensibles. Format : |
deidentifyTemplate |
Facultatif. Nom du modèle d'anonymisation DLP pour indiquer comment anonymiser le contenu. Format : |
AudioRecordingConfig
| Représentation JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Champs | |
|---|---|
gcsBucket |
Facultatif. Bucket Cloud Storage pour stocker les enregistrements audio des sessions. L'URI doit commencer par "gs://". Veuillez choisir un emplacement de bucket qui répond à vos exigences de résidence des données. Remarque : Si le bucket Cloud Storage se trouve dans un projet différent de celui de l'application, vous devez accorder l'autorisation |
gcsPathPrefix |
Facultatif. Préfixe du chemin d'accès Cloud Storage pour les enregistrements audio. Ce préfixe peut inclure les espaces réservés suivants, qui seront remplacés de manière dynamique au moment de la diffusion : - $project : ID du projet - $location : emplacement de l'application - $app : ID de l'application - $date : date de la session au format AAAA-MM-JJ - $session : ID de la session Si le préfixe de chemin n'est pas spécifié, le préfixe par défaut |
BigQueryExportSettings
| Représentation JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Champs | |
|---|---|
enabled |
Facultatif. Indique si l'exportation BigQuery est activée. |
project |
Facultatif. ID du projet de l'ensemble de données BigQuery vers lequel exporter les données. Remarque : Si l'ensemble de données BigQuery se trouve dans un projet différent de celui de l'application, vous devez attribuer le rôle |
dataset |
Facultatif. Ensemble de données BigQuery vers lequel exporter les données. |
CloudLoggingSettings
| Représentation JSON |
|---|
{ "enableCloudLogging": boolean } |
| Champs | |
|---|---|
enableCloudLogging |
Facultatif. Indique si Cloud Logging doit être activé pour les sessions. |
ConversationLoggingSettings
| Représentation JSON |
|---|
{ "disableConversationLogging": boolean } |
| Champs | |
|---|---|
disableConversationLogging |
Facultatif. Indique si la journalisation des conversations doit être désactivée pour les sessions. |
MetricAnalysisSettings
| Représentation JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| Champs | |
|---|---|
llmMetricsOptedOut |
Facultatif. Indique si les données de conversation doivent être collectées pour les métriques d'analyse des LLM. Si la valeur est "true", les données de conversation ne seront pas collectées pour les métriques d'analyse LLM. Dans le cas contraire, elles le seront. |
ErrorHandlingSettings
| Représentation JSON |
|---|
{
"errorHandlingStrategy": enum ( |
| Champs | |
|---|---|
errorHandlingStrategy |
Facultatif. Stratégie à utiliser pour le gestion des exceptions. |
ModelSettings
| Représentation JSON |
|---|
{ "model": string, // Union field |
| Champs | |
|---|---|
model |
Facultatif. Modèle LLM que l'agent doit utiliser. Si aucune valeur n'est définie, l'agent hérite du modèle de son agent parent. |
Champ d'union
|
|
temperature |
Facultatif. Si cette option est définie, cette température sera utilisée pour le modèle LLM. La température contrôle le caractère aléatoire des réponses du modèle. Les températures plus basses produisent des réponses plus prévisibles. Les températures plus élevées produisent des réponses plus créatives. |
EvaluationMetricsThresholds
| Représentation JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| Champs | |
|---|---|
goldenEvaluationMetricsThresholds |
Facultatif. Seuils des métriques d'évaluation privilégiées. |
hallucinationMetricBehavior |
Facultatif. Obsolète : utilisez plutôt |
goldenHallucinationMetricBehavior |
Facultatif. Comportement de la métrique d'hallucination pour les évaluations de référence. |
scenarioHallucinationMetricBehavior |
Facultatif. Comportement de la métrique d'hallucination pour les évaluations de scénarios. |
GoldenEvaluationMetricsThresholds
| Représentation JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Champs | |
|---|---|
turnLevelMetricsThresholds |
Facultatif. Seuils des métriques au niveau du tour. |
expectationLevelMetricsThresholds |
Facultatif. Seuils des métriques de niveau d'attente. |
toolMatchingSettings |
Facultatif. Paramètres de correspondance de l'outil. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence. |
TurnLevelMetricsThresholds
| Représentation JSON |
|---|
{ "semanticSimilarityChannel": enum ( |
| Champs | |
|---|---|
semanticSimilarityChannel |
Facultatif. Canal de similarité sémantique à utiliser pour l'évaluation. |
Champ d'union
|
|
semanticSimilaritySuccessThreshold |
Facultatif. Seuil de réussite pour la similarité sémantique. Veuillez saisir un nombre entier compris entre 0 et 4. La valeur par défaut est >= 3. |
Champ d'union
|
|
overallToolInvocationCorrectnessThreshold |
Facultatif. Seuil de réussite pour la correction globale de l'appel d'outil. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0. |
ExpectationLevelMetricsThresholds
| Représentation JSON |
|---|
{ // Union field |
| Champs | |
|---|---|
Champ d'union
|
|
toolInvocationParameterCorrectnessThreshold |
Facultatif. Seuil de réussite pour la correction des paramètres d'invocation d'outils individuels. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0. |
ToolMatchingSettings
| Représentation JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| Champs | |
|---|---|
extraToolCallBehavior |
Facultatif. Comportement pour les appels d'outils supplémentaires. La valeur par défaut est "FAIL". |
VariableDeclaration
| Représentation JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Champs | |
|---|---|
name |
Obligatoire. Nom de la variable. Le nom doit commencer par une lettre ou un trait de soulignement, et ne contenir que des lettres, des chiffres ou des traits de soulignement. |
description |
Obligatoire. Description de la variable. |
schema |
Obligatoire. Schéma de la variable. |
Schéma
| Représentation JSON |
|---|
{ "type": enum ( |
| Champs | |
|---|---|
type |
Obligatoire. Type des données. |
properties |
Facultatif. Propriétés de Type.OBJECT. Objet contenant une liste de paires |
required[] |
Facultatif. Propriétés requises de Type.OBJECT. |
description |
Facultatif. Description des données. |
items |
Facultatif. Schéma des éléments de Type.ARRAY. |
nullable |
Facultatif. Indique si la valeur peut être nulle. |
uniqueItems |
Facultatif. Indique que les éléments du tableau doivent être uniques. Ne s'applique qu'à TYPE.ARRAY. |
prefixItems[] |
Facultatif. Schémas des éléments initiaux de Type.ARRAY. |
additionalProperties |
Facultatif. Peut être une valeur booléenne ou un objet. Contrôle la présence de propriétés supplémentaires. |
anyOf[] |
Facultatif. La valeur doit être validée par rapport à l'un ou plusieurs des sous-schémas de la liste. |
enum[] |
Facultatif. Valeurs possibles de l'élément de type primitif avec le format enum. Exemples : 1. Nous pouvons définir la direction comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Nous pouvons définir le numéro d'appartement comme suit : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Facultatif. Valeur par défaut des données. |
ref |
Facultatif. Permet les références indirectes entre les nœuds de schéma. La valeur doit être une référence valide à un enfant de la racine Par exemple, le schéma suivant définit une référence à un nœud de schéma nommé "Pet" : La valeur de la propriété "pet" est une référence au nœud de schéma nommé "Pet". Pour en savoir plus, consultez https://json-schema.org/understanding-json-schema/structuring. |
defs |
Facultatif. Carte des définitions à utiliser par Objet contenant une liste de paires |
title |
Facultatif. Titre du schéma. |
minItems |
Facultatif. Nombre minimal d'éléments pour Type.ARRAY. |
maxItems |
Facultatif. Nombre maximal d'éléments pour Type.ARRAY. |
Champ d'union
|
|
minimum |
Facultatif. Valeur minimale pour Type.INTEGER et Type.NUMBER. |
Champ d'union
|
|
maximum |
Facultatif. Valeur maximale pour Type.INTEGER et Type.NUMBER. |
PropertiesEntry
| Représentation JSON |
|---|
{
"key": string,
"value": {
object ( |
| Champs | |
|---|---|
key |
|
value |
|
Valeur
| Représentation JSON |
|---|
{ // Union field |
| Champs | |
|---|---|
Champ d'union kind. Type de valeur. kind ne peut être qu'un des éléments suivants : |
|
nullValue |
Représente une valeur nulle. |
numberValue |
Représente une valeur double. |
stringValue |
Représente une valeur de chaîne. |
boolValue |
Représente une valeur booléenne. |
structValue |
Représente une valeur structurée. |
listValue |
Représente un |
Struct
| Représentation JSON |
|---|
{ "fields": { string: value, ... } } |
| Champs | |
|---|---|
fields |
Carte non ordonnée de valeurs typées de manière dynamique. Objet contenant une liste de paires |
FieldsEntry
| Représentation JSON |
|---|
{ "key": string, "value": value } |
| Champs | |
|---|---|
key |
|
value |
|
ListValue
| Représentation JSON |
|---|
{ "values": [ value ] } |
| Champs | |
|---|---|
values[] |
Champ répété de valeurs typées de manière dynamique. |
DefsEntry
| Représentation JSON |
|---|
{
"key": string,
"value": {
object ( |
| Champs | |
|---|---|
key |
|
value |
|
DataStoreSettings
| Représentation JSON |
|---|
{
"engines": [
{
object ( |
| Champs | |
|---|---|
engines[] |
Uniquement en sortie. Moteurs de l'application. |
Moteur
| Représentation JSON |
|---|
{
"name": string,
"type": enum ( |
| Champs | |
|---|---|
name |
Uniquement en sortie. Nom de ressource du moteur. Format : |
type |
Uniquement en sortie. Type de moteur. |
ChannelProfile
| Représentation JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| Champs | |
|---|---|
profileId |
Facultatif. Identifiant unique du profil de chaîne. |
channelType |
Facultatif. Type de profil de chaîne. |
personaProperty |
Facultatif. Propriété de la persona du profil de chaîne. |
disableDtmf |
Facultatif. Indique si le DTMF (double fréquence) doit être désactivé. |
disableBargeInControl |
Facultatif. Indique si le contrôle de l'interruption par l'utilisateur doit être désactivé dans la conversation. - true : les interruptions de l'utilisateur sont désactivées pendant que l'agent parle. - false : l'agent conserve le contrôle automatique du moment où l'utilisateur peut interrompre. |
webWidgetConfig |
Facultatif. Configuration du widget Web. |
noiseSuppressionLevel |
Facultatif. Niveau de suppression du bruit du profil de chaîne. Les valeurs disponibles sont "low", "moderate", "high" et "very_high". |
PersonaProperty
| Représentation JSON |
|---|
{
"persona": enum ( |
| Champs | |
|---|---|
persona |
Facultatif. Personnalité de la chaîne. |
WebWidgetConfig
| Représentation JSON |
|---|
{ "modality": enum ( |
| Champs | |
|---|---|
modality |
Facultatif. Modalité du widget Web. |
theme |
Facultatif. Thème du widget Web. |
webWidgetTitle |
Facultatif. Titre du widget Web. |
securitySettings |
Facultatif. Paramètres de sécurité du widget Web. |
SecuritySettings
| Représentation JSON |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| Champs | |
|---|---|
enablePublicAccess |
Facultatif. Indique si l'accès public au widget Web est activé. Si la valeur est |
enableOriginCheck |
Facultatif. Indique si la vérification de l'origine du widget Web est activée. Si la valeur est |
allowedOrigins[] |
Facultatif. Origines autorisées à héberger le widget Web. Une origine est définie par la RFC 6454. Si ce champ est vide, toutes les origines sont autorisées. Vous ne pouvez pas inclure plus de 100 origines. Exemple : "https://example.com" |
enableRecaptcha |
Facultatif. Indique si la validation reCAPTCHA pour le widget Web est activée. |
MetadataEntry
| Représentation JSON |
|---|
{ "key": string, "value": string } |
| Champs | |
|---|---|
key |
|
value |
|
Horodatage
| Représentation JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Champs | |
|---|---|
seconds |
Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z). |
nanos |
Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus. |
ClientCertificateSettings
| Représentation JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Champs | |
|---|---|
tlsCertificate |
Obligatoire. Certificat TLS encodé au format PEM. Cette chaîne doit inclure les lignes d'en-tête de début et de pied de page de fin. |
privateKey |
Obligatoire. Nom de la ressource de version du secret Secret Manager stockant la clé privée encodée au format PEM. Format : |
passphrase |
Facultatif. Nom de la ressource de version du secret Secret Manager stockant la phrase secrète permettant de déchiffrer la clé privée. Doit être laissé vide si la clé privée n'est pas chiffrée. Format : |
Annotations d'outils
Indication destructive : ❌ | Indication idempotente : ✅ | Indication en lecture seule : ✅ | Indication Open World : ❌