REST Resource: brands.agents

Ressource: Agent

Eine Konversationseinheit, die eine Marke repräsentiert.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Die eindeutige ID des Agents.

Schreibgeschützt. Von der Plattform definiert.
displayName

string

Erforderlich. Der Name, den der Agent Nutzern anzeigt. Der Titel darf maximal 100 Zeichen lang sein.

Kann nach der Agent-Überprüfung nicht mehr geändert werden.

Union-Feld detail_info. Enthält die Felder, die für das jeweilige Produkt erforderlich sind.

Erforderlich. Für detail_info ist nur einer der folgenden Werte zulässig:
businessMessagesAgent

object (BusinessMessagesAgent)

Detaillierte Agent-Informationen für Business Messages.

BusinessMessagesAgent

Agent-Informationen speziell für Business Messages.

JSON-Darstellung 
{
  "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)
  }
}
Felder
logoUrl

string

Optional. Öffentlich verfügbare URL des Logos für den Agent. Maximal 50 KB.

Kann nach der Agent-Überprüfung nicht mehr geändert werden.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Optional. Liste der Einstiegspunktkonfigurationen.

Kann nach der Agent-Überprüfung nicht mehr geändert werden.
conversationalSettings

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

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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Erforderlich. Die Standardsprache für den Agent. Muss mit einer in conversationalSettings definierten Sprache übereinstimmen.
primaryAgentInteraction

object (SupportedAgentInteraction)

Erforderlich. Informationen zur Interaktion mit dem primären Kundenservicemitarbeiter. Wird verwendet, wenn der Nutzer eine Unterhaltung initiiert.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Optional. Zusätzliche Informationen zur Interaktion mit dem Kundenservicemitarbeiter. Der Agent kann mehrere Interaktionstypen unterstützen.
customAgentId

string

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
(deprecated)

string

Nur Ausgabe. Die URL zum Testen des Konversationsmodus des Agents.

Von der Plattform definiert.
testUrls[]

object (TestUrl)

Nur Ausgabe. URLs zum Testen des Konversationsmodus des Agents.

Von der Plattform definiert.
phone

object (Phone)

Optional. Die Telefonnummer, die vom Kundenservicemitarbeiter angezeigt werden soll. Wenn nicht angegeben, zeigt der Agent die Telefonnummer der im Google Knowledge Graph gefundenen Marke an, sofern vorhanden.
authorizationConfig

object (AuthorizationConfig)

Optional. Autorisierungskonfiguration für OAuth-Unterstützung.
nonLocalConfig

object (NonLocalConfig)

Optional. Konfiguration für nicht lokale Einstiegspunkte.
surveyConfig

object (SurveyConfig)

Optional. Konfiguration zum Aktivieren benutzerdefinierter Umfragen.

BusinessMessagesEntryPointConfig

Die Konfiguration des Einstiegspunkts für einen Agent.

JSON-Darstellung 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Felder
allowedEntryPoint

enum (EntryPoint)

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 Einstiegspunkt nicht angegeben.
LOCATION Standorte für diesen Agent aktivieren.
NON_LOCAL Business Messages für nicht lokale Einstiegspunkte aktivieren.

SupportedAgentInteraction

Von einem Kundenservicemitarbeiter unterstützte Interaktionen.

JSON-Darstellung 
{
  "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.
}
Felder
interactionType

enum (InteractionType)

Erforderlich. Der vom Agent unterstützte Interaktionstyp.
Union-Feld representative. Die detaillierten Informationen für den Konfigurationstyp. Erforderlich. Für representative ist nur einer der folgenden Werte zulässig:
botRepresentative

object (BotRepresentative)

Details zum Bot-Ansprechpartner.
humanRepresentative

object (HumanRepresentative)

Details zu menschlichen Vertretern.

InteractionType

Art der Interaktion, die für den Agent unterstützt wird.

Enums
INTERACTION_TYPE_UNSPECIFIED Nicht spezifizierte Interaktion.
BOT Bot-Interaktion.
HUMAN Menschliche Interaktion.

BotRepresentative

Details zum Bot-Beauftragten.

JSON-Darstellung 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Felder
botMessagingAvailability

object (MessagingAvailability)

Erforderlich. Verfügbarkeit von Bot-Messaging.

MessagingAvailability

Die Zeiten an jedem Wochentag, an dem die Nachrichtenfunktion verfügbar ist. Sie können Stunden für mehrere Tage gruppieren. Beispiel: * Montag bis Mittwoch von 08:00 bis 16:00 Uhr PDT * Donnerstag bis Freitag 10:00 bis 14:00 Uhr PDT * Donnerstag bis Freitag 15:00 bis 18:00 Stunden PDT * Samstag bis Samstag von 10:00 bis 14:00 Stunden PDT

Wenn es Lücken in der Verfügbarkeit gibt, z. B. keine Verfügbarkeit am Sonntag, ist die Nachrichtenfunktion während dieser Lücken nicht verfügbar.

Bot-Stunden haben keinen Einfluss auf die Verfügbarkeit. Reine Bot-Agents zeigen immer eine Willkommensnachricht an, während Agents, deren Einstellungen sowohl für menschliche als auch für Bot-Beauftragte gelten, bei der Definition der Verfügbarkeit nur menschliche Bevollmächtigte berücksichtigen.

JSON-Darstellung 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Felder
hours[]

object (Hours)

Erforderlich. Zeiten, zu denen die Nachrichtenfunktion verfügbar ist.

Stunden

Zeitraum, in dem die Nachrichtenfunktion verfügbar ist.

JSON-Darstellung 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Felder
startTime

object (TimeOfDay)

Erforderlich. Startzeit für jeden Tag im Wochentag-Bereich.
endTime

object (TimeOfDay)

Erforderlich. Endzeit für jeden Tag innerhalb des Wochentags.
timeZone

string

Erforderlich. Die IANA-Zeitzone für die Öffnungszeiten. Beispiel: „America/Los_Angeles“.
startDay

enum (DayOfWeek)

Erforderlich. Starttag.
endDay

enum (DayOfWeek)

Erforderlich. Endtag. Enthält 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

integer

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

integer

Minuten der Zeitangabe. Muss zwischen 0 und 59 liegen.
seconds

integer

Sekunden der Zeitangabe. Muss normalerweise zwischen 0 und 59 liegen. Eine API kann den Wert 60 zulassen, wenn sie Schaltsekunden zulässt.
nanos

integer

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 für menschliche Vertreter

JSON-Darstellung 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Felder
humanMessagingAvailability

object (MessagingAvailability)

Erforderlich. Verfügbarkeit von menschlichen Mitteilungen

AuthorizationConfig

Konfigurationsdetails für die Unterstützung von OAuth in Business Messages.

JSON-Darstellung 
{
  "endpointUrl": string
}
Felder
endpointUrl

string

Die Endpunkt-URL, an der sich der Nutzer anmeldet.

NonLocalConfig

Konfiguration zum Aktivieren nicht lokaler Einstiegspunkte.

JSON-Darstellung 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Felder
contactOption

object (ContactOption)

Erforderlich. Kontaktinformationen für den Agent, die mit der Schaltfläche zum Senden einer Nachricht angezeigt werden.
enabledDomains[]

string

Erforderlich. Domains, die für den Sitelinks-Einstiegspunkt aktiviert werden sollen.
phoneNumber

object (Phone)

Erforderlich. Telefonnummer des Agenten. Überschreibt das Feld phone für Unterhaltungen, die über nicht lokale Einstiegspunkte gestartet wurden. Diese Telefonnummer wird für alle konfigurierten Regionen verwendet.
callDeflectionPhoneNumbers[]

object (Phone)

Erforderlich. Liste der Telefonnummern für die Anrufweiterleitung
regionCodes[]

string

Erforderlich. Liste der CLDR-Regionscodes für Länder, in denen der Agent NON_LOCAL-Einstiegspunkte starten darf. Erforderlich für NON_LOCAL Einstiegspunkte.

ContactOption

Kontaktdaten werden zusätzlich zur Nachrichtenschaltfläche angezeigt.

JSON-Darstellung 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Felder
url

string

Erforderlich. Die URL, für die Kontaktoptionen verfügbar sind.
options[]

enum (Option)

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 FAQ-Option.
TWITTER Twitter-Option.
WHATSAPP WhatsApp-Option.

SurveyConfig

Konfigurationsdetails für die Unterstützung benutzerdefinierter Fragen.

JSON-Darstellung 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Felder
templateQuestionIds[]

string

Liste der Vorlagenfragen-IDs für Vorlagenfragen, die in einer Umfrage enthalten sind.
customSurveys

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

Benutzerdefinierte Fragen 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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Benutzerdefinierte Umfragekonfiguration für einen Agent.

JSON-Darstellung 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Felder
customQuestions[]

object (SurveyQuestion)

Liste benutzerdefinierter Fragen.

SurveyQuestion

Den detaillierten Inhalt der einzelnen Fragen.

JSON-Darstellung 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Felder
name

string

Erforderlich. Die eindeutige Kennung der Frage.
questionType

enum (Type)

Nur Ausgabe. Art der Frage.
questionContent

string

Erforderlich. Inhalt der Frage. Benutzerdefinierte Fragen dürfen maximal 200 Zeichen lang sein.
responseOptions[]

object (SurveyResponse)

Erforderlich. Liste der mit der Frage angezeigten Antworten. Maximal 12.

Typ

Die Art der Frage.

Enums
TYPE_UNSPECIFIED Unbekannter Fragentyp für die Umfrage.
GOOGLE_STANDARD_QUESTION Standardfrage von Google.
GOOGLE_TEMPLATE_QUESTION Von Google bereitgestellte Vorlage für die Umfragefrage.
PARTNER_CUSTOM_QUESTION Benutzerdefinierte Frage des Partners.

SurveyResponse

Der Inhalt einer Antwort auf eine Frage.

JSON-Darstellung 
{
  "content": string,
  "postbackData": string
}
Felder
content

string

Erforderlich. Text, der in der Umfrage angezeigt und an den Kundenservicemitarbeiter zurückgesendet wird, wenn der Nutzer darauf tippt. Maximal 35 Zeichen.
postbackData

string

Der String, den der Agent erhält, wenn der Nutzer auf die Frageantwort tippt.

Methoden

create

 Erstellt einen neuen Agent, der eine Marke repräsentiert.

delete

 Löscht einen Agent.

get

 Informationen zu einem Agent abrufen.

getLaunch

 Ruft die Einführungsinformationen für einen Agent ab.

getVerification

 Ruft die Bestätigungsinformationen für einen Agent ab.

list

 Listet alle Agents auf, die mit einer Marke verknüpft sind.

patch

 Aktualisiert Informationen zu einem Agent.

requestLaunch

 Startet den Aktivierungsprozess für einen Agent.

requestVerification

 Hiermit wird die Bestätigung der Informationen zum Unternehmen für einen Agent gestartet.

updateLaunch

 Aktualisiert die Einführungsinformationen für einen Agent.

updateVerification

 Aktualisiert den Bestätigungsstatus für einen Agent.