REST Resource: brands.agents

Risorsa: agente

Un'entità conversazionale che rappresenta un brand.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  }
  // End of list of possible types for union field detail_info.
}
Campi
name

string

L'identificatore univoco dell'agente.

Sola lettura. Definite dalla piattaforma.
displayName

string

Obbligatorio. Il nome che l'agente mostra agli utenti. Massimo 100 caratteri.

Non modificabile dopo la verifica dell'agente.

Campo unione detail_info. Contiene i campi obbligatori per il prodotto specifico.

Obbligatorio. detail_info può essere solo uno dei seguenti:
businessMessagesAgent

object (BusinessMessagesAgent)

Informazioni dettagliate sull'agente per Business Messages.

BusinessMessagesAgent

Informazioni dell'agente specifiche per Business Messages.

Rappresentazione JSON 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
Campi
logoUrl

string

(Facoltativo) URL del logo disponibile pubblicamente per l'agente. Massimo 50 kB.

Non modificabile dopo la verifica dell'agente.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

(Facoltativo) Elenco delle configurazioni del punto di ingresso.

Non modificabile dopo la verifica dell'agente.
conversationalSettings

map (key: string, value: object (ConversationalSetting))

Obbligatorio. Impostazioni conversazionali di un agente mappate a una lingua. Le impostazioni internazionali sono rappresentate da un tag lingua IETF BCP 47 ben strutturato.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Obbligatorio. Le impostazioni internazionali predefinite dell'agente. Deve corrispondere a un'impostazione internazionale definita in conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Obbligatorio. Informazioni sull'interazione con l'agente principale. Utilizzato quando l'utente avvia una conversazione.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

(Facoltativo) Informazioni aggiuntive sull'interazione con l'agente. Consente all'agente di supportare più tipi di interazione.
customAgentId

string

(Facoltativo) Un identificatore specificato dal partner per l'agente. L'identificatore viene passato insieme a tutti i messaggi inviati all'agente.
agentTestUrl
(deprecated)

string

Solo output. L'URL per testare l'esperienza conversazionale dell'agente.

Definite dalla piattaforma.
testUrls[]

object (TestUrl)

Solo output. URL per testare l'esperienza conversazionale dell'agente.

Definite dalla piattaforma.
phone

object (Phone)

(Facoltativo) Il numero di telefono da mostrare all'agente. Se non specificato, l'agente mostra il numero di telefono del brand eventualmente trovato nel Google Knowledge Graph.
authorizationConfig

object (AuthorizationConfig)

(Facoltativo) Configurazione dell'autorizzazione per il supporto OAuth.
nonLocalConfig

object (NonLocalConfig)

(Facoltativo) Configurazione per punti di ingresso non locali.
surveyConfig

object (SurveyConfig)

(Facoltativo) Configurazione per attivare i sondaggi personalizzati.

BusinessMessagesEntryPointConfig

La configurazione del punto di ingresso di un agente.

Rappresentazione JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Campi
allowedEntryPoint

enum (EntryPoint)

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 Abilita Business Messages per punti di ingresso non locali.

SupportedAgentInteraction

Interazioni supportate da un agente.

Rappresentazione JSON 
{
  "interactionType": enum (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
Campi
interactionType

enum (InteractionType)

Obbligatorio. Il tipo di interazione supportato dall'agente.
Campo unione representative. Le informazioni dettagliate per il tipo di configurazione. Obbligatorio. representative può essere solo uno dei seguenti:
botRepresentative

object (BotRepresentative)

Dettagli del rappresentante del bot.
humanRepresentative

object (HumanRepresentative)

Dettagli rappresentativi umani.

InteractionType

Tipo di interazione supportata 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 (MessagingAvailability)
  }
}
Campi
botMessagingAvailability

object (MessagingAvailability)

Obbligatorio. Disponibilità della messaggistica dei bot.

MessagingAvailability

Gli orari di ogni giorno della settimana in cui è disponibile la messaggistica. Puoi raggruppare gli orari di più giorni. Ad esempio, * 08:00–16:00 PDT lunedì–mercoledì * 10:00–14:00 ore PDT giovedì-venerdì * 15:00–18:00 PDT giovedì–venerdì * 10:00–14:00 PDT sabato-sabato

In caso di lacune nella disponibilità, ad esempio se la disponibilità non è stata specificata la domenica, i messaggi non saranno disponibili durante queste interruzioni.

Le ore bot non hanno alcun effetto sulla disponibilità. Gli agenti solo bot mostrano sempre un messaggio di benvenuto, mentre quelli con impostazioni di rappresentanza sia umana che di bot prendono in considerazione i rappresentanti umani solo nel definire la disponibilità.

Rappresentazione JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Campi
hours[]

object (Hours)

Obbligatorio. Orari di disponibilità della messaggistica.

Ore

Un intervallo di ore in cui è disponibile la messaggistica.

Rappresentazione JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Campi
startTime

object (TimeOfDay)

Obbligatorio. Ora di inizio di ogni giorno compreso nell'intervallo di giorni della settimana.
endTime

object (TimeOfDay)

Obbligatorio. Ora di fine per ogni giorno compreso nell'intervallo di giorni della settimana.
timeZone

string

Obbligatorio. Il fuso orario IANA per le ore. Ad esempio, "America/Los_Angeles".
startDay

enum (DayOfWeek)

Obbligatorio. Giorno di inizio.
endDay

enum (DayOfWeek)

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

integer

Le ore del giorno nel formato 24 ore. 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 dell'attività.
minutes

integer

Minuti dell'ora del giorno. Il valore deve essere compreso tra 0 e 59.
seconds

integer

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

integer

Frazioni di secondi in nanosecondi. 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 rappresentante umano.

Rappresentazione JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Campi
humanMessagingAvailability

object (MessagingAvailability)

Obbligatorio. Disponibilità della messaggistica umana.

AuthorizationConfig

Dettagli di configurazione per il supporto di OAuth su Business Messages.

Rappresentazione JSON 
{
  "endpointUrl": string
}
Campi
endpointUrl

string

L'URL dell'endpoint a cui l'utente accede.

NonLocalConfig

Configurazione per abilitare punti di ingresso non locali.

Rappresentazione JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Campi
contactOption

object (ContactOption)

Obbligatorio. Dati di contatto dell'agente visualizzati con il pulsante di messaggistica.
enabledDomains[]

string

Obbligatorio. Domini da attivare per il punto di ingresso dei sitelink.
phoneNumber

object (Phone)

Obbligatorio. Numero di telefono dell'agente. Sostituisce il campo phone per le conversazioni avviate da punti di contatto non locali. Questo numero di telefono verrà utilizzato per tutte le regioni configurate.
callDeflectionPhoneNumbers[]

object (Phone)

Obbligatorio. Elenco di numeri di telefono per la deviazione chiamata.
regionCodes[]

string

Obbligatorio. Elenco di codici regione CLDR per i paesi in cui l'agente può lanciare gli entry point NON_LOCAL. Obbligatorio per NON_LOCAL punti di ingresso.

ContactOption

Dettagli di contatto visualizzati in aggiunta al pulsante dei messaggi.

Rappresentazione JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Campi
url

string

Obbligatorio. L'URL per cui sono disponibili le opzioni di contatto.
options[]

enum (Option)

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 telefono.
EMAIL Opzione email.
FAQS l'opzione Domande frequenti.
TWITTER Opzione Twitter.
WHATSAPP Opzione WhatsApp.

SurveyConfig

Dettagli di configurazione per supportare le domande del sondaggio personalizzato.

Rappresentazione JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Campi
templateQuestionIds[]

string

Elenco di ID modello per le domande modello incluse in un sondaggio.
customSurveys

map (key: string, value: object (CustomSurveyConfig))

Domande del sondaggio personalizzate per un agente, mappate a una lingua. Le impostazioni internazionali sono rappresentate da un tag lingua IETF BCP 47 ben strutturato.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Configurazione del sondaggio personalizzata per un agente.

Rappresentazione JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Campi
customQuestions[]

object (SurveyQuestion)

Elenco di domande personalizzate.

SurveyQuestion

Il contenuto dettagliato di ogni domanda del sondaggio.

Rappresentazione JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Campi
name

string

Obbligatorio. L'identificatore univoco della domanda.
questionType

enum (Type)

Solo output. Tipo di domanda.
questionContent

string

Obbligatorio. Contenuti delle domande. Massimo 200 caratteri per le domande personalizzate.
responseOptions[]

object (SurveyResponse)

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 standard del sondaggio Google.
GOOGLE_TEMPLATE_QUESTION Modello di domanda del sondaggio fornito da Google.
PARTNER_CUSTOM_QUESTION Domanda del sondaggio personalizzata per i partner.

SurveyResponse

I contenuti della risposta a una domanda del sondaggio.

Rappresentazione JSON 
{
  "content": string,
  "postbackData": string
}
Campi
content

string

Obbligatorio. Testo mostrato nel sondaggio e rinviato all'agente quando l'utente lo tocca. Massimo 35 caratteri.
postbackData

string

La stringa ricevuta dall'agente quando l'utente tocca la risposta alla domanda.

Metodi

create

 Crea un nuovo agente per rappresentare un brand.

delete

 Elimina un agente.

get

 Ricevere informazioni su un agente.

getLaunch

 Recupera le informazioni sul lancio di un agente.

getVerification

 Recupera le informazioni di verifica per un agente.

list

 Elenca tutti gli agenti associati a un brand.

patch

 Aggiorna le informazioni su un agente.

requestLaunch

 Avvia il processo di lancio per un agente.

requestVerification

 Avvia la verifica delle informazioni sull'attività per un agente.

updateLaunch

 Aggiorna le informazioni relative al lancio di un agente.

updateVerification

 Aggiorna lo stato della verifica per un agente.