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)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
Campi
name

string

L'identificatore univoco dell'agente.

Sola lettura. Definito dalla piattaforma.
displayName

string

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

Non modificabile dopo la verifica dell'agente.

Campo di 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.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Informazioni dettagliate sull'agente per RCS Business Messaging.

BusinessMessagesAgent

Informazioni sull'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

Campo facoltativo. URL del logo disponibile pubblicamente per l'agente. Massimo 50 kB.

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

object (BusinessMessagesEntryPointConfig)

Campo facoltativo. Elenco delle configurazioni dei punti di ingresso.

Non modificabile dopo la verifica dell'agente.
conversationalSettings

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

obbligatorio. Impostazioni di conversazione per un agente, mappate a un'impostazione internazionale. Le impostazioni internazionali sono rappresentate da un tag lingua IETF BCP 47 corretto.

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. Utilizzata quando l'utente avvia una conversazione.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Campo facoltativo. Ulteriori informazioni sull'interazione con l'agente. Consente all'agente di supportare più tipi di interazione.
customAgentId

string

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

string

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

Definito dalla piattaforma.
testUrls[]

object (TestUrl)

Solo output. URL per testare l'esperienza di conversazione dell'agente.

Definito dalla piattaforma.
phone

object (Phone)

Campo facoltativo. Il numero di telefono da mostrare all'agente. Se non specificato, l'agente mostra il numero di telefono del brand indicato nel Google Knowledge Graph, se presente.
authorizationConfig

object (AuthorizationConfig)

Campo facoltativo. Configurazione delle autorizzazioni per il supporto OAuth.
nonLocalConfig

object (NonLocalConfig)

Campo facoltativo. Configurazione per i punti di ingresso non locali.
surveyConfig

object (SurveyConfig)

Campo facoltativo. Configurazione per abilitare i sondaggi personalizzati.

BusinessMessagesEntryPointConfig

La configurazione del punto di ingresso per 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 Attiva le località per questo agente.
NON_LOCAL Attiva Business Messages per i 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 supportata dall'agente.
Campo di unione representative. Le informazioni dettagliate per il tipo di configurazione. obbligatorio. representative può essere solo uno dei seguenti:
botRepresentative

object (BotRepresentative)

Dettagli rappresentante bot.
humanRepresentative

object (HumanRepresentative)

Dettagli del rappresentante umano.

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

Le ore di ogni giorno della settimana in cui sono disponibili i messaggi. Puoi raggruppare le ore 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 delle lacune nella disponibilità, ad esempio nessuna disponibilità specificata di domenica, la messaggistica non è 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 considerano i rappresentanti umani solo quando definiscono la disponibilità.

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

object (Hours)

obbligatorio. Orari di disponibilità della messaggistica.

Ore

Un intervallo di ore in cui sono disponibili i messaggi.

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

object (TimeOfDay)

obbligatorio. Ora di inizio per ogni giorno compreso nell'intervallo di un giorno della settimana.
endTime

object (TimeOfDay)

obbligatorio. Ora di fine per ogni giorno nell'intervallo di un giorno 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 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

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 dell'attività.
minutes

integer

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

integer

Secondi di minuti. 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. 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 in persona.

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

object (MessagingAvailability)

obbligatorio. Disponibilità di messaggi umani.

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 i 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 le deviazioni delle chiamate.
regionCodes[]

string

obbligatorio. Elenco di codici regione CLDR per i paesi in cui l'agente è autorizzato a lanciare NON_LOCAL punti di ingresso. 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 specificata
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 di domande dei modelli per le domande dei modelli incluse in un sondaggio.
customSurveys

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

Domande del sondaggio personalizzate per un agente, mappate a un'impostazione internazionale. Le impostazioni internazionali sono rappresentate da un tag lingua IETF BCP 47 corretto.

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

CustomSurveyConfig

Configurazione del sondaggio personalizzato per un agente.

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

object (SurveyQuestion)

Elenco di domande personalizzate.

SurveyQuestion

I contenuti dettagliati di ciascuna 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 della domanda. La lunghezza massima è 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 del sondaggio standard di Google.
GOOGLE_TEMPLATE_QUESTION Modello di domanda fornito da Google.
PARTNER_CUSTOM_QUESTION Domanda del sondaggio personalizzato del partner.

SurveyResponse

I contenuti della risposta alla domanda di un sondaggio.

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

string

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

string

La stringa che l'agente riceve quando l'utente tocca la risposta alla domanda.

RcsBusinessMessagingAgent

Informazioni dell'agente correlate specificamente a RCS Business Messaging.

Rappresentazione JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
Campi
description

string

obbligatorio. Descrizione dell'agente visibile agli utenti. Massimo 100 caratteri.
logoUri

string

obbligatorio. URL del logo disponibile pubblicamente per l'agente. Massimo 50 kB.

Non modificabile dopo la verifica dell'agente.
heroUri

string

obbligatorio. URL dell'immagine hero disponibile pubblicamente per l'agente. Massimo 200 kB.

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

object (PhoneEntry)

obbligatorio. Numeri di telefono associati all'agente.
emails[]

object (EmailEntry)

Campo facoltativo. Indirizzi email associati all'agente.
websites[]

object (WebEntry)

Campo facoltativo. Siti web associati all'agente. Massimo 3.
privacy

object (WebEntry)

obbligatorio. Norme sulla privacy associate all'agente.
termsConditions

object (WebEntry)

obbligatorio. Termini e condizioni associati all'agente.
color

string

obbligatorio. Colore del tema dell'agente visibile agli utenti in formato esadecimale. Ad esempio, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

obbligatorio. Configurazione di fatturazione per l'agente.
agentUseCase

enum (AgentUseCase)

Campo facoltativo. Caso d'uso del bot.
hostingRegion

enum (HostingRegion)

obbligatorio. Regione dell'hosting per un agente.

PhoneEntry

Un numero di telefono associato all'agente.

Rappresentazione JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Campi
phoneNumber

object (Phone)

obbligatorio. Numero di telefono in formato E.164. Ad esempio, +12223334444.
label

string

obbligatorio. Etichetta per il numero di telefono.

EmailEntry

Un indirizzo email associato all'agente.

Rappresentazione JSON 
{
  "address": string,
  "label": string
}
Campi
address

string

obbligatorio. Un indirizzo email.
label

string

obbligatorio. Etichetta dell'indirizzo email.

WebEntry

Una risorsa basata sul web associata all'agente.

Rappresentazione JSON 
{
  "uri": string,
  "label": string
}
Campi
uri

string

obbligatorio. Un URI accessibile pubblicamente associato all'agente. Deve utilizzare il protocollo HTTP o HTTPS.
label

string

Campo facoltativo. Etichetta per l'URI.

RcsBusinessMessagingAgentBillingConfig

Configurazione di fatturazione per l'agente.

Rappresentazione JSON 
{
  "billingCategory": enum (BillingCategory)
}
Campi
billingCategory

enum (BillingCategory)

Categoria di fatturazione dell'agente.

BillingCategory

Categorie di fatturazione supportate.

Enum
BILLING_CATEGORY_UNSPECIFIED Categoria non specificata.
CONVERSATIONAL_LEGACY Categoria precedente per supportare la configurazione di fatturazione degli agenti esistenti.
CONVERSATIONAL Pensato per sessioni più lunghe e complesse, in cui utente e brand si scambiano una serie di messaggi.
SINGLE_MESSAGE Sostituisce gli SMS con un'esperienza di messaggistica più completa. Mai fatturata come CONVERSATIONAL.
BASIC_MESSAGE Il modello di fatturazione è simile a quello per gli SMS. Mai fatturata come CONVERSATIONAL.

AgentUseCase

Tipi di casi d'uso dell'agente utilizzati nello spazio di archiviazione.

Enum
AGENT_USE_CASE_UNSPECIFIED Caso d'uso non specificato.
TRANSACTIONAL Agenti che inviano solo messaggi essenziali, necessari e per cui il fattore temporale è decisivo.
PROMOTIONAL Agenti che inviano messaggi di vendita, marketing e promozionali. Tipo predefinito.
OTP Agenti che inviano una sola password.
MULTI_USE Agenti con più casi d'uso.

HostingRegion

Possibili regioni di hosting per un agente, utilizzate per il routing corretto dei messaggi P2A al server regionalizzato.

Enum
HOSTING_REGION_UNSPECIFIED Regione di hosting non specificata.
NORTH_AMERICA Nord America.
EUROPE Europa.
ASIA_PACIFIC Asia Pacifico.

Metodi

create

 Crea un nuovo agente per rappresentare un brand.

delete
(deprecated)

 Deprecato: l'eliminazione dell'agente è deprecata.

get

 Recuperare informazioni su un agente.

getLaunch

 Recupera le informazioni sul lancio per 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 sul lancio per un agente.

updateVerification

 Aggiorna lo stato di verifica di un agente.