REST Resource: projects.chatAppConfig

Risorsa: ChatAppConfig

Rappresenta la configurazione di un'app di Chat di Google creata come componente aggiuntivo di Google Workspace.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Campi
name

string

Obbligatorio. Identificatore. Nome della risorsa della configurazione dell'app di Chat.

Formato: projects/{project}/chatAppConfig, dove {project} è il numero del progetto Google Cloud.
displayName

string

Obbligatorio. Il nome visualizzato dell'app di Chat. La lunghezza deve essere compresa tra 3 e 25 caratteri.
description

string

Obbligatorio. Una breve descrizione dell'app di Chat. Deve contenere da 1 a 40 caratteri.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Facoltativo. Le impostazioni per le funzionalità interattive dell'app. Se non viene fornito, l'app non sarà interattiva, il che significa che può utilizzare l'API Chat, ma gli utenti non possono interagire con l'app.
avatarUri

string

Facoltativo. L'URL dell'immagine dell'avatar dell'app. Deve essere un URL HTTPS che ospita un'immagine PNG quadrata (proporzioni 1:1). Dimensioni minime consigliate: 256 x 256 pixel. Se non specificato, verrà utilizzato un avatar dell'app predefinito.
state

enum (AppState)

Facoltativo. Lo stato dell'app. Se non specificato, il valore predefinito è ACTIVE.
errorLoggingEnabled

boolean

Facoltativo. Indica se registrare gli errori in Cloud Logging. Se non specificato, il valore predefinito è false.
markupSyntax

enum (MarkupSyntax)

Facoltativo. La sintassi di markup predefinita per i messaggi inviati o letti da questa app di Chat. Se non specificato, il valore predefinito è MARKUP_SYNTAX_MARKDOWN.

AppState

Lo stato attuale dell'app di Chat.

Enum
APP_STATE_UNSPECIFIED Valore predefinito. Non specificato.
ACTIVE Corrisponde a LIVE nella pagina di configurazione dell'API Chat. L'app è attiva e può essere trovata e utilizzata dalle persone con visibilità.
DISABLED L'app è disattivata, non può più essere trovata da nessuno e nessuno può più interagire con l'app.

InteractiveFeatureConfig

Impostazioni per le funzionalità interattive dell'app.

Rappresentazione JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Campi
connectionConfig

object (ConnectionConfig)

Obbligatorio. In che modo l'app riceve gli eventi da Google Chat.
appCommands[]

object (AppCommand)

Facoltativo. Configurazione per i comandi dell'app.
urlPatterns[]

object (UrlPattern)

Facoltativo. Configurazione per le anteprime dei link.
allowlistedTestingPrincipals[]

string

Facoltativo. Gli indirizzi email degli utenti e dei gruppi nel tuo dominio Google Workspace che possono trovare e utilizzare l'app.
supportsMultiuserSpaces

boolean

Facoltativo. Se l'app può essere aggiunta a DM 1:1 con persone, chat di gruppo e spazi. Se non specificato, il valore predefinito è false.

ConnectionConfig

Come l'app riceve gli eventi.

Rappresentazione JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Campi
Il tipo di connessione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
httpEndpointConfig

object (HttpEndpointConfig)

Configurazione dell'endpoint HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Configurazione del deployment di Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Configurazione argomento Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Configurazione di Dialogflow.
Fine dei campi che si escludono a vicenda.

HttpEndpointConfig

Configurazione dell'endpoint HTTP.

Rappresentazione JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Campi
La configurazione dell'URL dell'endpoint HTTP. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
commonUrl

string

Facoltativo. L'URL HTTPS a cui Google Chat invia tutti gli eventi interattivi.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Facoltativo. URL HTTPS separati a cui Google Chat invia ogni tipo di evento interattivo.
Fine dei campi che si escludono a vicenda.

HttpPerEventEndpointConfig

Configurazione dell'endpoint HTTP per tipi di eventi specifici.

Rappresentazione JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Campi
appCommandEndpoint

string

Obbligatorio. Endpoint URL HTTPS per gli eventi di comando dell'app.
addedToSpaceEndpoint

string

Obbligatorio. Endpoint URL HTTPS per gli eventi di aggiunta allo spazio.
messageEndpoint

string

Obbligatorio. Endpoint URL HTTPS per gli eventi di messaggi.
removedFromSpaceEndpoint

string

Obbligatorio. Endpoint URL HTTPS per gli eventi di rimozione dallo spazio.

AppsScriptEndpointConfig

Configurazione dell'endpoint Apps Script.

Rappresentazione JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Campi
deploymentId

string

Obbligatorio. L'ID deployment di Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Facoltativo. I nomi delle funzioni Apps Script che Google Chat chiama per ogni tipo di evento interattivo. Se non specificato, Chat chiama la funzione predefinita per ogni tipo di evento.

AppsScriptPerEventEndpointConfig

Configurazione dell'endpoint Apps Script per tipi di eventi specifici.

Rappresentazione JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Campi
appCommandEndpoint

string

Facoltativo. Nome della funzione per gli eventi dei comandi dell'app. Se non specificato, verrà utilizzato il nome della funzione onAppCommand predefinito.
addedToSpaceEndpoint

string

Facoltativo. Nome della funzione per gli eventi di aggiunta allo spazio. Se non specificato, verrà utilizzato il nome della funzione onAddedToSpace predefinito.
messageEndpoint

string

Facoltativo. Nome della funzione per gli eventi dei messaggi. Se non specificato, verrà utilizzato il nome della funzione onMessage predefinito.
removedFromSpaceEndpoint

string

Facoltativo. Nome della funzione per gli eventi di rimozione dallo spazio. Se non specificato, verrà utilizzato il nome della funzione onRemovedFromSpace predefinito.

CloudPubSubEndpointConfig

Configurazione dell'endpoint Pub/Sub.

Rappresentazione JSON 
{
  "topic": string
}
Campi
topic

string

Obbligatorio. L'argomento Pub/Sub in cui Google Chat pubblica tutti gli eventi interattivi. L'argomento deve trovarsi nello stesso progetto cloud di Google Cloud dell'app e Chat deve disporre dell'autorizzazione per pubblicare messaggi nell'argomento. Per maggiori dettagli, vedi Crea un'app Google Chat con Pub/Sub.

Formato: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Configurazione dell'endpoint Dialogflow.

Rappresentazione JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Campi
dialogflowEdition

enum (DialogflowEdition)

Obbligatorio. La versione di Dialogflow.
agent

string

Facoltativo. Il nome dell'agente CX o dell'ambiente Dialogflow CX. Obbligatorio per Dialogflow CX. Non impostare per Dialogflow ES.

Formato: projects/{project}/locations/{location}/agents/{agent} o projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Tipo di versione di Dialogflow.

Enum
DIALOGFLOW_EDITION_UNSPECIFIED Valore predefinito. Non specificato.
ES Versione di Dialogflow ES. Per utilizzare questa versione, deve esistere un agente Dialogflow ES nello stesso progetto Google Cloud dell'app. Google Chat invia tutti gli eventi interattivi a quell'agente.
CX Versione di Dialogflow CX. Per utilizzare questa versione, deve esistere un agente Dialogflow CX nello stesso progetto Google Cloud dell'app e deve essere specificato nel campo agent. Google Chat invia tutti gli eventi interattivi a quell'agente.

AppCommand

Configurazione di un comando dell'app.

Rappresentazione JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Campi
commandType

enum (CommandType)

Obbligatorio. Il tipo di questo comando.
commandId

integer

Obbligatorio. L'ID del comando (1-1000). Deve essere univoco all'interno dell'app.
command

string

Facoltativo. Il nome del comando. Obbligatorio per SLASH_COMMAND, non impostare per altri tipi di comandi. Deve iniziare con "/", ad esempio "/comando".
displayName

string

Facoltativo. Il nome visualizzato facile da usare del comando. Obbligatorio per MESSAGE_ACTION e QUICK_COMMAND, non impostare per SLASH_COMMAND.
description

string

Obbligatorio. Una breve descrizione del comando.
dialogEnabled

boolean

Facoltativo. Indica se questo comando deve attivare una finestra di dialogo. Se non specificato, il valore predefinito è false.
loadingNotificationMessage

string

Facoltativo. Una notifica da inviare all'utente quando attiva l'azione del messaggio. Supportato solo per i comandi MESSAGE_ACTION.

CommandType

Il tipo di comando dell'app.

Enum
COMMAND_TYPE_UNSPECIFIED Valore predefinito. Non specificato.
SLASH_COMMAND Un comando richiamato digitando "/" seguito dal nome del comando. Può accettare argomenti aggiuntivi nel testo del messaggio.
QUICK_COMMAND Un comando rapido richiamato dal menu contestuale di composizione del messaggio. I comandi rapidi non accettano argomenti aggiuntivi.
MESSAGE_ACTION Un comando richiamato da un menu contestuale del messaggio.

UrlPattern

Configurazione per un'anteprima link.

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

string

Obbligatorio. Il dominio da abbinare. Trova un sottodominio specifico, ad esempio "subdomain.example.com", o un intero dominio includendo un asterisco (*) come carattere jolly iniziale. Ad esempio, "*.example.com" corrisponde a "https://subdomain.example.com" e "https://any.number.of.subdomains.example.com".
pathPrefix

string

Facoltativo. Prefisso del percorso aggiunto al pattern host. Se vuoto, corrisponde a tutti gli URL nel pattern host. Ad esempio, se accoppiato con il pattern host "subdomain.example.com", specifica "path/" in modo che corrisponda agli URL delle pagine corrispondenti che iniziano con "https://subdomain.example.com/path/".

MarkupSyntax

La sintassi di markup utilizzata per formattare il testo dei messaggi per questa app di Chat.

Enum
MARKUP_SYNTAX_UNSPECIFIED Valore predefinito. Non specificato. Le app di Chat esistenti create prima dell'introduzione di markup_syntax hanno questo valore e utilizzano MARKUP_SYNTAX_CHAT fino a quando non vengono aggiornate esplicitamente.
MARKUP_SYNTAX_CHAT Utilizza la sintassi di markup di Google Chat. Per saperne di più, visita la pagina https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN Utilizza la sintassi Markdown. Questa sintassi si basa sulla specifica CommonMark, con estensioni aggiuntive. Per saperne di più, visita la pagina https://developers.google.com/workspace/chat/format-messages#format-texts.

Metodi

get

 Recupera la configurazione dell'app di Chat di un progetto.

patch

 Aggiorna la configurazione dell'app di Chat di un progetto.