किसी उपयोगकर्ता के स्पेस को पढ़े जाने की स्थिति के बारे में जानकारी पाएं

इस गाइड में बताया गया है कि स्पेस में किसी उपयोगकर्ता की पढ़ने की स्थिति के बारे में जानकारी पाने के लिए, Google Chat API के SpaceReadState संसाधन पर getSpaceReadState तरीके का इस्तेमाल कैसे करते हैं. मैसेज थ्रेड में किसी मैसेज की पढ़ी गई स्थिति जानने के लिए, उपयोगकर्ता के थ्रेड में पढ़े गए मैसेज की स्थिति के बारे में जानकारी पाना देखें.

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 या chat.users.readstate.readonly की अनुमति के साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है.

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 या chat.users.readstate.readonly की अनुमति के साथ उपयोगकर्ता की पुष्टि करना ज़रूरी है.

Apps Script

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

कॉल करने वाले उपयोगकर्ता के लिए, स्पेस का ऐक्सेस पढ़े जाने की जानकारी पाना

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

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

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

Python

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

  2. chat_spaceReadState_get.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.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets 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().getSpaceReadState(

        # The space read state to get.
        #
        # 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'

      ).execute()

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

if __name__ == '__main__':
    main()

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

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

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

    python3 chat_spaceReadState_get.py

Node.js

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

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

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

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

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

  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.getSpaceReadState({

    /**
    * The space read state to get.
    *
    * 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'
  });
}

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

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

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

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

    node chat_spaceReadState_get.js

Apps Script

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

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

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

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

    /**
* Authenticates with Chat API via user credentials,
* then gets the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function getSpaceReadState(spaceReadStateName) {
  try {
    Chat.Users.Spaces.getSpaceReadState(spaceReadStateName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get read state with error %s', err.message);
  }
}

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