REST Resource: spaces.messages

संसाधन: मैसेज

Google Chat के स्पेस में मौजूद मैसेज.

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
फ़ील्ड
name

string

मैसेज के संसाधन का नाम.

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

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

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

sender

object (User)

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

createTime

string (Timestamp format)

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

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

lastUpdateTime

string (Timestamp format)

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

deleteTime

string (Timestamp format)

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

text

string

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

मैसेज बनाने का तरीका जानने के लिए, मैसेज भेजना लेख पढ़ें.

formattedText

string

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

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

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

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

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

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

cards[]
(deprecated)

object (Card)

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

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

cardsV2[]

object (CardWithId)

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

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

कार्ड के बारे में और उन्हें बनाने का तरीका जानने के लिए, कार्ड मैसेज भेजना देखें.

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

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

annotations[]

object (Annotation)

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

thread

object (Thread)

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

space

object (Space)

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

fallbackText

string

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

actionResponse

object (ActionResponse)

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

argumentText

string

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

slashCommand

object (SlashCommand)

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

attachment[]

object (Attachment)

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

matchedUrl

object (MatchedUrl)

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

threadReply

boolean

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

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

clientAssignedMessageId

string

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

emojiReactionSummaries[]

object (EmojiReactionSummary)

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

privateMessageViewer

object (User)

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

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

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

deletionMetadata

object (DeletionMetadata)

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

quotedMessageMetadata

object (QuotedMessageMetadata)

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

attachedGifs[]

object (AttachedGif)

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

accessoryWidgets[]

object (AccessoryWidget)

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

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

CardWithId

Google Chat मैसेज में मौजूद कार्ड.

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

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

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

जेएसओएन के काेड में दिखाना
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
फ़ील्ड
cardId

string

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

card

object (Card)

एक कार्ड. फ़ाइल का साइज़ 32 केबी से ज़्यादा नहीं होना चाहिए.

व्याख्या

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

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

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": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  }
  // End of list of possible types for union field metadata.
}
फ़ील्ड
type

enum (AnnotationType)

यह जानकारी किस तरह की है.

length

integer

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

startIndex

integer

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

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

object (UserMentionMetadata)

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

slashCommand

object (SlashCommandMetadata)

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

AnnotationType

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

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

UserMentionMetadata

उपयोगकर्ता का नाम टैग किए जाने पर दिखने वाला एनोटेशन मेटाडेटा (@).

जेएसओएन के काेड में दिखाना
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
फ़ील्ड
user

object (User)

उपयोगकर्ता ने टैग किया है.

type

enum (Type)

उपयोगकर्ता किस तरह का है.

टाइप

Enums
TYPE_UNSPECIFIED enum के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
ADD उपयोगकर्ता को स्पेस में जोड़ें.
MENTION स्पेस में उपयोगकर्ता का नाम टैग करें.

SlashCommandMetadata

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

जेएसओएन के काेड में दिखाना
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
फ़ील्ड
bot

object (User)

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

type

enum (Type)

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

commandName

string

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

commandId

string (int64 format)

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

triggersDialog

boolean

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

टाइप

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

RichLinkMetadata

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

जेएसओएन के काेड में दिखाना
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  }
  // End of list of possible types for union field data.
}
फ़ील्ड
uri

string

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

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

RichLinkType

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

Enums
DRIVE_FILE Google Drive का रिच लिंक टाइप.

DriveLinkData

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

जेएसओएन के काेड में दिखाना
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
फ़ील्ड
driveDataRef

object (DriveDataRef)

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

mimeType

string

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

Thread

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

अगर मैसेज बनाते समय थ्रेड तय की जाती है, तो messageReplyOption फ़ील्ड को सेट किया जा सकता है. इससे यह तय किया जा सकता है कि मिलता-जुलता कोई थ्रेड न मिलने पर क्या हो.

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "threadKey": string
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. थ्रेड के संसाधन का नाम.

उदाहरण: spaces/{space}/threads/{thread}

threadKey

string

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

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

ActionResponse

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

जेएसओएन के काेड में दिखाना
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
फ़ील्ड
type

enum (ResponseType)

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

url

string

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

dialogAction

object (DialogAction)

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

updatedWidget

object (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 विजेट टेक्स्ट के अपने-आप पूरा होने के विकल्पों की क्वेरी.

DialogAction

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

जेएसओएन के काेड में दिखाना
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
फ़ील्ड
actionStatus

object (ActionStatus)

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

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

object (Dialog)

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

डायलॉग

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

जेएसओएन के काेड में दिखाना
{
  "body": {
    object (Card)
  }
}
फ़ील्ड
body

object (Card)

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

ActionStatus

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

जेएसओएन के काेड में दिखाना
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
फ़ील्ड
statusCode

enum (Code)

स्टेटस कोड.

userFacingMessage

string

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

कोड

gRPC एपीआई के लिए कैननिकल गड़बड़ी कोड.

कभी-कभी एक से ज़्यादा गड़बड़ी कोड लागू हो सकते हैं. सेवाओं को लागू होने वाला सबसे खास गड़बड़ी कोड बताना चाहिए. उदाहरण के लिए, अगर दोनों कोड लागू होते हैं, तो FAILED_PRECONDITION की जगह OUT_OF_RANGE को प्राथमिकता दें. इसी तरह, FAILED_PRECONDITION के बजाय NOT_FOUND या ALREADY_EXISTS को प्राथमिकता दें.

Enums
OK

कोई गड़बड़ी नहीं; सफलता मिलने पर वापस आ गया है.

एचटीटीपी मैपिंग: 200 ठीक

CANCELLED

आम तौर पर कॉल करने वाले (कॉलर) ने ऑपरेशन रद्द कर दिया.

एचटीटीपी मैपिंग: 499 क्लाइंट का बंद किया गया अनुरोध

UNKNOWN

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

एचटीटीपी मैपिंग: 500 सर्वर में गड़बड़ी

INVALID_ARGUMENT

क्लाइंट ने एक अमान्य तर्क बताया. ध्यान दें कि यह FAILED_PRECONDITION से अलग है. INVALID_ARGUMENT ऐसे आर्ग्युमेंट के बारे में बताता है जो सिस्टम की स्थिति पर ध्यान दिए बिना समस्या पैदा करते हैं. जैसे, गलत फ़ाइल नाम.

एचटीटीपी मैपिंग: 400 गलत अनुरोध

DEADLINE_EXCEEDED

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

एचटीटीपी मैपिंग: 504 गेटवे टाइम आउट

NOT_FOUND

अनुरोध की गई कुछ इकाई (जैसे, फ़ाइल या डायरेक्ट्री) नहीं मिली.

सर्वर डेवलपर के लिए अहम जानकारी: अगर किसी ग्रुप के उपयोगकर्ताओं के लिए अनुरोध को अस्वीकार कर दिया जाता है, तो NOT_FOUND का इस्तेमाल किया जा सकता है. जैसे, धीरे-धीरे सुविधा लॉन्च करना या अनुमति वाले लोगों की सूची में शामिल नहीं किया गया अनुरोध. अगर उपयोगकर्ताओं की किसी कैटगरी के कुछ उपयोगकर्ताओं के अनुरोध को अस्वीकार कर दिया जाता है, जैसे कि उपयोगकर्ता को ध्यान में रखकर बनाया गया ऐक्सेस कंट्रोल, तो PERMISSION_DENIED का इस्तेमाल करना चाहिए.

एचटीटीपी मैपिंग: 404 नहीं मिला

ALREADY_EXISTS

क्लाइंट ने जो इकाई बनाने की कोशिश की है वह पहले से मौजूद है. जैसे- फ़ाइल या डायरेक्ट्री.

एचटीटीपी मैपिंग: 409 गड़बड़ी

PERMISSION_DENIED

कॉलर के पास यह काम करने की अनुमति नहीं है. कुछ संसाधन खत्म हो जाने की वजह से अस्वीकार किए जाने के लिए, PERMISSION_DENIED का इस्तेमाल नहीं किया जाना चाहिए. इन गड़बड़ियों के लिए, RESOURCE_EXHAUSTED का इस्तेमाल करें. अगर कॉलर की पहचान न हो पाए, तो PERMISSION_DENIED का इस्तेमाल नहीं किया जाना चाहिए. इन गड़बड़ियों के लिए, UNAUTHENTICATED का इस्तेमाल करें. यह गड़बड़ी कोड यह नहीं बताता है कि अनुरोध मान्य है या अनुरोध की गई इकाई मौजूद है या पहले से तय की गई अन्य शर्तों को पूरा करती है.

एचटीटीपी मैपिंग: 403 अनुमति नहीं है

UNAUTHENTICATED

कार्रवाई के लिए अनुरोध में मान्य प्रमाणीकरण क्रेडेंशियल नहीं हैं.

एचटीटीपी मैपिंग: 401 अनऑथराइज़्ड

RESOURCE_EXHAUSTED

कुछ संसाधन खत्म हो गए हैं. शायद हर उपयोगकर्ता के लिए कोटा खत्म हो गया है या शायद पूरा फ़ाइल सिस्टम खत्म हो गया है.

एचटीटीपी मैपिंग: 429 कई अनुरोध किए गए

FAILED_PRECONDITION

कार्रवाई को अस्वीकार कर दिया गया था, क्योंकि सिस्टम, कार्रवाई को पूरा करने के लिए ज़रूरी स्थिति में नहीं है. उदाहरण के लिए, जिस डायरेक्ट्री को मिटाया जाना है वह खाली नहीं है. साथ ही, किसी ऐसी डायरेक्ट्री पर rmder ऑपरेशन लागू किया जाता है जो डायरेक्ट्री नहीं है वगैरह.

सेवा लागू करने वाले टूल, FAILED_PRECONDITION, ABORTED, और UNAVAILABLE में से किसी एक को तय करने के लिए, इन दिशा-निर्देशों का इस्तेमाल कर सकते हैं: (a) अगर क्लाइंट, काम न करने वाले कॉल को फिर से कोशिश कर सकता है, तो UNAVAILABLE का इस्तेमाल करें. (b) अगर क्लाइंट को बड़े लेवल पर फिर से कोशिश करनी चाहिए, तो ABORTED का इस्तेमाल करें. उदाहरण के लिए, जब क्लाइंट के आधार पर तय किया गया टेस्ट-और-सेट काम नहीं करता, तो इसका मतलब है कि क्लाइंट को पढ़ने-लिखने के क्रम को रीस्टार्ट करना चाहिए. (c) अगर क्लाइंट को सिस्टम की स्थिति साफ़ तौर पर ठीक किए जाने तक फिर से कोशिश नहीं करनी चाहिए, तो FAILED_PRECONDITION का इस्तेमाल करें. उदाहरण के लिए, अगर कोई "rm गड़बड़ी" काम नहीं करती, क्योंकि डायरेक्ट्री खाली नहीं है, तो FAILED_PRECONDITION वापस आना चाहिए, क्योंकि क्लाइंट फिर से तब तक कोशिश नहीं करना चाहिए, जब तक कि फ़ाइलों को डायरेक्ट्री से मिटा न दिया जाए.

एचटीटीपी मैपिंग: 400 गलत अनुरोध

ABORTED

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

FAILED_PRECONDITION, ABORTED, और UNAVAILABLE में से किसी एक का इस्तेमाल करने के लिए, ऊपर दिए गए दिशा-निर्देश देखें.

एचटीटीपी मैपिंग: 409 गड़बड़ी

OUT_OF_RANGE

कार्रवाई की कोशिश मान्य सीमा से ज़्यादा की गई थी. उदाहरण के लिए, पिछली बार सेव किए गए कॉन्टेंट को ढूंढना या पढ़ना.

INVALID_ARGUMENT के उलट, यह गड़बड़ी एक ऐसी समस्या की जानकारी देती है जो सिस्टम की स्थिति बदलने पर ठीक हो सकती है. उदाहरण के लिए, अगर किसी ऐसे ऑफ़सेट पर पढ़ने के लिए कहा जाता है जो [0,2^32-1] की रेंज में नहीं है, तो 32-बिट फ़ाइल सिस्टम INVALID_ARGUMENT जनरेट करेगा. हालांकि, मौजूदा फ़ाइल साइज़ के बाद के ऑफ़सेट से पढ़ने के लिए कहने पर यह OUT_OF_RANGE जनरेट करेगा.

FAILED_PRECONDITION और OUT_OF_RANGE के बीच काफ़ी हद तक ओवरलैप है. हमारा सुझाव है कि जब यह लागू हो, तो OUT_OF_RANGE (ज़्यादा खास गड़बड़ी) का इस्तेमाल करें. इससे स्पेस में बार-बार आने वाले कॉलर, OUT_OF_RANGE गड़बड़ी का पता लगा सकेंगे, ताकि उन्हें पूरा होने का समय पता चल सके.

एचटीटीपी मैपिंग: 400 गलत अनुरोध

UNIMPLEMENTED

कार्रवाई लागू नहीं की गई है या इस सेवा में समर्थित/चालू नहीं है.

एचटीटीपी मैपिंग: 501 लागू नहीं किया गया

INTERNAL

अंदरूनी गड़बड़ियां. इसका मतलब है कि सिस्टम को जिन इन वैरिएंट की उम्मीद थी वे काम नहीं कर रहे हैं. गड़बड़ी का यह कोड गंभीर गड़बड़ियों के लिए रिज़र्व है.

एचटीटीपी मैपिंग: 500 सर्वर में गड़बड़ी

UNAVAILABLE

फ़िलहाल, सेवा उपलब्ध नहीं है. यह समस्या कुछ समय के लिए होती है, जिसे बैकऑफ़ की मदद से फिर से कोशिश करके ठीक किया जा सकता है. ध्यान दें कि हमेशा से गैर-गुमराह करने वाले कामों का फिर से करना सुरक्षित नहीं होता.

FAILED_PRECONDITION, ABORTED, और UNAVAILABLE में से किसी एक का इस्तेमाल करने के लिए, ऊपर दिए गए दिशा-निर्देश देखें.

एचटीटीपी मैपिंग: 503 सेवा उपलब्ध नहीं है

DATA_LOSS

डेटा को वापस नहीं पाया जा सकने वाला डेटा या नुकसान.

एचटीटीपी मैपिंग: 500 सर्वर में गड़बड़ी

UpdatedWidget

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

जेएसओएन के काेड में दिखाना
{
  "widget": string,

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
फ़ील्ड
widget

string

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

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

object (SelectionItems)

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

SelectionItems

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

जेएसओएन के काेड में दिखाना
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
फ़ील्ड
items[]

object (SelectionItem)

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

SlashCommand

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

जेएसओएन के काेड में दिखाना
{
  "commandId": string
}
फ़ील्ड
commandId

string (int64 format)

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

MatchedUrl

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

जेएसओएन के काेड में दिखाना
{
  "url": string
}
फ़ील्ड
url

string

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

EmojiReactionSummary

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

जेएसओएन के काेड में दिखाना
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
फ़ील्ड
emoji

object (Emoji)

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

reactionCount

integer

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

DeletionMetadata

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

जेएसओएन के काेड में दिखाना
{
  "deletionType": enum (DeletionType)
}
फ़ील्ड
deletionType

enum (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 ऐप्लिकेशन ने मैसेज मिटा दिया है.

QuotedMessageMetadata

कोट किए गए मैसेज के बारे में जानकारी.

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "lastUpdateTime": string
}
फ़ील्ड
name

string

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

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

lastUpdateTime

string (Timestamp format)

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

AttachedGif

यूआरएल से मिली GIF इमेज.

जेएसओएन के काेड में दिखाना
{
  "uri": string
}
फ़ील्ड
uri

string

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

AccessoryWidget

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

जेएसओएन के काेड में दिखाना
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
फ़ील्ड
यूनियन फ़ील्ड action. कार्रवाई का टाइप. action इनमें से सिर्फ़ एक हो सकती है:
buttonList

object (ButtonList)

बटन की सूची.

तरीके

create

Google Chat के स्पेस में मैसेज बनाता है.

delete

मैसेज को मिटाता है.

get

किसी मैसेज की जानकारी दिखाता है.

list

यह उस स्पेस में मैसेज की सूची बनाता है जिसका कॉलर सदस्य है. इसमें ब्लॉक किए गए सदस्यों और स्पेस के मैसेज भी शामिल हैं.

patch

मैसेज अपडेट करता है.

update

मैसेज अपडेट करता है.