Bir kullanıcının alan okuma durumuyla ilgili ayrıntıları alma

Bu kılavuzda, getSpaceReadState yönteminin nasıl kullanılacağı Bir kullanıcının okuma işlemiyle ilgili ayrıntıları almak için Google Chat API'nin SpaceReadState kaynağı durumu belirleyebilirsiniz. Bir ileti dizisindeki iletinin okunma durumunu öğrenmek için: bkz. Bir kullanıcının ileti dizisinin okunma durumuyla ilgili ayrıntıları alma.

İlgili içeriği oluşturmak için kullanılan SpaceReadState kaynak hakkındaki ayrıntıları temsil eden tekil bir kaynaktır: Belirtilen kullanıcının bir Google Chat alanında son okunan mesajı.

Ön koşullar

Python

  • Python 3.6 veya sonraki sürümler
  • pip paket yönetim aracı
  • En yeni Google istemci kitaplıkları. Bu uygulamaları yüklemek veya güncellemek için komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:
    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

Node.js

  • Node.js 14 veya sonraki sürümler
  • npm paket yönetim aracı
  • En yeni Google istemci kitaplıkları. Bu uygulamaları yüklemek veya güncellemek için komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:
    npm install @google-cloud/local-auth @googleapis/chat
    

Apps Komut Dosyası

Arayan kullanıcının alan okuma durumunu öğren

Bir kullanıcının alandaki okuma durumuyla ilgili ayrıntıları görmek için aşağıdaki bilgileri ekleyin talebinizde:

  • chat.users.readstate veya chat.users.readstate.readonly belirtin yetkilendirme kapsamı
  • Şunu çağırın: getSpaceReadState yöntem uygulamasında SpaceReadState kaynak.
  • Almak için alan okuma durumunun name kısmını iletin (kullanıcı kimliği veya kullanıcı kimliği dahil). takma ad ve alan kimliği girin. Alan okuma durumu, yalnızca okumanın alınmasını destekler Bu, arayan kullanıcının durumu, takip etmek için:
    • me takma adı. Örneğin, users/me/spaces/SPACE/spaceReadState
    • Arayan kullanıcının Workspace e-posta adresi. Örneğin, users/user@example.com/spaces/SPACE/spaceReadState
    • Arayan kullanıcının kullanıcı kimliği. Örneğin, users/USER/spaces/SPACE/spaceReadState

Aşağıdaki örnek, arayan kullanıcının alan okuma durumunu alır:

Python

  1. Çalışma dizininizde şu ada sahip bir dosya oluşturun: chat_spaceReadState_get.py
  2. Aşağıdaki kodu chat_spaceReadState_get.py bölümüne ekleyin:

    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. Bu kodda, aşağıdakini değiştirin:

    • SPACE: bir alan adı; şuradan edinebilirsiniz: spaces.list yöntem API'den veya bir alanın URL'sinden.
  4. Çalışma dizininizde örneği derleyin ve çalıştırın:

    python3 chat_spaceReadState_get.py
    

Node.js

  1. Çalışma dizininizde şu ada sahip bir dosya oluşturun: chat_spaceReadState_get.js
  2. Aşağıdaki kodu chat_spaceReadState_get bölümüne ekleyin:

    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. Bu kodda, aşağıdakini değiştirin:

    • SPACE: bir alan adı; şuradan edinebilirsiniz: spaces.list yöntem API'den veya bir alanın URL'sinden.
  4. Çalışma dizininizde örneği derleyin ve çalıştırın:

    node chat_spaceReadState_get.js
    

Apps Komut Dosyası

Bu örnekte, Gelişmiş Chat Hizmeti.

  1. chat.users.readstate.readonly yetkilendirme kapsamını Apps Komut Dosyası projesinin appsscript.json dosyası:

    "oauthScopes": [
      "https://www.googleapis.com/auth/chat.users.readstate.readonly"
    ]
    
  2. Apps Komut Dosyası projesinin kod:

    /**
    * 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, belirtilen alan okuma durumunu alır ve geri döner örneğinin SpaceReadState kaynak.