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. Zdefiniowane przez platformę.
displayName

string

To pole jest wymagane. Nazwa, którą agent wyświetla użytkownikom. Maksymalnie 100 znaków.

Nie można go zmienić po weryfikacji agenta.

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

To pole jest 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 związane z 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.

Nie można go zmienić po weryfikacji agenta.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Opcjonalnie. Lista konfiguracji punktu wejścia.

Nie można go zmienić po weryfikacji agenta.
conversationalSettings

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

To pole jest wymagane. Ustawienia rozmów dla agenta zmapowane na język. Język jest reprezentowany przez poprawnie sformatowany tag języka IETF BCP 47.

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

string

To pole jest wymagane. Domyślne ustawienie regionalne dla agenta. Musi być zgodny z językiem określonym w conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

To pole jest wymagane. Informacje o głównej interakcji z agentem. Używana, gdy użytkownik rozpoczyna 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 do wszystkich wiadomości wysyłanych do agenta.
agentTestUrl
(deprecated)

string

Tylko dane wyjściowe. Adres URL do testowania rozmowy agenta.

Zdefiniowane przez platformę.
testUrls[]

object (TestUrl)

Tylko dane wyjściowe. Adresy URL służące do testowania środowiska rozmowy agenta.

Zdefiniowane przez platformę.
phone

object (Phone)

Opcjonalnie. Numer telefonu do wyświetlenia przez pracownika obsługi klienta. Jeśli go nie podasz, agent wyświetli numer telefonu marki znaleziony w Grafie wiedzy Google.
authorizationConfig

object (AuthorizationConfig)

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

object (NonLocalConfig)

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

object (SurveyConfig)

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

BusinessMessagesEntryPointConfig

Konfiguracja punktu wejścia dla agenta.

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

enum (EntryPoint)

To pole jest wymagane. Usługi Google, w których włączono wyświetlanie agenta.

EntryPoint

Usługi Google, w których włączono wyświetlanie agenta.

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 w przypadku 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)

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

object (BotRepresentative)

Szczegółowe informacje o przedstawicielu bota.
humanRepresentative

object (HumanRepresentative)

Szczegóły dotyczące przedstawiciela człowieka.

InteractionType

Obsługiwany typ interakcji 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 dotyczące przedstawiciela bota.

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

object (MessagingAvailability)

To pole jest wymagane. Dostępność wiadomości z botami.

MessagingAvailability

W poszczególnych dniach tygodnia, w których dostępne są wiadomości, Możesz zgrupować godziny pracy na wiele dni. 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 czasu PDT sobota–14:00

W przypadku luk w dostępności, np. braku określonej dostępności w niedzielę, w tych okresach wiadomości będą niedostępne.

Godziny pracy bota nie mają wpływu na dostępność. Pracownicy obsługi klienta (tylko boty) zawsze wyświetlają wiadomość powitalną, a agenty z ustawieniami reprezentatywnymi zarówno dla ludzi, jak i botów, podczas określania dostępności uwzględniają tylko przedstawicieli.

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

object (Hours)

To pole jest wymagane. Godziny, w których można wyświetlać wiadomości

Godziny

Zakres godzin, w których można wysyłać wiadomości.

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

object (TimeOfDay)

To pole jest wymagane. Godzina rozpoczęcia dla każdego dnia w zakresie dni tygodnia.
endTime

object (TimeOfDay)

To pole jest wymagane. Godzina zakończenia dla każdego dnia w zakresie dni tygodnia.
timeZone

string

To pole jest wymagane. Strefa czasowa IANA wskazująca godziny. Na przykład „Ameryka/Los_Angeles”.
startDay

enum (DayOfWeek)

To pole jest wymagane. Rozpocznij dzień.
endDay

enum (DayOfWeek)

To pole jest wymagane. Dzień zakończenia. Obejmuje określony dzień.

TimeOfDay

Reprezentuje 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. Pokrewne rodzaje treści: 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. W przypadku takich sytuacji jak godzina zamknięcia firmy interfejs API może zezwolić na wartość „24:00:00”.
minutes

integer

Minuty w ciągu dnia. Wymagana wartość z zakresu od 0 do 59.
seconds

integer

Sekundy minut czasu. Zwykle musi mieścić się w zakresie od 0 do 59. Interfejs API może zezwolić na wartość 60, jeśli zezwala na sekundy przestępne.
nanos

integer

Ułamki sekund w nanosekundach. Wartość musi mieścić się w zakresie od 0 do 999 999 999.

DayOfWeek

Reprezentuje dzień tygodnia.

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

HumanRepresentative

Szczegółowe informacje dotyczące przedstawiciela.

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

object (MessagingAvailability)

To pole jest wymagane. Dostępność wiadomości z ludźmi.

AuthorizationConfig

Szczegóły konfiguracji obsługi protokołu OAuth w Business Messages.

Zapis JSON 
{
  "endpointUrl": string
}
Pola
endpointUrl

string

URL punktu końcowego, pod 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)

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

string

To pole jest wymagane. Domeny, które mają być włączone w punkcie wejścia linków do podstron.
phoneNumber

object (Phone)

To pole jest wymagane. Numer telefonu agenta. Zastępuje pole phone w przypadku wątków rozpoczętych w nielokalnych punktach wejścia. Ten numer telefonu będzie używany we wszystkich skonfigurowanych regionach.
callDeflectionPhoneNumbers[]

object (Phone)

To pole jest wymagane. Lista numerów telefonów, które mogą być odrzucane.
regionCodes[]

string

To pole jest wymagane. Lista kodów regionów CLDR dla krajów, w których agent może uruchamiać punkty wejścia NON_LOCAL. Wymagany w przypadku NON_LOCAL punktów wejścia.

ContactOption

Informacje kontaktowe są wyświetlane obok przycisku przesyłania wiadomości.

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

string

To pole jest wymagane. Adres URL, dla którego dostępne są opcje kontaktu.
options[]

enum (Option)

To pole jest wymagane. Lista opcji kontaktu dostępnych w przypadku określonego adresu URL.

Option

Opcje kontaktu.

Wartości w polu enum
OPTION_UNSPECIFIED Brak informacji
WEB_CHAT Opcja czatu internetowego.
PHONE Opcja telefonu.
EMAIL Opcja poczty e-mail.
FAQS Najczęstsze pytania.
TWITTER Opcja Twittera.
WHATSAPP Opcja WhatsApp.

SurveyConfig

Szczegóły konfiguracji obsługi niestandardowych pytań ankietowych.

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

string

Lista identyfikatorów szablonów pytań zawartych w ankiecie.
customSurveys

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

Niestandardowe pytania ankietowe do agenta zmapowane na język. Język jest reprezentowany przez poprawnie sformatowany 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 ankietowego.

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

string

To pole jest wymagane. Unikalny identyfikator pytania.
questionType

enum (Type)

Tylko dane wyjściowe. Typ pytania.
questionContent

string

To pole jest wymagane. Treść pytania. Pytania niestandardowe mogą mieć maksymalnie 200 znaków.
responseOptions[]

object (SurveyResponse)

To pole jest wymagane. Lista odpowiedzi wyświetlanych z pytaniem. Maksymalnie 12.

Typ

Rodzaj pytania ankiety.

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

SurveyResponse

Treść odpowiedzi na pytanie w ankiecie.

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

string

To pole jest 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 tekstowy, 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 agenta.

list

 Zawiera 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.