Package google.chat.v1

इंडेक्स

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

इस्तेमाल के उदाहरण के लिए, यहां देखें:

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

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • 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 पर मौजूद स्पेस में मैसेज भेजेगा. उदाहरण के लिए, मैसेज भेजना देखें.

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

इस इमेज में दिखाया गया है कि ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करने पर, Chat किसी मैसेज को कैसे एट्रिब्यूट करता है. Chat, मैसेज भेजने वाले के तौर पर Chat ऐप्लिकेशन दिखाता है. मैसेज के कॉन्टेंट में टेक्स्ट (text), कार्ड (cardsV2), और ऐक्सेसरी विजेट (accessoryWidgets) शामिल किए जा सकते हैं.

ऐप्लिकेशन की पुष्टि करने के बाद भेजा गया मैसेज

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

उपयोगकर्ता की पुष्टि के साथ भेजा गया मैसेज

मैसेज का साइज़ ज़्यादा से ज़्यादा 32,000 बाइट होना चाहिए. इसमें मैसेज का कॉन्टेंट भी शामिल है.

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

इसके लिए, 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 संगठन में मौजूद किसी मौजूदा स्पेस में, इस डिसप्ले नेम का पहले से ही इस्तेमाल किया जा रहा हो.

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

यह पुष्टि करने के लिए, इन तरीकों का इस्तेमाल करता है:

ऐप्लिकेशन के तौर पर पुष्टि करते समय, अनुरोध में space.customer फ़ील्ड को सेट करना ज़रूरी है.

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

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

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

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

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

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

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

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

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • 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.app.delete
  • 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 गड़बड़ी दिखाता है. उदाहरण के लिए, डायरेक्ट मैसेज ढूंढें देखें.

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

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

// पुष्टि करने के लिए, इन तरीकों का इस्तेमाल किया जा सकता है:

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

इसके लिए, 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)

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

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

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
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
  • https://www.googleapis.com/auth/chat.app.spaces

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

ध्यान दें: इस अनुरोध के लिए, Space इवेंट डेटा के Space ऑब्जेक्ट में permissionSettings फ़ील्ड नहीं दिखाया जाता.

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

उदाहरण के लिए, 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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

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

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

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

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

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

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
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)

यह डायलॉग बॉक्स उन स्पेस में मौजूद मैसेज की सूची बनाता है जिनका सदस्य कॉलर है. इसमें, ब्लॉक किए गए सदस्यों और स्पेस के मैसेज भी शामिल हैं. अगर किसी ऐसे स्पेस के मैसेज की सूची बनाई जाती है जिसमें कोई मैसेज नहीं है, तो रिस्पॉन्स के तौर पर खाली ऑब्जेक्ट दिखता है. REST/एचटीटीपी इंटरफ़ेस का इस्तेमाल करने पर, रिस्पॉन्स में एक खाली JSON ऑब्जेक्ट, {} होता है. उदाहरण के लिए, मैसेज की सूची देखें.

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

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

इनमें से किसी एक 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 या Directory API में मौजूद उपयोगकर्ता के लिए 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) बनाने के लिए, व्यक्ति के तौर पर सिर्फ़ एक सदस्यता के बारे में बताएं. अगर एक उपयोगकर्ता दूसरे उपयोगकर्ता को ब्लॉक करता है, तो अनुरोध पूरा नहीं होता और डीएम नहीं बनाया जाता.

कॉल करने वाले उपयोगकर्ता और कॉल करने वाले ऐप्लिकेशन के बीच डीएम बनाने के लिए, Space.singleUserBotDm को true पर सेट करें और किसी भी सदस्यता की जानकारी न दें. आप सिर्फ़ कॉलिंग ऐप्लिकेशन के साथ 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.app.memberships
  • 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.app.spaces
  • 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 एनम के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
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 ऐप्लिकेशन, कार्ड बना सकते हैं. अगर आपका 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

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

डेवलपर के लिए मार्कअप, ताकि वे संदर्भ के हिसाब से काम करने वाले AddOn के कॉन्टेंट की जानकारी दे सकें.

कार्ड

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

फ़ील्ड
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

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

CreateCustomEmojiRequest

पसंद के मुताबिक इमोजी बनाने का अनुरोध.

फ़ील्ड
custom_emoji

CustomEmoji

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

CreateMembershipRequest

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

फ़ील्ड
parent

string

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

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

Membership

ज़रूरी है. सदस्यता का वह संबंध जो बनाना है.

memberType फ़ील्ड में कोई उपयोगकर्ता होना चाहिए. साथ ही, user.name और user.type फ़ील्ड में जानकारी होनी चाहिए. सर्वर, संसाधन का नाम असाइन करेगा और बताई गई किसी भी चीज़ को ओवरराइट कर देगा.

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

  • उपयोगकर्ता के तौर पर पुष्टि करते समय, chat.memberships अनुमति का दायरा ज़रूरी है.

  • ऐप्लिकेशन के तौर पर पुष्टि करते समय, chat.app.memberships अनुमति का दायरा ज़रूरी है. ऐप्लिकेशन के तौर पर पुष्टि करने की सुविधा यहां उपलब्ध है

  • user.type को HUMAN पर सेट करें और user.name को users/{user} फ़ॉर्मैट में सेट करें. यहां उपयोगकर्ता का ईमेल पता {user} हो सकता है. एक ही Workspace संगठन के उपयोगकर्ताओं के लिए, {user}, People API में मौजूद व्यक्ति का id या Directory API में उपयोगकर्ता का 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 संगठन में मौजूद किसी मौजूदा स्पेस में, इस डिसप्ले नेम का पहले से ही इस्तेमाल किया जा रहा हो.

अगर आप Developer Preview प्रोग्राम के सदस्य हैं, तो SpaceType.GROUP_CHAT का इस्तेमाल तब किया जा सकता है, जब importMode को 'सही है' पर सेट किया गया हो.

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

string

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

CustomEmoji

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

फ़ील्ड
name

string

आइडेंटिफ़ायर. सर्वर से असाइन किए गए कस्टम इमोजी का संसाधन नाम.

फ़ॉर्मैट: customEmojis/{customEmoji}

uid

string

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

string

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

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

इमोजी के नाम, कोलन से शुरू और खत्म होने चाहिए. ये नाम अंग्रेज़ी के छोटे अक्षरों में होने चाहिए. साथ ही, इनमें सिर्फ़ अक्षर, अंक, हाइफ़न, और अंडरस्कोर होने चाहिए. शब्दों को अलग करने के लिए, हाइफ़न और अंडरस्कोर का इस्तेमाल किया जाना चाहिए. हालांकि, इनका लगातार इस्तेमाल नहीं किया जा सकता.

उदाहरण: :valid-emoji-name:

temporary_image_uri

string

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

payload

CustomEmojiPayload

सिर्फ़ इनपुट. पेलोड डेटा.

CustomEmojiPayload

पसंद के मुताबिक बनाए गए इमोजी का पेलोड डेटा.

फ़ील्ड
file_content

bytes

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

पेलोड का साइज़ 256 केबी से कम होना चाहिए. साथ ही, इमेज का डाइमेंशन 64 से 500 पिक्सल के बीच होना चाहिए. इन पाबंदियों में बदलाव किया जा सकता है.
filename

string

ज़रूरी है. सिर्फ़ इनपुट. इमेज फ़ाइल का नाम.

साथ काम करने वाले फ़ाइल एक्सटेंशन: .png, .jpg, .gif.

DeleteCustomEmojiRequest

पसंद के मुताबिक बनाए गए इमोजी को मिटाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. पसंद के मुताबिक बनाए गए जिस इमोजी को मिटाना है उसके संसाधन का नाम.

फ़ॉर्मैट: customEmojis/{customEmoji}

{customEmoji} के लिए, इमोजी के नाम का इस्तेमाल उपनाम के तौर पर किया जा सकता है. उदाहरण के लिए, customEmojis/:example-emoji:, जहां पसंद के मुताबिक बनाए गए इमोजी के इमोजी का नाम :example-emoji: है.

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 के अटैचमेंट के डेटा का रेफ़रंस.

फ़ील्ड
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 या Directory API में उपयोगकर्ता के लिए 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} फ़ॉर्म में, अटैचमेंट के संसाधन का नाम.

GetCustomEmojiRequest

पसंद के मुताबिक बनाया गया इमोजी लौटाने का अनुरोध.

फ़ील्ड
name

string

ज़रूरी है. पसंद के मुताबिक बनाए गए इमोजी के संसाधन का नाम.

फ़ॉर्मैट: customEmojis/{customEmoji}

{customEmoji} के लिए, इमोजी के नाम को उपनाम के तौर पर इस्तेमाल किया जा सकता है. उदाहरण के लिए, customEmojis/:example-emoji:, जहां :example-emoji: पसंद के मुताबिक बनाए गए इमोजी का नाम है.

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.

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

ग्रुप

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

फ़ील्ड
name

string

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

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

फ़ॉर्मैट: groups/{group}

HistoryState

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

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

ListCustomEmojisRequest

पसंद के मुताबिक बनाए गए इमोजी की सूची दिखाने का अनुरोध.

फ़ील्ड
page_size

int32

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

string

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

पसंद के मुताबिक बनाए गए इमोजी की सूची के लिए, पिछले कॉल से मिला पेज टोकन. अगला पेज देखने के लिए, यह डालें.

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

string

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

इसे क्रिएटर के हिसाब से फ़िल्टर किया जा सकता है.

क्रिएटर के हिसाब से फ़िल्टर करने के लिए, आपको कोई मान्य वैल्यू डालनी होगी. फ़िलहाल, कस्टम इमोजी को फ़िल्टर करने के लिए सिर्फ़ creator("users/me") और NOT creator("users/me") का इस्तेमाल किया जा सकता है. इससे यह पता चलता है कि इमोजी को कॉल करने वाले व्यक्ति ने बनाया है या नहीं.

उदाहरण के लिए, नीचे दी गई क्वेरी से, कॉल करने वाले व्यक्ति का बनाया हुआ कस्टम इमोजी दिखता है:

creator("users/me")

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

ListCustomEmojisResponse

पसंद के मुताबिक बनाए गए इमोजी की सूची का जवाब.

फ़ील्ड
custom_emojis[]

CustomEmoji

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

string

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

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) के हिसाब से फ़िल्टर किया जा सकता है.

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

थ्रेड के हिसाब से फ़िल्टर करने के लिए, thread.name को spaces/{space}/threads/{thread} के तौर पर फ़ॉर्मैट करें. हर क्वेरी के लिए, सिर्फ़ एक 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

नतीजे, समय के हिसाब से दिखाए जाते हैं. इसमें सबसे पुराना इवेंट सबसे पहले दिखता है. ध्यान दें: सूची के अनुरोधों के लिए, स्पेस ऑब्जेक्ट में permissionSettings फ़ील्ड नहीं दिखाया जाता.
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

अनुरोध किए गए (या पहले) पेज में मौजूद स्पेस की सूची. ध्यान दें: सूची के अनुरोधों के लिए, स्पेस ऑब्जेक्ट में permissionSettings फ़ील्ड नहीं दिखाया जाता.
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 ग्रुप जिससे सदस्यता जुड़ी है.

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

MembershipRole

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

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 ऐप्लिकेशन, कार्ड बना सकते हैं. अगर आपका 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 API को कॉल करना होगा. साथ ही, इन चीज़ों को हटाना होगा:

ज़्यादा जानकारी के लिए, निजी रूप से मैसेज भेजें देखें.
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}

जहां {space}, स्पेस के लिए सिस्टम से असाइन किया गया आईडी दिखाता है. स्पेस का आईडी पाने के लिए, spaces.list() तरीके को कॉल करें या स्पेस के यूआरएल का इस्तेमाल करें. उदाहरण के लिए, अगर स्पेस का यूआरएल https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA है, तो स्पेस का आईडी AAAAAAAAA होगा.
type
(deprecated)

Type

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

SpaceType

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

bool

ज़रूरी नहीं. स्पेस, Chat ऐप्लिकेशन और किसी एक व्यक्ति के बीच का डायरेक्ट मैसेज (डीएम) है या नहीं.
threaded
(deprecated)

bool

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

string

स्पेस का डिसप्ले नेम. SPACE के spaceType वाला स्पेस बनाने के लिए ज़रूरी है. अगर आपको स्पेस बनाते समय या 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

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

Import Mode में स्पेस बनाने के लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है.
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

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

string

ज़रूरी नहीं. इम्यूटेबल. स्पेस के डोमेन का ग्राहक आईडी. यह सिर्फ़ तब ज़रूरी है, जब ऐप्लिकेशन से पुष्टि करने की सुविधा के साथ स्पेस बनाया जा रहा हो और SpaceType की वैल्यू SPACE हो. ऐसा न होने पर, इसे सेट नहीं किया जाना चाहिए.

customers/{customer} फ़ॉर्मैट में, जहां customer, [एडमिन SDK के ग्राहक संसाधन]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) का id है. प्राइवेट ऐप्लिकेशन, customers/my_customer के उपनाम का इस्तेमाल करके भी उसी Google Workspace संगठन में स्पेस बना सकते हैं जहां ऐप्लिकेशन मौजूद है.

DM के लिए, इस फ़ील्ड में अपने-आप जानकारी नहीं भरती.

यूनियन फ़ील्ड space_permission_settings. यह किसी स्पेस की अनुमति की सेटिंग दिखाता है. यह सिर्फ़ तब पॉप्युलेट होता है, जब space_type SPACE हो.

उपयोगकर्ता की पुष्टि ज़रूरी है. space_permission_settings इनमें से कोई एक हो सकता है:
predefined_permission_settings

PredefinedPermissionSettings

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

PermissionSettings

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

AccessSettings

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

फ़ील्ड
access_state

AccessState

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

string

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

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

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

टारगेट ऑडियंस का डेटा पढ़ने की सुविधा इन कामों में मदद करती है:

ऐप्लिकेशन की पुष्टि के साथ chat.bot स्कोप का इस्तेमाल करने पर, यह फ़ील्ड अपने-आप नहीं भरता.

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

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 को अनदेखा कर दिया जाता है. मैसेज का आईडी client-assigned नंबर पर होना चाहिए. ऐसा न होने पर अनुरोध पूरा नहीं हो पाएगा.

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: स्पेस के ब्यौरे में बदलाव करता है. इसमें ज़्यादा से ज़्यादा 150 वर्ण डाले जा सकते हैं.

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

space_type: सिर्फ़ GROUP_CHAT स्पेस के टाइप को SPACE में बदला जा सकता है. अपडेट मास्क में, display_name को space_type के साथ शामिल करें. साथ ही, पक्का करें कि बताए गए स्पेस में कोई खाली डिसप्ले नेम और SPACE स्पेस टाइप हो. अगर मौजूदा स्पेस में पहले से ही SPACE टाइप है, तो डिसप्ले नेम अपडेट करते समय, किसी स्पेस में space_type मास्क और SPACE टाइप शामिल करना ज़रूरी नहीं है. स्पेस के टाइप को दूसरे तरीकों से अपडेट करने की कोशिश करने पर, अमान्य तर्क से जुड़ी गड़बड़ी मिलती है. space_type, useAdminAccess पर काम नहीं करता.

space_history_state: यह स्पेस के इतिहास को चालू या बंद करने पर, स्पेस के इतिहास की सेटिंग को अपडेट करता है. यह सुविधा सिर्फ़ तब काम करती है, जब Google Workspace इस्तेमाल करने वाले संगठन के लिए, इतिहास की सेटिंग चालू हों. स्पेस के इतिहास की स्थिति अपडेट करने के लिए, आपको अपने अनुरोध में अन्य सभी फ़ील्ड मास्क हटाने होंगे. space_history_state, useAdminAccess के साथ काम नहीं करता.

access_settings.audience: इसकी ऐक्सेस सेटिंग अपडेट की जाती है कि स्पेस को कौन खोज सकता है, स्पेस में शामिल हो सकता है, और नाम वाले स्पेस में मैसेज की झलक देख सकता है. यह वही स्पेस है जिसमें spaceType फ़ील्ड SPACE है. अगर मौजूदा स्पेस में टारगेट ऑडियंस हैं, तो ऑडियंस को हटाया जा सकता है. साथ ही, इस फ़ील्ड मास्क की वैल्यू को हटाकर, स्पेस के ऐक्सेस पर पाबंदी लगाई जा सकती है. किसी स्पेस के ऐक्सेस की सेटिंग अपडेट करने के लिए, यह ज़रूरी है कि पुष्टि करने वाला उपयोगकर्ता, स्पेस मैनेजर हो. साथ ही, उसे अनुरोध में शामिल अन्य सभी फ़ील्ड मास्क हटाने की ज़रूरत न पड़े. अगर स्पेस इंपोर्ट मोड में है, तो इस फ़ील्ड को अपडेट नहीं किया जा सकता. ज़्यादा जानने के लिए, स्पेस को कुछ खास उपयोगकर्ताओं के लिए उपलब्ध कराना लेख पढ़ें. access_settings.audience, useAdminAccess के साथ काम नहीं करता.

permission_settings: स्पेस की अनुमति की सेटिंग में बदलाव किया जा सकता है. अनुमति सेटिंग अपडेट करते समय, सिर्फ़ permissionSettings फ़ील्ड मास्क तय किए जा सकते हैं; एक ही समय पर, दूसरे फ़ील्ड मास्क अपडेट नहीं किए जा सकते. permissionSettings, useAdminAccess के साथ काम नहीं करता. इस्तेमाल किए जा सकने वाले फ़ील्ड मास्क में ये शामिल हैं:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
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