Bu kılavuzda, mesaj dizilerini okundu veya okunmadı olarak işaretlemek için Google Chat API'nin ThreadReadState kaynağında update yönteminin nasıl kullanılacağı açıklanmaktadır.
ThreadReadState kaynağı,
belirli bir kullanıcının Google Chat mesaj dizisinde en son okuduğu mesajla ilgili ayrıntıları temsil eden tekil bir kaynaktır.
Ön koşullar
Node.js
- Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
- Ortamınızı ayarlama:
- Google Cloud projesi oluşturun.
- OAuth kullanıcı rızası ekranını yapılandırın.
- Chat uygulamanız için bir ad, simge ve açıklama belirleyerek Google Chat API'yi etkinleştirin ve yapılandırın.
- Node.js Cloud istemci kitaplığını yükleyin.
- Masaüstü uygulaması için OAuth istemci kimliği kimlik bilgileri oluşturun. Bu kılavuzdaki örneği çalıştırmak için kimlik bilgilerini yerel dizininize
credentials.jsonadlı bir JSON dosyası olarak kaydedin.
- Kullanıcı kimlik doğrulamasını destekleyen bir yetkilendirme kapsamı seçin.
Python
- Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
- Ortamınızı ayarlama:
- Google Cloud projesi oluşturun.
- OAuth kullanıcı rızası ekranını yapılandırın.
- Chat uygulamanız için bir ad, simge ve açıklama belirleyerek Google Chat API'yi etkinleştirin ve yapılandırın.
- Python Cloud istemci kitaplığını yükleyin.
- Masaüstü uygulaması için OAuth istemci kimliği kimlik bilgileri oluşturun. Bu kılavuzdaki örneği çalıştırmak için kimlik bilgilerini yerel dizininize
credentials.jsonadlı bir JSON dosyası olarak kaydedin.
- Kullanıcı kimlik doğrulamasını destekleyen bir yetkilendirme kapsamı seçin.
Arayan kullanıcının ileti dizisi okuma durumunu güncelleme
Bir kullanıcının ileti dizisi görünümündeki okuma durumunu güncellemek için isteğinize aşağıdakileri ekleyin:
chat.users.readstateyetkilendirme kapsamını belirtin.UpdateThreadReadStateyöntemini çağırın.updateMaskparametresinilastReadTimedeğeriyle iletin.threadReadStatedeğerini, aşağıdaki kodlaThreadReadStateörneği olarak iletin:- Güncellenecek mesaj dizisi okuma durumuna ayarlanmış
namealanı. Bu alan; kullanıcı kimliği veya takma ad, alan kimliği ve mesaj dizisi kimliği içerir. Mesaj dizisinin okundu durumunu güncelleme işlemi, yalnızca arayan kullanıcının okundu durumunun güncellenmesini destekler. Bu durum, aşağıdakilerden biri ayarlanarak belirtilebilir:metakma adı. Örneğin,users/me/spaces/SPACE/threads/THREAD/threadReadState.- Arayan kullanıcının Workspace e-posta adresi. Örneğin,
users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState. - Arayan kullanıcının kullanıcı kimliği. Örneğin,
users/USER/spaces/SPACE/threads/THREAD/threadReadState.
lastReadTimealanı, ileti dizisinde arayan kullanıcının son okuma konumunu belirten zaman damgasına (ör. son okunan mesajın zaman damgası veya geçerli saat) ayarlanır:- Okunmadı olarak işaretle:
lastReadTimedeğerini, ileti dizisindeki en son mesajın oluşturulma zamanından daha önceki bir zaman damgasına ayarlayın. Chat'te, mesaj dizisi bu zaman damgasından itibaren okunmamış olarak görünür, okunmamış rozetleri güncellenir, mesaj dizisi kalın harflerle gösterilir ve Ana Sayfa'da gösterilir. - Okundu olarak işaretleme:
lastReadTimedeğerini, ileti dizisindeki son mesajın oluşturulma zamanına eşit veya daha sonraki bir zaman damgasına ayarlayın. Gelecekteki bir zaman damgası belirtirseniz API,lastReadTimedeğerini geçerli istek zamanına zorlar. - Minimum zaman damgası:
lastReadTimealanı, Unix epoch (1970-01-01T00:00:00Z) tarihinde veya sonrasında olmalıdır. Negatif bir zaman damgası (1970-01-01T00:00:00Ztarihinden önce) ayarlandığındaINVALID_ARGUMENT(400) hatası döndürülür.
- Okunmadı olarak işaretle:
- Güncellenecek mesaj dizisi okuma durumuna ayarlanmış
Aşağıdaki örnekte, arayan kullanıcının ileti dizisi okuma durumu güncellenmektedir:
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()
Bu örneği çalıştırmak için aşağıdakileri değiştirin:
SPACE_NAME: Alanınnamekimliği. Kimliği,ListSpacesyöntemini çağırarak veya alanın URL'sinden alabilirsiniz.THREAD_NAME: Mesaj dizisininnamekimliği. Kimliği, Chat API ile eşzamansız olarak bir mesaj oluşturduktan sonra döndürülen yanıt gövdesinden veya oluşturma sırasında mesaja atanan özel ad ile alabilirsiniz.
Chat API, belirtilen mesaj dizisinin okundu durumunu günceller ve bir ThreadReadState örneği döndürür.