Mendapatkan detail tentang status pembacaan ruang pengguna

Panduan ini menjelaskan cara menggunakan metode getSpaceReadState pada SpaceReadState resource Google Chat API untuk mendapatkan detail tentang pembacaan pengguna status dalam ruang. Untuk mendapatkan status dibaca dari pesan dalam rangkaian pesan, lihat Mendapatkan detail tentang status pembacaan thread pengguna.

Tujuan Referensi SpaceReadState adalah resource singleton yang mewakili detail tentang pesan yang terakhir dibaca pengguna tertentu di ruang Google Chat.

Prasyarat

Python

Node.js

Apps Script

Mendapatkan status pembacaan ruang pengguna yang menelepon

Untuk mendapatkan detail tentang status baca pengguna dalam ruang, sertakan info berikut dalam permintaan Anda:

  • Tentukan chat.users.readstate atau chat.users.readstate.readonly cakupan otorisasi.
  • Panggil Metode getSpaceReadState di Resource SpaceReadState.
  • Teruskan name status baca ruang yang akan didapatkan, yang mencakup ID pengguna atau alias dan ID ruang. Mendapatkan status baca ruang hanya mendukung mendapatkan operasi baca pengguna yang menelepon, yang bisa ditetapkan dengan mengatur salah satu status berikut ini:
    • Alias me. Misalnya, users/me/spaces/SPACE/spaceReadState.
    • Alamat email Workspace pengguna yang menelepon. Misalnya, users/user@example.com/spaces/SPACE/spaceReadState.
    • ID pengguna pengguna yang menelepon. Misalnya, users/USER/spaces/SPACE/spaceReadState.

Contoh berikut mendapatkan status pembacaan ruang pengguna yang melakukan panggilan:

Python

  1. Di direktori kerja, buat file bernama chat_spaceReadState_get.py.

  2. Sertakan kode berikut di 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. Dalam kode, ganti kode berikut:

    • SPACE: nama ruang, yang yang dapat diperoleh dari Metode spaces.list di Chat API, atau dari URL ruang.

  4. Dalam direktori kerja, build dan jalankan contoh:

    python3 chat_spaceReadState_get.py

Node.js

  1. Di direktori kerja, buat file bernama chat_spaceReadState_get.js.

  2. Sertakan kode berikut di 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. Dalam kode, ganti kode berikut:

    • SPACE: nama ruang, yang yang dapat diperoleh dari Metode spaces.list di Chat API, atau dari URL ruang.

  4. Dalam direktori kerja, build dan jalankan contoh:

    node chat_spaceReadState_get.js

Apps Script

Contoh ini memanggil Chat API menggunakan Layanan Chat Lanjutan.

  1. Tambahkan cakupan otorisasi chat.users.readstate.readonly ke File appsscript.json project Apps Script:

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

  2. Tambahkan fungsi seperti ini ke project Apps Script kode:

    /**
* 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 mendapatkan status pembacaan ruang yang ditentukan dan menampilkan contoh dari Referensi SpaceReadState.