REST Resource: brands.agents

Zasób: Agent

Element konwersacyjny, który reprezentuje markę.

Zapis 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.
}
Pola
name

string

Unikalny identyfikator agenta.

Tylko do odczytu. Definiowany przez platformę.
displayName

string

Wymagane. Nazwa, którą agent wyświetla użytkownikom. Maksymalnie 100 znaków.

Po weryfikacji agenta nie można zmienić tego ustawienia.

Pole sumy detail_info. Zawiera pola wymagane w przypadku konkretnego produktu.

Wymagane. detail_info może mieć tylko jedną z tych wartości:
businessMessagesAgent

object (BusinessMessagesAgent)

Szczegółowe informacje o agencie Business Messages.

BusinessMessagesAgent

Informacje o agencie specyficzne dla Business Messages.

Zapis 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)
  }
}
Pola
logoUrl

string

Opcjonalnie: Publicznie dostępny adres URL logo agenta. Maksymalnie 50 KB.

Po weryfikacji agenta nie można zmienić tego ustawienia.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opcjonalnie: Lista konfiguracji punktów wejścia.

Po weryfikacji agenta nie można zmienić tego ustawienia.
conversationalSettings

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

Wymagane. Ustawienia konwersacyjne dotyczące agenta zmapowane na język. Lokalizacja jest reprezentowana przez prawidłowy tag języka IETF BCP 47.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Wymagane. Domyślne ustawienie regionalne agenta. Musi odpowiadać językowi zdefiniowanemu w conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Wymagane. Informacje o interakcji z głównym agentem. Używany, gdy użytkownik rozpocznie rozmowę.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Opcjonalnie: Dodatkowe informacje o interakcji z agentem. Umożliwia agentowi obsługę wielu typów interakcji.
customAgentId

string

Opcjonalnie: Określony przez partnera identyfikator agenta. Identyfikator jest przekazywany razem ze wszystkimi wiadomościami wysyłanymi do agenta.
agentTestUrl
(deprecated)

string

Tylko dane wyjściowe. Adres URL do testowania trybu konwersacyjnego agenta.

Definiowany przez platformę.
testUrls[]

object (TestUrl)

Tylko dane wyjściowe. Adresy URL do testowania trybu konwersacyjnego agenta.

Definiowany przez platformę.
phone

object (Phone)

Opcjonalnie: Numer telefonu, który ma być wyświetlany pracownik obsługi klienta. Jeśli go nie podasz, agent wyświetli numer telefonu marki, którą można znaleźć w Grafie wiedzy Google (o ile taka istnieje).
authorizationConfig

object (AuthorizationConfig)

Opcjonalnie: Konfiguracja autoryzacji na potrzeby obsługi protokołu OAuth.
nonLocalConfig

object (NonLocalConfig)

Opcjonalnie: Konfiguracja dla nielokalnych punktów wejścia.
surveyConfig

object (SurveyConfig)

Opcjonalnie: Konfiguracja umożliwiająca włączenie ankiet niestandardowych.

BusinessMessagesEntryPointConfig

Konfiguracja punktu wejścia agenta.

Zapis JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Pola
allowedEntryPoint

enum (EntryPoint)

Wymagane. Platforma Google, na której ma włączony agent.

EntryPoint

Platforma Google, na której ma włączony agent.

Wartości w polu enum
ENTRY_POINT_UNSPECIFIED Nieokreślony punkt wejścia.
LOCATION Włącz lokalizacje dla tego agenta.
NON_LOCAL Włącz Business Messages dla nielokalnych punktów wejścia.

SupportedAgentInteraction

Interakcje obsługiwane przez agenta.

Zapis 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.
}
Pola
interactionType

enum (InteractionType)

Wymagane. Typ interakcji obsługiwany przez agenta.
Pole sumy representative. Szczegółowe informacje o typie konfiguracji. Wymagane. representative może mieć tylko jedną z tych wartości:
botRepresentative

object (BotRepresentative)

Dane przedstawiciela bota.
humanRepresentative

object (HumanRepresentative)

Szczegółowe informacje o przedstawicielu człowieka.

InteractionType

Typ interakcji obsługiwany przez agenta.

Wartości w polu enum
INTERACTION_TYPE_UNSPECIFIED Nieokreślona interakcja.
BOT Interakcja z botem.
HUMAN Interakcja między ludźmi.

BotRepresentative

Szczegóły przedstawiciela bota.

Zapis JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Pola
botMessagingAvailability

object (MessagingAvailability)

Wymagane. Dostępność wiadomości od bota.

MessagingAvailability

Godziny, w których w poszczególnych dniach tygodnia dostępne są wiadomości. Możesz grupować godziny z kilku dni łącznie. Na przykład: * 8:00–16:00 czasu PDT od poniedziałku do środy * 10:00–14:00 czasu PDT czwartek–piątek * 15:00–18:00 czasu PDT czwartek–piątek * 10:00–14:00, sobota i sobota

W przypadku przerw w dostępności, np. braku określonej dostępności w niedzielę, przesyłanie wiadomości będzie w tym czasie niedostępne.

Godziny otwarcia bota nie mają wpływu na dostępność. Pracownicy obsługi klienta korzystający tylko z bota zawsze wyświetlają wiadomość powitalną, a pracownicy obsługi klienta z ustawieniami pracowników i botów podczas określania dostępności biorą pod uwagę tylko ludzi.

Zapis JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Pola
hours[]

object (Hours)

Wymagane. Dostępność wiadomości w godzinach pracy.

Godziny

Zakres godzin, w których dostępne są wiadomości.

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

object (TimeOfDay)

Wymagane. Godzina rozpoczęcia dla każdego dnia w zakresie dni tygodnia.
endTime

object (TimeOfDay)

Wymagane. Godzina zakończenia każdego dnia w zakresie dni tygodnia.
timeZone

string

Wymagane. Strefa czasowa IANA dla godzin. Przykład: „Ameryka/Los_Angeles”.
startDay

enum (DayOfWeek)

Wymagane. Dzień rozpoczęcia.
endDay

enum (DayOfWeek)

Wymagane. Dzień zakończenia. Uwzględnia określony dzień.

TimeOfDay

Przedstawia porę dnia. Data i strefa czasowa są nieistotne lub zostały określone w innym miejscu. Interfejs API może zezwolić na sekundy przestępne. Podobne typy to google.type.Date i google.protobuf.Timestamp.

Zapis JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Pola
hours

integer

Godziny dnia w formacie 24-godzinnym. Wartość powinna mieścić się w zakresie od 0 do 23. Interfejs API może zezwolić na wartość „24:00:00” w takich sytuacjach jak zamknięcie firmy.
minutes

integer

Minuty dnia. Wartość musi mieścić się w przedziale od 0 do 59.
seconds

integer

Sekundy czasu trwania. Zwykle musi mieścić się w zakresie od 0 do 59. Interfejs API może akceptować wartość 60, jeśli zezwala na użycie sekund przestępnych.
nanos

integer

Ułamki sekund w nanosekundach. Musi mieścić się w przedziale od 0 do 999 999 999.

DzieńTygodnia

Przedstawia dzień tygodnia.

Wartości w polu enum
DAY_OF_WEEK_UNSPECIFIED Dzień tygodnia nie jest określony.
MONDAY Poniedziałek
TUESDAY Tuesday (wtorek)
WEDNESDAY Wednesday (środa)
THURSDAY Thursday (czwartek)
FRIDAY Friday (piątek)
SATURDAY Saturday (sobota)
SUNDAY niedziela

HumanRepresentative

Szczegóły dotyczące przedstawiciela.

Zapis JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Pola
humanMessagingAvailability

object (MessagingAvailability)

Wymagane. Dostępność funkcji przesyłania wiadomości przez człowieka.

AuthorizationConfig

Szczegóły konfiguracji obsługującej protokół OAuth w Business Messages.

Zapis JSON 
{
  "endpointUrl": string
}
Pola
endpointUrl

string

Adres URL punktu końcowego, w którym użytkownik się loguje.

NonLocalConfig

Konfiguracja umożliwiająca włączenie nielokalnych punktów wejścia.

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

object (ContactOption)

Wymagane. Informacje kontaktowe dotyczące agenta wyświetlane przy przycisku do wysyłania wiadomości.
enabledDomains[]

string

Wymagane. Domeny, w których chcesz włączyć punkt wejścia linków do podstron.
phoneNumber

object (Phone)

Wymagane. Numer telefonu agenta. Zastępuje pole phone w przypadku rozmów rozpoczętych z innych niż lokalne punkty wejścia. Ten numer telefonu będzie używany we wszystkich skonfigurowanych regionach.
callDeflectionPhoneNumbers[]

object (Phone)

Wymagane. Lista numerów telefonów do przekierowania połączeń.
regionCodes[]

string

Wymagane. Lista kodów regionów CLDR obejmujących kraje, w których agent może uruchomić punkty wejścia NON_LOCAL. Wymagany w przypadku NON_LOCAL punktów wejścia.

ContactOption

Dane kontaktowe wyświetlane obok przycisku wiadomości.

Zapis JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Pola
url

string

Wymagane. Adres URL, dla którego dostępne są opcje kontaktu.
options[]

enum (Option)

Wymagane. Lista opcji kontaktu dostępnych w przypadku określonego adresu URL.

Opcja

Opcje kontaktu.

Wartości w polu enum
OPTION_UNSPECIFIED Nie określono
WEB_CHAT Czat internetowy.
PHONE Opcja telefonu.
EMAIL Opcja e-mail.
FAQS Najczęstsze pytania.
TWITTER Opcja Twittera.
WHATSAPP Opcja WhatsApp.

SurveyConfig

Szczegóły konfiguracji na potrzeby obsługi niestandardowych pytań w ankiecie.

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

string

Lista identyfikatorów pytań szablonów uwzględnionych w ankiecie.
customSurveys

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

Niestandardowe pytania z ankiety dla pracownika obsługi klienta zmapowane na język. Lokalizacja jest reprezentowana przez prawidłowy tag języka IETF BCP 47.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Niestandardowa konfiguracja ankiety dla agenta.

Zapis JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Pola
customQuestions[]

object (SurveyQuestion)

Lista pytań niestandardowych.

SurveyQuestion

Szczegółowa treść każdego pytania ankiety.

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

string

Wymagane. Unikalny identyfikator pytania.
questionType

enum (Type)

Tylko dane wyjściowe. Typ pytania.
questionContent

string

Wymagane. Treść pytania. Limit 200 znaków w pytaniach niestandardowych.
responseOptions[]

object (SurveyResponse)

Wymagane. Lista odpowiedzi na pytanie. Maksymalnie 12.

Typ

Rodzaj pytania w ankiecie.

Wartości w polu enum
TYPE_UNSPECIFIED Nieznany typ pytania ankiety.
GOOGLE_STANDARD_QUESTION Standardowe pytanie w ankiecie Google.
GOOGLE_TEMPLATE_QUESTION Szablon pytania ankiety udostępnionego przez Google.
PARTNER_CUSTOM_QUESTION Pytanie w ankiecie dostosowane do partnera.

SurveyResponse

Treść odpowiedzi na pytanie w ankiecie.

Zapis JSON 
{
  "content": string,
  "postbackData": string
}
Pola
content

string

Wymagane. Tekst, który wyświetla się w ankiecie i jest odsyłany do agenta, gdy użytkownik go kliknie. Maksymalnie 35 znaków.
postbackData

string

Ciąg znaków, który agent otrzymuje, gdy użytkownik kliknie odpowiedź na pytanie.

Metody

create

 Tworzy nowego agenta reprezentującego markę.

delete

 Usuwa agenta.

get

 Uzyskaj informacje o agencie.

getLaunch

 Pobiera informacje o uruchomieniu agenta.

getVerification

 Pobiera informacje weryfikacyjne dotyczące agenta.

list

 Wyświetla listę wszystkich agentów powiązanych z marką.

patch

 Aktualizuje informacje o agencie.

requestLaunch

 Rozpoczyna proces uruchamiania agenta.

requestVerification

 Rozpoczyna weryfikację informacji o firmie agenta.

updateLaunch

 Aktualizuje informacje o uruchomieniu agenta.

updateVerification

 Aktualizuje stan weryfikacji agenta.