REST Resource: projects.chatAppConfig

संसाधन: ChatAppConfig

यह Google Workspace ऐड-ऑन के तौर पर बनाए गए Google Chat ऐप्लिकेशन के कॉन्फ़िगरेशन को दिखाता है.

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 ऐप्लिकेशन का डिसप्ले नेम. इसमें 3 से 25 वर्ण होने चाहिए.
description

string

ज़रूरी है. चैट ऐप्लिकेशन के बारे में कम शब्दों में जानकारी. इसमें 1 से 40 वर्ण होने चाहिए.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

ज़रूरी नहीं. ऐप्लिकेशन की इंटरैक्टिव सुविधाओं की सेटिंग. अगर यह जानकारी नहीं दी जाती है, तो ऐप्लिकेशन इंटरैक्टिव नहीं होगा. इसका मतलब है कि वह Chat API का इस्तेमाल कर सकता है, लेकिन उपयोगकर्ता ऐप्लिकेशन के साथ इंटरैक्ट नहीं कर सकते.
avatarUri

string

ज़रूरी नहीं. ऐप्लिकेशन की अवतार इमेज का यूआरएल. यह एक एचटीटीपीएस यूआरएल होना चाहिए, जो स्क्वेयर (1:1 आसपेक्ट रेशियो) वाली PNG इमेज को होस्ट करता हो. सुझाया गया कम से कम साइज़: 256 x 256 पिक्सल. अगर कोई अवतार नहीं चुना जाता है, तो ऐप्लिकेशन के डिफ़ॉल्ट अवतार का इस्तेमाल किया जाएगा.
state

enum (AppState)

ज़रूरी नहीं. ऐप्लिकेशन की स्थिति. अगर कुछ नहीं बताया गया है, तो डिफ़ॉल्ट रूप से ACTIVE पर सेट होता है.
errorLoggingEnabled

boolean

ज़रूरी नहीं. Cloud Logging में गड़बड़ियों को लॉग करना है या नहीं. अगर कुछ नहीं बताया गया है, तो डिफ़ॉल्ट वैल्यू false होती है.
markupSyntax

enum (MarkupSyntax)

ज़रूरी नहीं. इस चैट ऐप्लिकेशन से भेजे गए या पढ़े गए मैसेज के लिए, डिफ़ॉल्ट मार्कअप सिंटैक्स. अगर कोई सिंटैक्स तय नहीं किया गया है, तो डिफ़ॉल्ट रूप से MARKUP_SYNTAX_MARKDOWN का इस्तेमाल किया जाता है.

AppState

चैट ऐप्लिकेशन की मौजूदा स्थिति.

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

एचटीटीपी एंडपॉइंट कॉन्फ़िगरेशन.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Apps Script डिप्लॉयमेंट कॉन्फ़िगरेशन.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Pub/Sub विषय का कॉन्फ़िगरेशन.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Dialogflow का कॉन्फ़िगरेशन.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

HttpEndpointConfig

एचटीटीपी एंडपॉइंट कॉन्फ़िगरेशन.

JSON के काेड में दिखाना 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
फ़ील्ड
एचटीटीपी एंडपॉइंट यूआरएल का कॉन्फ़िगरेशन. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
commonUrl

string

ज़रूरी नहीं. वह एचटीटीपीएस यूआरएल जिस पर Google Chat, इंटरैक्टिव इवेंट भेजता है.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

ज़रूरी नहीं. अलग-अलग एचटीटीपीएस यूआरएल, जिन पर Google Chat हर तरह का इंटरैक्टिव इवेंट भेजता है.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

HttpPerEventEndpointConfig

खास तरह के इवेंट के लिए एचटीटीपी एंडपॉइंट कॉन्फ़िगरेशन.

JSON के काेड में दिखाना 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
फ़ील्ड
appCommandEndpoint

string

ज़रूरी है. ऐप्लिकेशन कमांड इवेंट के लिए एचटीटीपीएस यूआरएल एंडपॉइंट.
addedToSpaceEndpoint

string

ज़रूरी है. स्पेस में जोड़े जाने वाले इवेंट के लिए एचटीटीपीएस यूआरएल एंडपॉइंट.
messageEndpoint

string

ज़रूरी है. मैसेज इवेंट के लिए एचटीटीपीएस यूआरएल एंडपॉइंट.
removedFromSpaceEndpoint

string

ज़रूरी है. स्पेस से हटाए जाने वाले इवेंट के लिए एचटीटीपीएस यूआरएल एंडपॉइंट.

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 के पास विषय पर मैसेज पब्लिश करने की अनुमति होनी चाहिए. ज़्यादा जानकारी के लिए, Pub/Sub की मदद से Google Chat ऐप्लिकेशन बनाना लेख पढ़ें.

फ़ॉर्मैट: 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 के वर्शन का टाइप.

Enums
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

ज़रूरी है. कमांड का आईडी (1-1000). ऐप्लिकेशन में यूनीक होना चाहिए.
command

string

ज़रूरी नहीं. कमांड का नाम. SLASH_COMMAND के लिए ज़रूरी है. इसे अन्य कमांड टाइप के लिए सेट न करें. यह "/" से शुरू होना चाहिए. जैसे, "/command".
displayName

string

ज़रूरी नहीं. कमांड का डिसप्ले नेम, जो उपयोगकर्ता के लिए आसान हो. MESSAGE_ACTION और QUICK_COMMAND के लिए ज़रूरी है. इसे SLASH_COMMAND के लिए सेट न करें.
description

string

ज़रूरी है. कमांड के बारे में कम शब्दों में जानकारी.
dialogEnabled

boolean

ज़रूरी नहीं. क्या इस निर्देश से कोई डायलॉग बॉक्स ट्रिगर होना चाहिए. अगर कुछ नहीं बताया गया है, तो डिफ़ॉल्ट वैल्यू false होती है.
loadingNotificationMessage

string

ज़रूरी नहीं. जब उपयोगकर्ता मैसेज की कार्रवाई को ट्रिगर करता है, तो उसे एक सूचना भेजी जाती है. यह सिर्फ़ MESSAGE_ACTION कमांड के लिए काम करता है.

CommandType

ऐप्लिकेशन को दिए गए कमांड का टाइप.

Enums
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

इस चैट ऐप्लिकेशन के लिए, मैसेज के टेक्स्ट को फ़ॉर्मैट करने के लिए इस्तेमाल किया जाने वाला मार्कअप सिंटैक्स.

Enums
MARKUP_SYNTAX_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है markup_syntax को लॉन्च किए जाने से पहले बनाए गए चैट ऐप्लिकेशन में यह वैल्यू होती है. साथ ही, वे MARKUP_SYNTAX_CHAT का इस्तेमाल तब तक करते हैं, जब तक उन्हें अपडेट नहीं किया जाता.
MARKUP_SYNTAX_CHAT Google Chat के मार्कअप सिंटैक्स का इस्तेमाल करता है. ज़्यादा जानकारी के लिए, https://developers.google.com/workspace/chat/format-messages#format-texts पर जाएं.
MARKUP_SYNTAX_MARKDOWN मार्कडाउन सिंटैक्स का इस्तेमाल करता है. यह सिंटैक्स, CommonMark की खास बातों पर आधारित है. इसमें कुछ अतिरिक्त एक्सटेंशन भी शामिल हैं. ज़्यादा जानकारी के लिए, https://developers.google.com/workspace/chat/format-messages#format-texts पर जाएं.

तरीके

get

 किसी प्रोजेक्ट के चैट ऐप्लिकेशन का कॉन्फ़िगरेशन फ़ेच करता है.

patch

 किसी प्रोजेक्ट के चैट ऐप्लिकेशन का कॉन्फ़िगरेशन अपडेट करता है.