REST Resource: projects.chatAppConfig

منبع: ChatAppConfig

پیکربندی برنامه Google Chat را که به‌عنوان برافزای Google Workspace ساخته شده است نشان می‌دهد.

نمایش JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
فیلدها
name

string

الزامی. شناسه. نام منبع پیکربندی برنامه Chat.

قالب: projects/{project}/chatAppConfig، که {project} شماره پروژه Google Cloud است.
displayName

string

الزامی. نام نمایشی برنامه Chat. طول آن باید بین ۳ تا ۲۵ نویسه باشد.
description

string

الزامی. شرح کوتاهی از برنامه Chat. باید بین ۱ تا ۴۰ نویسه باشد.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

اختیاری. تنظیمات ویژگی‌های تعاملی برنامه. اگر این تنظیمات ارائه نشود، برنامه غیرتعاملی خواهد بود، یعنی می‌تواند از Chat API استفاده کند، اما کاربران نمی‌توانند با برنامه تعامل داشته باشند.
avatarUri

string

اختیاری. نشانی وب تصویر چهرک برنامه. باید نشانی وب HTTPS باشد که میزبان تصویر PNG مربعی (نسبت ابعادی ۱:۱) باشد. حداقل اندازه توصیه‌شده: ۲۵۶ در ۲۵۶ پیکسل. اگر مشخص نشده باشد، از چهره‌نمای پیش‌فرض برنامه استفاده خواهد شد.
state

enum (AppState)

اختیاری. وضعیت برنامه. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی ACTIVE تنظیم می‌شود.
errorLoggingEnabled

boolean

اختیاری. آیا خطاها در Cloud Logging ثبت شود یا نه. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی false تنظیم می‌شود.
markupSyntax

enum (MarkupSyntax)

اختیاری. نحو نشانه‌گذاری پیش‌فرض برای پیام‌های ارسال‌شده یا خوانده‌شده توسط این برنامه Chat. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی MARKUP_SYNTAX_MARKDOWN تنظیم می‌شود.

AppState

وضعیت فعلی برنامه Chat.

شمارشی‌ها
APP_STATE_UNSPECIFIED مقدار پیش‌فرض. نامشخص.
ACTIVE در صفحه پیکربندی Chat API، به LIVE نگاشت می‌شود. برنامه فعال است، افرادی که به آن دسترسی دارند می‌توانند آن را پیدا کنند و از آن استفاده کنند.
DISABLED برنامه غیرفعال شده است، دیگر هیچ‌کس نمی‌تواند آن را پیدا کند، و هیچ‌کس دیگر نمی‌تواند با برنامه صحبت کند.

InteractiveFeatureConfig

تنظیمات ویژگی‌های تعاملی برنامه.

نمایش JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
فیلدها
connectionConfig

object (ConnectionConfig)

الزامی. نحوه دریافت رویدادها از Google Chat توسط برنامه.
appCommands[]

object (AppCommand)

اختیاری. پیکربندی برای فرمان‌های برنامه.
urlPatterns[]

object (UrlPattern)

اختیاری. پیکربندی برای پیش‌نمایش پیوند.
allowlistedTestingPrincipals[]

string

اختیاری. نشانی ایمیل کاربران و گروه‌ها در دامنه Google Workspace شما که می‌توانند برنامه را پیدا و استفاده کنند.
supportsMultiuserSpaces

boolean

اختیاری. آیا برنامه می‌تواند به پیام‌های مستقیم دونفره، گپ‌های گروهی، و فضاها اضافه شود. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی false تنظیم می‌شود.

ConnectionConfig

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

نمایش JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
فیلدها
نوع اتصال. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
httpEndpointConfig

object (HttpEndpointConfig)

پیکربندی نقطه پایان HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

پیکربندی پیاده‌سازی Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

پیکربندی موضوع Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

پیکربندی Dialogflow.
پایان فیلدهای متقابلاً انحصاری.

HttpEndpointConfig

پیکربندی نقطه پایان HTTP.

نمایش JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
فیلدها
پیکربندی نشانی وب نقطه پایان HTTP. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
commonUrl

string

اختیاری. نشانی وب HTTPS که Google Chat همه رویدادهای تعاملی را به آن ارسال می‌کند.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

اختیاری. نشانی‌های وب HTTPS جداگانه‌ای که Google Chat هر نوع رویداد تعاملی را به آن‌ها ارسال می‌کند.
پایان فیلدهای متقابلاً انحصاری.

HttpPerEventEndpointConfig

پیکربندی نقطه پایان HTTP برای انواع رویداد خاص.

نمایش JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
فیلدها
appCommandEndpoint

string

الزامی. نقطه پایان نشانی وب HTTPS برای رویدادهای فرمان برنامه.
addedToSpaceEndpoint

string

الزامی. نقطه پایانی نشانی وب HTTPS برای رویدادهای اضافه‌شده به فضا.
messageEndpoint

string

الزامی. نقطه پایانی نشانی وب HTTPS برای رویدادهای پیام.
removedFromSpaceEndpoint

string

الزامی. نقطه پایانی نشانی وب HTTPS برای رویدادهای برداشته‌شده از فضا.

AppsScriptEndpointConfig

پیکربندی نقطه پایان Apps Script.

نمایش JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
فیلدها
deploymentId

string

الزامی. شناسه پیاده‌سازی Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

اختیاری. نام توابع Apps Script که Google Chat برای هر نوع رویداد تعاملی فراخوانی می‌کند. اگر مشخص نشده باشد، Chat تابع پیش‌فرض را برای هر نوع رویداد فراخوانی می‌کند.

AppsScriptPerEventEndpointConfig

پیکربندی نقطه پایان Apps Script برای انواع رویدادهای خاص.

نمایش JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
فیلدها
appCommandEndpoint

string

اختیاری. نام تابع برای رویدادهای فرمان برنامه. اگر مشخص نشده باشد، از نام تابع پیش‌فرض onAppCommand استفاده خواهد شد.
addedToSpaceEndpoint

string

اختیاری. نام تابع برای رویدادهای اضافه‌شده به فضا. اگر مشخص نشده باشد، از نام تابع پیش‌فرض onAddedToSpace استفاده خواهد شد.
messageEndpoint

string

اختیاری. نام تابع برای رویدادهای پیام. اگر مشخص نشده باشد، از نام تابع پیش‌فرض onMessage استفاده خواهد شد.
removedFromSpaceEndpoint

string

اختیاری. نام تابع برای رویدادهای حذف‌شده از فضا. اگر مشخص نشده باشد، از نام تابع پیش‌فرض onRemovedFromSpace استفاده خواهد شد.

CloudPubSubEndpointConfig

پیکربندی نقطه پایان Pub/Sub.

نمایش JSON 
{
  "topic": string
}
فیلدها
topic

string

الزامی. موضوع Pub/Sub که Google Chat همه رویدادهای تعاملی را در آن منتشر می‌کند. موضوع باید در همان پروژه Google Cloud برنامه باشد و Chat باید برای انتشار پیام در موضوع اجازه داشته باشد. برای جزئیات، به ساختن برنامه Google Chat با Pub/Sub مراجعه کنید.

قالب: projects/{project}/topics/{topic}

DialogflowEndpointConfig

پیکربندی نقطه پایان Dialogflow.

نمایش JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
فیلدها
dialogflowEdition

enum (DialogflowEdition)

الزامی. نسخه Dialogflow.
agent

string

اختیاری. نام محیط یا عامل Dialogflow CX. لازم برای Dialogflow CX. برای Dialogflow ES تنظیم نکنید.

قالب: projects/{project}/locations/{location}/agents/{agent} یا projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

نوع نسخه Dialogflow.

شمارشی‌ها
DIALOGFLOW_EDITION_UNSPECIFIED مقدار پیش‌فرض. نامشخص.
ES نسخه Dialogflow ES. برای استفاده از این نسخه، باید یک عامل Dialogflow ES در همان پروژه Google Cloud برنامه وجود داشته باشد. Google Chat همه رویدادهای تعاملی را به آن عامل ارسال می‌کند.
CX نسخه Dialogflow CX. برای استفاده از این نسخه، باید یک عامل Dialogflow CX در همان پروژه Google Cloud برنامه وجود داشته باشد و در فیلد agent مشخص شده باشد. Google Chat همه رویدادهای تعاملی را به آن نماینده ارسال می‌کند.

AppCommand

پیکربندی برای فرمان برنامه.

نمایش JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
فیلدها
commandType

enum (CommandType)

الزامی. نوع این فرمان.
commandId

integer

الزامی. شناسه فرمان (۱-۱۰۰۰). باید در برنامه منحصربه‌فرد باشد.
command

string

اختیاری. نام فرمان. برای SLASH_COMMAND الزامی است، برای انواع دیگر فرمان تنظیم نکنید. باید با «/» شروع شود، مثلاً «/command».
displayName

string

اختیاری. نام نمایشی کاربرپسند فرمان. برای MESSAGE_ACTION و QUICK_COMMAND الزامی است، برای SLASH_COMMAND تنظیم نکنید.
description

string

الزامی. شرح کوتاهی از فرمان.
dialogEnabled

boolean

اختیاری. اینکه این فرمان باید کادر گفتگویی را راه‌اندازی کند یا نه. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی false تنظیم می‌شود.
loadingNotificationMessage

string

اختیاری. اعلانی که وقتی کاربر کنش پیام را راه‌اندازی می‌کند برای او ارسال می‌شود. فقط برای فرمان‌های MESSAGE_ACTION پشتیبانی می‌شود.

CommandType

نوع «فرمان برنامه».

شمارشی‌ها
COMMAND_TYPE_UNSPECIFIED مقدار پیش‌فرض. نامشخص.
SLASH_COMMAND فرمانی که با تایپ کردن «/» و سپس نام فرمان فراخوانده می‌شود. ممکن است آرگومان‌های بیشتری را در نوشتار پیام بپذیرد.
QUICK_COMMAND فرمان سریعی که از منوِ بافت نوشتن پیام فراخوانده شده است. فرمان‌های سریع آرگومان‌های اضافی را نمی‌پذیرند.
MESSAGE_ACTION فرمانی که از منوِ زمینه‌ای پیام فراخوانده شده است.

UrlPattern

پیکربندی برای پیش‌نمای پیوند.

نمایش JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
فیلدها
hostPattern

string

الزامی. دامنه‌ای که باید مطابقت داشته باشد. با گنجاندن ستاره (*) به‌عنوان نویسه عام پیشرو، با زیردامنه خاصی مثل «subdomain.example.com» یا کل دامنه مطابقت دهید. برای مثال، «‎*.example.com» با «https://subdomain.example.com» و «https://any.number.of.subdomains.example.com» مطابقت دارد.
pathPrefix

string

اختیاری. پیشوند مسیر به الگوی میزبان اضافه شد. اگر خالی باشد، با همه نشانی‌های وب در الگوی میزبان مطابقت دارد. برای مثال، وقتی با الگوی میزبان «subdomain.example.com» مرتبط شود، «path/‎» را برای مطابقت با نشانی‌های وب صفحه‌ای که با «https://subdomain.example.com/path/‎» شروع می‌شوند مشخص کنید.

MarkupSyntax

نحو نشانه‌گذاری استفاده‌شده برای قالب‌بندی نوشتار پیام برای این برنامه Chat.

شمارشی‌ها
MARKUP_SYNTAX_UNSPECIFIED مقدار پیش‌فرض. نامشخص. برنامه‌های Chat موجود که قبل‌از معرفی markup_syntax ایجاد شده‌اند این مقدار را دارند و تا زمانی که به‌طور صریح به‌روزرسانی نشوند از MARKUP_SYNTAX_CHAT استفاده می‌کنند.
MARKUP_SYNTAX_CHAT از نحو نشانه‌گذاری Google Chat استفاده می‌کند. برای اطلاعات بیشتر، https://developers.google.com/workspace/chat/format-messages#format-texts را ببینید.
MARKUP_SYNTAX_MARKDOWN از نحو Markdown استفاده می‌کند. این نحو براساس مشخصات CommonMark با افزونه‌های اضافی است. برای اطلاعات بیشتر، به https://developers.google.com/workspace/chat/format-messages#format-texts مراجعه کنید.

روش‌ها

get

 پیکربندی برنامه Chat پروژه را دریافت می‌کند.

patch

 پیکربندی برنامه Chat پروژه را به‌روز می‌کند.