REST Resource: spaces.messages

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

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

JSON के काेड में दिखाना 
{
  "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.

अगर मैसेज बनाते समय कस्टम आईडी सेट किया जाता है, तो अनुरोध में मैसेज की जानकारी देने के लिए इस आईडी का इस्तेमाल किया जा सकता है. इसके लिए, {message} को clientAssignedMessageId फ़ील्ड की वैल्यू से बदलें. उदाहरण के लिए, 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>.

  • :{emojiName}: फ़ॉर्मैट का इस्तेमाल करके बनाया गया कस्टम इमोजी—उदाहरण के लिए, :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 API को कॉल करना होगा. साथ ही, इन्हें छोड़ देना होगा:

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

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

object (AttachedGif)

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

object (AccessoryWidget)

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

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

CardWithId

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

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

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

कार्ड बिल्डर खोलना

JSON के काेड में दिखाना 
{
  "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"
   }
}]
JSON के काेड में दिखाना 
{
  "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

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

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

object (User)

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

enum (Type)

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

टाइप

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

SlashCommandMetadata

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

JSON के काेड में दिखाना 
{
  "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

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

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

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

string

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

RichLinkType

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

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

DriveLinkData

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

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

object (DriveDataRef)

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

string

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

ChatSpaceLinkData

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

JSON के काेड में दिखाना 
{
  "space": string,
  "thread": string,
  "message": string
}
फ़ील्ड
space

string

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

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

string

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

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

string

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

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

थ्रेड

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

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

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

string

आइडेंटिफ़ायर. थ्रेड का संसाधन नाम.

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

string

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

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

ActionResponse

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

JSON के काेड में दिखाना 
{
  "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

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

JSON के काेड में दिखाना 
{
  "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)

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

Dialog

डायलॉग के कार्ड बॉडी के चारों ओर मौजूद रैपर.

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

object (Card)

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

ActionStatus

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

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

enum (Code)

स्टेटस कोड.
userFacingMessage

string

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

कोड

gRPC API के लिए कैननिकल गड़बड़ी कोड.

कभी-कभी एक से ज़्यादा गड़बड़ी कोड लागू हो सकते हैं. सेवाओं को गड़बड़ी का सबसे सटीक कोड दिखाना चाहिए. उदाहरण के लिए, अगर दोनों कोड लागू होते हैं, तो 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

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

सेवा लागू करने वाले लोग, 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 के उलट, यह गड़बड़ी किसी ऐसी समस्या की जानकारी देती है जिसे सिस्टम की स्थिति बदलने पर ठीक किया जा सकता है. उदाहरण के लिए, अगर 32-बिट फ़ाइल सिस्टम को किसी ऐसे ऑफ़सेट पर पढ़ने के लिए कहा जाए जो [0,2^32-1] की रेंज में नहीं है, तो यह 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 में से किसी एक को चुनने के लिए, ऊपर दिए गए दिशा-निर्देश देखें.

HTTP मैपिंग: 503 सेवा अनुपलब्ध
DATA_LOSS

डेटा को वापस नहीं पाया जा सकता या डेटा खराब हो गया.

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

UpdatedWidget

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

JSON के काेड में दिखाना 
{
  "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

विजेट के लिए ऑटोकंप्लीट की सुविधा से मिलने वाले नतीजों की सूची.

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

object (SelectionItem)

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

SlashCommand

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

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

string (int64 format)

इस्तेमाल किए गए स्लैश कमांड का आईडी.

MatchedUrl

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

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

string

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

EmojiReactionSummary

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

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

object (Emoji)

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

integer

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

DeletionMetadata

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

JSON के काेड में दिखाना 
{
  "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 किसी चैट ऐप्लिकेशन ने स्पेस के मालिक की ओर से मैसेज मिटाया हो.

QuotedMessageMetadata

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

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

string

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

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

string (Timestamp format)

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

AttachedGif

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

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

string

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

AccessoryWidget

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

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

  // 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

 यह किसी मैसेज को अपडेट करता है.