उपयोगकर्ता की स्पेस में पढ़ने की स्थिति अपडेट करें

इस गाइड में बताया गया है कि स्पेस को पढ़ा गया या नहीं पढ़ा गया का निशान लगाने के लिए, Google Chat API के SpaceReadState संसाधन पर updateSpaceReadState तरीके का इस्तेमाल कैसे करना है.

SpaceReadState रिसॉर्स एक सिंगलटन रिसॉर्स है, जो Google Chat के स्पेस में किसी उपयोगकर्ता के आखिरी बार पढ़े गए मैसेज की जानकारी दिखाता है.

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

Python

  • Python 3.6 या इससे नया वर्शन
  • pip पैकेज मैनेजमेंट टूल

  • Python के लिए नई Google क्लाइंट लाइब्रेरी. उन्हें इंस्टॉल या अपडेट करने के लिए, अपने कमांड-लाइन इंटरफ़ेस में नीचे दिया गया कमांड चलाएं:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • ऐसा Google Cloud प्रोजेक्ट जिसमें Google Chat API चालू हो और उसे कॉन्फ़िगर किया गया हो. तरीका जानने के लिए, Google Chat ऐप्लिकेशन बनाना देखें.

  • Chat ऐप्लिकेशन के लिए अनुमति कॉन्फ़िगर की गई. स्पेस में, उपयोगकर्ता के रीड स्टेटस के बारे में जानकारी पाने के लिए, chat.users.readstate की अनुमति के साथ-साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है.

Node.js

  • Node.js और npm

  • Node.js के लिए नई Google क्लाइंट लाइब्रेरी. उन्हें इंस्टॉल करने के लिए, अपने कमांड-लाइन इंटरफ़ेस में इस कमांड को चलाएं:

    npm install @google-cloud/local-auth @googleapis/chat
  • ऐसा Google Cloud प्रोजेक्ट जिसमें Google Chat API चालू हो और उसे कॉन्फ़िगर किया गया हो. तरीका जानने के लिए, Google Chat ऐप्लिकेशन बनाना देखें.

  • Chat ऐप्लिकेशन के लिए अनुमति कॉन्फ़िगर की गई. स्पेस में, उपयोगकर्ता के रीड स्टेटस के बारे में जानकारी पाने के लिए, chat.users.readstate की अनुमति के साथ-साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है.

Apps Script

  • Google Workspace खाता, जिसमें Google Chat का ऐक्सेस हो.
  • पब्लिश किया गया Chat ऐप्लिकेशन. Chat ऐप्लिकेशन बनाने के लिए, इस quickstart को अपनाएं.
  • Chat ऐप्लिकेशन के लिए अनुमति कॉन्फ़िगर की गई. स्पेस में, उपयोगकर्ता के रीड स्टेटस के बारे में जानकारी पाने के लिए, chat.users.readstate की अनुमति के साथ-साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है.

कॉल करने वाले उपयोगकर्ता के स्पेस में किए गए बदलाव की स्थिति अपडेट करें

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

  • chat.users.readstate अनुमति का स्कोप बताएं.
  • SpaceReadState संसाधन पर updateSpaceReadState वाला तरीका कॉल करें.
  • ऐक्सेस पाने के लिए, स्पेस का रीड स्टेट का name पास करें. इसमें यूज़र आईडी या उपनाम और स्पेस आईडी शामिल है. स्पेस में दी गई जानकारी फ़ेच करने की स्थिति, सिर्फ़ कॉल करने वाले उपयोगकर्ता की रीड की स्थिति पाने के लिए काम करती है. यह जानकारी, इनमें से किसी एक को सेट करके दी जा सकती है:
    • me उपनाम. उदाहरण के लिए, users/me/spaces/SPACE/spaceReadState.
    • कॉल करने वाले उपयोगकर्ता का Workspace ईमेल पता. उदाहरण के लिए, users/user@example.com/spaces/SPACE/spaceReadState.
    • कॉल करने वाले उपयोगकर्ता का यूज़र आईडी. उदाहरण के लिए, users/USER/spaces/SPACE/spaceReadState.
  • updateMask को पास करें, जो अपडेट करने के लिए स्पेस की रीड की स्थिति के पहलुओं के बारे में बताता है. यह इन फ़ील्ड पाथ के साथ काम करता है:
    • lastReadTime: वह समय जब उपयोगकर्ता के स्पेस के पढ़े जाने की स्थिति को अपडेट किया गया था. आम तौर पर, यह मैसेज पिछली बार पढ़े गए मैसेज के टाइमस्टैंप या स्पेस में उपयोगकर्ता की तरफ़ से आखिरी बार पढ़े गए मैसेज की पोज़िशन के तौर पर मार्क किया जाता है. जब lastReadTime, मैसेज बनाने के नए समय से पहले का होता है, तो यूज़र इंटरफ़ेस (यूआई) में स्पेस, 'नहीं पढ़ा गया' के तौर पर दिखता है. स्पेस को पढ़ा गया के तौर पर मार्क करने के लिए, lastReadTime को नए मैसेज बनाने के समय के मुकाबले, बाद में किसी भी वैल्यू (बड़े साइज़ में) पर सेट करें. lastReadTime को नए मैसेज बनाने के समय से मिलाने के लिए लागू किया गया है. ध्यान दें कि स्पेस के पढ़े जाने की स्थिति से, सिर्फ़ उन मैसेज को पढ़े जाने की स्थिति पर असर पड़ता है जो स्पेस की टॉप-लेवल की बातचीत में दिखते हैं. थ्रेड में दिए गए जवाबों पर इस टाइमस्टैंप का कोई असर नहीं पड़ता. इसके बजाय, वे थ्रेड के पढ़े जाने की स्थिति पर निर्भर होते हैं.

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

Python

  1. अपनी वर्किंग डायरेक्ट्री में, chat_spaceReadState_update.py नाम की फ़ाइल बनाएं.

  2. chat_spaceReadState_update.py में यह कोड शामिल करें:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.users.readstate"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the space read state for the calling user.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.users().spaces().updateSpaceReadState(

        # The space read state to update.
        #
        # Replace USER with the calling user's ID, Workspace email,
        # or the alias me.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='users/me/spaces/SPACE/spaceReadState',
        updateMask='lastReadTime',
        body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'}

      ).execute()

    # Prints the API's response.
    print(result)

if __name__ == '__main__':
    main()

  3. कोड में, इन्हें बदलें:

    • SPACE: स्पेस का नाम, जिसे Chat API में spaces.list तरीके से या स्पेस के यूआरएल से पाया जा सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, यह सैंपल बनाएं और चलाएं:

    python3 chat_spaceReadState_update.py

Node.js

  1. अपनी वर्किंग डायरेक्ट्री में, chat_spaceReadState_update.js नाम की फ़ाइल बनाएं.

  2. chat_spaceReadState_update में यह कोड शामिल करें:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Authenticates with Chat API via user credentials,
* then updates the space read state for the calling user.
* @return {!Promise<!Object>}
*/
async function updateSpaceReadState() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.users.readstate',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  /**
  * Build a service endpoint for Chat API.
  */
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  /**
  * Use the service endpoint to call Chat API.
  */
  return await chatClient.users.spaces.updateSpaceReadState({

    /**
    * The space read state to update.
    *
    * Replace USER with the calling user's ID, Workspace email,
    * or the alias me.
    *
    * Replace SPACE with a space name.
    * Obtain the space name from the spaces resource of Chat API,
    * or from a space's URL.
    */
    name: 'users/me/spaces/SPACE/spaceReadState',
    updateMask: 'lastReadTime',
    requestBody: {
      lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z'
    }
  });
}

/**
* Use the service endpoint to call Chat API.
*/
getSpaceReadState().then(console.log);

  3. कोड में, इन्हें बदलें:

    • SPACE: स्पेस का नाम, जिसे Chat API में spaces.list तरीके से या स्पेस के यूआरएल से पाया जा सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, यह सैंपल बनाएं और चलाएं:

    node chat_spaceReadState_update.js

Apps Script

इस उदाहरण में, बेहतर चैट सेवा का इस्तेमाल करके Chat API को कॉल किया जाता है.

  1. Apps Script प्रोजेक्ट की appsscript.json फ़ाइल में, chat.users.readstate अनुमति का स्कोप जोड़ें:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate"
]

  2. Apps Script प्रोजेक्ट के कोड में, इस तरह का कोई फ़ंक्शन जोड़ें:

    /**
* Authenticates with Chat API via user credentials,
* then updates the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function updateSpaceReadState(spaceReadStateName) {
  try {
    const time = new Date('January 1, 2000')).toJSON();
    const body = {'lastReadTime': time};
    Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to update read state with error %s', err.message);
  }
}

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