REST Resource: brands.agents

Kaynak: Temsilci

Bir markayı temsil eden sohbet öğesi.

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

Temsilcinin benzersiz tanımlayıcısı.

Salt okunur. Platform tarafından tanımlanır.
displayName

string

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

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

detail_info alanı. Belirli bir ü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. En fazla 50 KB.

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

object (BusinessMessagesEntryPointConfig)

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

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

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

Zorunlu. Temsilcinin görüşme ayarları bir yerel ayarla eşlenir. Yerel ayar, düzgün biçimlendirilmiş 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ı için varsayılan yerel ayar. conversationalSettings içinde tanımlanan bir yerel ayarla eşleşmelidir.
primaryAgentInteraction

object (SupportedAgentInteraction)

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

object (SupportedAgentInteraction)

İsteğe bağlı. Temsilci etkileşimiyle ilgili ek bilgiler. Temsilcinin 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ı. Temsilciye gönderilen tüm mesajlarla birlikte tanımlayıcı da iletilir.
agentTestUrl
(deprecated)

string

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

Platform tarafından tanımlanır.
testUrls[]

object (TestUrl)

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

Platform tarafından tanımlanır.
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österir.
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ştirmek için yapılandırma.

BusinessMessagesEntryPointConfig

Bir aracı için giriş noktası yapılandırması.

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

enum (EntryPoint)

Zorunlu. Temsilcinin gösterildiği Google platformları.

EntryPoint

Temsilcinin gösterildiği Google platformları.

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

SupportedAgentInteraction

Temsilciler 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. Temsilci tarafından desteklenen etkileşim türü.
representative alanı. Yapılandırma türü için ayrıntılı bilgi. Zorunlu. representative şunlardan yalnızca biri olabilir:
botRepresentative

object (BotRepresentative)

Bot temsilcisi ayrıntıları.
humanRepresentative

object (HumanRepresentative)

Gerçek kişi olan temsilci 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 kullanılabilir olduğu haftanın her günü çalışma 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-10:00-14:00

Müsaitlik durumu varsa (ör. pazar günü müsaitlik durumu belirtilmezse) bu zaman aralığında mesajlaşma kullanılamaz.

Bot saatlerinin müsaitlik durumu üzerinde etkisi yoktur. Yalnızca bot olan temsilciler her zaman karşılama mesajı gösterirken hem insan hem de bot temsilcisi ayarlarına sahip temsilciler, müsaitlik durumunu tanımlarken yalnızca insan temsilcileri dikkate alır.

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

object (Hours)

Zorunlu. Mesajlaşmanın kullanılabildiği saatler.

Saat

Mesajlaşmanın kullanılabileceğ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 için başlangıç zamanı.
endTime

object (TimeOfDay)

Zorunlu. Haftanın günü aralığındaki her gün için bitiş saati.
timeZone

string

Zorunlu. Saatler 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ş. API'ler artık saniyelere izin vermeyi tercih edebilir. İlgili türler şunlardır: 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. API'ler, işletmenin kapanış saati gibi senaryolar için "24:00:00" değerine izin vermeyi tercih edebilir.
minutes

integer

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

integer

Dakikanın saniye cinsinden saniyeleri. Normalde 0 ile 59 arasında olmalıdır. Artık saniyelere izin veren API'ler 60 değerine izin verebilir.
nanos

integer

Saniyenin nanosaniye cinsinden kısmı. 0 ile 999.999.999 arasında olmalıdır.

DayOfWeek

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

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

HumanRepresentative

Gerçek kişi olan temsilciye ilişkin ayrıntılar.

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

object (MessagingAvailability)

Zorunlu. İnsan tarafından yapılan mesajlaşma kullanılabilirliği.

AuthorizationConfig

Business Messages'ta 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ştirmek için 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. Acentenin telefon numarası Yerel olmayan giriş noktalarından başlatılan ileti dizileri için phone alanını geçersiz kılar. Bu telefon numarası tüm yapılandırılmış bölgelerde kullanılır.
callDeflectionPhoneNumbers[]

object (Phone)

Zorunlu. Çağrıyı yönlendirmek için kullanılan telefon numaralarının listesi.
regionCodes[]

string

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

ContactOption

Mesajlaşma düğmesinin yanında 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ılabilir iletişim seçeneklerinin listesi.

Option

Kişi seçenekleri.

Sıralamalar
OPTION_UNSPECIFIED Belirtilmedi
WEB_CHAT Web üzerinden sohbet seçeneği.
PHONE Telefon seçeneği.
EMAIL E-posta seçeneği.
FAQS SSS seçeneği.
TWITTER Twitter seçeneği.
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

Bir anketteki şablon sorularına ait şablon soru kimliklerinin listesi.
customSurveys

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

Bir temsilci için özel anket soruları (bir yerel ayarla eşlenir). Yerel ayar, düzgün biçimlendirilmiş 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 soru 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. En fazla 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, anket sorusu için şablon sundu.
PARTNER_CUSTOM_QUESTION İş ortağı için özelleştirilmiş anket sorusu.

SurveyResponse

Anket sorusu yanıtının 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ı soru yanıtına dokunduğunda aracının aldığı dize.

Yöntemler

create

 Bir markayı temsil etmesi için yeni bir temsilci oluşturur.

delete

 Aracıyı 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 temsilcileri listeler.

patch

 Temsilcilerle ilgili bilgileri günceller.

requestLaunch

 Bir temsilci için başlatma işlemini başlatır.

requestVerification

 Bir temsilci için işletme bilgilerini doğrulama işlemini başlatır.

updateLaunch

 Bir temsilci için başlatma bilgilerini günceller.

updateVerification

 Temsilcinin doğrulama durumunu günceller.