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

اختیاری. نشانی اینترنتی لوگوی نماینده برای عموم در دسترس است. حداکثر 50 کیلوبایت

پس از تأیید نمایندگی قابل تغییر نیست.

entryPointConfigs[]

object ( BusinessMessagesEntryPointConfig )

اختیاری. لیست تنظیمات نقطه ورودی

پس از تأیید نمایندگی قابل تغییر نیست.

conversationalSettings

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

ضروری. تنظیمات مکالمه برای یک عامل، نگاشت به یک منطقه. Locale توسط یک برچسب زبان 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 )

فقط خروجی نشانی‌های اینترنتی برای آزمایش تجربه مکالمه نماینده.

توسط پلت فرم تعریف شده است.

phone

object ( Phone )

اختیاری. شماره تلفن نماینده برای نمایش. اگر مشخص نشده باشد، نماینده شماره تلفن نام تجاری موجود در نمودار دانش Google را در صورت وجود نشان می دهد.

authorizationConfig

object ( AuthorizationConfig )

اختیاری. پیکربندی مجوز برای پشتیبانی OAuth.

nonLocalConfig

object ( NonLocalConfig )

اختیاری. پیکربندی برای نقاط ورودی غیر محلی.

surveyConfig

object ( SurveyConfig )

اختیاری. پیکربندی برای فعال کردن نظرسنجی های سفارشی.

BusinessMessagesEntryPointConfig

پیکربندی نقطه ورودی برای یک عامل.

نمایندگی JSON
{
  "allowedEntryPoint": enum (EntryPoint)
}
زمینه های
allowedEntryPoint

enum ( EntryPoint )

ضروری. سطوح Google که عامل فعال است تا در آنها ظاهر شود.

نقطه ورود

سطوح Google که عامل فعال است تا در آنها ظاهر شود.

Enums
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 )

جزئیات نماینده انسانی

نوع تعامل

نوع تعامل پشتیبانی شده برای عامل.

Enums
INTERACTION_TYPE_UNSPECIFIED تعامل نامشخص
BOT تعامل با ربات
HUMAN تعامل انسانی.

BotRepresentative

جزئیات برای نماینده ربات.

نمایندگی JSON
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
زمینه های
botMessagingAvailability

object ( MessagingAvailability )

ضروری. در دسترس بودن پیام ربات.

MessagingAvailability

ساعات هر روز هفته که پیام رسانی در دسترس است. می توانید ساعت ها را برای چند روز با هم گروه بندی کنید. به عنوان مثال، * 08:00-16:00 PDT دوشنبه تا چهارشنبه * 10:00-14:00 PDT پنجشنبه تا جمعه * 15:00-18:00 PDT پنجشنبه تا جمعه * 10:00-14:00 ساعت PDT شنبه تا شنبه

اگر شکاف هایی در دسترسی وجود داشته باشد، مانند عدم دسترسی مشخص در روز یکشنبه، پیام رسانی در طول این شکاف ها در دسترس نیست.

ساعت ربات هیچ تاثیری بر در دسترس بودن ندارد. نمایندگی‌های فقط ربات همیشه پیام خوش‌آمدگویی را نشان می‌دهند، در حالی که نمایندگان با تنظیمات انسانی و نماینده ربات تنها نمایندگان انسانی را در هنگام تعریف در دسترس بودن در نظر می‌گیرند.

نمایندگی 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

یک زمان از روز را نشان می دهد. تاریخ و منطقه زمانی یا مهم نیستند یا در جای دیگری مشخص شده اند. ممکن است یک API اجازه دهد ثانیه های کبیسه را مجاز کند. انواع مرتبط عبارتند از google.type.Date و google.protobuf.Timestamp .

نمایندگی JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
زمینه های
hours

integer

ساعات روز در قالب 24 ساعته. باید از 0 تا 23 باشد. یک API ممکن است برای سناریوهایی مانند زمان بسته شدن کسب و کار، مقدار "24:00:00" را مجاز کند.

minutes

integer

دقیقه از ساعت روز. باید از 0 تا 59 باشد.

seconds

integer

ثانیه های دقیقه از زمان. معمولاً باید از 0 تا 59 باشد. یک API ممکن است مقدار 60 را مجاز کند اگر ثانیه های کبیسه را مجاز کند.

nanos

integer

کسری از ثانیه در نانوثانیه. باید از 0 تا 999,999,999 باشد.

روز هفته

یک روز از هفته را نشان می دهد.

Enums
DAY_OF_WEEK_UNSPECIFIED روز هفته نامشخص است.
MONDAY دوشنبه
TUESDAY سهشنبه
WEDNESDAY چهار شنبه
THURSDAY پنج شنبه
FRIDAY جمعه
SATURDAY شنبه
SUNDAY یکشنبه

نماینده انسانی

جزئیات برای نماینده انسانی

نمایندگی JSON
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
زمینه های
humanMessagingAvailability

object ( MessagingAvailability )

ضروری. در دسترس بودن پیام های انسانی

AuthorizationConfig

جزئیات پیکربندی برای پشتیبانی از OAuth در پیام‌های تجاری.

نمایندگی JSON
{
  "endpointUrl": string
}
زمینه های
endpointUrl

string

نشانی وب نقطه پایانی که کاربر در آن وارد می شود.

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

ضروری. نشانی اینترنتی که گزینه‌های تماس برای آن در دسترس هستند.

options[]

enum ( Option )

ضروری. لیست گزینه های تماس موجود برای URL مشخص شده.

گزینه

گزینه های تماس

Enums
OPTION_UNSPECIFIED نامشخص
WEB_CHAT گزینه چت وب
PHONE گزینه تلفن
EMAIL گزینه ایمیل
FAQS گزینه پرسش و پاسخ
TWITTER گزینه توییتر
WHATSAPP گزینه واتساپ

SurveyConfig

جزئیات پیکربندی برای پشتیبانی از سوالات نظرسنجی سفارشی.

نمایندگی JSON
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
زمینه های
templateQuestionIds[]

string

فهرست شناسه‌های سؤال الگو برای سؤالات الگو موجود در نظرسنجی.

customSurveys

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

سؤالات نظرسنجی سفارشی برای یک نماینده، نگاشت شده به یک منطقه. Locale توسط یک برچسب زبان 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.

تایپ کنید

نوع سوال نظرسنجی

Enums
TYPE_UNSPECIFIED نوع سوال نظرسنجی نامشخص.
GOOGLE_STANDARD_QUESTION سوال استاندارد نظرسنجی گوگل
GOOGLE_TEMPLATE_QUESTION گوگل نمونه سوال نظرسنجی را ارائه کرد.
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

ضروری. نشانی وب لوگوی نماینده برای عموم در دسترس است. حداکثر 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 )

ضروری. منطقه میزبانی برای یک نماینده.

ورودی تلفن

شماره تلفن مرتبط با نماینده.

نمایندگی JSON
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
زمینه های
phoneNumber

object ( Phone )

ضروری. شماره تلفن با فرمت E.164. برای مثال +12223334444 .

label

string

ضروری. برچسب برای شماره تلفن

Email Entry

یک ایمیل مرتبط با نماینده.

نمایندگی 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 )

دسته صورتحساب برای نماینده.

دسته صورتحساب

دسته های صورتحساب پشتیبانی شده

Enums
BILLING_CATEGORY_UNSPECIFIED دسته مشخص نشده است
CONVERSATIONAL_LEGACY دسته قدیمی برای پشتیبانی از پیکربندی صورتحساب نمایندگان موجود.
CONVERSATIONAL طراحی شده برای جلسات طولانی تر و پیچیده تر که در آن کاربر و برند مجموعه ای از پیام ها را مبادله می کنند.
SINGLE_MESSAGE پیامک را با یک تجربه پیام رسانی غنی تر جایگزین می کند. هیچ‌وقت به‌عنوان CONVERSATIONAL صورت‌حساب صادر نشد.
BASIC_MESSAGE مدل صورتحساب شبیه پیامک است. هیچ‌وقت به‌عنوان CONVERSATIONAL صورت‌حساب صادر نشد.

AgentUseCase

انواع مورد استفاده عامل در ذخیره سازی.

Enums
AGENT_USE_CASE_UNSPECIFIED مورد استفاده مشخص نشده است.
TRANSACTIONAL عواملی که فقط پیام های ضروری، ضروری و حساس به زمان ارسال می کنند.
PROMOTIONAL نمایندگی هایی که پیام های فروش، بازاریابی و تبلیغاتی را ارسال می کنند. نوع پیش فرض
OTP نمایندگی هایی که فقط یک بار رمز عبور ارسال می کنند.
MULTI_USE عواملی که موارد استفاده چندگانه دارند.

Hosting Region

مناطق میزبانی ممکن برای یک عامل، که برای مسیریابی صحیح پیام های P2A به سرور منطقه ای شده استفاده می شود.

Enums
HOSTING_REGION_UNSPECIFIED منطقه میزبان نامشخص
NORTH_AMERICA آمریکای شمالی.
EUROPE اروپا
ASIA_PACIFIC آسیا و اقیانوسیه.

مواد و روش ها

create

 یک عامل جدید برای نمایندگی یک برند ایجاد می کند.

delete
(deprecated)

 منسوخ شده: حذف عامل منسوخ شده است.

get

 اطلاعاتی در مورد یک نماینده دریافت کنید.

getLaunch

 اطلاعات راه اندازی را برای یک نماینده دریافت می کند.

getVerification

 اطلاعات تأیید را برای یک نماینده دریافت می کند.

list

 تمام عوامل مرتبط با یک برند را فهرست می کند.

patch

 اطلاعات یک نماینده را به روز می کند.

requestLaunch

 فرآیند راه اندازی را برای یک نماینده آغاز می کند.

requestVerification

 تأیید اطلاعات کسب و کار را برای یک نماینده آغاز می کند.

updateLaunch

 اطلاعات راه اندازی را برای یک نماینده به روز می کند.

updateVerification

 وضعیت تأیید را برای یک نماینده به روز می کند.