REST Resource: brands.agents

Kaynak: Aracı

Bir markayı temsil eden, diyaloğa dayalı varlık.

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

string

Temsilcinin benzersiz tanımlayıcısı.

Salt okunurdur. Platform tarafından tanımlanır.
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. Belirli bir ürün için gerekli alanları içerir.

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

object (BusinessMessagesAgent)

Business Messages ile ilgili ayrıntılı temsilci bilgileri.
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

RCS Business Messaging 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. Bir aracının, yerel ayarla eşlenen görüşme ayarları. Yerel ayar, düzgün biçimlendirilmiş bir IETF BCP 47 dil etiketiyle temsil edilir.

"key": value çiftlerin 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 temsilci 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. Aracının birden fazla etkileşim türünü desteklemesini sağlar.
customAgentId

string

İsteğe bağlı. Aracı 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ış. Aracının 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ı gösterir (varsa).
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örünmesinin etkinleştirildiği Google platformları.

EntryPoint

Temsilcinin görünmesinin etkinleştirildiğ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

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. Temsilci 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 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 temsilcisinin 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ılabileceği haftanın her günü saatleri. Birden fazla gün için saatleri bir arada 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 (Cumartesi-Cumartesi)

Müsaitlikte eksiklik varsa (ör. pazar günü müsaitlik durumunun belirtilmemesi) bu boşluklarda mesajlaşma kullanılamaz.

Bot saatlerinin müsaitlik durumu üzerinde etkisi yoktur. Yalnızca bot olan temsilciler her zaman bir 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 uygun olduğu saatler.

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ş 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 saniyeler eklemeye izin verebilir. İ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. 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 dakika cinsinden ifade edilir. 0 ile 59 arasında olmalıdır.
seconds

integer

Dakika cinsinden saniye sayısı. Normalde 0 ile 59 arasında olmalıdır. API'ler artık saniyelere izin veriyorsa 60 değerine izin verebilir.
nanos

integer

Saniyenin nanosaniye cinsinden kesirleri. 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 temsilci için ayrıntılar.

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

object (MessagingAvailability)

Zorunlu. İnsan tarafından sağlanan 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 görüşmeler için phone alanını geçersiz kılar. Bu telefon numarası tüm yapılandırılmış bölgeler için kullanılır.
callDeflectionPhoneNumbers[]

object (Phone)

Zorunlu. Çağrıyı saptırmaya ilişkin 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ı sıra 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

İletişim seçenekleri'ne dokunun.

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ğ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 ankete dahil edilen şablon soruları için şablon soru kimliklerinin listesi.
customSurveys

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

Temsilci için, bir yerel ayarla eşlenmiş özel anket soruları. Yerel ayar, düzgün biçimlendirilmiş bir IETF BCP 47 dil etiketiyle temsil edilir.

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

CustomSurveyConfig

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ıdır.
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 soru türü.
GOOGLE_STANDARD_QUESTION Google standart anket sorusu.
GOOGLE_TEMPLATE_QUESTION Google anket sorusunu sağladı.
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.

RcsBusinessMessagingAgent

Temsilci bilgileri, özellikle RCS Business Messaging ile ilgili olmalıdır.

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

string

Zorunlu. Kullanıcıların görebildiği aracının açıklaması. En fazla 100 karakter.
logoUri

string

Zorunlu. Temsilcinin logosunun herkese açık URL'si. En fazla 50 KB.

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

string

Zorunlu. Aracının hero resminin herkese açık URL'si. En fazla 200 KB.

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

object (PhoneEntry)

Zorunlu. Temsilciyle ilişkili telefon numaraları.
emails[]

object (EmailEntry)

İsteğe bağlı. Temsilciyle ilişkili e-posta adresleri.
websites[]

object (WebEntry)

İsteğe bağlı. Aracıyla ilişkili web siteleri. En fazla 3.
privacy

object (WebEntry)

Zorunlu. Aracıyla ilişkili gizlilik politikası.
termsConditions

object (WebEntry)

Zorunlu. Temsilciyle ilişkili hükümler ve koşullar.
color

string

Zorunlu. Temsilcinin, kullanıcılar tarafından görülen onaltılık biçimde tema rengi. Örneğin, #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Zorunlu. Aracı için faturalandırma yapılandırması.
agentUseCase

enum (AgentUseCase)

İsteğe bağlı. Bot'un kullanım alanı.
hostingRegion

enum (HostingRegion)

Zorunlu. Aracının barındırma bölgesi.

PhoneEntry

Temsilciyle ilişkili telefon numarası.

JSON gösterimi 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Alanlar
phoneNumber

object (Phone)

Zorunlu. E.164 biçiminde telefon numarası. Örneğin, +12223334444.
label

string

Zorunlu. Telefon numarasının etiketi.

EmailEntry

Temsilciyle ilişkili bir e-posta.

JSON gösterimi 
{
  "address": string,
  "label": string
}
Alanlar
address

string

Zorunlu. Bir e-posta adresi.
label

string

Zorunlu. E-posta adresinin etiketi.

WebEntry

Aracıyla ilişkilendirilmiş web tabanlı kaynak.

JSON gösterimi 
{
  "uri": string,
  "label": string
}
Alanlar
uri

string

Zorunlu. Aracıyla ilişkilendirilmiş, herkesin erişebileceği URI. HTTP veya HTTPS protokolü kullanılmalıdır.
label

string

İsteğe bağlı. URI'nın etiketi.

RcsBusinessMessagingAgentBillingConfig

Aracı için faturalandırma yapılandırması.

JSON gösterimi 
{
  "billingCategory": enum (BillingCategory)
}
Alanlar
billingCategory

enum (BillingCategory)

Aracı için faturalandırma kategorisi.

BillingCategory

Desteklenen faturalandırma kategorileri.

Sıralamalar
BILLING_CATEGORY_UNSPECIFIED Kategori belirtilmedi.
CONVERSATIONAL_LEGACY Mevcut aracıların faturalandırma yapılandırmasını destekleyen eski kategori.
CONVERSATIONAL Kullanıcı ile markanın bir dizi mesaj alışverişi yaptığı daha uzun ve daha karmaşık oturumlar için tasarlanmıştır.
SINGLE_MESSAGE SMS'in yerine daha zengin bir mesajlaşma deneyimi sunuyor. Hiçbir zaman CONVERSATIONAL olarak faturalandırılmaz.
BASIC_MESSAGE Faturalandırma modeli SMS'e benzer. Hiçbir zaman CONVERSATIONAL olarak faturalandırılmaz.

AgentUseCase

Depolama alanında kullanılan aracı kullanım alanı türleri.

Sıralamalar
AGENT_USE_CASE_UNSPECIFIED Kullanım alanı belirtilmedi.
TRANSACTIONAL Yalnızca gerekli, gerekli ve zamana duyarlı iletileri gönderen aracılar.
PROMOTIONAL Satış, pazarlama ve promosyon iletileri gönderen aracılar. Varsayılan tür.
OTP Yalnızca tek seferlik şifre gönderen aracılar.
MULTI_USE Birden çok kullanım alanı olan aracılar.

HostingRegion

Bir aracı için olası barındırma bölgeleri. P2A mesajlarını bölgeselleştirilmiş sunucuya doğru şekilde yönlendirmek için kullanılır.

Sıralamalar
HOSTING_REGION_UNSPECIFIED Belirtilmemiş barındırma bölgesi.
NORTH_AMERICA Kuzey Amerika.
EUROPE Avrupa.
ASIA_PACIFIC Asya-Pasifik.

Yöntemler

create

 Markayı temsil edecek yeni bir temsilci oluşturur.

delete
(deprecated)

 Kullanımdan kaldırıldı: Temsilci silme desteği sonlandırıldı.

get

 Temsilciler hakkında bilgi alma.

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

 Temsilcilerle ilgili bilgileri günceller.

requestLaunch

 Bir temsilci için başlatma sürecini 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

 Bir temsilcinin doğrulama durumunu günceller.