REST Resource: brands.agents

Ressource: Agent

Eine dialogorientierte Entität, 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)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // 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 Nutzer vom Agent sehen. Der Titel darf maximal 100 Zeichen lang sein.

Kann nach der Bestätigung durch einen Kundenservicemitarbeiter 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.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

Detaillierte Agent-Informationen für RCS Business Messaging.

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 Bestätigung durch einen Kundenservicemitarbeiter nicht mehr geändert werden.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Optional. Liste der Einstiegspunktkonfigurationen.

Kann nach der Bestätigung durch einen Kundenservicemitarbeiter 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 wohlgeformtes Tag im Format 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. Interaktionsinformationen zum primären Agent. Wird verwendet, wenn der Nutzer eine Unterhaltung startet.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Optional. Zusätzliche Informationen zur Agent-Interaktion. Ermöglicht dem Agent, mehrere Interaktionstypen zu 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 der Agent anzeigen soll. Wenn keine Angabe erfolgt, zeigt der Agent die im Google Knowledge Graph gefundene Telefonnummer für die 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 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 (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. Detaillierte Informationen zum Konfigurationstyp. Erforderlich. Für representative ist nur einer der folgenden Werte zulässig:
botRepresentative

object (BotRepresentative)

Details zum Bot-Mitarbeiter.
humanRepresentative

object (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 (MessagingAvailability)
  }
}
Felder
botMessagingAvailability

object (MessagingAvailability)

Erforderlich. Verfügbarkeit von Bot-Nachrichten.

MessagingAvailability

Die Tageszeiten der Wochentage, an denen Mitteilungen verfügbar sind. Sie können Öffnungszeiten für mehrere Tage gleichzeitig gruppieren. Beispielsweise

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

Bot-Stunden haben keine Auswirkungen auf die Verfügbarkeit. Reine Bot-Agents zeigen immer eine Willkommensnachricht an, während Kundenservicemitarbeiter mit Einstellungen sowohl für Mitarbeiter als auch für Bot-Mitarbeiter nur menschliche Vertreter berücksichtigen, wenn sie die Verfügbarkeit definieren.

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

object (Hours)

Erforderlich. Verfügbarkeit der Nachrichtenfunktion.

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 innerhalb des Wochentags.
endTime

object (TimeOfDay)

Erforderlich. Endzeit für jeden Tag im Wochentag.
timeZone

string

Erforderlich. Die IANA-Zeitzone für die Stunden. Beispiel: „Amerika/Los_Angeles“.
startDay

enum (DayOfWeek)

Erforderlich. Starttag.
endDay

enum (DayOfWeek)

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

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 menschlichen Vertreter.

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

object (MessagingAvailability)

Erforderlich. Verfügbarkeit der menschlichen Nachrichtenfunktion

AuthorizationConfig

Konfigurationsdetails zur 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 Kundenservicemitarbeiters. Ü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 mit Telefonnummern für die Anrufumleitung.
regionCodes[]

string

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

ContactOption

Neben der Schaltfläche für Nachrichten werden Kontaktdaten 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 Kontaktoptionen, die für die angegebene URL verfügbar sind.

Wahltaste

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 zur Unterstützung benutzerdefinierter Fragen in Umfragen.

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

string

Liste der Vorlagenfrage-IDs für Fragenvorlagen in einer Umfrage.
customSurveys

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

Benutzerdefinierte Fragen für einen Agent, die einer Sprache zugeordnet sind. Die Sprache wird durch ein wohlgeformtes Tag im Format 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

Der detaillierte Inhalt jeder Frage.

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

string

Erforderlich. Die eindeutige ID der Frage.
questionType

enum (Type)

Nur Ausgabe Art der Frage.
questionContent

string

Erforderlich. Inhalt der Frage Bei benutzerdefinierten Fragen auf 200 Zeichen begrenzt.
responseOptions[]

object (SurveyResponse)

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 Standardumfrage von Google.
GOOGLE_TEMPLATE_QUESTION Eine von Google bereitgestellte Umfragevorlage.
PARTNER_CUSTOM_QUESTION Benutzerdefinierte Umfrage 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 Agent 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 Antwort auf die Frage tippt.

RcsBusinessMessagingAgent

Informationen zu Agenten, die sich speziell auf RCS Business Messaging beziehen.

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

string

Erforderlich. Beschreibung des Agents, die für Nutzer sichtbar ist. Der Titel darf maximal 100 Zeichen lang sein.
logoUri

string

Erforderlich. Ö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.
heroUri

string

Erforderlich. Öffentlich verfügbare URL des Hero-Images für den Agenten. Maximal 200 KB.

Kann nach der Bestätigung durch einen Kundenservicemitarbeiter nicht mehr geändert werden.
phoneNumbers[]

object (PhoneEntry)

Erforderlich. Mit dem Agent verknüpfte Telefonnummern.
emails[]

object (EmailEntry)

Optional. Mit dem Agent verknüpfte E-Mail-Adressen.
websites[]

object (WebEntry)

Optional. Mit dem Agent verknüpfte Websites. Maximal 3.
privacy

object (WebEntry)

Erforderlich. Mit dem Agent verknüpfte Datenschutzerklärung.
termsConditions

object (WebEntry)

Erforderlich. Mit dem Agenten verknüpfte Nutzungsbedingungen
color

string

Erforderlich. Designfarbe des Agents, die für Nutzer im Hexadezimalformat sichtbar ist. Beispiel: #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Erforderlich. Abrechnungskonfiguration für den Agent.
agentUseCase

enum (AgentUseCase)

Optional. Anwendungsfall eines Bots.
hostingRegion

enum (HostingRegion)

Erforderlich. Hosting-Region für einen Agent.

PhoneEntry

Eine mit dem Agent verknüpfte Telefonnummer.

JSON-Darstellung 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Felder
phoneNumber

object (Phone)

Erforderlich. Telefonnummer im E.164-Format. Beispiel: +12223334444.
label

string

Erforderlich. Label für die Telefonnummer.

EmailEntry

Eine mit dem Agent verknüpfte E-Mail-Adresse.

JSON-Darstellung 
{
  "address": string,
  "label": string
}
Felder
address

string

Erforderlich. Eine E-Mail-Adresse.
label

string

Erforderlich. Label für die E-Mail-Adresse.

WebEntry

Eine webbasierte Ressource, die mit dem Agent verknüpft ist.

JSON-Darstellung 
{
  "uri": string,
  "label": string
}
Felder
uri

string

Erforderlich. Ein öffentlich zugänglicher URI, der dem Agent zugeordnet ist. Es muss das HTTP- oder HTTPS-Protokoll verwendet werden.
label

string

Optional. Label für den URI.

RcsBusinessMessagingAgentBillingConfig

Abrechnungskonfiguration für den Agent.

JSON-Darstellung 
{
  "billingCategory": enum (BillingCategory)
}
Felder
billingCategory

enum (BillingCategory)

Abrechnungskategorie für den Agent.

BillingCategory

Unterstützte Abrechnungskategorien

Enums
BILLING_CATEGORY_UNSPECIFIED Keine Kategorie angegeben.
CONVERSATIONAL_LEGACY Legacy-Kategorie, die die Abrechnungskonfiguration vorhandener Agents unterstützt.
CONVERSATIONAL Für längere, komplexere Sitzungen konzipiert, bei denen Nutzer und Marke eine Reihe von Botschaften austauschen.
SINGLE_MESSAGE ersetzt SMS durch verbesserte Nachrichtenfunktion. Nie als CONVERSATIONAL abgerechnet.
BASIC_MESSAGE Das Abrechnungsmodell ähnelt dem bei SMS. Nie als CONVERSATIONAL abgerechnet.

AgentUseCase

Im Speicher verwendete Agent-Anwendungsfalltypen.

Enums
AGENT_USE_CASE_UNSPECIFIED Anwendungsfall nicht angegeben.
TRANSACTIONAL Agents, die nur wichtige, notwendige und zeitkritische Nachrichten senden.
PROMOTIONAL Agents, die Vertriebs-, Marketing- und Werbenachrichten senden. Standardtyp.
OTP Agents, die nur Einmalpasswörter senden.
MULTI_USE Agents für mehrere Anwendungsfälle.

HostingRegion

Mögliche Hostingregionen für einen Agent, die für die korrekte Weiterleitung von P2A-Nachrichten an den regionalisierten Server verwendet werden.

Enums
HOSTING_REGION_UNSPECIFIED Nicht angegebene Hosting-Region.
NORTH_AMERICA Nordamerika.
EUROPE Europa.
ASIA_PACIFIC Asiatisch-pazifischer Raum.

Methoden

create

 Erstellt einen neuen Agent, der eine Marke darstellt.

delete
(deprecated)

 Eingestellt: Das Löschen des Agents wurde verworfen.

get

 Informationen zu einem Agent abrufen.

getLaunch

 Ruft die Startinformationen 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 Startprozess für einen Agent.

requestVerification

 Startet die Bestätigung der Informationen zum Unternehmen für einen Agent.

updateLaunch

 Aktualisiert die Startinformationen für einen Agent.

updateVerification

 Aktualisiert den Bestätigungsstatus für einen Agent.