REST Resource: brands.agents

Kaynak: Temsilci

Bir markayı temsil eden, sohbete dayalı varlık.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Aracının benzersiz tanımlayıcısı.

Salt okunur. Platform tarafından belirlenir.
displayName

string

Zorunlu. Aracının kullanıcılara gösterdiği ad. En fazla 100 karakter.

Temsilci doğrulamasından sonra değiştirilemez.

Birleştirme alanı detail_info. İlgili ürün için gerekli alanları içerir.

Zorunlu. detail_info şunlardan yalnızca biri olabilir:
businessMessagesAgent

object (BusinessMessagesAgent)

Business Messages için ayrıntılı temsilci bilgileri.

BusinessMessagesAgent

Business Messages'a özel temsilci bilgileri.

JSON gösterimi 
{
  "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)
  }
}
Alanlar
logoUrl

string

İsteğe bağlı. Temsilcinin logosunun herkese açık URL'si. Maksimum 50 KB.

Temsilci doğrulamasından sonra değiştirilemez.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

İsteğe bağlı. Giriş noktası yapılandırmaları listesi.

Temsilci doğrulamasından sonra değiştirilemez.
conversationalSettings

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

Zorunlu. Bir aracı için yerel ayarla eşlenen görüşme ayarları. Yerel ayar, iyi biçimlendirilmiş bir IETF BCP 47 dil etiketiyle temsil edilir.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Zorunlu. Aracının varsayılan yerel ayarı. conversationalSettings içinde tanımlanan bir yerel ayarla eşleşmelidir.
primaryAgentInteraction

object (SupportedAgentInteraction)

Zorunlu. Birincil temsilci etkileşim bilgileri. Kullanıcı bir görüşme başlattığında kullanılır.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

İsteğe bağlı. Ek temsilci etkileşim bilgileri. Aracının birden fazla etkileşim türünü desteklemesini sağlar.
customAgentId

string

İsteğe bağlı. Temsilci için iş ortağı tarafından belirtilen tanımlayıcı. Tanımlayıcı, temsilciye gönderilen tüm mesajlarla birlikte iletilir.
agentTestUrl
(deprecated)

string

Yalnızca çıkış. Temsilcinin sohbet deneyimini test etmek için kullanılan URL.

Platform tarafından belirlenir.
testUrls[]

object (TestUrl)

Yalnızca çıkış. Temsilcinin konuşma deneyimini test etmek için kullanılan URL'ler.

Platform tarafından belirlenir.
phone

object (Phone)

İsteğe bağlı. Temsilcinin göstereceği telefon numarası. Belirtilmezse temsilci, Google Bilgi Grafiği'nde bulunan markanın telefon numarasını (varsa) görüntüler.
authorizationConfig

object (AuthorizationConfig)

İsteğe bağlı. OAuth desteği için yetkilendirme yapılandırması.
nonLocalConfig

object (NonLocalConfig)

İsteğe bağlı. Yerel olmayan giriş noktaları için yapılandırma.
surveyConfig

object (SurveyConfig)

İsteğe bağlı. Özel anketleri etkinleştirecek yapılandırma.

BusinessMessagesEntryPointConfig

Bir aracının giriş noktası yapılandırması.

JSON gösterimi 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Alanlar
allowedEntryPoint

enum (EntryPoint)

Zorunlu. Aracının gösterilmesinin etkinleştirildiği Google gösterilir.

EntryPoint

Aracının gösterilmesinin etkinleştirildiği Google gösterilir.

Sıralamalar
ENTRY_POINT_UNSPECIFIED Belirtilmemiş giriş noktası.
LOCATION Bu aracı için konumları etkinleştirin.
NON_LOCAL Yerel olmayan giriş noktaları için Business Messages'ı etkinleştirin.

SupportedAgentInteraction

Bir aracı tarafından desteklenen etkileşimler.

JSON gösterimi 
{
  "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.
}
Alanlar
interactionType

enum (InteractionType)

Zorunlu. Aracı tarafından desteklenen etkileşim türü.
Birleştirme alanı representative. Yapılandırma türü için ayrıntılı bilgi. Zorunlu. representative şunlardan yalnızca biri olabilir:
botRepresentative

object (BotRepresentative)

Bot temsilcisiyle ilgili ayrıntılar.
humanRepresentative

object (HumanRepresentative)

Gerçek kişi tarafından sağlanan temsilcilerle ilgili ayrıntılar.

InteractionType

Temsilci için desteklenen etkileşim türü.

Sıralamalar
INTERACTION_TYPE_UNSPECIFIED Belirtilmemiş etkileşim.
BOT Bot etkileşimi.
HUMAN İnsan etkileşimi.

BotRepresentative

Bot temsilcisiyle ilgili ayrıntılar.

JSON gösterimi 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Alanlar
botMessagingAvailability

object (MessagingAvailability)

Zorunlu. Bot mesajlaşma kullanılabilirliği.

MessagingAvailability

Mesajlaşmanın haftanın her gününün saatleri. Birden fazla gün için saatleri birlikte gruplandırabilirsiniz. Örneğin, * 08:00-16:00 (PDT) Pazartesi-Çarşamba * 10:00-14:00 PDT Perşembe-Cuma * 15:00-18:00 PDT Perşembe-Cuma * 10:00-14:00 PDT-Cumartesi-Cumartesi

Pazar günleri uygunluk durumunun belirtilmemesi gibi kullanılabilirlik boşlukları varsa bu boşluklar sırasında mesajlaşma özelliği kullanılamaz.

Bot saatlerinin müsaitlik durumu üzerinde bir etkisi yoktur. Yalnızca bot kullanan temsilciler her zaman bir karşılama mesajı gösterirken hem insan hem de bot temsilcisi ayarlarına sahip temsilciler, kullanılabilirliği tanımlarken yalnızca gerçek temsilcileri dikkate alır.

JSON gösterimi 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Alanlar
hours[]

object (Hours)

Zorunlu. Mesajlaşmanın çalışma saatleri.

Saat

Mesajlaşmanın kullanılabildiği saat aralığı.

JSON gösterimi 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Alanlar
startTime

object (TimeOfDay)

Zorunlu. Haftanın günü aralığındaki her günün başlangıç zamanı.
endTime

object (TimeOfDay)

Zorunlu. Haftanın günü aralığındaki her günün bitiş zamanı.
timeZone

string

Zorunlu. Saat için IANA saat dilimi. Örneğin, "Amerika/Los_Angeles".
startDay

enum (DayOfWeek)

Zorunlu. Başlangıç günü.
endDay

enum (DayOfWeek)

Zorunlu. Bitiş günü. Belirtilen günü içerir.

TimeOfDay

Günün saatini temsil eder. Tarih ve saat dilimi önemli değil veya başka bir yerde belirtilmiş. Bir API, artık saniyeye izin vermeyi seçebilir. İlgili türler: google.type.Date ve google.protobuf.Timestamp.

JSON gösterimi 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Alanlar
hours

integer

24 saat biçiminde günün saatleri. 0 ile 23 arasında olmalıdır. Bir API, "24:00:00" değerine izin vermeyi seçebilir. gibi senaryolar için oldukça yararlı olabilir.
minutes

integer

Günün saatindeki dakikalar. 0 ile 59 arasında olmalıdır.
seconds

integer

Saniye cinsinden dakika. Normalde 0 ile 59 arasında olmalıdır. Bir API, artık saniyeye izin veriyorsa 60 değerine izin verebilir.
nanos

integer

Nanosaniye cinsinden saniyenin kesirleri. 0 ile 999.999.999 arasında olmalıdır.

HaftanınGünü

Haftanın bir gününü temsil eder.

Sıralamalar
DAY_OF_WEEK_UNSPECIFIED Haftanın günü belirtilmemiş.
MONDAY Pazartesi
TUESDAY Salı
WEDNESDAY Çarşamba
THURSDAY Perşembe
FRIDAY Cuma
SATURDAY Cumartesi
SUNDAY Pazar

HumanRepresentative

Gerçek kişi olan temsilcinin ayrıntıları.

JSON gösterimi 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Alanlar
humanMessagingAvailability

object (MessagingAvailability)

Zorunlu. İnsan mesaj özelliğinin kullanılabilirliği.

AuthorizationConfig

Business Messages'da OAuth desteği için yapılandırma ayrıntıları.

JSON gösterimi 
{
  "endpointUrl": string
}
Alanlar
endpointUrl

string

Kullanıcının giriş yaptığı uç nokta URL'si.

NonLocalConfig

Yerel olmayan giriş noktalarını etkinleştirecek yapılandırma.

JSON gösterimi 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Alanlar
contactOption

object (ContactOption)

Zorunlu. Mesajlaşma düğmesiyle görüntülenen temsilci iletişim bilgileri.
enabledDomains[]

string

Zorunlu. Site bağlantıları giriş noktası için etkinleştirilecek alan adları.
phoneNumber

object (Phone)

Zorunlu. Müşteri temsilcisinin telefon numarası. Yerel olmayan giriş noktalarından başlatılan görüşmeler için phone alanını geçersiz kılar. Bu telefon numarası, yapılandırılmış tüm bölgeler için kullanılacak.
callDeflectionPhoneNumbers[]

object (Phone)

Zorunlu. Çağrı saptırma için telefon numaralarının listesi.
regionCodes[]

string

Zorunlu. Temsilcinin NON_LOCAL giriş noktasını başlatmasına izin verilen ülkeler için CLDR bölge kodlarının listesi. NON_LOCAL giriş noktası için zorunludur.

ContactOption

Mesajlaşma düğmesine ek olarak iletişim bilgileri gösterilir.

JSON gösterimi 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Alanlar
url

string

Zorunlu. İletişim seçeneklerinin kullanılabildiği URL.
options[]

enum (Option)

Zorunlu. Belirtilen URL için kullanılabilen iletişim seçeneklerinin listesi.

Option

Kişi seçenekleri.

Sıralamalar
OPTION_UNSPECIFIED Belirtilmedi
WEB_CHAT Web Sohbeti seçeneği.
PHONE Telefon seçeneği.
EMAIL E-posta seçeneği.
FAQS SSS seçeneği.
TWITTER Twitter seçeneğidir.
WHATSAPP WhatsApp seçeneği.

SurveyConfig

Özelleştirilmiş anket sorularını desteklemek için yapılandırma ayrıntıları.

JSON gösterimi 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Alanlar
templateQuestionIds[]

string

Ankete dahil edilen şablon soruları için şablon soru kimliklerinin listesi.
customSurveys

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

Bir temsilci için yerel ayarla eşlenmiş özel anket soruları. Yerel ayar, iyi biçimlendirilmiş bir IETF BCP 47 dil etiketiyle temsil edilir.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Bir temsilci için özel anket yapılandırması.

JSON gösterimi 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Alanlar
customQuestions[]

object (SurveyQuestion)

Özel soruların listesi.

SurveyQuestion

Her anket sorusunun ayrıntılı içeriği.

JSON gösterimi 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Alanlar
name

string

Zorunlu. Sorunun benzersiz tanımlayıcısı.
questionType

enum (Type)

Yalnızca çıkış. Sorunun türü.
questionContent

string

Zorunlu. Soru içeriği. Özel sorular için 200 karakterle sınırlıdır.
responseOptions[]

object (SurveyResponse)

Zorunlu. Soruyla birlikte gösterilen yanıtların listesi. Maksimum 12.

Tür

Anket sorusunun türü.

Sıralamalar
TYPE_UNSPECIFIED Bilinmeyen anket sorusu türü.
GOOGLE_STANDARD_QUESTION Google standart anket sorusu.
GOOGLE_TEMPLATE_QUESTION Google tarafından sağlanan şablon anket sorusu.
PARTNER_CUSTOM_QUESTION İş ortağı için özelleştirilmiş anket sorusu.

SurveyResponse

Anket sorusu yanıtı içeriği.

JSON gösterimi 
{
  "content": string,
  "postbackData": string
}
Alanlar
content

string

Zorunlu. Ankette gösterilen ve kullanıcı dokunduğunda temsilciye geri gönderilen metin. Maksimum 35 karakter.
postbackData

string

Kullanıcı sorunun yanıtına dokunduğunda aracının aldığı dize.

Yöntemler

create

 Bir markayı temsil edecek yeni bir temsilci oluşturur.

delete

 Bir temsilciyi siler.

get

 Temsilciler hakkında bilgi edinin.

getLaunch

 Bir temsilcinin başlatma bilgilerini alır.

getVerification

 Bir temsilcinin doğrulama bilgilerini alır.

list

 Bir markayla ilişkili tüm aracıları listeler.

patch

 Bir temsilci hakkındaki bilgileri günceller.

requestLaunch

 Temsilci için başlatma sürecini başlatır.

requestVerification

 Bir temsilci için işletme bilgileri doğrulamasını başlatır.

updateLaunch

 Temsilcinin başlatma bilgilerini günceller.

updateVerification

 Temsilcinin doğrulama durumunu günceller.