REST Resource: brands.agents

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

تمثّل هذه السمة كيانًا حواريًا يمثّل علامة تجارية.

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

string

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

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

string

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

لا يمكن تعديله بعد التأكّد من هوية الوكيل.

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

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

object (BusinessMessagesAgent)

معلومات مفصّلة عن الوكيل في ميزة "الرسائل التجارية"
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

معلومات تفصيلية عن الوكيل لخدمة RCS Business Messaging

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_UNSPECIFIED نوع سؤال الاستطلاع غير معروف.
GOOGLE_STANDARD_QUESTION سؤال استبيان عادي من Google.
GOOGLE_TEMPLATE_QUESTION سؤال نموذجي تقدّمه Google.
PARTNER_CUSTOM_QUESTION سؤال استطلاع مخصّص للشريك

SurveyResponse

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

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

string

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

string

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

RcsBusinessMessagingAgent

معلومات الوكيل ذات الصلة على وجه التحديد بخدمة "مراسلة الأنشطة التجارية من خلال خدمات الاتصالات التفاعلية" (RCS).

تمثيل JSON 
{
  "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)
}
الحقول
description

string

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

string

مطلوبة. عنوان URL متاح للجميع لشعار الوكيل. 50 كيلوبايت كحد أقصى.

لا يمكن تعديله بعد التأكّد من هوية الوكيل.
heroUri

string

مطلوبة. عنوان URL المتاح للجميع لصورة الجزء الرئيسي للوكيل. الحد الأقصى هو 200 كيلوبايت.

لا يمكن تعديله بعد التأكّد من هوية الوكيل.
phoneNumbers[]

object (PhoneEntry)

مطلوبة. أرقام الهواتف المرتبطة بالوكيل
emails[]

object (EmailEntry)

اختياريّ. عناوين البريد الإلكتروني المرتبطة بالوكيل
websites[]

object (WebEntry)

اختياريّ. المواقع الإلكترونية المرتبطة بالوكيل 3 مرات كحد أقصى
privacy

object (WebEntry)

مطلوبة. سياسة الخصوصية المرتبطة بالوكيل
termsConditions

object (WebEntry)

مطلوبة. الأحكام والشروط المرتبطة بالوكيل
color

string

مطلوبة. لون مظهر الوكيل الذي يظهر للمستخدمين بالتنسيق السداسي العشري على سبيل المثال، #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

مطلوبة. إعدادات الفوترة للوكيل
agentUseCase

enum (AgentUseCase)

اختياريّ. حالة استخدام برنامج التتبُّع.
hostingRegion

enum (HostingRegion)

مطلوبة. منطقة استضافة لوكيل

PhoneEntry

رقم هاتف مرتبط بالوكيل

تمثيل JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
الحقول
phoneNumber

object (Phone)

مطلوبة. رقم الهاتف بالتنسيق E.164 مثلاً: +12223334444
label

string

مطلوبة. تصنيف لرقم الهاتف

EmailEntry

تمثّل هذه السمة رسالة إلكترونية مرتبطة بالوكيل.

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

string

مطلوبة. عنوان بريد إلكتروني
label

string

مطلوبة. تصنيف لعنوان البريد الإلكتروني

WebEntry

مرجع مستنِد إلى الويب مرتبط بالوكيل.

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

string

مطلوبة. معرّف موارد منتظم (URI) متاح للجميع ومرتبط بالوكيل. يجب استخدام بروتوكول HTTP أو HTTPS.
label

string

اختياريّ. تصنيف معرف الموارد المنتظم (URI).

RcsBusinessMessagingAgentBillingConfig

إعدادات الفوترة للوكيل

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

enum (BillingCategory)

فئة الفوترة للوكيل

BillingCategory

فئات الفوترة المتوافقة

عمليات التعداد
BILLING_CATEGORY_UNSPECIFIED لم يتم تحديد الفئة.
CONVERSATIONAL_LEGACY فئة قديمة لدعم ضبط الفوترة للوكلاء الحاليين
CONVERSATIONAL مصمّمة للجلسات الطويلة الأكثر تعقيدًا حيث يتبادل المستخدم والعلامة التجارية سلسلة من الرسائل.
SINGLE_MESSAGE يستبدل الرسائل القصيرة SMS بتجربة مراسلة أفضل. لم يتم تحصيل رسوم الاشتراك مطلقًا من خلال CONVERSATIONAL.
BASIC_MESSAGE يتشابه نموذج الفوترة مع الرسائل القصيرة SMS. لم يتم تحصيل رسوم الاشتراك مطلقًا من خلال CONVERSATIONAL.

AgentUseCase

أنواع حالات استخدام موظّف الدعم في مساحة التخزين

عمليات التعداد
AGENT_USE_CASE_UNSPECIFIED لم يتم تحديد حالة الاستخدام.
TRANSACTIONAL موظّفو الدعم الذين لا يرسلون سوى الرسائل الأساسية والضرورية والحساسة من حيث التوقيت
PROMOTIONAL الوكلاء الذين يرسلون رسائل مبيعات وتسويقية وترويجية. النوع التلقائي.
OTP الوكلاء الذين يرسلون كلمات مرور لمرة واحدة فقط.
MULTI_USE موظّفو الدعم الذين لديهم حالات استخدام متعدّدة

HostingRegion

مناطق استضافة محتملة للوكيل يتم استخدامها لتوجيه رسائل P2A إلى الخادم الإقليمي بشكل صحيح

عمليات التعداد
HOSTING_REGION_UNSPECIFIED منطقة الاستضافة غير محدّدة.
NORTH_AMERICA أمريكا الشمالية
EUROPE أوروبا.
ASIA_PACIFIC آسيا والمحيط الهادئ.

الطُرق

create

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

delete
(deprecated)

 مهملة: تم إيقاف حذف الوكيل نهائيًا.

get

 الحصول على معلومات عن الوكيل

getLaunch

 للحصول على معلومات الإطلاق لأحد موظفي الدعم

getVerification

 الحصول على معلومات إثبات الهوية للوكيل

list

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

patch

 لتعديل المعلومات المتعلّقة بالوكيل

requestLaunch

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

requestVerification

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

updateLaunch

 تعدِّل معلومات الإطلاق لأحد موظفي الدعم.

updateVerification

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