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

الساعات من كل يوم من الأسبوع التي تكون فيها المراسلة متاحة. يمكنك تجميع ساعات لعدة أيام معًا. على سبيل المثال، * من 8: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

نوع سؤال الاستبيان.

عمليات التعداد
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

 لتعديل حالة إثبات الهوية للوكيل