Panduan ini menjelaskan cara menggunakan metode getThreadReadState
pada
ThreadReadState
resource Google Chat API untuk mendapatkan detail tentang
status baca dalam rangkaian pesan. Untuk mendapatkan status dibaca pesan dalam
spasi, lihat
Mendapatkan detail tentang status pembacaan ruang pengguna.
Tujuan
Referensi ThreadReadState
adalah resource singleton yang mewakili detail tentang
pesan yang terakhir dibaca oleh pengguna tertentu dalam rangkaian pesan Google Chat.
Prasyarat
Python
- Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- Menyiapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Python Library Klien Google API.
-
Membuat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan
sampel dalam
panduan, simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Node.js
- Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- Menyiapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Node.js Library Klien Google API.
-
Membuat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan
sampel dalam
panduan, simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Apps Script
- Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- Menyiapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Membuat project Apps Script mandiri, dan aktifkan Layanan Chat Lanjutan.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Mendapatkan status pembacaan thread pengguna yang pemanggil
Untuk mendapatkan detail tentang status dibaca pengguna dalam rangkaian pesan, sertakan atribut berikut dalam permintaan Anda:
- Tentukan
chat.users.readstate
atauchat.users.readstate.readonly
cakupan otorisasi. - Panggil
Metode
getThreadReadState
di ResourceThreadReadState
. - Teruskan
name
status pembacaan thread yang akan didapatkan, yang mencakup ID pengguna atau alias dan ID ruang. Mendapatkan status pembacaan thread 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/threads/THREAD/threadReadState
. - Alamat email Workspace pengguna yang menelepon. Misalnya,
users/[email protected]/spaces/SPACEthreads/THREAD/threadReadState
. - ID pengguna pengguna yang menelepon. Misalnya,
users/USER/spaces/SPACE/threads/THREAD/threadReadState
.
- Alias
Contoh berikut mendapatkan status pembacaan thread pengguna yang pemanggil:
Python
- Di direktori kerja, buat file bernama
chat_threadReadState_get.py
. Sertakan kode berikut di
chat_threadReadState_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 thread 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().threads().getThreadReadState( # The thread 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. # # Replace THREAD with a thread name. # Obtain the thread name from the messages resource of Chat API. name='users/me/spaces/SPACE/threads/THREAD/threadReadState' ).execute() # Prints the API's response. print(result) if __name__ == '__main__': main()
Dalam kode, ganti kode berikut:
SPACE
: nama ruang, yang yang dapat diperoleh dari Metodespaces.list
di Chat API, atau dari URL ruang.THREAD
: nama thread, yang yang dapat diperoleh dari Metodespaces.messages.get
di Chat API.
Dalam direktori kerja, build dan jalankan contoh:
python3 chat_threadReadState_get.py
Node.js
- Di direktori kerja, buat file bernama
chat_threadReadState_get.js
. Sertakan kode berikut di
chat_threadReadState_get
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then gets the thread read state for the calling user. * @return {!Promise<!Object>} */ async function getThreadReadState() { /** * 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.threads.getThreadReadState({ /** * The thread 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/threads/THREADS/threadReadState' }); } /** * Use the service endpoint to call Chat API. */ getThreadReadState().then(console.log);
Dalam kode, ganti kode berikut:
SPACE
: nama ruang, yang yang dapat diperoleh dari Metodespaces.list
di Chat API, atau dari URL ruang.THREAD
: nama thread, yang yang dapat diperoleh dari Metodespaces.messages.get
di Chat API.
Dalam direktori kerja, build dan jalankan contoh:
node chat_threadReadState_get.js
Apps Script
Contoh ini memanggil Chat API menggunakan Layanan Chat Lanjutan.
Tambahkan cakupan otorisasi
chat.users.readstate.readonly
ke Fileappsscript.json
project Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate.readonly" ]
Tambahkan fungsi seperti ini ke project Apps Script kode:
/** * Authenticates with Chat API via user credentials, * then gets the thread read state for the calling user. * @param {string} threadReadStateName The resource name of the thread read state. */ function getThreadReadState(threadReadStateName) { try { Chat.Users.Spaces.Threads.getThreadReadState(threadReadStateName); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to get read state with error %s', err.message); } }
Google Chat API mendapatkan status pembacaan thread yang ditentukan dan menampilkan
contoh dari
Referensi ThreadReadState
.
Topik terkait
- Memperbarui status pembacaan ruang pengguna yang melakukan panggilan.
- Mendapatkan status pembacaan ruang pengguna yang melakukan panggilan.