Ressource: Agent
Eine dialogorientierte Entität, die eine Marke repräsentiert.
JSON-Darstellung |
---|
{ "name": string, "displayName": string, // Union field |
Felder | |
---|---|
name |
Die eindeutige ID des Agents. Schreibgeschützt. Von der Plattform definiert. |
displayName |
Erforderlich. Der Name, den der Agent den Nutzern anzeigt. Der Titel darf maximal 100 Zeichen lang sein. Kann nach der Bestätigung durch einen Kundenservicemitarbeiter nicht mehr geändert werden. |
Union-Feld Erforderlich. Für |
|
businessMessagesAgent |
Detaillierte Agent-Informationen für Business Messages. |
BusinessMessagesAgent
Spezifische Agent-Informationen für Business Messages.
JSON-Darstellung |
---|
{ "logoUrl": string, "entryPointConfigs": [ { object ( |
Felder | |
---|---|
logoUrl |
Optional. Öffentlich verfügbare URL des Logos für den Agent. Maximal 50 KB. Kann nach der Bestätigung durch einen Kundenservicemitarbeiter nicht mehr geändert werden. |
entryPointConfigs[] |
Optional. Liste der Einstiegspunktkonfigurationen. Kann nach der Bestätigung durch einen Kundenservicemitarbeiter nicht mehr geändert werden. |
conversationalSettings |
Erforderlich. Konversationseinstellungen für einen Agent, die einer Sprache zugeordnet sind. Die Sprache wird durch ein korrekt formatiertes Sprach-Tag IETF BCP 47 dargestellt. Ein Objekt, das eine Liste von |
defaultLocale |
Erforderlich. Die Standardsprache für den Agent. Muss mit einer in |
primaryAgentInteraction |
Erforderlich. Informationen zur Interaktion mit dem primären Agent. Wird verwendet, wenn der Nutzer eine Unterhaltung startet. |
additionalAgentInteractions[] |
Optional. Zusätzliche Informationen zur Interaktion mit dem Agent. Ermöglicht dem Agent, mehrere Interaktionstypen zu unterstützen. |
customAgentId |
Optional. Eine vom Partner angegebene Kennung für den Agent. Die ID wird zusammen mit allen Nachrichten übergeben, die an den Agent gesendet werden. |
agentTestUrl |
Nur Ausgabe Die URL zum Testen der Konversationsversion des Agents. Von der Plattform definiert. |
testUrls[] |
Nur Ausgabe URLs zum Testen der Konversationsfähigkeit des Agents. Von der Plattform definiert. |
phone |
Optional. Die Telefonnummer, die der Agent anzeigen soll. Wenn nicht angegeben, zeigt der Agent die Telefonnummer der Marke aus Google Knowledge Graph an, falls vorhanden. |
authorizationConfig |
Optional. Autorisierungskonfiguration für die OAuth-Unterstützung. |
nonLocalConfig |
Optional. Konfiguration für nicht lokale Einstiegspunkte. |
surveyConfig |
Optional. Konfiguration zum Aktivieren benutzerdefinierter Umfragen. |
BusinessMessagesEntryPointConfig
Die Konfiguration des Einstiegspunkts eines Agents.
JSON-Darstellung |
---|
{
"allowedEntryPoint": enum ( |
Felder | |
---|---|
allowedEntryPoint |
Erforderlich. Die Google-Plattformen, auf denen der Agent angezeigt werden kann. |
EntryPoint
Die Google-Plattformen, auf denen der Agent angezeigt werden kann.
Enums | |
---|---|
ENTRY_POINT_UNSPECIFIED |
Unbekannter Einstiegspunkt. |
LOCATION |
Standorte für diesen Agent aktivieren. |
NON_LOCAL |
Aktivieren Sie Business Messages für nicht lokale Einstiegspunkte. |
SupportedAgentInteraction
Von einem Agent unterstützte Interaktionen.
JSON-Darstellung |
---|
{ "interactionType": enum ( |
Felder | |
---|---|
interactionType |
Erforderlich. Der vom Agent unterstützte Interaktionstyp. |
Union-Feld representative . Die detaillierten Informationen zum Konfigurationstyp. Erforderlich. Für representative ist nur einer der folgenden Werte zulässig: |
|
botRepresentative |
Details zum Bot-Mitarbeiter. |
humanRepresentative |
Details des menschlichen Vertreters. |
InteractionType
Der für den Agent unterstützte Interaktionstyp.
Enums | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Nicht angegebene Interaktion. |
BOT |
Bot-Interaktion. |
HUMAN |
Menschliche Interaktion |
BotRepresentative
Details für Bot-Mitarbeiter.
JSON-Darstellung |
---|
{
"botMessagingAvailability": {
object ( |
Felder | |
---|---|
botMessagingAvailability |
Erforderlich. Verfügbarkeit von Bot-Nachrichten. |
MessagingAvailability
Die Uhrzeiten der einzelnen Wochentage, an denen die Nachrichtenfunktion verfügbar ist. Sie können Öffnungszeiten für mehrere Tage gruppieren. Beispiel: * Montag bis Mittwoch von 08:00 bis 16:00 Uhr PDT * Donnerstag bis Freitag von 10:00 bis 14:00 Uhr PDT * 15:00 bis 18:00 Uhr PDT Donnerstag bis Freitag * 10:00 bis 14:00 Uhr PDT Samstag bis Samstag
Wenn es Lücken in der Verfügbarkeit gibt, z. B. wenn die Verfügbarkeit am Sonntag nicht angegeben wurde, ist die Nachrichtenfunktion während dieser Lücken nicht verfügbar.
Bot-Stunden haben keine Auswirkungen auf die Verfügbarkeit. Nur-Bot-Agents zeigen immer eine Willkommensnachricht an, während Agents mit Einstellungen sowohl für Mitarbeiter als auch für Bot-Mitarbeiter beim Definieren der Verfügbarkeit nur menschliche Vertreter berücksichtigen.
JSON-Darstellung |
---|
{
"hours": [
{
object ( |
Felder | |
---|---|
hours[] |
Erforderlich. Verfügbarkeit der Nachrichtenfunktion. |
Stunden
Zeitraum, in dem die Nachrichtenfunktion verfügbar ist
JSON-Darstellung |
---|
{ "startTime": { object ( |
Felder | |
---|---|
startTime |
Erforderlich. Startzeit für jeden Tag im Wochentag |
endTime |
Erforderlich. Endzeit für jeden Tag im Wochentag. |
timeZone |
Erforderlich. Die IANA-Zeitzone für die Stunden. Beispiel: „Amerika/Los_Angeles“. |
startDay |
Erforderlich. Starttag. |
endDay |
Erforderlich. Endtag. Beinhaltet den angegebenen Tag. |
TimeOfDay
Stellt eine Tageszeit dar. Das Datum und die Zeitzone sind entweder nicht relevant oder werden an anderer Stelle angegeben. Eine API kann Schaltsekunden zulassen. Vergleichbare Typen sind google.type.Date
und google.protobuf.Timestamp
.
JSON-Darstellung |
---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
Felder | |
---|---|
hours |
Stunden im 24-Stunden-Format. Sollte zwischen 0 und 23 liegen. Eine API kann den Wert "24:00:00" für Szenarien wie Geschäftsschlusszeit zulassen. |
minutes |
Minuten der Zeitangabe. Muss zwischen 0 und 59 liegen. |
seconds |
Sekunden der Zeitangabe. Muss normalerweise zwischen 0 und 59 liegen. Eine API kann den Wert 60 zulassen, wenn sie Schaltsekunden zulässt. |
nanos |
Sekundenbruchteile in Nanosekunden. Muss zwischen 0 und 999.999.999 liegen. |
DayOfWeek
Steht für einen Wochentag.
Enums | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
Der Wochentag ist nicht angegeben. |
MONDAY |
Montag |
TUESDAY |
Dienstag |
WEDNESDAY |
Mittwoch |
THURSDAY |
Donnerstag |
FRIDAY |
Freitag |
SATURDAY |
Samstag |
SUNDAY |
Sonntag |
HumanRepresentative
Details zum menschlichen Vertreter.
JSON-Darstellung |
---|
{
"humanMessagingAvailability": {
object ( |
Felder | |
---|---|
humanMessagingAvailability |
Erforderlich. Verfügbarkeit menschlicher Nachrichten. |
AuthorizationConfig
Konfigurationsdetails zur Unterstützung von OAuth in Business Messages.
JSON-Darstellung |
---|
{ "endpointUrl": string } |
Felder | |
---|---|
endpointUrl |
Die Endpunkt-URL, an der sich der Nutzer anmeldet. |
NonLocalConfig
Konfiguration zum Aktivieren nicht lokaler Einstiegspunkte.
JSON-Darstellung |
---|
{ "contactOption": { object ( |
Felder | |
---|---|
contactOption |
Erforderlich. Kontaktinformationen für den Agent, die mit der Schaltfläche zum Senden einer Nachricht angezeigt werden. |
enabledDomains[] |
Erforderlich. Domains, die für den Sitelinks-Einstiegspunkt aktiviert werden sollen. |
phoneNumber |
Erforderlich. Telefonnummer des Kundenservicemitarbeiters. Überschreibt das Feld |
callDeflectionPhoneNumbers[] |
Erforderlich. Liste mit Telefonnummern für die Anrufweiterleitung. |
regionCodes[] |
Erforderlich. Liste der CLDR-Regionscodes für Länder, in denen der Agent |
ContactOption
Neben der Schaltfläche „SMS/MMS“ werden Kontaktdaten angezeigt.
JSON-Darstellung |
---|
{
"url": string,
"options": [
enum ( |
Felder | |
---|---|
url |
Erforderlich. Die URL, für die Kontaktoptionen verfügbar sind. |
options[] |
Erforderlich. Die Liste der für die angegebene URL verfügbaren Kontaktoptionen. |
Option
Kontaktoptionen.
Enums | |
---|---|
OPTION_UNSPECIFIED |
Ohne Angabe |
WEB_CHAT |
Webchat-Option. |
PHONE |
Telefonoption. |
EMAIL |
E-Mail-Option. |
FAQS |
Option „Häufig gestellte Fragen“. |
TWITTER |
Twitter-Option. |
WHATSAPP |
WhatsApp-Option. |
SurveyConfig
Konfigurationsdetails zur Unterstützung benutzerdefinierter Fragen.
JSON-Darstellung |
---|
{
"templateQuestionIds": [
string
],
"customSurveys": {
string: {
object ( |
Felder | |
---|---|
templateQuestionIds[] |
Liste der Vorlagenfrage-IDs für Vorlagenfragen in einer Umfrage. |
customSurveys |
Benutzerdefinierte Fragen in der Umfrage für einen Kundenservicemitarbeiter, die einer Sprache zugeordnet sind. Die Sprache wird durch ein korrekt formatiertes Sprach-Tag IETF BCP 47 dargestellt. Ein Objekt, das eine Liste von |
CustomSurveyConfig
Benutzerdefinierte Umfragekonfiguration für einen Agent.
JSON-Darstellung |
---|
{
"customQuestions": [
{
object ( |
Felder | |
---|---|
customQuestions[] |
Liste benutzerdefinierter Fragen. |
SurveyQuestion
Der detaillierte Inhalt jeder Umfragefrage.
JSON-Darstellung |
---|
{ "name": string, "questionType": enum ( |
Felder | |
---|---|
name |
Erforderlich. Die eindeutige ID der Frage. |
questionType |
Nur Ausgabe Art der Frage. |
questionContent |
Erforderlich. Inhalte der Frage Bei benutzerdefinierten Fragen auf 200 Zeichen begrenzt. |
responseOptions[] |
Erforderlich. Liste der mit der Frage angezeigten Antworten. Maximal 12 |
Typ
Die Art der Frage.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unbekannter Fragentyp der Umfrage. |
GOOGLE_STANDARD_QUESTION |
Google-Standardumfrage. |
GOOGLE_TEMPLATE_QUESTION |
Von Google bereitgestellte Vorlage für eine Umfrage. |
PARTNER_CUSTOM_QUESTION |
Angepasste Frage der Partnerumfrage. |
SurveyResponse
Der Inhalt einer Antwort auf eine Frage.
JSON-Darstellung |
---|
{ "content": string, "postbackData": string } |
Felder | |
---|---|
content |
Erforderlich. Text, der in der Umfrage angezeigt und an den Kundenservicemitarbeiter zurückgesendet wird, wenn der Nutzer darauf tippt. Maximal 35 Zeichen. |
postbackData |
Der String, den der Agent erhält, wenn der Nutzer auf die Frageantwort tippt. |
Methoden |
|
---|---|
|
Erstellt einen neuen Agent, der eine Marke darstellt. |
|
Löscht einen Agent. |
|
Informationen zu einem Agent abrufen. |
|
Ruft die Startinformationen für einen Agent ab. |
|
Ruft die Bestätigungsinformationen für einen Agent ab. |
|
Listet alle mit einer Marke verknüpften Agents auf. |
|
Aktualisiert Informationen zu einem Agent. |
|
Startet den Startprozess für einen Agent. |
|
Startet die Bestätigung der Unternehmensinformationen für einen Agent. |
|
Aktualisiert die Startinformationen für einen Agent. |
|
Aktualisiert den Bestätigungsstatus für einen Agent. |