Risorsa: agente
Entità conversazionale che rappresenta un brand.
Rappresentazione JSON |
---|
{ "name": string, "displayName": string, // Union field |
Campi | |
---|---|
name |
L'identificatore univoco dell'agente. Sola lettura. Definito dalla piattaforma. |
displayName |
Obbligatorio. Il nome che l'agente mostra agli utenti. Massimo 100 caratteri. Non modificabile dopo la verifica dell'agente. |
Campo di unione Obbligatorio. |
|
businessMessagesAgent |
Informazioni dettagliate sull'agente per Business Messages. |
BusinessMessagesAgent
Informazioni dell'agente specifiche per Business Messages.
Rappresentazione JSON |
---|
{ "logoUrl": string, "entryPointConfigs": [ { object ( |
Campi | |
---|---|
logoUrl |
Campo facoltativo. URL disponibile pubblicamente del logo per l'agente. Massimo 50 kB. Non modificabile dopo la verifica dell'agente. |
entryPointConfigs[] |
Campo facoltativo. Elenco di configurazioni del punto di ingresso. Non modificabile dopo la verifica dell'agente. |
conversationalSettings |
Obbligatorio. Impostazioni di conversazione per un agente, mappate a un'impostazione internazionale. Le impostazioni internazionali sono rappresentate da un tag della lingua IETF BCP 47 corretto. Un oggetto contenente un elenco di |
defaultLocale |
Obbligatorio. Le impostazioni internazionali predefinite dell'agente. Deve corrispondere a un'impostazione internazionale definita in |
primaryAgentInteraction |
Obbligatorio. Informazioni sull'interazione con l'agente principale. Utilizzato quando l'utente avvia una conversazione. |
additionalAgentInteractions[] |
Campo facoltativo. Ulteriori informazioni sull'interazione con l'agente. Consente all'agente di supportare più tipi di interazione. |
customAgentId |
Campo facoltativo. Un identificatore specificato dal partner per l'agente. L'identificatore viene trasmesso insieme a tutti i messaggi inviati all'agente. |
agentTestUrl |
Solo output. L'URL per testare l'esperienza di conversazione dell'agente. Definito dalla piattaforma. |
testUrls[] |
Solo output. URL per testare l'esperienza di conversazione dell'agente. Definito dalla piattaforma. |
phone |
Campo facoltativo. Il numero di telefono da mostrare all'agente. Se non specificato, l'agente mostra il numero di telefono del brand trovato nel Google Knowledge Graph, se presente. |
authorizationConfig |
Campo facoltativo. Configurazione dell'autorizzazione per il supporto OAuth. |
nonLocalConfig |
Campo facoltativo. Configurazione per punti di ingresso non locali. |
surveyConfig |
Campo facoltativo. Configurazione per attivare i sondaggi personalizzati. |
BusinessMessagesEntryPointConfig
La configurazione del punto di ingresso per un agente.
Rappresentazione JSON |
---|
{
"allowedEntryPoint": enum ( |
Campi | |
---|---|
allowedEntryPoint |
Obbligatorio. Le piattaforme Google su cui è abilitata la visualizzazione dell'agente. |
EntryPoint
Le piattaforme Google su cui è abilitata la visualizzazione dell'agente.
Enum | |
---|---|
ENTRY_POINT_UNSPECIFIED |
Punto di ingresso non specificato. |
LOCATION |
Abilita le località per questo agente. |
NON_LOCAL |
Attiva Business Messages per i punti di contatto non locali. |
SupportedAgentInteraction
Interazioni supportate da un agente.
Rappresentazione JSON |
---|
{ "interactionType": enum ( |
Campi | |
---|---|
interactionType |
Obbligatorio. Il tipo di interazione supportata dall'agente. |
Campo di unione representative . Le informazioni dettagliate relative al tipo di configurazione. Obbligatorio. representative può essere solo uno dei seguenti: |
|
botRepresentative |
Dettagli rappresentante del bot. |
humanRepresentative |
Dettagli rappresentativi delle persone. |
InteractionType
Tipo di interazione supportato per l'agente.
Enum | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Interazione non specificata. |
BOT |
Interazione con il bot. |
HUMAN |
Interazione umana. |
BotRepresentative
Dettagli per il rappresentante del bot.
Rappresentazione JSON |
---|
{
"botMessagingAvailability": {
object ( |
Campi | |
---|---|
botMessagingAvailability |
Obbligatorio. Disponibilità della messaggistica tramite bot. |
MessagingAvailability
Le ore di ogni giorno della settimana in cui sono disponibili i messaggi. Puoi raggruppare gli orari per più giorni. Ad esempio, * 08:00-16:00 PDT lunedì-mercoledì * 10:00-14:00 PDT giovedì-venerdì * 15:00-18:00 PDT giovedì-venerdì * 10:00-14:00 PDT sabato-sabato
Se ci sono lacune nella disponibilità, ad esempio nessuna disponibilità specificata la domenica, la messaggistica non sarà disponibile durante questi intervalli.
Le ore bot non hanno alcun effetto sulla disponibilità. Gli agenti solo bot mostrano sempre un messaggio di benvenuto, mentre gli agenti con impostazioni sia umane che di bot prendono in considerazione solo i rappresentanti umani quando definiscono la disponibilità.
Rappresentazione JSON |
---|
{
"hours": [
{
object ( |
Campi | |
---|---|
hours[] |
Obbligatorio. Orari di disponibilità della messaggistica. |
Orari
Un intervallo di ore in cui è disponibile la messaggistica.
Rappresentazione JSON |
---|
{ "startTime": { object ( |
Campi | |
---|---|
startTime |
Obbligatorio. Ora di inizio di ogni giorno nell'intervallo dei giorni della settimana. |
endTime |
Obbligatorio. Ora di fine di ogni giorno nell'intervallo dei giorni della settimana. |
timeZone |
Obbligatorio. Il fuso orario IANA per le ore. Ad esempio, "America/Los_Angeles". |
startDay |
Obbligatorio. Giorno di inizio. |
endDay |
Obbligatorio. Giorno di fine. Include il giorno specificato. |
TimeOfDay
Rappresenta un'ora del giorno. La data e il fuso orario non sono significativi o sono specificati altrove. Un'API può scegliere di consentire i secondi intercalari. I tipi correlati sono google.type.Date
e google.protobuf.Timestamp
.
Rappresentazione JSON |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Campi | |
---|---|
hours |
Le ore del giorno nel formato 24 ore. Il valore deve essere compreso tra 0 e 23. Un'API può scegliere di consentire il valore "24:00:00" per scenari come l'orario di chiusura di un'attività. |
minutes |
Minuti di ora del giorno. Il valore deve essere compreso tra 0 e 59. |
seconds |
Secondi di minuti del tempo. Normalmente deve essere compreso tra 0 e 59. Un'API potrebbe consentire il valore 60 se consente i secondi intercalari. |
nanos |
Frazioni di secondi in nanosecondi. Il valore deve essere compreso tra 0 e 999.999.999. |
DayOfWeek
Rappresenta un giorno della settimana.
Enum | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Il giorno della settimana non è specificato. |
MONDAY |
Lunedì |
TUESDAY |
Martedì |
WEDNESDAY |
mercoledì |
THURSDAY |
giovedì |
FRIDAY |
venerdì |
SATURDAY |
Sabato |
SUNDAY |
domenica |
HumanRepresentative
Dettagli per il rappresentante umano.
Rappresentazione JSON |
---|
{
"humanMessagingAvailability": {
object ( |
Campi | |
---|---|
humanMessagingAvailability |
Obbligatorio. Disponibilità della messaggistica umana. |
AuthorizationConfig
Dettagli di configurazione per il supporto di OAuth in Business Messages.
Rappresentazione JSON |
---|
{ "endpointUrl": string } |
Campi | |
---|---|
endpointUrl |
L'URL dell'endpoint a cui l'utente accede. |
NonLocalConfig
Configurazione per abilitare i punti di ingresso non locali.
Rappresentazione JSON |
---|
{ "contactOption": { object ( |
Campi | |
---|---|
contactOption |
Obbligatorio. Dati di contatto dell'agente visualizzati con il pulsante di messaggistica. |
enabledDomains[] |
Obbligatorio. Domini da attivare per il punto di ingresso dei sitelink. |
phoneNumber |
Obbligatorio. Numero di telefono dell'agente. Sostituisce il campo |
callDeflectionPhoneNumbers[] |
Obbligatorio. Elenco di numeri di telefono per il deviazione delle chiamate. |
regionCodes[] |
Obbligatorio. Elenco di codici regione CLDR per i paesi in cui l'agente è autorizzato a lanciare |
ContactOption
Dettagli di contatto visualizzati oltre al pulsante dei messaggi.
Rappresentazione JSON |
---|
{
"url": string,
"options": [
enum ( |
Campi | |
---|---|
url |
Obbligatorio. L'URL per cui sono disponibili le opzioni di contatto. |
options[] |
Obbligatorio. L'elenco di opzioni di contatto disponibili per l'URL specificato. |
Opzione
Opzioni di contatto.
Enum | |
---|---|
OPTION_UNSPECIFIED |
Non specificato |
WEB_CHAT |
Opzione Chat web. |
PHONE |
Opzione telefonica. |
EMAIL |
Opzione email. |
FAQS |
l'opzione Domande frequenti. |
TWITTER |
Opzione Twitter. |
WHATSAPP |
Opzione WhatsApp. |
SurveyConfig
Dettagli di configurazione per il supporto delle domande personalizzate del sondaggio.
Rappresentazione JSON |
---|
{
"templateQuestionIds": [
string
],
"customSurveys": {
string: {
object ( |
Campi | |
---|---|
templateQuestionIds[] |
Elenco di ID domanda modello per domande modello incluse in un sondaggio. |
customSurveys |
Domande del sondaggio personalizzate per un agente, mappate a un'impostazione internazionale. Le impostazioni internazionali sono rappresentate da un tag della lingua IETF BCP 47 corretto. Un oggetto contenente un elenco di |
CustomSurveyConfig
Configurazione del sondaggio personalizzato per un agente.
Rappresentazione JSON |
---|
{
"customQuestions": [
{
object ( |
Campi | |
---|---|
customQuestions[] |
Elenco di domande personalizzate. |
SurveyQuestion
I contenuti dettagliati di ciascuna domanda del sondaggio.
Rappresentazione JSON |
---|
{ "name": string, "questionType": enum ( |
Campi | |
---|---|
name |
Obbligatorio. L'identificatore univoco della domanda. |
questionType |
Solo output. Tipo di domanda. |
questionContent |
Obbligatorio. Contenuti della domanda. Il limite di caratteri per le domande personalizzate è 200. |
responseOptions[] |
Obbligatorio. Elenco di risposte visualizzate con la domanda. Massimo 12. |
Tipo
Il tipo di domanda del sondaggio.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Tipo di domanda del sondaggio sconosciuto. |
GOOGLE_STANDARD_QUESTION |
Domanda del sondaggio standard di Google. |
GOOGLE_TEMPLATE_QUESTION |
Modello di domanda del sondaggio fornito da Google. |
PARTNER_CUSTOM_QUESTION |
Domanda del sondaggio personalizzato del partner. |
SurveyResponse
I contenuti della risposta a una domanda del sondaggio.
Rappresentazione JSON |
---|
{ "content": string, "postbackData": string } |
Campi | |
---|---|
content |
Obbligatorio. Testo visualizzato nel sondaggio e inviato all'agente quando l'utente lo tocca. Massimo 35 caratteri. |
postbackData |
La stringa che l'agente riceve quando l'utente tocca la risposta alla domanda. |
Metodi |
|
---|---|
|
Crea un nuovo agente per rappresentare un brand. |
|
Elimina un agente. |
|
Recuperare informazioni su un agente. |
|
Recupera le informazioni sul lancio per un agente. |
|
Recupera le informazioni di verifica per un agente. |
|
Elenca tutti gli agenti associati a un brand. |
|
Aggiorna le informazioni su un agente. |
|
Avvia il processo di lancio per un agente. |
|
Avvia la verifica delle informazioni sull'attività per un agente. |
|
Aggiorna le informazioni sul lancio di un agente. |
|
Consente di aggiornare lo stato di verifica di un agente. |