REST Resource: brands.agents

المرجع: موظّف دعم

يشير هذا المصطلح إلى كيان حواري يمثّل علامة تجارية.

تمثيل 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.
}
الحقول
name

string

المعرّف الفريد للوكيل

للقراءة فقط. يحدده النظام الأساسي.
displayName

string

مطلوب. الاسم الذي يعرضه الوكيل للمستخدمين. الحد الأقصى لعدد الأحرف هو 100 حرف.

غير قابل للتعديل بعد التحقّق من الوكيل.

حقل الاتحاد detail_info. يحتوي على الحقول المطلوبة لمنتج معيّن.

مطلوب. يمكن أن يكون detail_info واحدًا فقط مما يلي:
businessMessagesAgent

object (BusinessMessagesAgent)

معلومات تفصيلية حول الوكيل الخاص بميزة "الرسائل التجارية"

BusinessMessagesAgent

معلومات الوكيل الخاصة بميزة "الرسائل التجارية"

تمثيل 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)
  }
}
الحقول
logoUrl

string

اختياريّ. تمثّل هذه السمة عنوان URL المتاح للجميع لشعار الوكيل. الحد الأقصى 50 كيلوبايت.

غير قابل للتعديل بعد التحقّق من الوكيل.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

اختياريّ. قائمة بعمليات ضبط نقاط الدخول

غير قابل للتعديل بعد التحقّق من الوكيل.
conversationalSettings

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

مطلوب. إعدادات المحادثات للوكيل التي يتم ربطها بلغة معيّنة يتم تمثيل اللغة بعلامة لغة IETF BCP 47 بتنسيق صحيح.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
defaultLocale

string

مطلوب. اللغة التلقائية للوكيل. يجب أن تتطابق مع لغة تم تحديدها في conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

مطلوب. معلومات تفاعل الوكيل الأساسي تُستخدَم عندما يبدأ المستخدم محادثة.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

اختياريّ. معلومات إضافية حول تفاعل موظّف الدعم تفعيل الوكيل من خلال إتاحة أنواع تفاعل متعددة.
customAgentId

string

اختياريّ. معرّف خاص بالوكيل يحدّده الشريك ويتم تمرير المعرّف إلى جانب جميع الرسائل المرسَلة إلى الوكيل.
agentTestUrl
(deprecated)

string

النتائج فقط. عنوان URL لاختبار تجربة موظّف الدعم في المحادثات.

يحدده النظام الأساسي.
testUrls[]

object (TestUrl)

النتائج فقط. عناوين URL لاختبار تجربة موظّف الدعم في المحادثات.

يحدده النظام الأساسي.
phone

object (Phone)

اختياريّ. تمثّل هذه السمة رقم الهاتف الذي يجب أن يعرضه موظّف الدعم. إذا لم يتم تحديده، سيعرض الوكيل رقم هاتف العلامة التجارية الواردة في الرسم البياني المعرفي من Google، إن توفّر.
authorizationConfig

object (AuthorizationConfig)

اختياريّ. إعداد التفويض لدعم بروتوكول OAuth.
nonLocalConfig

object (NonLocalConfig)

اختياريّ. إعداد نقاط الدخول غير المحلية
surveyConfig

object (SurveyConfig)

اختياريّ. إعدادات لتفعيل الاستطلاعات المخصّصة

BusinessMessagesEntryPointConfig

إعدادات نقطة الدخول للوكيل

تمثيل JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
الحقول
allowedEntryPoint

enum (EntryPoint)

مطلوب. تعرض Google ميزة ظهور الوكيل.

EntryPoint

تعرض Google ميزة ظهور الوكيل.

عمليات التعداد
ENTRY_POINT_UNSPECIFIED نقطة دخول غير محدَّدة
LOCATION تفعيل المواقع الجغرافية لهذا الوكيل
NON_LOCAL تفعيل ميزة "الرسائل التجارية" لنقاط الدخول غير المحلية

SupportedAgentInteraction

التفاعلات مع موظّف دعم

تمثيل 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.
}
الحقول
interactionType

enum (InteractionType)

مطلوب. نوع التفاعل الذي يقدّمه موظّف الدعم
حقل الاتحاد representative. تمثّل هذه السمة المعلومات التفصيلية لنوع الإعدادات. مطلوب. يمكن أن يكون representative واحدًا فقط مما يلي:
botRepresentative

object (BotRepresentative)

تفاصيل ممثل برنامج التتبُّع
humanRepresentative

object (HumanRepresentative)

تفاصيل الممثّل البشري

InteractionType

نوع التفاعل المتوافق مع موظّف الدعم.

عمليات التعداد
INTERACTION_TYPE_UNSPECIFIED تفاعل غير محدَّد.
BOT تفاعل روبوت الدردشة.
HUMAN التفاعل البشري.

BotRepresentative

تفاصيل حول ممثل برنامج التتبُّع

تمثيل JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
الحقول
botMessagingAvailability

object (MessagingAvailability)

مطلوب. مدى توفّر ميزة المراسلة باستخدام برامج التتبُّع

MessagingAvailability

ساعات العمل في كل يوم من الأسبوع التي تتوفر فيها المراسلة. يمكنك تجميع ساعات العمل لعدة أيام معًا. على سبيل المثال، * من 08:00 إلى 16:00 ساعة بتوقيت المحيط الهادئ من الاثنين إلى الأربعاء * من 10:00 إلى 14:00 ساعة بتوقيت المحيط الهادئ الصيفي من الخميس إلى الجمعة، ومن الساعة 15:00 إلى 18:00 بتوقيت المحيط الهادئ، من الخميس إلى الجمعة، ومن الساعة 10:00 إلى 14:00 ساعة بتوقيت المحيط الهادئ أيام السبت والسبت.

إذا كان هناك فجوات في مدى التوفّر، مثل عدم توفّر معلومات محدّدة يوم الأحد، لن تتوفّر المراسلة خلال هذه الفجوات.

لا تؤثر ساعات عمل برنامج التتبُّع على مدى التوفّر. دائمًا ما يعرض الوكلاء الذين يستخدمون برامج التتبُّع فقط رسالة ترحيب، بينما ينظر موظّفو الدعم الذين لديهم إعدادات تمثيلية لبرنامج التتبُّع وأعضاء الفريق في الاعتبار فقط عند تحديد مدى التوفّر.

تمثيل JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
الحقول
hours[]

object (Hours)

مطلوب. ساعات توفّر المراسلة

ساعات العمل

نطاق الساعات التي تكون فيها المراسلة متاحة.

تمثيل JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
الحقول
startTime

object (TimeOfDay)

مطلوب. وقت البدء لكل يوم ضمن نطاق اليوم من الأسبوع.
endTime

object (TimeOfDay)

مطلوب. وقت الانتهاء لكل يوم ضمن نطاق اليوم من الأسبوع.
timeZone

string

مطلوب. المنطقة الزمنية الخاصة بهيئة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة) للساعات على سبيل المثال، "America/Los_Angeles".
startDay

enum (DayOfWeek)

مطلوب. يوم البدء.
endDay

enum (DayOfWeek)

مطلوب. يوم الانتهاء. يتضمّن اليوم المحدّد.

TimeOfDay

يمثل وقتًا من اليوم. إما أن التاريخ والمنطقة الزمنية ليست مهمة أو تم تحديدها في مكان آخر. قد تختار واجهة برمجة التطبيقات السماح بالثواني. الأنواع ذات الصلة هي google.type.Date وgoogle.protobuf.Timestamp.

تمثيل JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
الحقول
hours

integer

ساعات اليوم بتنسيق 24 ساعة. يجب أن تتراوح القيمة بين 0 و23. قد تختار واجهة برمجة التطبيقات السماح بالقيمة "24:00:00" لسيناريوهات مثل موعد إغلاق العمل.
minutes

integer

دقائق من ساعات اليوم. يجب أن تتراوح القيمة بين 0 و59.
seconds

integer

ثواني الدقائق من الوقت. يجب أن تتراوح القيمة عادةً بين 0 و59. وقد تسمح واجهة برمجة التطبيقات بالقيمة 60 إذا كانت تسمح بالثواني الكبيسة.
nanos

integer

الكسور من الثواني بالنانو ثانية. يجب أن تتراوح القيمة بين 0 و999,999,999.

DayOfWeek

يمثل يومًا من الأسبوع.

عمليات التعداد
DAY_OF_WEEK_UNSPECIFIED لم يتم تحديد اليوم من الأسبوع.
MONDAY الاثنين
TUESDAY الثلاثاء
WEDNESDAY الأربعاء
THURSDAY الخميس
FRIDAY الجمعة
SATURDAY السبت
SUNDAY الأحد

HumanRepresentative

تفاصيل حول ممثل بشري

تمثيل JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
الحقول
humanMessagingAvailability

object (MessagingAvailability)

مطلوب. مدى توفّر المراسلة البشرية

AuthorizationConfig

تفاصيل الإعدادات لإتاحة بروتوكول OAuth في "الرسائل التجارية"

تمثيل JSON 
{
  "endpointUrl": string
}
الحقول
endpointUrl

string

عنوان URL لنقطة النهاية حيث يسجّل المستخدم الدخول.

NonLocalConfig

إعداد لتفعيل نقاط الدخول غير المحلية

تمثيل JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
الحقول
contactOption

object (ContactOption)

مطلوب. معلومات الاتصال الخاصة بالوكيل التي يتم عرضها بجانب زر المراسلة
enabledDomains[]

string

مطلوب. النطاقات التي سيتم تفعيلها لنقطة الدخول من خلال روابط أقسام الموقع
phoneNumber

object (Phone)

مطلوب. رقم هاتف الوكيل يتجاوز هذا الحقل الحقل phone للمحادثات التي تبدأ من نقاط دخول غير محلية. سيتم استخدام رقم الهاتف هذا في جميع المناطق التي تم ضبطها.
callDeflectionPhoneNumbers[]

object (Phone)

مطلوب. قائمة بأرقام الهواتف التي تُستخدم لمنع المكالمات.
regionCodes[]

string

مطلوب. قائمة رموز CLDR للمناطق للبلدان التي يُسمح فيها للوكيل بتفعيل NON_LOCAL نقطة دخول مطلوب لعدد NON_LOCAL نقطة دخول

ContactOption

يتم عرض تفاصيل الاتصال بالإضافة إلى زر المراسلة.

تمثيل JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
الحقول
url

string

مطلوب. عنوان URL الذي تتوفّر خيارات التواصل له.
options[]

enum (Option)

مطلوب. قائمة خيارات جهات الاتصال المتاحة لعنوان URL المحدّد.

Option

خيارات جهات الاتصال

عمليات التعداد
OPTION_UNSPECIFIED غير محدّد
WEB_CHAT خيار الدردشة على الويب.
PHONE خيار الهاتف.
EMAIL خيار البريد الإلكتروني.
FAQS خيار الأسئلة الشائعة
TWITTER Twitter.
WHATSAPP WhatsApp.

SurveyConfig

تفاصيل الإعدادات لإتاحة أسئلة الاستطلاع المخصّصة

تمثيل JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
الحقول
templateQuestionIds[]

string

قائمة بأرقام تعريف أسئلة النماذج لأسئلة النماذج المضمّنة في الاستطلاع.
customSurveys

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

أسئلة استطلاع مخصّصة للموظف، يتم ربطها بلغة معيّنة. يتم تمثيل اللغة بعلامة لغة IETF BCP 47 بتنسيق صحيح.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

CustomSurveyConfig

إعداد استطلاع مخصّص لأحد موظفي الدعم.

تمثيل JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
الحقول
customQuestions[]

object (SurveyQuestion)

قائمة بالأسئلة المخصّصة

SurveyQuestion

المحتوى التفصيلي لكل سؤال استبيان.

تمثيل JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
الحقول
name

string

مطلوب. تمثّل هذه السمة المعرّف الفريد للسؤال.
questionType

enum (Type)

النتائج فقط. تمثّل هذه السمة نوع السؤال.
questionContent

string

مطلوب. محتوى السؤال. الحد الأقصى المسموح به للأسئلة المخصّصة هو 200 حرف.
responseOptions[]

object (SurveyResponse)

مطلوب. قائمة الردود المعروضة مع السؤال 12 حرفًا كحد أقصى

النوع

تمثّل هذه السمة نوع سؤال الاستطلاع.

عمليات التعداد
TYPE_UNSPECIFIED نوع سؤال الاستطلاع غير معروف.
GOOGLE_STANDARD_QUESTION سؤال استبيان Google القياسي.
GOOGLE_TEMPLATE_QUESTION قدّمت Google نموذج سؤال استبيان.
PARTNER_CUSTOM_QUESTION سؤال استطلاع مخصّص للشركاء

SurveyResponse

محتوى الإجابة على سؤال الاستطلاع.

تمثيل JSON 
{
  "content": string,
  "postbackData": string
}
الحقول
content

string

مطلوب. النص الذي يظهر في الاستطلاع ويتم إرساله مرة أخرى إلى الوكيل عند نقر المستخدم عليه. 35 حرفًا كحدّ أقصى
postbackData

string

السلسلة التي يتلقّاها الوكيل عندما ينقر المستخدم على الردّ على السؤال.

الطُرق

create

 يتم إنشاء وكيل جديد لتمثيل العلامة التجارية.

delete

 حذف وكيل.

get

 يمكنك الحصول على معلومات عن موظّف دعم.

getLaunch

 الحصول على معلومات الإطلاق للوكيل

getVerification

 الحصول على معلومات إثبات الهوية الخاصة بموظّف دعم

list

 يسرد جميع الوكلاء المرتبطين بعلامة تجارية.

patch

 تعدّل المعلومات المتعلّقة بموظّف دعم.

requestLaunch

 تبدأ عملية الإطلاق للوكيل.

requestVerification

 بدء عملية إثبات صحة معلومات النشاط التجاري للوكيل

updateLaunch

 لتعديل معلومات إطلاق الوكيل

updateVerification

 تعمل على تعديل حالة إثبات صحة بيانات الوكيل.