Package google.chat.v1

इंडेक्स

ChatService

इससे डेवलपर को Google Chat प्लैटफ़ॉर्म पर चैट ऐप्लिकेशन और इंटिग्रेशन बनाने में मदद मिलती है.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

यह तय किए गए स्पेस के लिए, इंपोर्ट करने की प्रोसेस पूरी करता है और उसे उपयोगकर्ताओं को दिखाता है. इसके लिए, ऐप्लिकेशन की पुष्टि करने और पूरे डोमेन के लोगों को डेटा का ऐक्सेस देने की ज़रूरत होती है. ज़्यादा जानकारी के लिए, Google Chat के ऐप्लिकेशन को डेटा इंपोर्ट करने की अनुमति देना लेख पढ़ें.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/chat.import

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

कॉलिंग ऐप्लिकेशन के लिए एक मैन्युअल सदस्यता या ऐप्लिकेशन सदस्यता बनाता है. अन्य ऐप्लिकेशन के लिए, पैसे चुकाकर ली जाने वाली सदस्यताएं नहीं बनाई जा सकतीं. उदाहरण के लिए, किसी उपयोगकर्ता या Google Chat ऐप्लिकेशन को स्पेस में जोड़ना या न्योता भेजना लेख पढ़ें. सदस्यता बनाते समय, अगर किसी सदस्य ने अपने-आप स्वीकार करने की सुविधा की नीति बंद की है, तो उसे न्योता भेजा जाता है. साथ ही, शामिल होने से पहले उसे स्पेस का न्योता स्वीकार करना होगा. अगर ऐसा नहीं किया जाता है, तो पैसे चुकाकर ली जाने वाली सदस्यता लेने पर, सदस्य को सीधे तौर पर तय किए गए स्पेस में जोड़ दिया जाता है. उपयोगकर्ता की पुष्टि ज़रूरी है.

सदस्य को जोड़ने के लिए, व्यक्ति या ऐप्लिकेशन सदस्य के लिए membership.member.name सेट करें या ग्रुप के सदस्य के लिए membership.group_member.name सेट करें.

  • कॉल के लिए इस्तेमाल होने वाले ऐप्लिकेशन को स्पेस में जोड़ने या दो लोगों के बीच डायरेक्ट मैसेज भेजने के लिए, users/app का इस्तेमाल करें. स्पेस में अन्य ऐप्लिकेशन नहीं जोड़े जा सके.

  • किसी उपयोगकर्ता को जोड़ने के लिए, users/{user} का इस्तेमाल करें. यहां {user} उस उपयोगकर्ता का ईमेल पता हो सकता है. एक ही Workspace संगठन के उपयोगकर्ताओं के लिए, {user}, People API का इस्तेमाल करने वाले व्यक्ति के लिए id या डायरेक्ट्री एपीआई में मौजूद उपयोगकर्ता के लिए id भी हो सकता है. उदाहरण के लिए, अगर user@example.com के लिए People API पर व्यक्ति की प्रोफ़ाइल का आईडी 123456789 है, तो membership.member.name को users/user@example.com या users/123456789 पर सेट करके, उपयोगकर्ता को स्पेस में जोड़ा जा सकता है.

  • नाम वाले स्पेस में Google ग्रुप को जोड़ने या न्योता भेजने के लिए, groups/{group} का इस्तेमाल करें. इसमें Cloud Identity Groups API से ग्रुप का id मान {group} है. उदाहरण के लिए, ग्रुप ईमेल group@example.com का आईडी 123456789 पाने के लिए, Cloud Identity Groups lookup API का इस्तेमाल किया जा सकता है. इसके बाद, membership.group_member.name को groups/123456789 पर सेट करके, ग्रुप को नाम वाले स्पेस में जोड़ा या न्योता भेजा जा सकता है. ग्रुप ईमेल की सुविधा काम नहीं करती. साथ ही, Google ग्रुप को सिर्फ़ नाम वाले स्पेस में सदस्यों के तौर पर जोड़ा जा सकता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

यह Google Chat पर मौजूद स्पेस में मैसेज भेजेगा. मैसेज का साइज़ ज़्यादा से ज़्यादा 32,000 बाइट होना चाहिए. इसमें टेक्स्ट और कार्ड भी शामिल हैं. उदाहरण के लिए, मैसेज भेजना देखें.

इस तरीके से कॉल करने के लिए, पुष्टि करने की सुविधा की ज़रूरत होती है. साथ ही, इसके लिए पुष्टि करने के ये तरीके काम करते हैं:

  • मैसेज के लिए, उपयोगकर्ता की पुष्टि करने या ऐप्लिकेशन की पुष्टि करने की सुविधा काम करती है.
  • कार्ड मैसेज के लिए, सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा काम करती है. (सिर्फ़ Chat ऐप्लिकेशन ही कार्ड मैसेज बना सकते हैं.)
अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

इससे कोई प्रतिक्रिया दी जाती है और उसे मैसेज में जोड़ दिया जाता है. सिर्फ़ यूनिकोड इमोजी का इस्तेमाल किया जा सकता है. उदाहरण के लिए, किसी मैसेज पर प्रतिक्रिया देना लेख पढ़ें. उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

नाम वाला स्पेस बनाता है. विषयों के हिसाब से ग्रुप किए गए स्पेस का इस्तेमाल नहीं किया जा सकता. उदाहरण के लिए, स्पेस बनाना लेख पढ़ें.

अगर स्पेस बनाते समय आपको गड़बड़ी का मैसेज ALREADY_EXISTS मिलता है, तो कोई दूसरा displayName आज़माएं. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

पैसे चुकाकर ली गई सदस्यता को मिटा दिया जाता है. उदाहरण के लिए, स्पेस से किसी उपयोगकर्ता या Google Chat ऐप्लिकेशन को हटाना लेख पढ़ें.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

मैसेज को मिटाता है. उदाहरण के लिए, मैसेज मिटाना देखें.

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

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

किसी मैसेज पर दी गई प्रतिक्रिया मिटा देता है. सिर्फ़ यूनिकोड इमोजी का इस्तेमाल किया जा सकता है. उदाहरण के लिए, कोई प्रतिक्रिया मिटाना लेख पढ़ें. उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

नाम वाले स्पेस को मिटाता है. हमेशा कैस्केडिंग मिटाता रहता है. इसका मतलब है कि स्पेस के चाइल्ड रिसॉर्स (जैसे, स्पेस में पोस्ट किए गए मैसेज और स्पेस में पैसे चुकाकर ली गई सदस्यताएं) भी मिटा दिए जाते हैं. उदाहरण के लिए, स्पेस मिटाना लेख पढ़ें. किसी ऐसे उपयोगकर्ता से उपयोगकर्ता की पुष्टि करना ज़रूरी है जिसके पास स्पेस को मिटाने की अनुमति है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

यह विकल्प, किसी उपयोगकर्ता को पहले से मौजूद डायरेक्ट मैसेज दिखाता है. अगर डायरेक्ट मैसेज के लिए कोई स्पेस नहीं मिलता है, तो 404 NOT_FOUND गड़बड़ी दिखाता है. उदाहरण के लिए, डायरेक्ट मैसेज ढूंढें देखें.

उपयोगकर्ता की पुष्टि की मदद से, चुने गए उपयोगकर्ता और पुष्टि किए गए उपयोगकर्ता के बीच डायरेक्ट मैसेज स्पेस मिलता है.

ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करने पर, चुने गए उपयोगकर्ता और चैट ऐप्लिकेशन के बीच डायरेक्ट मैसेज स्पेस दिखाता है.

उपयोगकर्ता की पुष्टि या ऐप्लिकेशन की पुष्टि करना ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

मैसेज अटैचमेंट का मेटाडेटा ले जाता है. अटैचमेंट का डेटा, मीडिया एपीआई का इस्तेमाल करके फ़ेच किया जाता है. उदाहरण के लिए, मैसेज अटैचमेंट के बारे में मेटाडेटा पाना देखें. इसके लिए, ऐप्लिकेशन की पुष्टि करना ज़रूरी है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/chat.bot

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

किसी सदस्यता के बारे में जानकारी दिखाता है. उदाहरण के लिए, किसी उपयोगकर्ता या Google Chat ऐप्लिकेशन की सदस्यता के बारे में जानकारी पाना देखें.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

किसी मैसेज की जानकारी दिखाता है. उदाहरण के लिए, मैसेज की जानकारी पाना देखें.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

ध्यान दें: आपको किसी ब्लॉक किए गए सदस्य या स्पेस से भी मैसेज मिल सकता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

किसी स्पेस के बारे में जानकारी दिखाता है. उदाहरण के लिए, स्पेस के बारे में जानकारी पाना लेख पढ़ें.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Google Chat पर मौजूद किसी स्पेस से कोई इवेंट दिखाता है. इवेंट पेलोड में उस संसाधन का सबसे नया वर्शन शामिल होता है जिसमें बदलाव हुआ है. उदाहरण के लिए, अगर आपने किसी नए मैसेज के बारे में किसी इवेंट का अनुरोध किया है, लेकिन मैसेज बाद में अपडेट किया गया था, तो सर्वर, इवेंट पेलोड में अपडेट किया गया Message रिसॉर्स दिखाता है.

उपयोगकर्ता की पुष्टि ज़रूरी है. किसी इवेंट को पाने के लिए, पुष्टि किया गया उपयोगकर्ता स्पेस का सदस्य होना चाहिए.

उदाहरण के लिए, Google Chat पर मौजूद किसी स्पेस में होने वाले किसी इवेंट की जानकारी पाना लेख पढ़ें.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

स्पेस में, उपयोगकर्ता के पढ़े गए मैसेज की स्थिति की जानकारी दिखाता है. इसका इस्तेमाल, पढ़े गए और नहीं पढ़े गए मैसेज की पहचान करने के लिए किया जाता है. उदाहरण के लिए, उपयोगकर्ता के स्पेस की पढ़ने की स्थिति के बारे में जानकारी पाना देखें.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

किसी थ्रेड में उपयोगकर्ता के पढ़े गए की स्थिति के बारे में जानकारी दिखाता है. इसका इस्तेमाल, पढ़े गए और नहीं पढ़े गए मैसेज की पहचान करने के लिए किया जाता है. उदाहरण के लिए, उपयोगकर्ता के थ्रेड पढ़ने की स्थिति के बारे में जानकारी पाना देखें.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

यह विकल्प, स्पेस में पैसे चुकाकर ली जाने वाली सदस्यताओं की सूची दिखाता है. उदाहरण के लिए, स्पेस में उपयोगकर्ताओं और Google Chat ऐप्लिकेशन की सूची बनाना देखें. ऐप्लिकेशन की पुष्टि करने पर, पैसे चुकाकर ली जाने वाली सदस्यताओं की सूची में, उन स्पेस की सदस्यताओं की सूची शामिल होती है जिनका ऐक्सेस Chat ऐप्लिकेशन के पास है. हालांकि, इसमें Chat ऐप्लिकेशन की सदस्यताएं शामिल नहीं हैं. उपयोगकर्ता की पुष्टि के साथ सदस्यताओं की सूची बनाने पर, उन स्पेस की सदस्यताओं की सूची बनती है जिनका ऐक्सेस पुष्टि किए गए उपयोगकर्ता के पास है.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

यह डायलॉग बॉक्स उन स्पेस में मौजूद मैसेज की सूची बनाता है जिनका सदस्य कॉलर है. इसमें, ब्लॉक किए गए सदस्यों और स्पेस के मैसेज भी शामिल हैं. उदाहरण के लिए, मैसेज की सूची बनाना देखें. उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

यह किसी मैसेज पर प्रतिक्रियाएं देने के लिए इस्तेमाल किया जाता है. उदाहरण के लिए, मैसेज के लिए प्रतिक्रियाओं की सूची बनाना देखें. उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

यह Google Chat पर मौजूद किसी स्पेस के इवेंट की सूची बनाता है. हर इवेंट के लिए, पेलोड में Chat संसाधन का सबसे नया वर्शन होता है. उदाहरण के लिए, अगर स्पेस के नए सदस्यों के इवेंट की सूची बनाई जाती है, तो सर्वर Membership ऐसे संसाधन दिखाता है जिनमें सदस्यता की नई जानकारी शामिल होती है. अगर अनुरोध की गई अवधि के दौरान नए सदस्यों को हटाया गया था, तो इवेंट पेलोड में Membership संसाधन नहीं होता.

उपयोगकर्ता की पुष्टि ज़रूरी है. इवेंट की सूची बनाने के लिए, पुष्टि किया गया उपयोगकर्ता स्पेस का सदस्य होना चाहिए.

उदाहरण के लिए, Google Chat पर मौजूद किसी स्पेस के इवेंट की सूची बनाना लेख पढ़ें.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

उन स्पेस की सूची बनाता है जिनका सदस्य कॉलर है. पहला मैसेज भेजे जाने तक, ग्रुप चैट और डायरेक्ट मैसेज की सूची नहीं दिखाई जाती है. उदाहरण के लिए, स्पेस की सूची बनाना देखें.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है.

कॉलर या पुष्टि किए गए उपयोगकर्ता को दिखने वाले स्पेस की सूची बनाता है. पहला मैसेज भेजे जाने तक, ग्रुप चैट और डायरेक्ट मैसेज की सूची नहीं दिखाई जाती है.

Google Workspace संगठन के नाम वाले सभी स्पेस को सूची में शामिल करने के लिए, spaces.search() तरीके का इस्तेमाल करें. इसके लिए, Workspace एडमिन के खास अधिकारों का इस्तेमाल करें.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

उपयोगकर्ता की खोज के आधार पर स्पेस की सूची दिखाता है. उपयोगकर्ता की पुष्टि ज़रूरी है. उपयोगकर्ता, Google Workspace संगठन का एडमिन होना चाहिए. अनुरोध में, use_admin_access को true पर सेट करें.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

स्पेस बनाता है और उसमें उन लोगों को जोड़ता है जिन पर यह तय किया गया है. कॉल करने वाले व्यक्ति को स्पेस में अपने-आप जोड़ दिया जाता है. उसे अनुरोध में, पैसे चुकाकर ली जाने वाली सदस्यता के तौर पर नहीं बताया जाना चाहिए. उदाहरण के लिए, शुरुआती सदस्यों के साथ स्पेस सेट अप करना लेख पढ़ें.

सदस्यों को जोड़ने के लिए, सही membership.member.name के साथ सदस्यताएं जोड़ें. किसी उपयोगकर्ता को जोड़ने के लिए, users/{user} का इस्तेमाल करें. यहां {user} उस उपयोगकर्ता का ईमेल पता हो सकता है. एक ही Workspace संगठन के उपयोगकर्ताओं के लिए, {user}, People API का इस्तेमाल करने वाले व्यक्ति के लिए id या डायरेक्ट्री एपीआई में मौजूद उपयोगकर्ता के लिए id भी हो सकता है. उदाहरण के लिए, अगर user@example.com के लिए People API पर व्यक्ति की प्रोफ़ाइल का आईडी 123456789 है, तो membership.member.name को users/user@example.com या users/123456789 पर सेट करके, उपयोगकर्ता को स्पेस में जोड़ा जा सकता है.

Google ग्रुप जोड़ने के लिए, सही membership.group_member.name के साथ सदस्यताएं जोड़ें. किसी Google ग्रुप को जोड़ने या न्योता देने के लिए, groups/{group} का इस्तेमाल करें. इसमें Cloud Identity Groups API से, ग्रुप का id {group} है. उदाहरण के लिए, ग्रुप ईमेल group@example.com का आईडी 123456789 फिर से पाने के लिए, Cloud Identity Groups lookup API का इस्तेमाल किया जा सकता है. इसके बाद, membership.group_member.name को groups/123456789 पर सेट करके ग्रुप को स्पेस में जोड़ा जा सकता है. ग्रुप ईमेल की सुविधा काम नहीं करती. साथ ही, Google ग्रुप को सिर्फ़ नाम वाले स्पेस में सदस्यों के तौर पर जोड़ा जा सकता है.

नाम वाले किसी स्पेस या ग्रुप चैट में, अगर कॉलर को ब्लॉक किया जाता है या कुछ सदस्यों ने ब्लॉक किया है या उसके पास कुछ सदस्यों को जोड़ने की अनुमति नहीं है, तो उन सदस्यों को बनाए गए स्पेस में नहीं जोड़ा जाता.

कॉल करने वाले व्यक्ति और दूसरे व्यक्ति के बीच डायरेक्ट मैसेज (DM) बनाने के लिए, व्यक्ति के तौर पर सिर्फ़ एक सदस्यता के बारे में बताएं. अगर एक उपयोगकर्ता दूसरे उपयोगकर्ता को ब्लॉक करता है, तो अनुरोध पूरा नहीं होता और डीएम नहीं बनाया जाता.

कॉल करने वाले उपयोगकर्ता और कॉल करने के लिए इस्तेमाल किए जाने वाले ऐप्लिकेशन के बीच DM बनाने के लिए, Space.singleUserBotDm को true पर सेट करें. साथ ही, पैसे चुकाकर ली जाने वाली किसी सदस्यता की जानकारी न दें. आप सिर्फ़ कॉलिंग ऐप्लिकेशन के साथ DM सेट अप करने के लिए ही इस तरीके का इस्तेमाल कर सकते हैं. कॉलिंग ऐप्लिकेशन को स्पेस के सदस्य के रूप में या दो उपयोगकर्ताओं के बीच किसी मौजूदा DM को जोड़ने के लिए, किसी उपयोगकर्ता या ऐप्लिकेशन को स्पेस में आमंत्रित करें या जोड़ें देखें.

अगर दो उपयोगकर्ताओं के बीच पहले से कोई DM मौजूद है, भले ही कोई अनुरोध किए जाते समय एक उपयोगकर्ता दूसरे को ब्लॉक करता हो, तो मौजूदा DM लौटाया जाता है.

थ्रेड वाले जवाब की सुविधा वाले स्पेस में यह सुविधा काम नहीं करती. अगर स्पेस सेट अप करते समय आपको गड़बड़ी का मैसेज ALREADY_EXISTS मिलता है, तो किसी दूसरे displayName का इस्तेमाल करें. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

पैसे चुकाकर ली गई सदस्यता को अपडेट करता है. उदाहरण के लिए, स्पेस में उपयोगकर्ता की सदस्यता अपडेट करना देखें.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

यह किसी मैसेज को अपडेट करता है. patch और update तरीकों में अंतर है. patch तरीके में, patch अनुरोध का इस्तेमाल किया जाता है, जबकि update तरीके में, put अनुरोध का इस्तेमाल किया जाता है. हमारा सुझाव है कि आप patch तरीके का इस्तेमाल करें. उदाहरण के लिए, मैसेज अपडेट करें देखें.

पुष्टि करना ज़रूरी है. ऐप्लिकेशन की पुष्टि और उपयोगकर्ता की पुष्टि करने की सुविधा काम करती है. ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करते समय, अनुरोध सिर्फ़ कॉल के दौरान बनाए गए Chat ऐप्लिकेशन से बनाए गए मैसेज को अपडेट कर सकते हैं.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

स्पेस को अपडेट करता है. उदाहरण के लिए, स्पेस अपडेट करना लेख पढ़ें.

अगर displayName फ़ील्ड को अपडेट किया जा रहा है और आपको गड़बड़ी का मैसेज ALREADY_EXISTS मिलता है, तो कोई दूसरा डिसप्ले नेम डालकर देखें. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

स्पेस में, उपयोगकर्ता के पढ़े गए मैसेज की स्थिति को अपडेट करता है. इसका इस्तेमाल, पढ़े गए और नहीं पढ़े गए मैसेज की पहचान करने के लिए किया जाता है. उदाहरण के लिए, उपयोगकर्ता के स्पेस की पढ़ने की स्थिति अपडेट करना देखें.

उपयोगकर्ता की पुष्टि ज़रूरी है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/chat.users.readstate

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

AccessoryWidget

एक या इससे ज़्यादा इंटरैक्टिव विजेट, जो मैसेज के निचले हिस्से में दिखते हैं. ज़्यादा जानकारी के लिए, मैसेज के निचले हिस्से में इंटरैक्टिव विजेट जोड़ना लेख पढ़ें.

फ़ील्ड
यूनियन फ़ील्ड action. कार्रवाई का टाइप. action इनमें से सिर्फ़ एक हो सकता है:
button_list

ButtonList

बटन की सूची.

ActionResponse

ऐसे पैरामीटर जिनका इस्तेमाल करके Chat ऐप्लिकेशन, अपने जवाब को पोस्ट करने के तरीके को कॉन्फ़िगर कर सकता है.

फ़ील्ड
type

ResponseType

सिर्फ़ इनपुट. Chat ऐप्लिकेशन को मिलने वाले जवाब का टाइप.

url

string

सिर्फ़ इनपुट. उपयोगकर्ताओं के लिए, पुष्टि करने या कॉन्फ़िगर करने का यूआरएल. (सिर्फ़ REQUEST_CONFIG रिस्पॉन्स टाइप के लिए.)

dialog_action

DialogAction

सिर्फ़ इनपुट. किसी डायलॉग से जुड़े इंटरैक्शन इवेंट का जवाब. ResponseType.Dialog के साथ होना चाहिए.

updated_widget

UpdatedWidget

सिर्फ़ इनपुट. अपडेट किए गए विजेट का रिस्पॉन्स.

ResponseType

Chat ऐप्लिकेशन को मिलने वाले जवाब का टाइप.

Enums
TYPE_UNSPECIFIED डिफ़ॉल्ट टाइप, जिसे NEW_MESSAGE के तौर पर हैंडल किया जाता है.
NEW_MESSAGE विषय में नए मैसेज के तौर पर पोस्ट करें.
UPDATE_MESSAGE Chat ऐप्लिकेशन का मैसेज अपडेट करें. ऐसा सिर्फ़ CARD_CLICKED इवेंट के लिए किया जा सकता है, जहां मैसेज भेजने वाला टाइप BOT है.
UPDATE_USER_MESSAGE_CARDS उपयोगकर्ता के मैसेज पर कार्ड अपडेट करें. ऐसा सिर्फ़, मेल खाने वाले यूआरएल वाले MESSAGE इवेंट या CARD_CLICKED इवेंट के जवाब के तौर पर किया जा सकता है, क्योंकि मैसेज भेजने वाला व्यक्ति HUMAN है. टेक्स्ट को अनदेखा कर दिया जाता है.
REQUEST_CONFIG उपयोगकर्ता से निजी तौर पर अतिरिक्त पुष्टि या कॉन्फ़िगरेशन के लिए कहें.
DIALOG डायलॉग दिखाता है.
UPDATE_WIDGET विजेट टेक्स्ट के अपने-आप पूरे होने वाले विकल्पों से जुड़ी क्वेरी.

SelectionItems

विजेट के अपने-आप पूरे होने वाले नतीजों की सूची.

फ़ील्ड
items[]

SelectionItem

SelectItem ऑब्जेक्ट का कलेक्शन.

UpdatedWidget

अपडेट किए गए विजेट का रिस्पॉन्स. इसका इस्तेमाल, किसी विजेट के लिए अपने-आप पूरा होने वाले विकल्प देने के लिए किया जाता है.

फ़ील्ड
widget

string

अपडेट किए गए विजेट का आईडी. यह आईडी, अपडेट का अनुरोध करने वाले विजेट के आईडी से मेल खाना चाहिए.

यूनियन फ़ील्ड updated_widget. उपयोगकर्ता की कार्रवाई के जवाब में विजेट अपडेट किया गया. updated_widget इनमें से सिर्फ़ एक हो सकता है:
suggestions

SelectionItems

विजेट के अपने-आप पूरे होने वाले नतीजों की सूची

ActionStatus

यह किसी डायलॉग को शुरू या सबमिट करने के अनुरोध का स्टेटस दिखाता है.

फ़ील्ड
status_code

Code

स्टेटस कोड.

user_facing_message

string

उपयोगकर्ताओं को उनके अनुरोध की स्थिति के बारे में भेजने के लिए मैसेज. अगर यह नीति सेट नहीं है, तो status_code के हिसाब से सामान्य मैसेज भेजा जाता है.

टिप्पणी

सिर्फ़ आउटपुट के लिए. मैसेज में सामान्य टेक्स्ट से जुड़ी व्याख्याएं. किसी मैसेज में बेसिक फ़ॉर्मैटिंग जोड़ने के लिए, मैसेज को फ़ॉर्मैट करना देखें.

सादे टेक्स्ट वाले मैसेज का मुख्य हिस्सा:

Hello @FooBot how are you!"

संबंधित एनोटेशन का मेटाडेटा:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
फ़ील्ड
type

AnnotationType

इस एनोटेशन का टाइप.

length

int32

यह एनोटेशन, सादे टेक्स्ट वाले मैसेज के मुख्य हिस्से में मौजूद सबस्ट्रिंग की लंबाई दिखाता है.

start_index

int32

उस सादे लेख वाले मुख्य हिस्से में स्टार्ट इंडेक्स (0-आधारित, शामिल है) जिससे यह जानकारी जुड़ी है.

यूनियन फ़ील्ड metadata. एनोटेशन के बारे में अतिरिक्त मेटाडेटा. metadata इनमें से सिर्फ़ एक हो सकता है:
user_mention

UserMentionMetadata

उपयोगकर्ता का मेटाडेटा.

slash_command

SlashCommandMetadata

स्लैश कमांड के लिए मेटाडेटा.

AnnotationType

एनोटेशन का टाइप.

Enums
ANNOTATION_TYPE_UNSPECIFIED Enum के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
USER_MENTION किसी उपयोगकर्ता का नाम टैग किया गया है.
SLASH_COMMAND एक स्लैश कमांड को शुरू किया जाता है.

AttachedGif

यूआरएल में दी गई GIF इमेज.

फ़ील्ड
uri

string

सिर्फ़ आउटपुट के लिए. GIF इमेज को होस्ट करने वाला यूआरएल.

अटैचमेंट

Google Chat में मौजूद एक अटैचमेंट.

फ़ील्ड
name

string

spaces/{space}/messages/{message}/attachments/{attachment} फ़ॉर्म में, अटैचमेंट के संसाधन का नाम.

content_name

string

सिर्फ़ आउटपुट के लिए. कॉन्टेंट के लिए ओरिजनल फ़ाइल नाम, न कि पूरा पाथ.

content_type

string

सिर्फ़ आउटपुट के लिए. फ़ाइल का कॉन्टेंट टाइप (MIME टाइप).

thumbnail_uri

string

सिर्फ़ आउटपुट के लिए. थंबनेल का यूआरएल, जिसका इस्तेमाल किसी उपयोगकर्ता के अटैचमेंट की झलक देखने के लिए किया जाना चाहिए. अटैचमेंट का कॉन्टेंट डाउनलोड करने के लिए, चैट ऐप्लिकेशन को इस यूआरएल का इस्तेमाल नहीं करना चाहिए.

download_uri

string

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

source

Source

सिर्फ़ आउटपुट के लिए. अटैचमेंट का सोर्स.

यूनियन फ़ील्ड data_ref. अटैचमेंट का डेटा रेफ़रंस. data_ref इनमें से सिर्फ़ एक हो सकता है:
attachment_data_ref

AttachmentDataRef

अटैचमेंट डेटा का रेफ़रंस. इस फ़ील्ड का इस्तेमाल मीडिया एपीआई के साथ, अटैचमेंट का डेटा डाउनलोड करने के लिए किया जाता है.

drive_data_ref

DriveDataRef

सिर्फ़ आउटपुट के लिए. Google Drive अटैचमेंट का रेफ़रंस. इस फ़ील्ड का इस्तेमाल Google Drive API के साथ किया जाता है.

स्रोत

अटैचमेंट का सोर्स.

Enums
SOURCE_UNSPECIFIED रिज़र्व किया गया.
DRIVE_FILE यह Google Drive में मौजूद एक फ़ाइल है.
UPLOADED_CONTENT फ़ाइल को Chat पर अपलोड किया गया.

AttachmentDataRef

अटैचमेंट डेटा का रेफ़रंस.

फ़ील्ड
resource_name

string

अटैचमेंट डेटा के संसाधन का नाम. इस फ़ील्ड का इस्तेमाल मीडिया एपीआई के साथ, अटैचमेंट का डेटा डाउनलोड करने के लिए किया जाता है.

attachment_upload_token

string

ओपेक टोकन, जिसमें अपलोड किए गए अटैचमेंट का रेफ़रंस है. क्लाइंट इसे ओपेक स्ट्रिंग मानते हैं और इसका इस्तेमाल, अटैचमेंट वाले Chat मैसेज बनाने या उन्हें अपडेट करने के लिए किया जाता है.

CardWithId

Google Chat में दिखने वाले मैसेज में एक कार्ड.

सिर्फ़ चैट ऐप्लिकेशन के लिए कार्ड बनाए जा सकते हैं. अगर आपका Chat ऐप्लिकेशन उपयोगकर्ता के तौर पर पुष्टि करता है, तो मैसेज में कार्ड नहीं जोड़े जा सकते.

कार्ड बिल्डर की मदद से कार्ड डिज़ाइन करना और उनकी झलक देखना.

कार्ड बिल्डर खोलें

फ़ील्ड
card_id

string

अगर मैसेज में एक से ज़्यादा कार्ड हों, तो ज़रूरी है. मैसेज में मौजूद कार्ड के लिए यूनीक आइडेंटिफ़ायर.

card

Card

एक कार्ड. ज़्यादा से ज़्यादा साइज़ 32 केबी हो.

ChatSpaceLinkData

चैट स्पेस के लिंक का डेटा.

फ़ील्ड
space

string

लिंक किए गए चैट स्पेस के संसाधन का स्पेस.

फ़ॉर्मैट: spaces/{space}

thread

string

लिंक किए गए चैट स्पेस के संसाधन का थ्रेड.

फ़ॉर्मैट: spaces/{space}/threads/{thread}

message

string

लिंक किए गए Chat स्पेस के संसाधन का मैसेज.

फ़ॉर्मैट: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

किसी स्पेस में इंपोर्ट की प्रोसेस पूरी करने के लिए अनुरोध से जुड़ा मैसेज.

फ़ील्ड
name

string

ज़रूरी है. इंपोर्ट मोड स्पेस के संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}

CompleteImportSpaceResponse

स्पेस के लिए इंपोर्ट की प्रोसेस पूरी करने पर दिखने वाला जवाब.

फ़ील्ड
space

Space

इंपोर्ट मोड स्पेस.

ContextualAddOnMarkup

इस टाइप में कोई फ़ील्ड नहीं है.

डेवलपर के लिए मार्कअप की मदद से किसी प्रासंगिक ऐड-ऑन की सामग्री तय की जा सकती है.

कार्ड

कार्ड, यूज़र इंटरफ़ेस (यूआई) एलिमेंट होता है. इसमें टेक्स्ट और इमेज जैसे यूज़र इंटरफ़ेस (यूआई) विजेट हो सकते हैं.

फ़ील्ड
header

CardHeader

कार्ड का हेडर. हेडर में आम तौर पर एक टाइटल और एक इमेज होती है.

sections[]

Section

सेक्शन को लाइन डिवाइडर से अलग किया जाता है.

card_actions[]

CardAction

इस कार्ड पर की जाने वाली कार्रवाइयां.

name

string

कार्ड का नाम.

CardAction

कार्ड से जुड़ी कार्रवाई, कार्ड से जुड़ी कार्रवाई है. इनवॉइस कार्ड के लिए, एक सामान्य कार्रवाई होगी: इनवॉइस मिटाना, ईमेल इनवॉइस बनाना या इनवॉइस को ब्राउज़र में खोलना.

यह सुविधा, Google Chat ऐप्लिकेशन पर काम नहीं करती.

फ़ील्ड
action_label

string

यह लेबल, ऐक्शन मेन्यू आइटम में दिखाया जाता था.

on_click

OnClick

इस कार्रवाई आइटम के लिए onclick कार्रवाई.

CardHeader

फ़ील्ड
title

string

शीर्षक बताना ज़रूरी है. हेडर की लंबाई तय है: अगर टाइटल और सबटाइटल, दोनों की जानकारी दी गई है, तो दोनों में एक ही लाइन इस्तेमाल होगी. अगर सिर्फ़ टाइटल की जानकारी दी गई है, तो उसमें दोनों लाइनें इस्तेमाल होंगी.

subtitle

string

कार्ड के हेडर का सबटाइटल.

image_style

ImageStyle

इमेज का टाइप (उदाहरण के लिए, स्क्वेयर बॉर्डर या गोल बॉर्डर).

image_url

string

कार्ड के हेडर में मौजूद इमेज का यूआरएल.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE वर्गाकार बॉर्डर.
AVATAR गोल बॉर्डर.

सेक्शन

किसी सेक्शन में विजेट का ऐसा कलेक्शन होता है जिन्हें तय किए गए क्रम में रेंडर (वर्टिकल) किया जाता है. सभी प्लैटफ़ॉर्म पर, कार्ड की चौड़ाई तय होती है. इसलिए, फ़िलहाल लेआउट प्रॉपर्टी (उदाहरण के लिए, फ़्लोट) की कोई ज़रूरत नहीं है.

फ़ील्ड
header

string

सेक्शन का हेडर. प्रारूपित टेक्स्ट समर्थित है. टेक्स्ट को फ़ॉर्मैट करने के बारे में ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन में टेक्स्ट फ़ॉर्मैट करना और Google Workspace ऐड-ऑन में टेक्स्ट फ़ॉर्मैट करना लेख पढ़ें.

widgets[]

WidgetMarkup

किसी सेक्शन में कम से कम एक विजेट होना चाहिए.

CreateMembershipRequest

सदस्यता बनाने के लिए मैसेज का अनुरोध करें.

फ़ील्ड
parent

string

ज़रूरी है. स्पेस के संसाधन का नाम, जिसके लिए सदस्यता बनानी है.

फ़ॉर्मैट: स्पेस/{space}

membership

Membership

ज़रूरी है. बनाने के लिए सदस्यता. memberType फ़ील्ड में ऐसा उपयोगकर्ता होना चाहिए जिसमें user.name और user.type फ़ील्ड भरे हों. सर्वर, संसाधन को एक नाम असाइन करेगा और बताई गई किसी भी चीज़ को ओवरराइट कर देगा. जब कोई Chat ऐप्लिकेशन, किसी उपयोगकर्ता के लिए सदस्यता बनाता है, तो उसे chat.memberships के दायरे का इस्तेमाल करना होगा. साथ ही, user.type को HUMAN पर और user.name को users/{user} फ़ॉर्मैट में सेट करना होगा. यहां उपयोगकर्ता का ईमेल पता {user} की मदद से बनाया जा सकता है. एक ही Workspace संगठन {user} के उपयोगकर्ताओं के लिए, People API के व्यक्ति का id या डायरेक्ट्री एपीआई में उपयोगकर्ता के लिए id भी हो सकता है. उदाहरण के लिए, अगर user@example.com के लिए People API पर व्यक्ति की प्रोफ़ाइल का आईडी 123456789 है, तो membership.member.name को users/user@example.com या users/123456789 पर सेट करके, उपयोगकर्ता को स्पेस में जोड़ा जा सकता है. जब कोई Chat ऐप्लिकेशन अपने लिए सदस्यता बनाता है, तो उसे chat.memberships.app के स्कोप का इस्तेमाल करना चाहिए. साथ ही, user.type को BOT पर और user.name को users/app पर सेट करना चाहिए.

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.memberships OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस का इस्तेमाल करके, एडमिन के Google Workspace खाते से बाहर के उपयोगकर्ताओं के लिए, ऐप्लिकेशन की सदस्यताएं बनाने या सदस्यताएं बनाने की सुविधा उपलब्ध नहीं है.

CreateMessageRequest

मैसेज लिखें.

फ़ील्ड
parent

string

ज़रूरी है. उस स्पेस का संसाधन नाम जिसमें मैसेज बनाना है.

फ़ॉर्मैट: spaces/{space}

message

Message

ज़रूरी है. संदेश का मुख् य भाग.

thread_key
(deprecated)

string

ज़रूरी नहीं. अब काम नहीं करता: इसके बजाय, thread.thread_key का इस्तेमाल करें. थ्रेड का आईडी. ज़्यादा से ज़्यादा 4,000 वर्णों का इस्तेमाल किया जा सकता है. किसी थ्रेड को शुरू करने या उसमें कुछ जोड़ने के लिए, मैसेज बनाएं और threadKey या thread.name तय करें. इस्तेमाल के उदाहरण के लिए, मैसेज थ्रेड शुरू करना या उसका जवाब देना देखें.

request_id

string

ज़रूरी नहीं. इस मैसेज के लिए यूनीक अनुरोध आईडी. मौजूदा अनुरोध आईडी की जानकारी देने पर, नया मैसेज बनाने के बजाय उस आईडी से बनाया गया मैसेज दिखता है.

message_reply_option

MessageReplyOption

ज़रूरी नहीं. इससे पता चलता है कि कोई मैसेज, थ्रेड शुरू करता है या किसी थ्रेड पर जवाब देता है. यह सुविधा सिर्फ़ नाम वाले स्पेस में काम करती है.

message_id

string

ज़रूरी नहीं. किसी मैसेज के लिए कस्टम आईडी. इससे Chat ऐप्लिकेशन को मैसेज के संसाधन नाम (मैसेज name फ़ील्ड में दिखाया गया) में, सिस्टम से असाइन किए गए आईडी को सेव किए बिना, मैसेज पाने, अपडेट करने या उसे मिटाने की सुविधा मिलती है.

इस फ़ील्ड की वैल्यू को नीचे दी गई ज़रूरी शर्तें पूरी करनी होंगी:

  • client- से शुरू होता है. उदाहरण के लिए, client-custom-name एक मान्य कस्टम आईडी है, लेकिन custom-name नहीं.
  • इसमें 63 से ज़्यादा वर्ण नहीं होने चाहिए. साथ ही, इसमें सिर्फ़ अंग्रेज़ी के छोटे अक्षर, नंबर, और हाइफ़न शामिल होने चाहिए.
  • हर स्पेस का यूनीक स्पेस होता है. Chat ऐप्लिकेशन, अलग-अलग मैसेज के लिए एक ही कस्टम आईडी का इस्तेमाल नहीं कर सकता.

ज़्यादा जानकारी के लिए, मैसेज को नाम देना देखें.

MessageReplyOption

मैसेज का जवाब देने का तरीका बताता है. आने वाले समय में और राज्य जोड़े जा सकते हैं.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED डिफ़ॉल्ट. नया थ्रेड शुरू करता है. इस विकल्प का इस्तेमाल करने पर, इसमें शामिल किसी भी thread ID या thread_key को अनदेखा कर दिया जाता है.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD thread ID या thread_key के बताए गए थ्रेड के जवाब के तौर पर मैसेज बनाता है. अगर यह काम नहीं करता, तो मैसेज नया थ्रेड शुरू करता है.
REPLY_MESSAGE_OR_FAIL thread ID या thread_key के बताए गए थ्रेड के जवाब के तौर पर मैसेज बनाता है. अगर नए thread_key का इस्तेमाल किया जाता है, तो नया थ्रेड बन जाता है. अगर मैसेज नहीं बन पाता, तो NOT_FOUND गड़बड़ी का मैसेज दिखता है.

CreateReactionRequest

किसी मैसेज पर प्रतिक्रिया दें.

फ़ील्ड
parent

string

ज़रूरी है. वह मैसेज जहां प्रतिक्रिया दी गई है.

फ़ॉर्मैट: spaces/{space}/messages/{message}

reaction

Reaction

ज़रूरी है. कॉन्टेंट बनाने के लिए दी जाने वाली प्रतिक्रिया.

CreateSpaceRequest

नाम वाला स्पेस बनाने का अनुरोध.

फ़ील्ड
space

Space

ज़रूरी है. displayName और spaceType फ़ील्ड में जानकारी भरी जानी चाहिए. सिर्फ़ SpaceType.SPACE का इस्तेमाल किया जा सकता है.

अगर आपको ALREADY_EXISTS गड़बड़ी का मैसेज मिलता है, तो displayName का इस्तेमाल करें. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

सर्वर पर name स्पेस असाइन किया गया है. इसलिए, इस फ़ील्ड में बताई गई किसी भी चीज़ को अनदेखा कर दिया जाएगा.

request_id

string

ज़रूरी नहीं. इस अनुरोध के लिए यूनीक आइडेंटिफ़ायर. हमारा सुझाव है कि आप रैंडम यूयूआईडी का इस्तेमाल करें. मौजूदा अनुरोध आईडी तय करने पर, नया स्पेस बनाने के बजाय उस आईडी से बनाया गया स्पेस दिखता है. पुष्टि किए गए किसी दूसरे उपयोगकर्ता के साथ, उसी Chat ऐप्लिकेशन के मौजूदा अनुरोध आईडी को बताने पर गड़बड़ी वाला मैसेज दिखता है.

CustomEmoji

यह पसंद के मुताबिक बनाया गया इमोजी दिखाता है.

फ़ील्ड
uid

string

सिर्फ़ आउटपुट के लिए. पसंद के मुताबिक बनाए गए इमोजी के लिए, खास कुंजी.

DeleteMembershipRequest

स्पेस से, पैसे चुकाकर ली गई सदस्यता को मिटाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. जिस सदस्यता को मिटाना है उसके संसाधन का नाम. चैट ऐप्लिकेशन, लोगों की या अपनी सदस्यता का इस्तेमाल करने में मदद मिल सकती है. चैट ऐप्लिकेशन को दूसरे ऐप्लिकेशन नहीं मिटाए जा सकते की सदस्यता.

लोगों से ली जाने वाली किसी सदस्यता को मिटाते समय, chat.memberships स्कोप और spaces/{space}/members/{member} फ़ॉर्मैट का इस्तेमाल करना ज़रूरी है. आप इस ईमेल को {member} के लिए उपनाम के तौर पर इस्तेमाल कर सकते हैं. उदाहरण के लिए, spaces/{space}/members/example@gmail.com, जहां example@gmail.com, Google Chat इस्तेमाल करने वाले व्यक्ति का ईमेल है.

ऐप्लिकेशन की सदस्यता मिटाते समय, chat.memberships.app स्कोप और spaces/{space}/members/app फ़ॉर्मैट का इस्तेमाल करना ज़रूरी है.

फ़ॉर्मैट: spaces/{space}/members/{member} या spaces/{space}/members/app.

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.memberships OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस का इस्तेमाल करके, स्पेस में ऐप्लिकेशन की पैसे चुकाकर ली जाने वाली सदस्यताएं नहीं मिटाई जा सकतीं.

DeleteMessageRequest

मैसेज मिटाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. मैसेज में दिए गए संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/messages/{message}

अगर आपने मैसेज के लिए कस्टम आईडी सेट किया है, तो {message} के लिए clientAssignedMessageId फ़ील्ड के मान का इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, मैसेज को नाम देना देखें.

force

bool

true पर किसी मैसेज को मिटाने पर, थ्रेड वाले जवाब भी मिट जाते हैं. false के दौरान, अगर किसी मैसेज में थ्रेड वाले जवाब हैं, तो उसे मिटाया नहीं जा सकता.

सिर्फ़ तब लागू होता है, जब उपयोगकर्ता के तौर पर पुष्टि की जा रही हो. चैट ऐप्लिकेशन के तौर पर पुष्टि करने पर इसका कोई असर नहीं पड़ता.

DeleteReactionRequest

किसी मैसेज पर दी गई प्रतिक्रिया मिटा देता है.

फ़ील्ड
name

string

ज़रूरी है. मिटाई जाने वाली प्रतिक्रिया का नाम.

फ़ॉर्मैट: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

स्पेस को मिटाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. मिटाए जाने वाले स्पेस में मौजूद संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.delete OAuth 2.0 स्कोप की ज़रूरत होती है.

DeletionMetadata

मिटाए गए मैसेज के बारे में जानकारी. delete_time के सेट होने पर मैसेज को मिटा दिया जाता है.

फ़ील्ड
deletion_type

DeletionType

यह बताता है कि मैसेज किसने मिटाया है.

DeletionType

मैसेज किसने मिटाया और कैसे मिटाया.

Enums
DELETION_TYPE_UNSPECIFIED इस वैल्यू का इस्तेमाल नहीं किया गया है.
CREATOR उपयोगकर्ता ने अपना मैसेज मिटा दिया है.
SPACE_OWNER स्पेस के मालिक ने मैसेज मिटा दिया है.
ADMIN Google Workspace एडमिन ने यह मैसेज मिटा दिया है.
APP_MESSAGE_EXPIRY समयसीमा खत्म होने पर, Chat ऐप्लिकेशन ने अपना मैसेज मिटा दिया है.
CREATOR_VIA_APP किसी Chat ऐप्लिकेशन ने उपयोगकर्ता की ओर से यह मैसेज मिटा दिया है.
SPACE_OWNER_VIA_APP स्पेस के मालिक की ओर से, Chat ऐप्लिकेशन ने मैसेज मिटा दिया है.

Dialog

डायलॉग के कार्ड के मुख्य हिस्से को रैप करें.

फ़ील्ड
body

Card

सिर्फ़ इनपुट. डायलॉग बॉक्स का मुख्य हिस्सा, जिसे मॉडल में रेंडर किया जाता है. Google Chat के ऐप्लिकेशन, इन कार्ड इकाइयों के साथ काम नहीं करते: DateTimePicker, OnChangeAction.

DialogAction

इसमें एक डायलॉग और अनुरोध की स्थिति के कोड की जानकारी होती है.

फ़ील्ड
action_status

ActionStatus

सिर्फ़ इनपुट. किसी डायलॉग को शुरू करने या सबमिट करने के अनुरोध की स्थिति. ज़रूरत पड़ने पर, उपयोगकर्ताओं को स्टेटस और मैसेज दिखाता है. उदाहरण के लिए, किसी गड़बड़ी या सफल होने की स्थिति में.

यूनियन फ़ील्ड action. की जाने वाली कार्रवाई. action इनमें से सिर्फ़ एक हो सकता है:
dialog

Dialog

सिर्फ़ इनपुट. अनुरोध के लिए डायलॉग.

DriveDataRef

ड्राइव में मौजूद अटैचमेंट के डेटा का रेफ़रंस.

फ़ील्ड
drive_file_id

string

ड्राइव फ़ाइल का आईडी. Drive API के साथ इस्तेमाल करें.

DriveLinkData

Google Drive के लिंक का डेटा.

फ़ील्ड
drive_data_ref

DriveDataRef

DriveDataRef, जो Google Drive की फ़ाइल का रेफ़रंस देता है.

mime_type

string

लिंक किए गए Google Drive संसाधन का MIME टाइप.

इमोजी

ऐसा इमोजी जिसका इस्तेमाल किसी मैसेज पर प्रतिक्रिया देने के लिए किया जाता है.

फ़ील्ड
यूनियन फ़ील्ड content. इमोजी का कॉन्टेंट. content इनमें से सिर्फ़ एक हो सकता है:
unicode

string

एक सामान्य इमोजी, जिसे यूनिकोड स्ट्रिंग से दिखाया जाता है.

custom_emoji

CustomEmoji

सिर्फ़ आउटपुट के लिए. पसंद के मुताबिक बनाया गया इमोजी.

EmojiReactionSummary

ऐसे लोगों की संख्या जिन्होंने खास इमोजी वाले मैसेज पर प्रतिक्रिया दी.

फ़ील्ड
emoji

Emoji

इमोजी से दिया गया इमोजी.

reaction_count

int32

इससे जुड़े इमोजी का इस्तेमाल करके दी गई प्रतिक्रियाओं की कुल संख्या.

FindDirectMessageRequest

उपयोगकर्ता के संसाधन के आधार पर, डायरेक्ट मैसेज के लिए स्पेस पाने का अनुरोध.

फ़ील्ड
name

string

ज़रूरी है. डायरेक्ट मैसेज ढूंढने के लिए उपयोगकर्ता का संसाधन.

फ़ॉर्मैट: users/{user}, जहां {user}, People API के व्यक्ति के लिए या डायरेक्ट्री एपीआई में उपयोगकर्ता के लिए id है.id उदाहरण के लिए, अगर People API का प्रोफ़ाइल आईडी 123456789 है, तो users/123456789 का name के तौर पर इस्तेमाल करके, उस व्यक्ति को डायरेक्ट मैसेज किया जा सकता है. उपयोगकर्ता के तौर पर पुष्टि होने पर, {user} के लिए ईमेल को उपनाम के तौर पर इस्तेमाल किया जा सकता है. उदाहरण के लिए, users/example@gmail.com, जहां example@gmail.com, Google Chat इस्तेमाल करने वाले व्यक्ति का ईमेल है.

GetAttachmentRequest

अटैचमेंट पाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. spaces/{space}/messages/{message}/attachments/{attachment} फ़ॉर्म में, अटैचमेंट के संसाधन का नाम.

GetMembershipRequest

स्पेस की सदस्यता पाने का अनुरोध करना.

फ़ील्ड
name

string

ज़रूरी है. वापस पाने के लिए सदस्यता का संसाधन नाम.

उपयोगकर्ता की पुष्टि करके, ऐप्लिकेशन की खुद की सदस्यता पाने के लिए, spaces/{space}/members/app का इस्तेमाल किया जा सकता है.

फ़ॉर्मैट: spaces/{space}/members/{member} या spaces/{space}/members/app

उपयोगकर्ता के तौर पर पुष्टि होने पर, आपके पास {member} के लिए, उपयोगकर्ता के ईमेल पते का इस्तेमाल उपनाम के तौर पर करने का विकल्प होता है. उदाहरण के लिए, spaces/{space}/members/example@gmail.com, जहां example@gmail.com, Google Chat इस्तेमाल करने वाले व्यक्ति का ईमेल है.

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.memberships या chat.admin.memberships.readonly OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस इस्तेमाल करने पर, किसी स्पेस में ऐप्लिकेशन के लिए सदस्यता लेने की सुविधा काम नहीं करती.

GetMessageRequest

मैसेज पाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. मैसेज में दिए गए संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/messages/{message}

अगर आपने मैसेज के लिए कस्टम आईडी सेट किया है, तो {message} के लिए clientAssignedMessageId फ़ील्ड के मान का इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, मैसेज को नाम देना देखें.

GetSpaceEventRequest

स्पेस में होने वाले इवेंट के लिए मैसेज का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. स्पेस इवेंट के संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

GetSpaceReadState API के लिए अनुरोध से जुड़ा मैसेज.

फ़ील्ड
name

string

ज़रूरी है. डेटा वापस पाने के लिए, स्पेस के संसाधन का रीड स्टेज का नाम.

कॉल करने वाले व्यक्ति की स्थिति का सिर्फ़ पता लगाया जा सकता है.

कॉल करने वाले उपयोगकर्ता को रेफ़र करने के लिए, इनमें से कोई एक शर्त सेट करें:

  • me का दूसरा ईमेल पता. उदाहरण के लिए, users/me/spaces/{space}/spaceReadState.

  • उनका Workspace ईमेल पता. उदाहरण के लिए, users/user@example.com/spaces/{space}/spaceReadState.

  • उसका यूज़र आईडी. उदाहरण के लिए, users/123456789/spaces/{space}/spaceReadState.

फ़ॉर्मैट: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

किसी स्पेस को वापस करने का अनुरोध.

फ़ील्ड
name

string

ज़रूरी है. स्पेस में मौजूद संसाधन का नाम, spaces/{space} फ़ॉर्म में.

फ़ॉर्मैट: spaces/{space}

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.spaces या chat.admin.spaces.readonly OAuth 2.0 स्कोप की ज़रूरत होती है.

GetThreadReadStateRequest

GetThreadReadStateRequest एपीआई के लिए अनुरोध मैसेज.

फ़ील्ड
name

string

ज़रूरी है. वापस पाने के लिए, थ्रेड के रीड स्टेटस के संसाधन का नाम.

कॉल करने वाले व्यक्ति की सिर्फ़ पढ़ने की स्थिति का पता लगाया जा सकता है.

कॉल करने वाले उपयोगकर्ता को रेफ़र करने के लिए, इनमें से कोई एक शर्त सेट करें:

  • me का दूसरा ईमेल पता. उदाहरण के लिए, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • उनका Workspace ईमेल पता. उदाहरण के लिए, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • उसका यूज़र आईडी. उदाहरण के लिए, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

फ़ॉर्मैट: user/{user}/spaces/{space}/threads/{thread}/threadReadState

ग्रुप

Google Chat में एक Google ग्रुप.

फ़ील्ड
name

string

किसी Google ग्रुप के लिए संसाधन का नाम.

यह Cloud Identity Groups API में किसी ग्रुप को दिखाता है.

फ़ॉर्मैट: ग्रुप/{group}

HistoryState

मैसेज और स्पेस के इतिहास की स्थिति. इससे पता चलता है कि मैसेज और बातचीत की थ्रेड को बनाए जाने के बाद, उन्हें कितने समय तक रखा जाता है.

Enums
HISTORY_STATE_UNSPECIFIED डिफ़ॉल्ट मान. इस्तेमाल न करें.
HISTORY_OFF इतिहास बंद है. मैसेज और थ्रेड को 24 घंटे तक सेव रखा जाता है.
HISTORY_ON इतिहास चालू है. संगठन के Vault के निजी डेटा के रखरखाव के नियम से पता चलता है कि मैसेज और थ्रेड को कितने समय तक रखा जाएगा.

ListMembershipsRequest

सदस्यताओं की सूची बनाने के लिए अनुरोध मैसेज.

फ़ील्ड
parent

string

ज़रूरी है. स्पेस का संसाधन नाम, जिसके लिए सदस्यता की सूची फ़ेच करनी है.

फ़ॉर्मैट: स्पेस/{space}

page_size

int32

ज़रूरी नहीं. वापस करने के लिए सदस्यताओं की ज़्यादा से ज़्यादा संख्या. यह सेवा इस वैल्यू से कम वैल्यू दिखा सकती है.

अगर जानकारी नहीं दी जाती है, तो ज़्यादा से ज़्यादा 100 सदस्यताएं दिखाई जा सकती हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.

page_token

string

ज़रूरी नहीं. सदस्यताओं की सूची बनाने के लिए किए गए पिछले कॉल के ज़रिए मिला पेज टोकन. बाद वाले पेज को फिर से पाने के लिए यह पैरामीटर दें.

पेजों पर नंबर डालते समय, दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मैच होने चाहिए. दूसरे पैरामीटर के लिए अलग-अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं.

filter

string

ज़रूरी नहीं. क्वेरी फ़िल्टर.

सदस्य की भूमिका (role) और टाइप (member.type) के हिसाब से, पैसे चुकाकर ली जाने वाली सदस्यताओं को फ़िल्टर किया जा सकता है.

भूमिका के हिसाब से फ़िल्टर करने के लिए, role को ROLE_MEMBER या ROLE_MANAGER पर सेट करें.

टाइप के हिसाब से फ़िल्टर करने के लिए, member.type को HUMAN या BOT पर सेट करें. डेवलपर की झलक: != ऑपरेटर का इस्तेमाल करके भी member.type को फ़िल्टर किया जा सकता है.

भूमिका और टाइप, दोनों के हिसाब से फ़िल्टर करने के लिए, AND ऑपरेटर का इस्तेमाल करें. किसी भी भूमिका या टाइप के हिसाब से फ़िल्टर करने के लिए, OR ऑपरेटर का इस्तेमाल करें.

use_admin_access को 'सही है' पर सेट करने पर, member.type = "HUMAN" या member.type != "BOT" में से किसी एक को चुनना ज़रूरी है. अन्य मेंबर टाइप फ़िल्टर अस्वीकार कर दिए जाएंगे.

उदाहरण के लिए, नीचे दी गई क्वेरी मान्य हैं:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

ये क्वेरी अमान्य हैं:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

अमान्य क्वेरी को सर्वर INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

show_groups

bool

ज़रूरी नहीं. जब true, दूसरी तरह की सदस्यताओं के साथ-साथ, Google Group से जुड़ी सदस्यताएं भी दिखाता है. अगर filter सेट है, तो Google Group की ऐसी सदस्यताएं नहीं दिखाई जाती हैं जो फ़िल्टर करने की शर्तों से मेल नहीं खातीं.

show_invited

bool

ज़रूरी नहीं. जब true, अन्य तरह की सदस्यताओं के साथ-साथ, invited सदस्यों से जुड़ी सदस्यताएं भी दिखाता है. अगर कोई फ़िल्टर सेट किया जाता है, तो फ़िल्टर करने की शर्तों से मेल न खाने वाली invited सदस्यताएं नहीं दिखाई जाती हैं.

फ़िलहाल, उपयोगकर्ता की पुष्टि ज़रूरी है.

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.memberships.readonly या chat.admin.memberships OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस का इस्तेमाल करते समय, स्पेस में ऐप्लिकेशन की पैसे चुकाकर ली जाने वाली सदस्यताओं की लिस्टिंग नहीं की जा सकती.

ListMembershipsResponse

स्पेस की सदस्यताओं की सूची का जवाब दें.

फ़ील्ड
memberships[]

Membership

बिना क्रम वाली सूची. अनुरोध किए गए (या पहले) पेज पर मौजूद सदस्यताओं की सूची.

next_page_token

string

ऐसा टोकन जिसे आप नतीजों के अगले पेज को फिर से पाने के लिए pageToken के तौर पर भेज सकते हैं. अगर खाली है, तो इसके बाद कोई पेज नहीं होता.

ListMessagesRequest

तय किए गए स्पेस में उन मैसेज की सूची बनाता है जिनका सदस्य सदस्य है.

फ़ील्ड
parent

string

ज़रूरी है. स्पेस के मैसेज की सूची बनाने के लिए, संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}

page_size

int32

लौटाए गए मैसेज की ज़्यादा से ज़्यादा संख्या. ऐसा हो सकता है कि सेवा, इस वैल्यू से कम मैसेज दिखाए.

अगर जानकारी नहीं है, तो ज़्यादा से ज़्यादा 25 नतीजे लौटाए जाते हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.

page_token

string

ज़रूरी नहीं, अगर इसे किसी पिछली क्वेरी से फिर से शुरू किया जा रहा हो.

पिछले मैसेज कॉल से मिला पेज टोकन. बाद वाले पेज को फिर से पाने के लिए यह पैरामीटर दें.

पेजों पर नंबर डालते समय, दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मैच होने चाहिए. दूसरे पैरामीटर के लिए अलग-अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं.

filter

string

क्वेरी फ़िल्टर.

तारीख (create_time) और थ्रेड (thread.name) के हिसाब से मैसेज फ़िल्टर किए जा सकते हैं.

मैसेज को उन्हें बनाए जाने की तारीख के हिसाब से फ़िल्टर करने के लिए, RFC-3339 फ़ॉर्मैट में टाइमस्टैंप और डबल कोटेशन मार्क के साथ create_time की जानकारी दें. उदाहरण के लिए, "2023-04-21T11:30:00-04:00". टाइमस्टैंप के बाद बनाए गए मैसेज की सूची बनाने के लिए, ऑपरेटर > से ज़्यादा ऑपरेटर का इस्तेमाल किया जा सकता है. वहीं, टाइमस्टैंप से पहले बनाए गए मैसेज की सूची बनाने के लिए, ऑपरेटर < का इस्तेमाल किया जा सकता है. किसी समयावधि में मैसेज फ़िल्टर करने के लिए, दो टाइमस्टैंप के बीच AND ऑपरेटर का इस्तेमाल करें.

थ्रेड के हिसाब से फ़िल्टर करने के लिए, spaces/{space}/threads/{thread} फ़ॉर्मैट में thread.name डालें. हर क्वेरी के लिए सिर्फ़ एक thread.name तय किया जा सकता है.

थ्रेड और तारीख, दोनों के हिसाब से फ़िल्टर करने के लिए, अपनी क्वेरी में AND ऑपरेटर का इस्तेमाल करें.

उदाहरण के लिए, नीचे दी गई क्वेरी मान्य हैं:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

अमान्य क्वेरी को सर्वर INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

order_by

string

ज़रूरी नहीं, अगर इसे किसी पिछली क्वेरी से फिर से शुरू किया जा रहा हो.

मैसेज की सूची को क्रम से लगाने का तरीका. ऑर्डर करने की कार्रवाई के हिसाब से वह वैल्यू डालें जिसे ऑर्डर करना है. मान्य ऑर्डर ऑपरेशन मान इस प्रकार हैं:

  • बढ़ते क्रम में लगाने के लिए ASC.

  • घटते क्रम में लगाने के लिए, DESC.

डिफ़ॉल्ट क्रम create_time ASC है.

show_deleted

bool

क्या मिटाए गए मैसेज शामिल करने हैं. मिटाए गए मैसेज में, मिटाए जाने का समय और उनसे जुड़ा मेटाडेटा शामिल होता है. हालांकि, मैसेज का कॉन्टेंट उपलब्ध नहीं होता.

ListMessagesResponse

लिस्टिंग मैसेज के लिए जवाब देने वाला मैसेज.

फ़ील्ड
messages[]

Message

मैसेज की सूची.

next_page_token

string

नतीजों का अगला पेज वापस पाने के लिए, pageToken के तौर पर टोकन भेजा जा सकता है. अगर खाली है, तो इसके बाद कोई पेज नहीं होता.

ListReactionsRequest

यह किसी मैसेज पर प्रतिक्रियाएं देने के लिए इस्तेमाल किया जाता है.

फ़ील्ड
parent

string

ज़रूरी है. वह मैसेज जिस पर उपयोगकर्ताओं ने प्रतिक्रिया दी है.

फ़ॉर्मैट: spaces/{space}/messages/{message}

page_size

int32

ज़रूरी नहीं. ज़्यादा से ज़्यादा प्रतिक्रियाएं दिखाई जा रही हैं. यह सेवा, इस वैल्यू से कम प्रतिक्रियाएं दिखा सकती है. अगर इसके लिए कोई वैल्यू तय नहीं की गई है, तो डिफ़ॉल्ट तौर पर वैल्यू 25 होती है. ज़्यादा से ज़्यादा वैल्यू 200 है; अगर वैल्यू 200 से ज़्यादा है, तो उसे 200 में बदल दिया जाता है.

page_token

string

ज़रूरी नहीं. (पिछली क्वेरी से फिर से शुरू करने पर.)

प्रतिक्रियाओं की पिछली कॉल से मिला पेज टोकन. अगले पेज को वापस पाने के लिए, यह जानकारी दें.

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

filter

string

ज़रूरी नहीं. क्वेरी फ़िल्टर.

प्रतिक्रियाओं को इमोजी (emoji.unicode या emoji.custom_emoji.uid) और उपयोगकर्ता (user.name) के हिसाब से फ़िल्टर किया जा सकता है.

एक से ज़्यादा इमोजी या लोगों के लिए प्रतिक्रियाएं फ़िल्टर करने के लिए, OR ऑपरेटर के साथ मिलते-जुलते फ़ील्ड जोड़ें. जैसे, emoji.unicode = "🙂" OR emoji.unicode = "👍" और user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

इमोजी और उपयोगकर्ता के हिसाब से प्रतिक्रियाओं को फ़िल्टर करने के लिए, emoji.unicode = "🙂" AND user.name = "users/AAAAAA" जैसे AND ऑपरेटर का इस्तेमाल करें.

अगर आपकी क्वेरी में AND और OR, दोनों का इस्तेमाल किया गया है, तो उन्हें ब्रैकेट में रखें.

उदाहरण के लिए, नीचे दी गई क्वेरी मान्य हैं:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

ये क्वेरी अमान्य हैं:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

अमान्य क्वेरी को सर्वर INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

ListReactionsResponse

प्रतिक्रियाओं की सूची के अनुरोध का जवाब देना.

फ़ील्ड
reactions[]

Reaction

अनुरोध किए गए (या पहले) पेज पर दी गई प्रतिक्रियाओं की सूची.

next_page_token

string

नतीजों का अगला पेज वापस पाने के लिए कंटिन्यूवेशन टोकन. यह खोज के नतीजों वाले आखिरी पेज के लिए खाली है.

ListSpaceEventsRequest

स्पेस के इवेंट की सूची बनाने के लिए अनुरोध वाला मैसेज.

फ़ील्ड
parent

string

ज़रूरी है. Google Chat पर मौजूद उस स्पेस के संसाधन का नाम जहां इवेंट हुए हैं.

फ़ॉर्मैट: spaces/{space}.

page_size

int32

ज़रूरी नहीं. स्पेस के ज़्यादा से ज़्यादा इवेंट लौटाए जा सकते हैं. यह सेवा इस वैल्यू से कम वैल्यू दिखा सकती है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.

page_token

string

पेज टोकन, जो पिछले लिस्ट स्पेस इवेंट कॉल से मिला है. अगले पेज को वापस पाने के लिए, यह जानकारी दें.

पेज पर नंबर डालते समय, स्पेस इवेंट की सूची में दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मैच होने चाहिए. दूसरे पैरामीटर के लिए अलग-अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं.

filter

string

ज़रूरी है. क्वेरी फ़िल्टर.

आपको : ऑपरेटर का इस्तेमाल करके कम से कम एक इवेंट टाइप (event_type) तय करना होगा. एक से ज़्यादा इवेंट टाइप के हिसाब से फ़िल्टर करने के लिए, OR ऑपरेटर का इस्तेमाल करें. अपने फ़िल्टर में बैच इवेंट प्रकार हटाएं. अनुरोध करने पर, उससे जुड़े बैच के इवेंट अपने-आप दिखते हैं. उदाहरण के लिए, नई प्रतिक्रियाओं (google.workspace.chat.reaction.v1.created) के हिसाब से फ़िल्टर करने पर, सर्वर नई प्रतिक्रियाओं के बैच (google.workspace.chat.reaction.v1.batchCreated) भी दिखाता है. इस्तेमाल किए जा सकने वाले इवेंट टाइप की सूची के लिए, SpaceEvents रेफ़रंस दस्तावेज़ देखें.

इसके अलावा, इसे शुरू होने के समय (start_time) और खत्म होने के समय (end_time) के हिसाब से भी फ़िल्टर किया जा सकता है:

  • start_time: खास टाइमस्टैंप, जिससे स्पेस के इवेंट की लिस्टिंग शुरू की जा सकती है. आपके पास उन इवेंट की सूची बनाने का विकल्प होता है जो 28 दिन पहले हुए हैं. अगर यह जानकारी नहीं दी गई है, तो यह पिछले 28 दिनों के स्पेस के इवेंट की सूची दिखाता है.
  • end_time: बिना किसी भेदभाव के सभी को शामिल करने वाला टाइमस्टैंप, जब तक कि स्पेस इवेंट नहीं जोड़े जाते. अगर यह जानकारी उपलब्ध नहीं है, तो यह अनुरोध किए जाने के समय तक के इवेंट की सूची बनाता है.

शुरू या खत्म होने का समय बताने के लिए, RFC-3339 में बराबर = ऑपरेटर और फ़ॉर्मैट का इस्तेमाल करें. start_time और end_time, दोनों के हिसाब से फ़िल्टर करने के लिए, AND ऑपरेटर का इस्तेमाल करें.

उदाहरण के लिए, नीचे दी गई क्वेरी मान्य हैं:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"
start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

ये क्वेरी अमान्य हैं:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

अमान्य क्वेरी को सर्वर INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

ListSpaceEventsResponse

स्पेस के इवेंट की सूची बनाने के लिए जवाब देने वाला मैसेज.

फ़ील्ड
space_events[]

SpaceEvent

नतीजे, समय के हिसाब से दिखाए जाते हैं (सबसे पुराने इवेंट के पहले).

next_page_token

string

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

ListSpacesRequest

उन स्पेस की सूची बनाने का अनुरोध जिनके सदस्य कॉलर हैं.

फ़ील्ड
page_size

int32

ज़रूरी नहीं. लौटाए जाने वाले स्पेस की ज़्यादा से ज़्यादा संख्या. यह सेवा इस वैल्यू से कम वैल्यू दिखा सकती है.

अगर कोई वैल्यू न दी गई हो, तो ज़्यादा से ज़्यादा 100 स्पेस लौटाए जाते हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

नेगेटिव वैल्यू से INVALID_ARGUMENT गड़बड़ी मिलती है.

page_token

string

ज़रूरी नहीं. पेज टोकन, जो पिछले स्पेस स्पेस कॉल से मिला है. बाद वाले पेज को फिर से पाने के लिए यह पैरामीटर दें.

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

filter

string

ज़रूरी नहीं. क्वेरी फ़िल्टर.

स्पेस के टाइप (space_type) के हिसाब से, स्पेस फ़िल्टर किए जा सकते हैं.

स्पेस के टाइप के हिसाब से फ़िल्टर करने के लिए, आपको ईनम की मान्य वैल्यू डालनी होगी. जैसे, SPACE या GROUP_CHAT (space_type, SPACE_TYPE_UNSPECIFIED नहीं हो सकता). एक से ज़्यादा तरह के स्पेस के बारे में क्वेरी करने के लिए, OR ऑपरेटर का इस्तेमाल करें.

उदाहरण के लिए, नीचे दी गई क्वेरी मान्य हैं:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

अमान्य क्वेरी को सर्वर INVALID_ARGUMENT गड़बड़ी के साथ अस्वीकार कर देता है.

ListSpacesResponse

स्पेस की सूची के अनुरोध का जवाब.

फ़ील्ड
spaces[]

Space

अनुरोध किए गए (या पहले) पेज में स्पेस की सूची.

next_page_token

string

नतीजों का अगला पेज वापस पाने के लिए, pageToken के तौर पर टोकन भेजा जा सकता है. अगर खाली है, तो इसके बाद कोई पेज नहीं होता.

MatchedUrl

Chat के मैसेज में मिलता-जुलता यूआरएल. चैट ऐप्लिकेशन, मैच होने वाले यूआरएल की झलक देख सकते हैं. ज़्यादा जानकारी के लिए, झलक के लिंक देखें.

फ़ील्ड
url

string

सिर्फ़ आउटपुट के लिए. मेल खाने वाला यूआरएल.

सदस्यता

यह Google Chat में पैसे चुकाकर ली जाने वाली सदस्यता को दिखाता है. जैसे, किसी उपयोगकर्ता या Chat ऐप्लिकेशन को स्पेस में शामिल होने का न्योता दिया गया है, स्पेस में शामिल नहीं किया गया है या वह उसमें शामिल नहीं है.

फ़ील्ड
name

string

सदस्यता के संसाधन का नाम, जिसे सर्वर असाइन करता है.

फ़ॉर्मैट: spaces/{space}/members/{member}

state

MembershipState

सिर्फ़ आउटपुट के लिए. सदस्यता की स्थिति.

role

MembershipRole

ज़रूरी नहीं. चैट स्पेस में उपयोगकर्ता की भूमिका. इससे यह तय होता है कि स्पेस में उपयोगकर्ता को कौनसी कार्रवाइयां करने की अनुमति है.

इस फ़ील्ड का इस्तेमाल सिर्फ़ UpdateMembership में इनपुट के तौर पर किया जा सकता है.

create_time

Timestamp

ज़रूरी नहीं. इम्यूटेबल. सदस्यता बनाने का समय, जैसे कि किसी स्पेस में शामिल होने का न्योता या उसे स्पेस में शामिल होने का न्योता. यह फ़ील्ड सिर्फ़ आउटपुट के लिए है. इसका इस्तेमाल इंपोर्ट मोड वाले स्पेस में पुरानी सदस्यताओं को इंपोर्ट करने के लिए नहीं किया जाता.

delete_time

Timestamp

ज़रूरी नहीं. इम्यूटेबल. सदस्यता मिटाने का समय, जैसे कि किसी सदस्य ने स्पेस छोड़ा या उसे स्पेस से हटाया गया. यह फ़ील्ड सिर्फ़ आउटपुट के लिए है. इसका इस्तेमाल इंपोर्ट मोड वाले स्पेस में पुरानी सदस्यताओं को इंपोर्ट करने के लिए नहीं किया जाता.

यूनियन फ़ील्ड memberType. इस सदस्यता से जुड़ा सदस्य. आने वाले समय में, अन्य तरह के सदस्यों के लिए भी सुविधाएं उपलब्ध कराई जा सकती हैं. memberType इनमें से सिर्फ़ एक हो सकता है:
member

User

वह Google Chat उपयोगकर्ता या ऐप्लिकेशन जिससे सदस्यता ली गई है. अगर Chat ऐप्लिकेशन में उपयोगकर्ता के तौर पर पुष्टि की जाती है, तो आउटपुट उपयोगकर्ता name और type की जानकारी अपने-आप भर जाती है.

group_member

Group

वह Google ग्रुप जिससे सदस्यता जुड़ी है.

MembershipRole

चैट स्पेस में उपयोगकर्ता की अनुमति मिली कार्रवाइयां दिखाता है. आने वाले समय में, ईनम की और वैल्यू जोड़ी जा सकती हैं.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED डिफ़ॉल्ट मान. users के लिए: वे स्पेस के सदस्य नहीं हैं. हालांकि, उन्हें न्योता दिया जा सकता है. Google Groups के लिए: उन्हें यह भूमिका हमेशा असाइन की जाती है (इनम की अन्य वैल्यू का इस्तेमाल आने वाले समय में किया जा सकता है).
ROLE_MEMBER स्पेस का सदस्य. उपयोगकर्ता के पास बुनियादी अनुमतियां होती हैं. जैसे, स्पेस में मैसेज भेजना. 1:1 और बिना नाम वाली ग्रुप बातचीत में, सभी लोगों के पास यह भूमिका होती है.
ROLE_MANAGER स्पेस मैनेजर. उपयोगकर्ता के पास सभी बुनियादी अनुमतियां के साथ-साथ एडमिन की ऐसी अनुमतियां भी होती हैं जिनसे वह स्पेस को मैनेज कर सकता है. जैसे- सदस्यों को जोड़ना या हटाना. यह सुविधा सिर्फ़ SpaceType.SPACE में काम करती है.

MembershipState

स्पेस के साथ सदस्य के संबंध को बताता है. आने वाले समय में, पैसे चुकाकर ली जाने वाली सदस्यता की अन्य स्थितियों को भी इस्तेमाल किया जा सकता है.

Enums
MEMBERSHIP_STATE_UNSPECIFIED डिफ़ॉल्ट मान. इस्तेमाल न करें.
JOINED उपयोगकर्ता को स्पेस में जोड़ दिया गया है और वह स्पेस में हिस्सा ले सकता है.
INVITED उपयोगकर्ता को स्पेस में शामिल होने का न्योता मिला है, लेकिन वह उसमें शामिल नहीं हुआ है.
NOT_A_MEMBER उपयोगकर्ता, स्पेस का न हो और न ही उसके स्पेस में शामिल होने का न्योता स्वीकार किया गया हो.

MembershipBatchCreatedEventData

एक से ज़्यादा नई सदस्यताओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.batchCreated

फ़ील्ड
memberships[]

MembershipCreatedEventData

नई सदस्यताओं की सूची.

MembershipBatchDeletedEventData

मिटाई गई कई सदस्यताओं के लिए इवेंट पेलोड.

इवेंट प्रकार: google.workspace.chat.membership.v1.batchDeleted

फ़ील्ड
memberships[]

MembershipDeletedEventData

मिटाई गई सदस्यताओं की सूची.

MembershipBatchUpdatedEventData

अपडेट की गई एक से ज़्यादा सदस्यताओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.batchUpdated

फ़ील्ड
memberships[]

MembershipUpdatedEventData

अपडेट की गई सदस्यताओं की सूची.

MembershipCreatedEventData

नई सदस्यता के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.created.

फ़ील्ड
membership

Membership

नई सदस्यता.

MembershipDeletedEventData

मिटाई गई सदस्यता के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.deleted

फ़ील्ड
membership

Membership

मिटाई गई सदस्यता. सिर्फ़ name और state फ़ील्ड में जानकारी भरी जाती है.

MembershipUpdatedEventData

अपडेट की गई सदस्यता के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.updated

फ़ील्ड
membership

Membership

अपडेट की गई सदस्यता.

मैसेज

Google Chat पर मौजूद किसी स्पेस में कोई मैसेज.

फ़ील्ड
name

string

मैसेज में दिए गए संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/messages/{message}

जहां {space}, मैसेज पोस्ट किए जाने वाले स्पेस का आईडी होता है और {message} मैसेज के लिए, सिस्टम से असाइन किया गया आईडी होता है. उदाहरण के लिए, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

अगर मैसेज बनाते समय कस्टम आईडी सेट किया जाता है, तो अनुरोध में मैसेज की जानकारी देने के लिए इस आईडी का इस्तेमाल किया जा सकता है. इसके लिए, {message} को clientAssignedMessageId फ़ील्ड की वैल्यू से बदलें. उदाहरण के लिए, spaces/AAAAAAAAAAA/messages/client-custom-name. ज़्यादा जानकारी के लिए, मैसेज को नाम देना देखें.

sender

User

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने मैसेज बनाया है. अगर Chat ऐप्लिकेशन में उपयोगकर्ता के तौर पर पुष्टि की जाती है, तो आउटपुट उपयोगकर्ता name और type की जानकारी अपने-आप भर जाती है.

create_time

Timestamp

ज़रूरी नहीं. इम्यूटेबल. Chat में बनाए गए स्पेस के लिए, वह समय जब मैसेज बनाया गया था. यह फ़ील्ड सिर्फ़ आउटपुट के लिए है. हालांकि, इंपोर्ट मोड वाले स्पेस में इसका इस्तेमाल नहीं किया जाता.

इंपोर्ट मोड वाले स्पेस के लिए, इस फ़ील्ड को उस पुराने टाइमस्टैंप पर सेट करें जिस पर सोर्स में मैसेज बनाया गया था. ऐसा करने से, बनाए जाने का मूल समय सुरक्षित रहेगा.

last_update_time

Timestamp

सिर्फ़ आउटपुट के लिए. वह समय जब किसी उपयोगकर्ता ने मैसेज में आखिरी बार बदलाव किया था. अगर मैसेज में कभी कोई बदलाव नहीं किया गया है, तो यह फ़ील्ड खाली होता है.

delete_time

Timestamp

सिर्फ़ आउटपुट के लिए. Google Chat में मैसेज को मिटाने का समय. अगर मैसेज कभी मिटाया नहीं जाता है, तो यह फ़ील्ड खाली रहता है.

text

string

मैसेज का सामान्य टेक्स्ट. किसी इमेज, वीडियो या वेब पेज का पहला लिंक, झलक दिखाने वाला चिप जनरेट करता है. आपके पास Google Chat के किसी उपयोगकर्ता का नाम या स्पेस के सभी सदस्यों का नाम टैग करने का विकल्प भी होता है.

मैसेज बनाने के बारे में जानने के लिए, मैसेज भेजना देखें.

formatted_text

string

सिर्फ़ आउटपुट के लिए. इसमें text मैसेज शामिल होता है. इसमें फ़ॉर्मैटिंग के बारे में बताने के लिए मार्कअप जोड़े गए हैं. ऐसा हो सकता है कि यह फ़ील्ड, यूज़र इंटरफ़ेस (यूआई) में दिखने वाले सभी फ़ॉर्मैट को कैप्चर न करे. हालांकि, इसमें ये चीज़ें शामिल होती हैं:

  • बोल्ड, इटैलिक, स्ट्राइकथ्रू, मोनोस्पेस, मोनोस्पेस ब्लॉक, और बुलेट वाली सूची के लिए मार्कअप सिंटैक्स.

  • <users/{user}> फ़ॉर्मैट का इस्तेमाल करके, उपयोगकर्ता ने टैग किया.

  • <{url}|{rendered_text}> फ़ॉर्मैट का इस्तेमाल करने वाले कस्टम हाइपरलिंक. इनमें पहली स्ट्रिंग यूआरएल और दूसरी रेंडर किया गया टेक्स्ट होती है. उदाहरण के लिए, <http://example.com|custom text>.

  • :{emoji_name}: फ़ॉर्मैट का इस्तेमाल करके, पसंद के मुताबिक इमोजी बनाना—उदाहरण के लिए, :smile:. यह यूनिकोड इमोजी पर लागू नहीं होता है, जैसे कि मुस्कुराते हुए चेहरे वाले इमोजी के लिए U+1F600.

ज़्यादा जानकारी के लिए, मैसेज में भेजा गया टेक्स्ट का फ़ॉर्मैट देखना लेख पढ़ें

cards[]
(deprecated)

Card

अब काम नहीं करता: इसके बजाय, cards_v2 का इस्तेमाल करें.

रिच, फ़ॉर्मैट किए गए, और इंटरैक्टिव कार्ड जिनका इस्तेमाल यूज़र इंटरफ़ेस (यूआई) एलिमेंट दिखाने के लिए किया जा सकता है. जैसे: फ़ॉर्मैट किए गए टेक्स्ट, बटन, और क्लिक की जा सकने वाली इमेज. कार्ड आम तौर पर, मैसेज में सामान्य टेक्स्ट के नीचे दिखाए जाते हैं. cards और cards_v2 का साइज़ ज़्यादा से ज़्यादा 32 केबी हो सकता है.

cards_v2[]

CardWithId

कार्ड का कलेक्शन.

सिर्फ़ चैट ऐप्लिकेशन के लिए कार्ड बनाए जा सकते हैं. अगर आपका Chat ऐप्लिकेशन उपयोगकर्ता के तौर पर पुष्टि करता है, तो मैसेज में कार्ड शामिल नहीं किए जा सकते.

कार्ड और उन्हें बनाने के बारे में जानने के लिए, कार्ड मैसेज भेजना लेख पढ़ें.

कार्ड बिल्डर की मदद से कार्ड डिज़ाइन करना और उनकी झलक देखना.

कार्ड बिल्डर खोलें

annotations[]

Annotation

सिर्फ़ आउटपुट के लिए. इस मैसेज में मौजूद text से जुड़ी जानकारी.

thread

Thread

वह थ्रेड जिससे मैसेज जुड़ा है. इस्तेमाल के उदाहरण के लिए, मैसेज थ्रेड शुरू करना या उसका जवाब देना देखें.

space

Space

अगर Chat ऐप्लिकेशन उपयोगकर्ता के तौर पर पुष्टि करता है, तो आउटपुट, स्पेस name में जानकारी अपने-आप भर जाता है.

fallback_text

string

मैसेज के कार्ड के बारे में सामान्य टेक्स्ट में जानकारी, जिसका इस्तेमाल तब किया जाता है, जब असल कार्ड नहीं दिखाए जा सकते—उदाहरण के लिए, मोबाइल सूचनाएं.

action_response

ActionResponse

सिर्फ़ इनपुट. ऐसे पैरामीटर जिनका इस्तेमाल करके Chat ऐप्लिकेशन, अपने जवाब को पोस्ट करने के तरीके को कॉन्फ़िगर कर सकता है.

argument_text

string

सिर्फ़ आउटपुट के लिए. मैसेज में सामान्य टेक्स्ट वाला हिस्सा, जिसमें Chat ऐप्लिकेशन के सभी टैग हटा दिए गए हैं.

slash_command

SlashCommand

सिर्फ़ आउटपुट के लिए. अगर लागू हो, तो स्लैश कमांड की जानकारी.

attachment[]

Attachment

उपयोगकर्ता का अपलोड किया गया अटैचमेंट.

matched_url

MatchedUrl

सिर्फ़ आउटपुट के लिए. spaces.messages.text में मौजूद यूआरएल, जो लिंक की झलक दिखाने वाले पैटर्न से मेल खाता है. ज़्यादा जानकारी के लिए, झलक के लिंक देखें.

thread_reply

bool

सिर्फ़ आउटपुट के लिए. true पर मिलने वाला मैसेज, जवाब के थ्रेड में जवाब के तौर पर दिखता है. false पर, स्पेस की टॉप-लेवल बातचीत में कोई मैसेज, थ्रेड के पहले मैसेज या थ्रेड वाले जवाब की सुविधा वाले मैसेज के तौर पर दिखता है.

अगर स्पेस में थ्रेड में जवाब देने की सुविधा उपलब्ध नहीं है, तो यह फ़ील्ड हमेशा false होता है.

client_assigned_message_id

string

ज़रूरी नहीं. मैसेज के लिए कस्टम आईडी. मैसेज की पहचान करने के लिए या मैसेज को पाने, मिटाने या अपडेट करने के लिए, फ़ील्ड का इस्तेमाल किया जा सकता है. कस्टम आईडी सेट करने के लिए, मैसेज बनाते समय messageId फ़ील्ड में वैल्यू डालें. ज़्यादा जानकारी के लिए, मैसेज को नाम देना देखें.

emoji_reaction_summaries[]

EmojiReactionSummary

सिर्फ़ आउटपुट के लिए. मैसेज पर, इमोजी से दी गई खास जानकारी की सूची.

private_message_viewer

User

इम्यूटेबल. मैसेज बनाने के लिए इनपुट डालें, नहीं तो सिर्फ़ आउटपुट देगा. वह उपयोगकर्ता जो मैसेज देख सकता है. सेट किया जाने पर, मैसेज निजी रहता है और सिर्फ़ चुने गए उपयोगकर्ता और Chat ऐप्लिकेशन को दिखता है. निजी मैसेज में लिंक की झलक और अटैचमेंट काम नहीं करते.

सिर्फ़ चैट ऐप्लिकेशन ही निजी मैसेज भेज सकते हैं. अगर आपका Chat ऐप्लिकेशन, मैसेज भेजने के लिए उपयोगकर्ता के तौर पर पुष्टि करता है, तो मैसेज को निजी नहीं बनाया जा सकता. इसलिए, आपको इस फ़ील्ड में मौजूद मैसेज को शामिल नहीं करना चाहिए.

ज़्यादा जानकारी के लिए, Google Chat इस्तेमाल करने वाले लोगों को निजी मैसेज भेजना लेख पढ़ें.

deletion_metadata

DeletionMetadata

सिर्फ़ आउटपुट के लिए. मिटाए गए मैसेज के बारे में जानकारी. delete_time के सेट होने पर मैसेज को मिटा दिया जाता है.

quoted_message_metadata

QuotedMessageMetadata

सिर्फ़ आउटपुट के लिए. स्पेस में Google Chat का इस्तेमाल करने वाले व्यक्ति ने मैसेज के बारे में जानकारी दी है. Google Chat का इस्तेमाल करने वाले लोग, किसी मैसेज का जवाब देने के लिए उसे कोट कर सकते हैं.

attached_gifs[]

AttachedGif

सिर्फ़ आउटपुट के लिए. मैसेज से अटैच की गई GIF इमेज.

accessory_widgets[]

AccessoryWidget

एक या इससे ज़्यादा इंटरैक्टिव विजेट, जो मैसेज के निचले हिस्से में दिखते हैं. आपके पास टेक्स्ट, कार्ड या टेक्स्ट और कार्ड दोनों वाले मैसेज के लिए ऐक्सेसरी विजेट जोड़ने का विकल्प होता है. यह सुविधा, डायलॉग बॉक्स वाले मैसेज के लिए उपलब्ध नहीं है. ज़्यादा जानकारी के लिए, मैसेज के निचले हिस्से में इंटरैक्टिव विजेट जोड़ना लेख पढ़ें.

ऐक्सेसरी विजेट से मैसेज बनाने के लिए, ऐप्लिकेशन की पुष्टि करना ज़रूरी है.

MessageBatchCreatedEventData

एक से ज़्यादा नए मैसेज के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.batchCreated

फ़ील्ड
messages[]

MessageCreatedEventData

नए मैसेज की सूची.

MessageBatchDeletedEventData

मिटाए गए एक से ज़्यादा मैसेज का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.batchDeleted

फ़ील्ड
messages[]

MessageDeletedEventData

मिटाए गए मैसेज की सूची.

MessageBatchUpdatedEventData

अपडेट किए गए एक से ज़्यादा मैसेज के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.batchUpdated

फ़ील्ड
messages[]

MessageUpdatedEventData

अपडेट किए गए मैसेज की सूची.

MessageCreatedEventData

नए मैसेज के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.created

फ़ील्ड
message

Message

नया मैसेज.

MessageDeletedEventData

मिटाए गए मैसेज का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.deleted

फ़ील्ड
message

Message

मिटाया गया मैसेज. सिर्फ़ name, createTime, deleteTime, और deletionMetadata फ़ील्ड में जानकारी भरी जाती है.

MessageUpdatedEventData

अपडेट किए गए मैसेज का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.updated

फ़ील्ड
message

Message

अपडेट किया गया मैसेज.

QuotedMessageMetadata

कोट किए हुए मैसेज की जानकारी.

फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. कोट किए गए मैसेज के संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/messages/{message}

last_update_time

Timestamp

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब कोट किया गया मैसेज बनाया गया था या जब कोट किया गया मैसेज पिछली बार अपडेट किया गया था.

प्रतिक्रिया

किसी मैसेज पर दी गई प्रतिक्रिया.

फ़ील्ड
name

string

प्रतिक्रिया के संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिसने प्रतिक्रिया दी है.

emoji

Emoji

वह इमोजी जिसका इस्तेमाल प्रतिक्रिया में किया गया है.

ReactionBatchCreatedEventData

कई नई प्रतिक्रियाओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.batchCreated

फ़ील्ड
reactions[]

ReactionCreatedEventData

नई प्रतिक्रियाओं की सूची.

ReactionBatchDeletedEventData

मिटाई गई कई प्रतिक्रियाओं का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.batchDeleted

फ़ील्ड
reactions[]

ReactionDeletedEventData

मिटाई गई प्रतिक्रियाओं की सूची.

ReactionCreatedEventData

नई प्रतिक्रिया के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.created

फ़ील्ड
reaction

Reaction

नई प्रतिक्रिया.

ReactionDeletedEventData

मिटाई गई प्रतिक्रिया का इवेंट पेलोड.

कैंपेन किस तरह का है: google.workspace.chat.reaction.v1.deleted

फ़ील्ड
reaction

Reaction

मिटाई गई प्रतिक्रिया.

RichLinkMetadata

किसी संसाधन का रिच लिंक.

फ़ील्ड
uri

string

इस लिंक का यूआरआई.

यूनियन फ़ील्ड data. लिंक किए गए संसाधन का डेटा. data इनमें से सिर्फ़ एक हो सकता है:

RichLinkType

रिच लिंक का टाइप. आने वाले समय में, इसमें और टाइप जोड़े जा सकते हैं.

Enums
DRIVE_FILE Google Drive का रिच लिंक.
CHAT_SPACE चैट स्पेस के लिए रिच लिंक टाइप. उदाहरण के लिए, स्पेस की सुविधा देने वाला स्मार्ट चिप.

SearchSpacesRequest

क्वेरी के आधार पर स्पेस की सूची खोजने का अनुरोध करें.

फ़ील्ड
use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.spaces.readonly या chat.admin.spaces OAuth 2.0 स्कोप की ज़रूरत होती है.

फ़िलहाल, इस तरीके से सिर्फ़ एडमिन ऐक्सेस काम करता है. इसलिए, इस फ़ील्ड के लिए सिर्फ़ true को स्वीकार किया जाता है.

page_size

int32

लौटाए जाने वाले स्पेस की ज़्यादा से ज़्यादा संख्या. सेवा इस वैल्यू से कम वैल्यू दिखा सकती है.

अगर कोई वैल्यू न दी गई हो, तो ज़्यादा से ज़्यादा 100 स्पेस लौटाए जाते हैं.

ज़्यादा से ज़्यादा वैल्यू 1,000 है. अगर 1,000 से ज़्यादा वैल्यू का इस्तेमाल किया जाता है, तो वह अपने-आप 1,000 में बदल जाता है.

page_token

string

सर्च स्पेस के पिछले कॉल से मिला टोकन. बाद वाले पेज को फिर से पाने के लिए यह पैरामीटर दें.

पेजों पर नंबर डालते समय, दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मैच होने चाहिए. दूसरे पैरामीटर के लिए अलग-अलग वैल्यू पास करने पर, अनचाहे नतीजे मिल सकते हैं.

query

string

ज़रूरी है. एक खोज क्वेरी.

इन पैरामीटर का इस्तेमाल करके, जानकारी खोजी जा सकती है:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time और last_active_time, RFC-3339 फ़ॉर्मैट में टाइमस्टैंप स्वीकार करते हैं. साथ ही, तुलना करने वाले इन ऑपरेटर का इस्तेमाल किया जा सकता है: =, <, >, <=, >=.

customer ज़रूरी है. इसका इस्तेमाल यह बताने के लिए किया जाता है कि किस ग्राहक से स्पेस फ़ेच करने हैं. सिर्फ़ customers/my_customer वैल्यू इस्तेमाल की जा सकती है.

display_name सिर्फ़ HAS (:) ऑपरेटर को स्वीकार करता है. मैच किए जाने वाले टेक्स्ट को सबसे पहले, टोकन में टोकन के तौर पर टोकन किया जाता है. हर टोकन, स्पेस के display_name में कहीं भी सबस्ट्रिंग के तौर पर, केस-इनसेंसिटिव (बड़े और छोटे अक्षरों में अंतर) के तौर पर प्रीफ़िक्स का इस्तेमाल करता है. उदाहरण के लिए, Fun Eve, Fun event या The evening was fun से मेल खाता है, लेकिन notFun event या even से नहीं.

external_user_allowed, true या false को स्वीकार करता है.

space_history_state सिर्फ़ space संसाधन के historyState फ़ील्ड से वैल्यू स्वीकार करता है.

space_type ज़रूरी है और सिर्फ़ SPACE मान्य मान है.

अलग-अलग फ़ील्ड में, सिर्फ़ AND ऑपरेटर काम करते हैं. space_type = "SPACE" AND display_name:"Hello" सही उदाहरण है और space_type = "SPACE" OR display_name:"Hello" अमान्य उदाहरण है.

इसी फ़ील्ड में, space_type पर AND या OR ऑपरेटर काम नहीं करते. display_name, 'space_history_state', और 'external_user_allowed' सिर्फ़ OR ऑपरेटर के साथ काम किया जा सकता है. last_active_time और create_time, AND और OR, दोनों ऑपरेटर के साथ काम करते हैं. AND का इस्तेमाल सिर्फ़ किसी इंटरवल को दिखाने के लिए किया जा सकता है, जैसे कि last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

उदाहरण के तौर पर, यहां दी गई क्वेरी मान्य हैं:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

ज़रूरी नहीं. स्पेस की सूची को क्रम से लगाने का तरीका.

इसके हिसाब से क्रम में लगाने के लिए, ये एट्रिब्यूट इस्तेमाल किए जा सकते हैं:

  • membership_count.joined_direct_human_user_count — स्पेस में सीधे तौर पर शामिल हुए, उपयोगकर्ताओं की संख्या दिखाता है.
  • last_active_time — इससे यह पता चलता है कि इस स्पेस में किसी विषय के लिए, ज़रूरी शर्तें पूरी करने वाले आखिरी आइटम को कब जोड़ा गया था.
  • create_time — स्पेस बनाने का समय दिखाता है.

ऑर्डर करने के मान्य ऑपरेशन मान ये हैं:

  • बढ़ते क्रम में लगाने के लिए ASC. डिफ़ॉल्ट मान.

  • घटते क्रम में लगाने के लिए, DESC.

इस्तेमाल किए जा सकने वाले सिंटैक्स हैं:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

खोज स्पेस के अनुरोध से जुड़े स्पेस की सूची की मदद से जवाब दें.

फ़ील्ड
spaces[]

Space

अनुरोध किए गए स्पेस का पेज.

next_page_token

string

एक टोकन, जिसका इस्तेमाल अगले पेज को फिर से पाने के लिए किया जा सकता है. अगर यह फ़ील्ड खाली है, तो इसके बाद कोई पेज नहीं होता.

total_size

int32

सभी पेजों पर, क्वेरी से मैच करने वाले स्पेस की कुल संख्या. अगर नतीजे में 10,000 से ज़्यादा स्पेस हैं, तो यह एक अनुमानित वैल्यू होती है.

SetUpSpaceRequest

स्पेस बनाने और उसमें चुनिंदा लोगों को जोड़ने का अनुरोध करें.

फ़ील्ड
space

Space

ज़रूरी है. Space.spaceType फ़ील्ड में वैल्यू डालना ज़रूरी है.

स्पेस बनाने के लिए, Space.spaceType को SPACE पर सेट करें. इसके बाद, Space.displayName को सेट करें. अगर स्पेस सेट अप करते समय आपको गड़बड़ी का मैसेज ALREADY_EXISTS मिलता है, तो किसी दूसरे displayName का इस्तेमाल करें. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

ग्रुप चैट बनाने के लिए, Space.spaceType को GROUP_CHAT पर सेट करें. Space.displayName को सेट न करें.

लोगों के बीच 1:1 बातचीत करने के लिए, Space.spaceType को DIRECT_MESSAGE पर सेट करें. साथ ही, Space.singleUserBotDm को false पर सेट करें. Space.displayName या Space.spaceDetails सेट न करें.

किसी व्यक्ति और कॉल के लिए इस्तेमाल किए जा रहे Chat ऐप्लिकेशन के बीच 1:1 बातचीत शुरू करने के लिए, Space.spaceType को DIRECT_MESSAGE पर और Space.singleUserBotDm को true पर सेट करें. Space.displayName या Space.spaceDetails सेट न करें.

अगर DIRECT_MESSAGE स्पेस पहले से मौजूद है, तो नया स्पेस बनाने के बजाय उसे वापस भेज दिया जाता है.

request_id

string

ज़रूरी नहीं. इस अनुरोध के लिए यूनीक आइडेंटिफ़ायर. हमारा सुझाव है कि आप रैंडम यूयूआईडी का इस्तेमाल करें. मौजूदा अनुरोध आईडी तय करने पर, नया स्पेस बनाने के बजाय उस आईडी से बनाया गया स्पेस दिखता है. पुष्टि किए गए किसी दूसरे उपयोगकर्ता के साथ, उसी Chat ऐप्लिकेशन के मौजूदा अनुरोध आईडी को बताने पर गड़बड़ी वाला मैसेज दिखता है.

memberships[]

Membership

ज़रूरी नहीं. Google Chat के ऐसे उपयोगकर्ता या ग्रुप जिन्हें स्पेस में शामिल होने का न्योता भेजना है. कॉल करने वाले उपयोगकर्ताओं को हटाएं, क्योंकि वे अपने-आप जुड़ जाते हैं.

फ़िलहाल, इस सेट में कॉलर के अलावा 20 सदस्यताएं ली जा सकती हैं.

लोगों के लिए, Membership.member फ़ील्ड में user डालना ज़रूरी है. इसमें name की जानकारी अपने-आप दी जानी चाहिए (फ़ॉर्मैट: users/{user}) और type को User.Type.HUMAN पर सेट किया जाना चाहिए. स्पेस सेट अप करते समय, सिर्फ़ लोगों को जोड़ा जा सकता है. हालांकि, Chat ऐप्लिकेशन को, कॉल करने वाले ऐप्लिकेशन के साथ डायरेक्ट मैसेज की सुविधा सेटअप करने के लिए ही इस्तेमाल किया जा सकता है. आपके पास {user} के लिए, उपयोगकर्ता के ईमेल उपनाम का इस्तेमाल करके भी सदस्यों को जोड़ने का विकल्प है. उदाहरण के लिए, user.name को users/example@gmail.com हो सकता है. Gmail के उपयोगकर्ताओं या संगठन से बाहर के Google Workspace डोमेन के उपयोगकर्ताओं को न्योता भेजने के लिए, उपयोगकर्ता के ईमेल पते का इस्तेमाल {user} के लिए करना ज़रूरी है.

Google ग्रुप की सदस्यता के लिए, Membership.group_member फ़ील्ड में group का अपने-आप भरा हुआ name होना चाहिए (फ़ॉर्मैट groups/{group}). Space.spaceType को SPACE पर सेट करने पर ही, Google ग्रुप जोड़े जा सकते हैं.

Space.spaceType को SPACE पर सेट करते समय ज़रूरी नहीं है.

Space.spaceType को GROUP_CHAT पर सेट करने के लिए ज़रूरी है. साथ ही, कम से कम दो सदस्यताएं होनी चाहिए.

किसी उपयोगकर्ता के साथ, Space.spaceType को DIRECT_MESSAGE पर सेट करने के लिए ज़रूरी है. साथ ही, सिर्फ़ एक सदस्यता का इस्तेमाल करना ज़रूरी है.

किसी व्यक्ति और कॉल के लिए इस्तेमाल किए जाने वाले Chat ऐप्लिकेशन के बीच 1:1 बातचीत शुरू करते समय, इस फ़ील्ड को खाली छोड़ा जाना चाहिए. ऐसा तब होता है, जब Space.spaceType को DIRECT_MESSAGE और Space.singleUserBotDm को true पर सेट किया जा रहा हो.

SlashCommand

Google Chat में स्लैश कमांड.

फ़ील्ड
command_id

int64

स्लैश कमांड का आईडी शुरू किया गया.

SlashCommandMetadata

स्लैश कमांड (/) के लिए एनोटेशन मेटाडेटा.

फ़ील्ड
bot

User

वह Chat ऐप्लिकेशन जिसका निर्देश दिया गया था.

type

Type

स्लैश कमांड का टाइप.

command_name

string

शुरू किए गए स्लैश कमांड का नाम.

command_id

int64

शुरू किए गए स्लैश कमांड का कमांड आईडी.

triggers_dialog

bool

यह बताता है कि स्लैश कमांड डायलॉग के लिए है या नहीं.

टाइप

Enums
TYPE_UNSPECIFIED Enum के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
ADD स्पेस में Chat ऐप्लिकेशन जोड़ें.
INVOKE स्पेस में स्लैश कमांड शुरू करें.

स्पेस

Google Chat में कोई स्पेस. स्पेस, दो या उससे ज़्यादा उपयोगकर्ताओं के बीच होने वाली बातचीत या किसी उपयोगकर्ता और Chat ऐप्लिकेशन के बीच 1:1 मैसेज होते हैं.

फ़ील्ड
name

string

स्पेस में मौजूद संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}

type
(deprecated)

Type

सिर्फ़ आउटपुट के लिए. अब काम नहीं करता: इसके बजाय, space_type का इस्तेमाल करें. स्पेस का टाइप.

space_type

SpaceType

स्पेस का टाइप. स्पेस बनाते समय या स्पेस टाइप अपडेट करते समय इसका इस्तेमाल करना ज़रूरी है. सिर्फ़ दूसरे इस्तेमाल के लिए आउटपुट.

single_user_bot_dm

bool

ज़रूरी नहीं. क्या स्पेस, Chat ऐप्लिकेशन और किसी एक इंसान के बीच का कोई डायरेक्ट मैसेज है.

threaded
(deprecated)

bool

सिर्फ़ आउटपुट के लिए. अब काम नहीं करता: इसके बजाय, spaceThreadingState का इस्तेमाल करें. इस स्पेस में मैसेज थ्रेड हैं या नहीं.

display_name

string

स्पेस का डिसप्ले नेम. स्पेस बनाते समय ज़रूरी है. अगर आपको स्पेस बनाते समय या displayName अपडेट करते समय ALREADY_EXISTS गड़बड़ी का मैसेज मिलता है, तो कोई दूसरा displayName आज़माएं. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

डायरेक्ट मैसेज के लिए, यह फ़ील्ड खाली हो सकता है.

ज़्यादा से ज़्यादा 128 वर्णों का इस्तेमाल किया जा सकता है.

external_user_allowed

bool

इम्यूटेबल. इस स्पेस में, Google Chat का इस्तेमाल करने वाले किसी भी व्यक्ति को सदस्य के तौर पर अनुमति दी जाएगी या नहीं. Google Workspace का इस्तेमाल करने वाले संगठन में स्पेस बनाते समय इनपुट दें. इन शर्तों में स्पेस बनाते समय, इस फ़ील्ड को छोड़ दें:

  • पुष्टि किया गया उपयोगकर्ता, उपभोक्ता खाते (मैनेज नहीं किया जा रहा उपयोगकर्ता खाता) का इस्तेमाल करता है. डिफ़ॉल्ट रूप से, उपभोक्ता खाते से बनाया गया स्पेस, Google Chat के किसी भी उपयोगकर्ता को अनुमति देता है.

मौजूदा स्पेस के लिए, यह फ़ील्ड सिर्फ़ आउटपुट के लिए है.

space_threading_state

SpaceThreadingState

सिर्फ़ आउटपुट के लिए. चैट स्पेस में थ्रेड की स्थिति.

space_details

SpaceDetails

स्पेस के बारे में जानकारी. इसमें स्पेस का ब्यौरा और नियम भी शामिल हैं.

space_history_state

HistoryState

इस स्पेस में मौजूद मैसेज और थ्रेड के मैसेज के इतिहास की स्थिति.

import_mode

bool

ज़रूरी नहीं. Import Mode में यह स्पेस, Google Workspace में डेटा माइग्रेट करने की वजह से बनाया गया है या नहीं. स्पेस इंपोर्ट किए जाने के दौरान, इंपोर्ट पूरा होने तक उपयोगकर्ताओं को ये नहीं दिखते.

create_time

Timestamp

ज़रूरी नहीं. इम्यूटेबल. Chat में बनाए गए स्पेस के बनाए जाने का समय. यह फ़ील्ड सिर्फ़ आउटपुट के लिए है. हालांकि, इंपोर्ट मोड वाले स्पेस में इसका इस्तेमाल नहीं किया जाता.

इंपोर्ट मोड वाले स्पेस के लिए, इस फ़ील्ड को उस पुराने टाइमस्टैंप पर सेट करें जिस पर सोर्स में स्पेस बनाया गया था. ऐसा करने से, स्पेस बनाने का मूल समय सुरक्षित रहता है.

आउटपुट में सिर्फ़ तब अपने-आप जानकारी भर जाती है, जब spaceType, GROUP_CHAT या SPACE पर सेट होती है.

last_active_time

Timestamp

सिर्फ़ आउटपुट के लिए. स्पेस में, आखिरी मैसेज का टाइमस्टैंप.

admin_installed

bool

सिर्फ़ आउटपुट के लिए. Chat ऐप्लिकेशन वाले डायरेक्ट मैसेज (DM) वाले स्पेस के लिए, यह जानकारी ज़रूरी है कि स्पेस को Google Workspace एडमिन ने बनाया है या नहीं. एडमिन अपने संगठन के उपयोगकर्ताओं की ओर से, Chat ऐप्लिकेशन पर डायरेक्ट मैसेज इंस्टॉल कर सकते हैं. साथ ही, उन्हें सेट अप कर सकते हैं.

एडमिन इंस्टॉल करने की सुविधा देने के लिए, आपके Chat ऐप्लिकेशन में डायरेक्ट मैसेज की सुविधा होनी चाहिए.

membership_count

MembershipCount

सिर्फ़ आउटपुट के लिए. पैसे चुकाकर बने सदस्यों की संख्या, जिसे सदस्य के टाइप के हिसाब से ग्रुप में बांटा गया है. space_type के SPACE, DIRECT_MESSAGE या GROUP_CHAT होने पर जानकारी अपने-आप भर जाती है.

access_settings

AccessSettings

ज़रूरी नहीं. यह स्पेस की ऐक्सेस सेटिंग के बारे में बताता है. space_type के SPACE होने पर ही जानकारी अपने-आप भर जाती है.

space_uri

string

सिर्फ़ आउटपुट के लिए. स्पेस को ऐक्सेस करने के लिए, उपयोगकर्ता का यूआरआई.

यूनियन फ़ील्ड space_permission_settings. यह किसी स्पेस की अनुमति की सेटिंग दिखाता है. space_type के SPACE होने पर ही जानकारी अपने-आप भर जाती है. space_permission_settings इनमें से सिर्फ़ एक हो सकता है:
predefined_permission_settings

PredefinedPermissionSettings

ज़रूरी नहीं. सिर्फ़ इनपुट. स्पेस की अनुमति से जुड़ी सेटिंग. स्पेस बनाने के लिए इनपुट. अगर यह फ़ील्ड सेट नहीं है, तो मिलकर काम करने के लिए स्पेस बन जाता है. स्पेस बनाने के बाद, सेटिंग की जानकारी PermissionSettings फ़ील्ड में अपने-आप भर जाती है.

permission_settings

PermissionSettings

ज़रूरी नहीं. अनुमति से जुड़ी सटीक सेटिंग, जिन्हें स्पेस को अपडेट करने के लिए सेट किया जा सकता है. स्पेस को अपडेट करने के लिए इनपुट. अगर ऐसा नहीं है, तो सिर्फ़ आउटपुट के लिए. स्पेस बनाने के लिए, इसके बजाय predefined_permission_settings का इस्तेमाल करें.

AccessSettings

इससे स्पेस की ऐक्सेस सेटिंग दिखती है.

फ़ील्ड
access_state

AccessState

सिर्फ़ आउटपुट के लिए. इससे स्पेस के ऐक्सेस की स्थिति के बारे में पता चलता है.

audience

string

ज़रूरी नहीं. टारगेट ऑडियंस के संसाधन का नाम, जो स्पेस को खोज सकती है, उसमें शामिल हो सकती है, और स्पेस में मैसेज की झलक देख सकती है. अगर इस नीति को सेट नहीं किया जाता है, तो स्पेस में शामिल किए गए या व्यक्तिगत तौर पर न्योता दिए गए लोग या Google ग्रुप ही इसे ऐक्सेस कर सकते हैं. ज़्यादा जानकारी के लिए, टारगेट ऑडियंस के लिए, स्पेस को खोजे जाने लायक बनाना लेख पढ़ें.

फ़ॉर्मैट: audiences/{audience}

अगर आपको Google Workspace संगठन के लिए, डिफ़ॉल्ट टारगेट ऑडियंस का इस्तेमाल करना है, तो audiences/default पर सेट करें.

AccessState

इससे स्पेस के ऐक्सेस की स्थिति के बारे में पता चलता है.

Enums
ACCESS_STATE_UNSPECIFIED इस एपीआई में ऐक्सेस की स्थिति की जानकारी नहीं है या यह जानकारी मौजूद नहीं है.
PRIVATE सिर्फ़ वे उपयोगकर्ता या Google ग्रुप, स्पेस को खोज सकते हैं और ऐक्सेस कर सकते हैं जिन्हें दूसरे उपयोगकर्ताओं या Google Workspace एडमिन ने व्यक्तिगत तौर पर जोड़ा है या न्योता भेजा है.
DISCOVERABLE स्पेस मैनेजर ने, टारगेट ऑडियंस को इस स्पेस का ऐक्सेस दिया है. जिन उपयोगकर्ताओं या Google ग्रुप को स्पेस में अलग-अलग जोड़ा गया है या जिनमें शामिल होने का न्योता भेजा गया है वे स्पेस को खोज सकते हैं और उसे ऐक्सेस कर सकते हैं. ज़्यादा जानने के लिए, स्पेस को कुछ खास उपयोगकर्ताओं के लिए उपलब्ध कराना लेख पढ़ें.

MembershipCount

इससे किसी स्पेस में मौजूद सदस्यों की संख्या के बारे में पता चलता है. इसके लिए, इन सदस्यों को कैटगरी में बांटा जाता है.

फ़ील्ड
joined_direct_human_user_count

int32

ऐसे लोगों की संख्या जो स्पेस में सीधे तौर पर शामिल हुए हैं. हालांकि, इसमें उन लोगों की गिनती नहीं की जाती है जो किसी ग्रुप में शामिल होने के बावजूद स्पेस में शामिल हुए हैं.

joined_group_count

int32

स्पेस में सीधे तौर पर शामिल होने वाले सभी ग्रुप की संख्या.

PermissionSetting

यह स्पेस की अनुमति की सेटिंग दिखाता है.

फ़ील्ड
managers_allowed

bool

स्पेस के मैनेजर के पास यह अनुमति है या नहीं.

members_allowed

bool

क्या नॉन-मैनेजर सदस्यों के पास यह अनुमति है.

PermissionSettings

नाम वाले स्पेस के लिए, अनुमति की सेटिंग. स्पेस बनाते समय अनुमति की सेटिंग को सेट करने के लिए, अपने अनुरोध में PredefinedPermissionSettings फ़ील्ड के बारे में बताएं.

फ़ील्ड
manage_members_and_groups

PermissionSetting

स्पेस में सदस्यों और ग्रुप को मैनेज करने की सेटिंग.

modify_space_details

PermissionSetting

स्पेस का नाम, अवतार, ब्यौरा, और दिशा-निर्देशों को अपडेट करने के लिए सेटिंग.

toggle_history

PermissionSetting

स्पेस के इतिहास को चालू और बंद करने की सेटिंग.

use_at_mention_all

PermissionSetting

स्पेस में @all का इस्तेमाल करने की सेटिंग.

manage_apps

PermissionSetting

स्पेस में ऐप्लिकेशन मैनेज करने की सेटिंग.

manage_webhooks

PermissionSetting

स्पेस में वेबहुक मैनेज करने की सेटिंग.

post_messages

PermissionSetting

सिर्फ़ आउटपुट के लिए. स्पेस में मैसेज पोस्ट करने की सेटिंग.

reply_messages

PermissionSetting

स्पेस में मैसेज का जवाब देने के लिए सेटिंग.

PredefinedPermissionSettings

स्पेस की अनुमति से जुड़ी सेटिंग. इन्हें नाम वाला स्पेस बनाते समय तय किया जा सकता है. आने वाले समय में, और भी सेटिंग जोड़ी जा सकती हैं. नाम वाले स्पेस के लिए अनुमति की सेटिंग के बारे में जानने के लिए, स्पेस के बारे में जानें लेख पढ़ें.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED नहीं बताया गया है इस्तेमाल न करें.
COLLABORATION_SPACE स्पेस को दूसरों के साथ मिलकर काम करने के लिए बनाए जाने वाले स्पेस के तौर पर सेट किया जा रहा है, जहां सभी सदस्य मैसेज पोस्ट कर सकते हैं.
ANNOUNCEMENT_SPACE इस स्पेस को सूचना ब्रॉडकास्ट करने के लिए सेट किया गया है. इसमें स्पेस मैनेजर ही मैसेज पोस्ट कर सकते हैं.

SpaceDetails

स्पेस के बारे में जानकारी. इसमें स्पेस का ब्यौरा और नियम भी शामिल हैं.

फ़ील्ड
description

string

ज़रूरी नहीं. स्पेस का ब्यौरा. उदाहरण के लिए, स्पेस में चर्चा करने के विषय, उसके काम करने के मकसद या मीटिंग में हिस्सा लेने वाले लोगों के बारे में बताएं.

ज़्यादा से ज़्यादा 150 वर्णों का इस्तेमाल किया जा सकता है.

guidelines

string

ज़रूरी नहीं. स्पेस के नियम, उम्मीदें, और विनम्रता.

ज़्यादा से ज़्यादा 5,000 वर्णों का इस्तेमाल किया जा सकता है.

SpaceThreadingState

यह बताता है कि चैट स्पेस में किस तरह की थ्रेड की स्थिति है.

Enums
SPACE_THREADING_STATE_UNSPECIFIED रिज़र्व किया गया.
THREADED_MESSAGES नाम वाले ऐसे स्पेस जिनमें मैसेज थ्रेड की सुविधा काम करती है. जब उपयोगकर्ता किसी मैसेज का जवाब देते हैं, तो वे थ्रेड में जवाब दे सकते हैं. इससे उनका जवाब मूल मैसेज के कॉन्टेक्स्ट के हिसाब से रहता है.
GROUPED_MESSAGES नाम वाले स्पेस, जहां बातचीत को विषय के हिसाब से व्यवस्थित किया जाता है. विषय और उनके जवाबों को एक साथ रखा जाता है.
UNTHREADED_MESSAGES दो लोगों के बीच डायरेक्ट मैसेज (DM) और तीन या उससे ज़्यादा लोगों के बीच होने वाली ग्रुप बातचीत.

SpaceType

स्पेस का टाइप. स्पेस बनाते या अपडेट करते समय इसका इस्तेमाल करना ज़रूरी है. सिर्फ़ दूसरे इस्तेमाल के लिए आउटपुट.

Enums
SPACE_TYPE_UNSPECIFIED रिज़र्व किया गया.
SPACE वह जगह जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और साथ मिलकर काम करते हैं. SPACE में चैट ऐप्लिकेशन शामिल हो सकते हैं.
GROUP_CHAT तीन या उससे ज़्यादा लोगों के बीच ग्रुप बातचीत. GROUP_CHAT में चैट ऐप्लिकेशन शामिल हो सकते हैं.
DIRECT_MESSAGE दो लोगों या किसी इंसान और किसी Chat ऐप्लिकेशन के बीच 1:1 मैसेज.

टाइप

अब काम नहीं करता: इसके बजाय, SpaceType का इस्तेमाल करें.

Enums
TYPE_UNSPECIFIED रिज़र्व किया गया.
ROOM दो या दो से ज़्यादा लोगों के बीच बातचीत.
DM किसी व्यक्ति और Chat ऐप्लिकेशन के बीच 1:1 डायरेक्ट मैसेज, जिसमें सभी मैसेज एक जैसे हों. ध्यान दें कि इसमें दो लोगों के बीच डायरेक्ट मैसेज शामिल नहीं हैं.

SpaceBatchUpdatedEventData

किसी स्पेस में कई अपडेट के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.space.v1.batchUpdated

फ़ील्ड
spaces[]

SpaceUpdatedEventData

अपडेट किए गए स्पेस की सूची.

SpaceEvent

यह ऐसा इवेंट होता है जो Google Chat पर मौजूद स्पेस में हुए किसी बदलाव या गतिविधि को दिखाता है. ज़्यादा जानने के लिए, Google Chat के इवेंट के साथ काम करना लेख पढ़ें.

फ़ील्ड
name

string

स्पेस इवेंट के संसाधन का नाम.

फ़ॉर्मैट: spaces/{space}/spaceEvents/{spaceEvent}

event_time

Timestamp

इवेंट होने का समय.

event_type

string

स्पेस इवेंट का टाइप. हर इवेंट टाइप का एक बैच वर्शन होता है. इसमें, कम समय में होने वाले इवेंट टाइप के कई इंस्टेंस दिखते हैं. spaceEvents.list() अनुरोधों के लिए, अपने क्वेरी फ़िल्टर में बैच इवेंट टाइप को छोड़ दें. डिफ़ॉल्ट रूप से, सर्वर इवेंट टाइप और उसके बैच वर्शन, दोनों दिखाता है.

मैसेज के लिए इस्तेमाल किए जा सकने वाले इवेंट टाइप:

  • नया मैसेज: google.workspace.chat.message.v1.created
  • अपडेट किया गया मैसेज: google.workspace.chat.message.v1.updated
  • मिटाया गया मैसेज: google.workspace.chat.message.v1.deleted
  • एक से ज़्यादा नए मैसेज: google.workspace.chat.message.v1.batchCreated
  • अपडेट किए गए कई मैसेज: google.workspace.chat.message.v1.batchUpdated
  • कई मिटाए गए मैसेज: google.workspace.chat.message.v1.batchDeleted

पैसे चुकाकर ली जाने वाली सदस्यताओं के लिए इस्तेमाल किए जा सकने वाले इवेंट के टाइप:

  • नई सदस्यता: google.workspace.chat.membership.v1.created
  • अपडेट की गई सदस्यता: google.workspace.chat.membership.v1.updated
  • सदस्यता मिटाई गई: google.workspace.chat.membership.v1.deleted
  • कई नई सदस्यताएं: google.workspace.chat.membership.v1.batchCreated
  • अपडेट की गई कई सदस्यताएं: google.workspace.chat.membership.v1.batchUpdated
  • कई बार मिटाई गई सदस्यताएं: google.workspace.chat.membership.v1.batchDeleted

प्रतिक्रियाओं के लिए इस्तेमाल किए जा सकने वाले इवेंट के प्रकार:

  • नई प्रतिक्रिया: google.workspace.chat.reaction.v1.created
  • मिटाई गई प्रतिक्रिया: google.workspace.chat.reaction.v1.deleted
  • कई नई प्रतिक्रियाएं: google.workspace.chat.reaction.v1.batchCreated
  • कई प्रतिक्रियाएं मिटाई गईं: google.workspace.chat.reaction.v1.batchDeleted

स्पेस के बारे में इस्तेमाल किए जा सकने वाले इवेंट के टाइप:

  • अपडेट किया गया स्पेस: google.workspace.chat.space.v1.updated
  • स्पेस के कई अपडेट: google.workspace.chat.space.v1.batchUpdated

यूनियन फ़ील्ड payload.

payload इनमें से सिर्फ़ एक हो सकता है:

message_created_event_data

MessageCreatedEventData

नए मैसेज के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.created

message_updated_event_data

MessageUpdatedEventData

अपडेट किए गए मैसेज का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.updated

message_deleted_event_data

MessageDeletedEventData

मिटाए गए मैसेज का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.deleted

message_batch_created_event_data

MessageBatchCreatedEventData

एक से ज़्यादा नए मैसेज के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.batchCreated

message_batch_updated_event_data

MessageBatchUpdatedEventData

अपडेट किए गए एक से ज़्यादा मैसेज के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.batchUpdated

message_batch_deleted_event_data

MessageBatchDeletedEventData

मिटाए गए एक से ज़्यादा मैसेज का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.message.v1.batchDeleted

space_updated_event_data

SpaceUpdatedEventData

स्पेस के अपडेट के लिए इवेंट का पेलोड.

इवेंट टाइप: google.workspace.chat.space.v1.updated

space_batch_updated_event_data

SpaceBatchUpdatedEventData

किसी स्पेस में कई अपडेट के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.space.v1.batchUpdated

membership_created_event_data

MembershipCreatedEventData

नई सदस्यता के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.created

membership_updated_event_data

MembershipUpdatedEventData

अपडेट की गई सदस्यता के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.updated

membership_deleted_event_data

MembershipDeletedEventData

मिटाई गई सदस्यता के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.deleted

membership_batch_created_event_data

MembershipBatchCreatedEventData

एक से ज़्यादा नई सदस्यताओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.batchCreated

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

अपडेट की गई एक से ज़्यादा सदस्यताओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.batchUpdated

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

मिटाई गई कई सदस्यताओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.membership.v1.batchDeleted

reaction_created_event_data

ReactionCreatedEventData

नई प्रतिक्रिया के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.created

reaction_deleted_event_data

ReactionDeletedEventData

मिटाई गई प्रतिक्रिया का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.deleted

reaction_batch_created_event_data

ReactionBatchCreatedEventData

कई नई प्रतिक्रियाओं के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.batchCreated

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

मिटाई गई कई प्रतिक्रियाओं का इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

स्पेस में, उपयोगकर्ता के पढ़े गए मैसेज की स्थिति. इसका इस्तेमाल, पढ़े गए और नहीं पढ़े गए मैसेज की पहचान करने के लिए किया जाता है.

फ़ील्ड
name

string

स्पेस के संसाधन का नाम, 'पढ़ा गया' के तौर पर सेट है.

फ़ॉर्मैट: users/{user}/spaces/{space}/spaceReadState

last_read_time

Timestamp

ज़रूरी नहीं. वह समय जब उपयोगकर्ता के स्पेस में पढ़ने की स्थिति को अपडेट किया गया था. आम तौर पर, यह मैसेज आखिरी बार पढ़े गए मैसेज के टाइमस्टैंप या स्पेस में पढ़े गए आखिरी मैसेज को मार्क करने के लिए, उपयोगकर्ता के तय किए गए टाइमस्टैंप से मेल खाता है.

SpaceUpdatedEventData

अपडेट की गई जगह के लिए इवेंट पेलोड.

इवेंट टाइप: google.workspace.chat.space.v1.updated

फ़ील्ड
space

Space

अपडेट किया गया स्पेस.

थ्रेड

Google Chat पर मौजूद स्पेस में मौजूद थ्रेड. इस्तेमाल के उदाहरण के लिए, मैसेज थ्रेड शुरू करना या उसका जवाब देना देखें.

अगर मैसेज बनाते समय कोई थ्रेड तय किया जाता है, तो messageReplyOption फ़ील्ड को सेट करके यह तय किया जा सकता है कि मिलता-जुलता कोई थ्रेड न मिलने पर क्या होता है.

फ़ील्ड
name

string

थ्रेड के संसाधन का नाम.

उदाहरण: spaces/{space}/threads/{thread}

thread_key

string

ज़रूरी नहीं. थ्रेड बनाने या अपडेट करने के लिए इनपुट. अगर ऐसा नहीं है, तो सिर्फ़ आउटपुट के लिए. थ्रेड का आईडी. ज़्यादा से ज़्यादा 4,000 वर्णों का इस्तेमाल किया जा सकता है.

यह आईडी, Chat ऐप्लिकेशन के लिए यूनीक होता है, जो इसे सेट करता है. उदाहरण के लिए, अगर एक ही थ्रेड कुंजी का इस्तेमाल करके कई Chat ऐप्लिकेशन बनाते हैं, तो मैसेज अलग-अलग थ्रेड में पोस्ट किए जाते हैं. किसी व्यक्ति या Chat ऐप्लिकेशन के बनाए गए थ्रेड का जवाब देने के लिए, थ्रेड name फ़ील्ड डालें.

ThreadReadState

किसी थ्रेड में उपयोगकर्ता के पढ़े जाने की स्थिति. इसका इस्तेमाल, पढ़े गए और नहीं पढ़े गए मैसेज की पहचान करने के लिए किया जाता है.

फ़ील्ड
name

string

थ्रेड के पढ़े जाने की स्थिति के संसाधन का नाम.

फ़ॉर्मैट: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

Timestamp

वह समय जब उपयोगकर्ता के थ्रेड को पढ़ने की स्थिति को अपडेट किया गया था. आम तौर पर, यह किसी थ्रेड में आखिरी बार पढ़े गए मैसेज के टाइमस्टैंप से मेल खाता है.

UpdateMembershipRequest

सदस्यता अपडेट करने के लिए मैसेज का अनुरोध करें.

फ़ील्ड
membership

Membership

ज़रूरी है. अपडेट की जाने वाली सदस्यता. सिर्फ़ update_mask के तय किए गए फ़ील्ड अपडेट किए जाते हैं.

update_mask

FieldMask

ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड पाथ. एक से ज़्यादा वैल्यू को कॉमा लगाकर अलग करें या सभी फ़ील्ड पाथ को अपडेट करने के लिए, * का इस्तेमाल करें.

फ़िलहाल, इन फ़ील्ड पाथ का इस्तेमाल किया जा सकता है:

  • role
use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.memberships OAuth 2.0 स्कोप की ज़रूरत होती है.

UpdateMessageRequest

मैसेज को अपडेट करने का अनुरोध करें.

फ़ील्ड
message

Message

ज़रूरी है. फ़ील्ड वाला मैसेज अपडेट किया गया.

update_mask

FieldMask

ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड पाथ. एक से ज़्यादा वैल्यू को कॉमा लगाकर अलग करें या सभी फ़ील्ड पाथ को अपडेट करने के लिए, * का इस्तेमाल करें.

फ़िलहाल, इन फ़ील्ड पाथ का इस्तेमाल किया जा सकता है:

allow_missing

bool

ज़रूरी नहीं. अगर true और मैसेज नहीं मिलता है, तो एक नया मैसेज बनाया जाता है और updateMask को अनदेखा कर दिया जाता है. मैसेज का आईडी क्लाइंट के असाइन किए गए नंबर पर होना चाहिए. ऐसा न होने पर अनुरोध पूरा नहीं हो पाएगा.

UpdateSpaceReadStateRequest

UpdateSpaceReadState API के लिए अनुरोध से जुड़ा मैसेज.

फ़ील्ड
space_read_state

SpaceReadState

ज़रूरी है. स्पेस का रीड ओनली स्टेटस और फ़ील्ड, जिन्हें अपडेट करना है.

कॉल करने वाले व्यक्ति की रीड स्टेटस सिर्फ़ अपडेट किया जा सकता है.

कॉल करने वाले उपयोगकर्ता को रेफ़र करने के लिए, इनमें से कोई एक शर्त सेट करें:

  • me का दूसरा ईमेल पता. उदाहरण के लिए, users/me/spaces/{space}/spaceReadState.

  • उनका Workspace ईमेल पता. उदाहरण के लिए, users/user@example.com/spaces/{space}/spaceReadState.

  • उसका यूज़र आईडी. उदाहरण के लिए, users/123456789/spaces/{space}/spaceReadState.

फ़ॉर्मैट: users/{user}/spaces/{space}/spaceReadState

update_mask

FieldMask

ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड पाथ. फ़िलहाल, इन फ़ील्ड पाथ का इस्तेमाल किया जा सकता है:

  • last_read_time

जब last_read_time, नए मैसेज बनाने के समय से पहले होता है, तो यूज़र इंटरफ़ेस (यूआई) में स्पेस, 'नहीं पढ़ा गया' के तौर पर दिखता है.

स्पेस को 'पढ़ा गया' के तौर पर मार्क करने के लिए, last_read_time को सबसे नए मैसेज बनाने के समय के बाद की (ज़्यादा बड़ी) वैल्यू पर सेट करें. last_read_time को नए मैसेज बनाने के समय के हिसाब से तय किया गया है. ध्यान दें कि स्पेस में मैसेज पढ़े जाने की स्थिति से सिर्फ़ उन मैसेज की स्थिति पर असर पड़ता है जो स्पेस की टॉप-लेवल बातचीत में दिखते हैं. थ्रेड में दिए गए जवाबों पर इस टाइमस्टैंप का कोई असर नहीं होता. इसके बजाय, वे थ्रेड के पढ़े गए स्टेटस के हिसाब से काम करते हैं.

UpdateSpaceRequest

किसी स्पेस को अपडेट करने का अनुरोध.

फ़ील्ड
space

Space

ज़रूरी है. अपडेट किए जाने वाले फ़ील्ड वाला स्पेस. Space.name में spaces/{space} के तौर पर जानकारी भरी जानी चाहिए. सिर्फ़ update_mask के तय किए गए फ़ील्ड अपडेट किए जाते हैं.

update_mask

FieldMask

ज़रूरी है. अपडेट किए गए फ़ील्ड पाथ, अगर एक से ज़्यादा फ़ील्ड हैं, तो उन्हें कॉमा से अलग किया जाता है.

स्पेस के लिए, इन फ़ील्ड को अपडेट किया जा सकता है:

  • space_details

  • display_name: सिर्फ़ उन स्पेस का डिसप्ले नेम अपडेट किया जा सकता है जहां spaceType फ़ील्ड SPACE है. अगर आपको ALREADY_EXISTS गड़बड़ी का मैसेज मिलता है, तो कोई दूसरी वैल्यू डालकर देखें. ऐसा हो सकता है कि Google Workspace का इस्तेमाल करने वाले संगठन में पहले से मौजूद स्पेस में, इस डिसप्ले नेम का इस्तेमाल पहले से किया जा रहा हो.

  • space_type: सिर्फ़ GROUP_CHAT स्पेस के टाइप को SPACE में बदला जा सकता है. अपडेट मास्क में, display_name को space_type के साथ शामिल करें. साथ ही, पक्का करें कि बताए गए स्पेस में कोई खाली डिसप्ले नेम और SPACE स्पेस टाइप हो. अगर मौजूदा स्पेस में पहले से ही SPACE टाइप इस्तेमाल किया जा रहा है, तो डिसप्ले नेम को अपडेट करते समय, बताए गए स्पेस में space_type मास्क और SPACE टाइप को शामिल करना ज़रूरी नहीं है. स्पेस के टाइप को दूसरे तरीकों से अपडेट करने की कोशिश करने पर, अमान्य तर्क से जुड़ी गड़बड़ी मिलती है. space_type के पास एडमिन ऐक्सेस नहीं है.

  • space_history_state: यह स्पेस के इतिहास को चालू या बंद करने पर, स्पेस के इतिहास की सेटिंग को अपडेट करता है. यह सुविधा सिर्फ़ तब काम करती है, जब Google Workspace इस्तेमाल करने वाले संगठन के लिए, इतिहास की सेटिंग चालू हों. स्पेस के इतिहास की स्थिति अपडेट करने के लिए, आपको अपने अनुरोध में अन्य सभी फ़ील्ड मास्क हटाने होंगे. space_history_state के पास एडमिन ऐक्सेस नहीं है.

  • access_settings.audience: इसकी ऐक्सेस सेटिंग अपडेट की जाती है कि स्पेस को कौन खोज सकता है, स्पेस में शामिल हो सकता है, और नाम वाले स्पेस में मैसेज की झलक देख सकता है. यह वही स्पेस है जिसमें spaceType फ़ील्ड SPACE है. अगर मौजूदा स्पेस में टारगेट ऑडियंस हैं, तो ऑडियंस को हटाया जा सकता है. साथ ही, इस फ़ील्ड मास्क की वैल्यू को हटाकर, स्पेस के ऐक्सेस पर पाबंदी लगाई जा सकती है. किसी स्पेस के ऐक्सेस की सेटिंग अपडेट करने के लिए, यह ज़रूरी है कि पुष्टि करने वाला उपयोगकर्ता, स्पेस मैनेजर हो. साथ ही, उसे अनुरोध में शामिल अन्य सभी फ़ील्ड मास्क हटाने की ज़रूरत न पड़े. अगर स्पेस इंपोर्ट मोड में है, तो इस फ़ील्ड को अपडेट नहीं किया जा सकता. ज़्यादा जानने के लिए, स्पेस को कुछ खास उपयोगकर्ताओं के लिए उपलब्ध कराना लेख पढ़ें. access_settings.audience के पास एडमिन ऐक्सेस नहीं है.

  • डेवलपर की झलक: स्पेस की अनुमति सेटिंग को बदलने में मदद मिलती है. साथ ही, ये फ़ील्ड पाथ इस्तेमाल किए जा सकते हैं: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (चेतावनी: बिना अनुमति वाले अन्य सभी सेटिंग फ़ील्ड पाथ के साथ इन्हें अलग से इस्तेमाल नहीं किया जा सकता). permission_settings के पास एडमिन ऐक्सेस नहीं है.

use_admin_access

bool

true के साथ, यह तरीका उपयोगकर्ता के Google Workspace एडमिन के खास अधिकारों का इस्तेमाल करके चलता है.

कॉल करने वाला उपयोगकर्ता, Google Workspace एडमिन होना चाहिए. उसके पास, चैट और स्पेस में होने वाली बातचीत को मैनेज करने का अधिकार होना चाहिए.

chat.admin.spaces OAuth 2.0 स्कोप की ज़रूरत होती है.

एडमिन ऐक्सेस का इस्तेमाल करने पर, FieldMask की कुछ वैल्यू का इस्तेमाल नहीं किया जा सकता. ज़्यादा जानकारी के लिए, update_mask का ब्यौरा देखें.

उपयोगकर्ता

Google Chat इस्तेमाल करने वाला कोई व्यक्ति. अगर अनुरोध के आउटपुट के तौर पर दिखाया जाता है और आपका Chat ऐप्लिकेशन उपयोगकर्ता के तौर पर पुष्टि करता है, तो User संसाधन के आउटपुट में उपयोगकर्ता के name और type की जानकारी ही अपने-आप भर जाती है.

फ़ील्ड
name

string

Google Chat user के लिए संसाधन का नाम.

फ़ॉर्मैट: users/{user}. users/app का इस्तेमाल, कॉलिंग ऐप्लिकेशन bot के उपयोगकर्ता के लिए उपनाम के तौर पर किया जा सकता है.

human users के लिए, {user} और ये उपयोगकर्ता आइडेंटिफ़ायर एक ही हैं:

  • People API में, Person के लिए id. उदाहरण के लिए, Chat API में users/123456789, People API में 123456789 व्यक्ति प्रोफ़ाइल आईडी के तौर पर उसी व्यक्ति को दिखाता है.

  • Admin SDK Directory API में किसी उपयोगकर्ता के लिए id.

  • उपयोगकर्ता के ईमेल पते का इस्तेमाल, एपीआई अनुरोधों में {user} के लिए उपनाम के तौर पर किया जा सकता है. उदाहरण के लिए, अगर user@example.com के लिए People API पर्सोनी की प्रोफ़ाइल का आईडी 123456789 है, तो users/123456789 का रेफ़रंस देने के लिए users/user@example.com का इस्तेमाल उपनाम के तौर पर किया जा सकता है. एपीआई से सिर्फ़ कैननिकल रिसॉर्स का नाम दिखाया जाएगा. उदाहरण के लिए, users/123456789.

display_name

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता का डिसप्ले नेम.

domain_id

string

उपयोगकर्ता के Google Workspace डोमेन का यूनीक आइडेंटिफ़ायर.

type

Type

उपयोगकर्ता का टाइप.

is_anonymous

bool

सिर्फ़ आउटपुट के लिए. true पर, उपयोगकर्ता को मिटा दिया जाता है या उसकी प्रोफ़ाइल नहीं दिखती है.

टाइप

Enums
TYPE_UNSPECIFIED Enum के लिए डिफ़ॉल्ट वैल्यू. इसका इस्तेमाल न करें.
HUMAN उपयोगकर्ता.
BOT Chat ऐप्लिकेशन का उपयोगकर्ता.

UserMentionMetadata

उपयोगकर्ताओं को टैग करने के लिए एनोटेशन मेटाडेटा (@).

फ़ील्ड
user

User

उपयोगकर्ता का बताया गया नाम.

type

Type

उपयोगकर्ता किस तरह का उल्लेख करता है.

टाइप

Enums
TYPE_UNSPECIFIED Enum के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
ADD उपयोगकर्ता को स्पेस में जोड़ें.
MENTION स्पेस में उपयोगकर्ता को टैग करें.

WidgetMarkup

विजेट एक यूज़र इंटरफ़ेस (यूआई) एलिमेंट है, जो टेक्स्ट और इमेज दिखाता है.

फ़ील्ड
buttons[]

Button

बटन की सूची. बटन भी oneof data हैं और इनमें से सिर्फ़ एक फ़ील्ड को सेट किया जाना चाहिए.

यूनियन फ़ील्ड data. WidgetMarkup में, इनमें से सिर्फ़ एक आइटम हो सकता है. ज़्यादा आइटम दिखाने के लिए, एक से ज़्यादा WidgetMarkup फ़ील्ड का इस्तेमाल किया जा सकता है. data इनमें से सिर्फ़ एक हो सकता है:
text_paragraph

TextParagraph

इस विजेट में टेक्स्ट पैराग्राफ़ दिखाएं.

image

Image

इस विजेट में कोई इमेज दिखाएं.

key_value

KeyValue

इस विजेट में मुख्य वैल्यू वाला आइटम दिखाएं.

बटन

एक बटन. यह टेक्स्ट बटन या इमेज बटन हो सकता है.

फ़ील्ड

यूनियन फ़ील्ड type.

type इनमें से सिर्फ़ एक हो सकता है:

text_button

TextButton

टेक्स्ट और onclick कार्रवाई वाला बटन.

image_button

ImageButton

इमेज और onclick कार्रवाई वाला बटन.

FormAction

फ़ॉर्म कार्रवाई से, फ़ॉर्म सबमिट होने पर व्यवहार के बारे में पता चलता है. उदाहरण के लिए, फ़ॉर्म को हैंडल करने के लिए, Apps Script को शुरू किया जा सकता है.

फ़ील्ड
action_method_name

string

तरीके के नाम का इस्तेमाल यह पता लगाने के लिए किया जाता है कि फ़ॉर्म के किस हिस्से से फ़ॉर्म सबमिशन ट्रिगर हुआ. यह जानकारी, कार्ड क्लिक इवेंट के हिस्से के तौर पर Chat ऐप्लिकेशन में भी दिखती है. एक जैसा तरीका इस्तेमाल करने वाले कई एलिमेंट के लिए भी इस तरीके का इस्तेमाल किया जा सकता है.

parameters[]

ActionParameter

कार्रवाई पैरामीटर की सूची.

ActionParameter

कार्रवाई का तरीका शुरू करते समय दिए जाने वाले स्ट्रिंग पैरामीटर की सूची. उदाहरण के लिए, स्नूज़ करने के लिए तीन बटन इस्तेमाल करें: अभी स्नूज़ करें, एक दिन स्नूज़ करें, और अगले हफ़्ते स्नूज़ करें. आप स्ट्रिंग पैरामीटर की सूची में से स्नूज़ करने का टाइप और स्नूज़ का समय पास करके, action method = snooze() का इस्तेमाल कर सकते हैं.

फ़ील्ड
key

string

ऐक्शन स्क्रिप्ट के लिए पैरामीटर का नाम.

value

string

पैरामीटर की वैल्यू.

आइकॉन

इस्तेमाल किए जा सकने वाले आइकॉन का सेट.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

इमेज

ऐसी इमेज जिसे यूआरएल से तय किया गया हो और जिसमें onclick कार्रवाई हो सकती हो.

फ़ील्ड
image_url

string

इमेज का यूआरएल.

on_click

OnClick

onclick कार्रवाई.

aspect_ratio

double

इस इमेज की चौड़ाई-ऊंचाई का अनुपात (चौड़ाई और ऊंचाई). इस फ़ील्ड की मदद से, इमेज के लोड होने का इंतज़ार करते समय, उसके लिए सही ऊंचाई रिज़र्व की जा सकती है. हालांकि, इसका मकसद इमेज के पहले से मौजूद आसपेक्ट रेशियो (लंबाई-चौड़ाई का अनुपात) को बदलना नहीं है. अगर इस नीति को सेट नहीं किया जाता है, तो सर्वर इमेज को प्रीफ़ेच करके इसे भरता है.

ImageButton

onclick कार्रवाई वाला इमेज बटन.

फ़ील्ड
on_click

OnClick

onclick कार्रवाई.

name

string

इस image_button का नाम, जिसका इस्तेमाल सुलभता के लिए किया जाता है. अगर यह नाम नहीं बताया गया है, तो डिफ़ॉल्ट मान दिया जाता है.

यूनियन फ़ील्ड icons. आइकॉन को Icon enum या यूआरएल की मदद से बताया जा सकता है. icons इनमें से सिर्फ़ एक हो सकता है:
icon

Icon

enum की ओर से तय किया गया आइकॉन, जो Chat API से मिले आइकॉन के बारे में बताता है.

icon_url

string

यूआरएल में मौजूद आइकॉन.

KeyValue

यूज़र इंटरफ़ेस (यूआई) एलिमेंट में, कुंजी (लेबल) और वैल्यू (कॉन्टेंट) होती है. इस एलिमेंट में onclick बटन जैसी कुछ कार्रवाइयां भी शामिल हो सकती हैं.

फ़ील्ड
top_label

string

सबसे ऊपर मौजूद लेबल का टेक्स्ट. फ़ॉर्मैट किया गया टेक्स्ट काम करता है. टेक्स्ट को फ़ॉर्मैट करने के बारे में ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन में टेक्स्ट फ़ॉर्मैट करना और Google Workspace ऐड-ऑन में टेक्स्ट फ़ॉर्मैट करना लेख पढ़ें.

content

string

कॉन्टेंट का टेक्स्ट. फ़ॉर्मैट किया गया टेक्स्ट काम करता है और हमेशा ज़रूरी होता है. टेक्स्ट को फ़ॉर्मैट करने के बारे में ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन में टेक्स्ट फ़ॉर्मैट करना और Google Workspace ऐड-ऑन में टेक्स्ट फ़ॉर्मैट करना लेख पढ़ें.

content_multiline

bool

कॉन्टेंट मल्टीलाइन होना चाहिए या नहीं.

bottom_label

string

सबसे नीचे वाले लेबल का टेक्स्ट. फ़ॉर्मैट किया गया टेक्स्ट काम करता है. टेक्स्ट को फ़ॉर्मैट करने के बारे में ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन में टेक्स्ट फ़ॉर्मैट करना और Google Workspace ऐड-ऑन में टेक्स्ट फ़ॉर्मैट करना लेख पढ़ें.

on_click

OnClick

onclick कार्रवाई. सिर्फ़ सबसे ऊपर वाले लेबल, सबसे नीचे वाले लेबल, और कॉन्टेंट वाले हिस्से पर क्लिक किया जा सकता है.

यूनियन फ़ील्ड icons. आइकॉन, top_label और bottom_label में से कम से कम एक के बारे में बताना ज़रूरी है. icons इनमें से सिर्फ़ एक हो सकता है:
icon

Icon

एक ईनम वैल्यू, जिसे Chat API से संबंधित आइकॉन इमेज से बदल दिया जाता है.

icon_url

string

यूआरएल में मौजूद आइकॉन.

यूनियन फ़ील्ड control. कंट्रोल विजेट. button या switch_widget में से किसी एक को सेट किया जा सकता है, दोनों को नहीं. control इनमें से सिर्फ़ एक हो सकता है:
button

Button

वह बटन जिस पर क्लिक करके, कार्रवाई को ट्रिगर किया जा सकता है.

OnClick

onclick कार्रवाई (उदाहरण के लिए, कोई लिंक खोलें).

फ़ील्ड

यूनियन फ़ील्ड data.

data इनमें से सिर्फ़ एक हो सकता है:

action

FormAction

अगर बताया गया है, तो इस onclick कार्रवाई से फ़ॉर्म कार्रवाई ट्रिगर होती है.

TextButton

टेक्स्ट और onclick कार्रवाई वाला बटन.

फ़ील्ड
text

string

बटन का टेक्स्ट.

on_click

OnClick

बटन की onclick कार्रवाई.

TextParagraph

टेक्स्ट का पैराग्राफ़. फ़ॉर्मैट किया गया टेक्स्ट काम करता है. टेक्स्ट को फ़ॉर्मैट करने के बारे में ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन में टेक्स्ट फ़ॉर्मैट करना और Google Workspace ऐड-ऑन में टेक्स्ट फ़ॉर्मैट करना लेख पढ़ें.

फ़ील्ड
text

string