किसी उपयोगकर्ता के लिए, थ्रेड के पढ़े जाने की स्थिति अपडेट करना

इस गाइड में, Google Chat API के ThreadReadState संसाधन पर update तरीके का इस्तेमाल करके, मैसेज थ्रेड को 'पढ़ा गया' या 'नहीं पढ़ा गया' के तौर पर मार्क करने का तरीका बताया गया है.

ThreadReadState संसाधन एक सिंगलटन संसाधन है. इससे Google Chat के मैसेज थ्रेड में, किसी उपयोगकर्ता के पढ़े गए आखिरी मैसेज की जानकारी मिलती है.

ज़रूरी शर्तें

Node.js

Python

कॉल करने वाले उपयोगकर्ता के थ्रेड को पढ़े जाने की स्थिति अपडेट करना

किसी मैसेज थ्रेड में उपयोगकर्ता के लिए, मैसेज पढ़े जाने की स्थिति अपडेट करने के लिए, अपने अनुरोध में यह शामिल करें:

  • chat.users.readstate अनुमति का स्कोप तय करें.
  • UpdateThreadReadState मेथड को कॉल करें.
  • updateMask को lastReadTime वैल्यू के साथ पास करें.
  • threadReadState को ThreadReadState के इंस्टेंस के तौर पर पास करें. इसके लिए, यह तरीका अपनाएं:
    • name फ़ील्ड को थ्रेड के पढ़े जाने की स्थिति पर सेट किया गया है, ताकि उसे अपडेट किया जा सके. इसमें यूज़र आईडी या उपनाम, स्पेस आईडी, और थ्रेड आईडी शामिल होता है. थ्रेड के पढ़े जाने की स्थिति को अपडेट करने पर, सिर्फ़ कॉल करने वाले उपयोगकर्ता के पढ़े जाने की स्थिति अपडेट होती है. इसे इनमें से कोई एक सेट करके तय किया जा सकता है:
      • me एलियस. उदाहरण के लिए, users/me/spaces/SPACE/threads/THREAD/threadReadState.
      • कॉल करने वाले उपयोगकर्ता के Workspace खाते से जुड़ा ईमेल पता. उदाहरण के लिए, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
      • कॉल करने वाले उपयोगकर्ता का यूज़र आईडी. उदाहरण के लिए, users/USER/spaces/SPACE/threads/THREAD/threadReadState.
    • lastReadTime फ़ील्ड को उस टाइमस्टैंप पर सेट किया गया है जो थ्रेड में कॉल करने वाले उपयोगकर्ता की आखिरी बार पढ़ी गई पोज़िशन को मार्क करता है. जैसे, आखिरी बार पढ़े गए मैसेज का टाइमस्टैंप या मौजूदा समय:
      • 'नहीं पढ़ा गया' के तौर पर मार्क करें: lastReadTime को थ्रेड में मौजूद सबसे नए मैसेज के बनाए जाने के समय से पहले के टाइमस्टैंप पर सेट करें. Chat में, उस टाइमस्टैंप के बाद से थ्रेड 'नहीं पढ़ा गया' के तौर पर दिखता है. साथ ही, 'नहीं पढ़े गए' बैज अपडेट हो जाते हैं, थ्रेड बोल्ड हो जाता है, और होम पेज पर दिखता है.
      • 'पढ़ा गया' के तौर पर मार्क करें: lastReadTime को थ्रेड में मौजूद सबसे नए मैसेज के बनाए जाने के समय के बराबर या उसके बाद के टाइमस्टैंप पर सेट करें. अगर आपने आने वाले समय का कोई टाइमस्टैंप तय किया है, तो एपीआई lastReadTime को अनुरोध के मौजूदा समय के हिसाब से सेट कर देता है.
      • कम से कम टाइमस्टैंप: lastReadTime फ़ील्ड, Unix epoch (1970-01-01T00:00:00Z) के समय या उसके बाद का होना चाहिए. नेगेटिव टाइमस्टैंप (1970-01-01T00:00:00Z से पहले) सेट करने पर, INVALID_ARGUMENT (400) गड़बड़ी का मैसेज दिखता है.

यहां दिए गए उदाहरण में, कॉल करने वाले उपयोगकर्ता के थ्रेड को पढ़े जाने की स्थिति अपडेट की गई है:

Node.js

/**
 * This sample shows how to update the calling user's thread read state.
 *
 * It relies on the @google-apps/chat npm package.
 */
// Read the documentation for more details:
// https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');

async function main() {
  // Create a client
  const chatClient = new ChatServiceClient({
    authClient: await auth.getClient({
      scopes: ['https://www.googleapis.com/auth/chat.users.readstate']
    })
  });

  // Initialize request arguments.
  const request = {
    threadReadState: {
      name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState',
      lastReadTime: {
        seconds: Math.floor(Date.now() / 1000),
        nanos: 0
      }
    },
    updateMask: {
      paths: ['last_read_time']
    }
  };

  // Make the request
  const response = await chatClient.updateThreadReadState(request);
  console.log(response);
}

main().catch(console.error);

Python

"""
This sample shows how to update the calling user's thread read state.
"""
from google.apps import chat_v1
import google.auth
from google.protobuf import timestamp_pb2

# Read the documentation for more details:
# https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

def update_thread_read_state():
    # Authenticate with Chat API using user credentials.
    credentials, _ = google.auth.default(
        scopes=["https://www.googleapis.com/auth/chat.users.readstate"]
    )
    client = chat_v1.ChatServiceClient(credentials=credentials)

    # Set timestamp for last read time.
    now = timestamp_pb2.Timestamp()
    now.GetCurrentTime()

    thread_read_state = chat_v1.ThreadReadState(
        name="users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState",
        last_read_time=now,
    )

    request = chat_v1.UpdateThreadReadStateRequest(
        thread_read_state=thread_read_state,
        update_mask={"paths": ["last_read_time"]},
    )

    response = client.update_thread_read_state(request=request)
    print(response)

if __name__ == "__main__":
    update_thread_read_state()

इस सैंपल को चलाने के लिए, इन्हें बदलें:

  • SPACE_NAME: स्पेस के name से मिला आईडी. आईडी पाने के लिए, ListSpaces तरीके को कॉल करें या स्पेस के यूआरएल का इस्तेमाल करें.
  • THREAD_NAME: थ्रेड के name का आईडी. आईडी को, Chat API की मदद से एसिंक्रोनस तरीके से मैसेज बनाने के बाद, रिस्पॉन्स बॉडी से हासिल किया जा सकता है. इसके अलावा, मैसेज बनाते समय असाइन किए गए कस्टम नाम से भी आईडी हासिल किया जा सकता है.

Chat API, थ्रेड के पढ़े जाने की स्थिति को अपडेट करता है और ThreadReadState का इंस्टेंस दिखाता है.