Get details about a message

Python

• A Business or Enterprise Google Workspace account with access to Google Chat.

• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Python Google API Client Library.
  • Create access credentials based on how you want to authenticate in your Google Chat API request:
    • To authenticate as a Chat user, create OAuth client ID credentials and save the credentials as a JSON file named client_secrets.json to your local directory.
    • To authenticate as the Chat app, create service account credentials and save the credentials as a JSON file named credentials.json.
• Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

Python

1. In your working directory, create a file named chat_message_get_user.py.

2. Include the following code in chat_message_get_user.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.messages.readonly"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then gets a message.
       '''
   
       # 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.spaces().messages().get(
   
           # The message to get.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Replace MESSAGE with a message name.
           # Obtain the message name from the response body returned
           # after creating a message asynchronously with Chat REST API.
           name = 'spaces/SPACE/messages/MESSAGE'
   
       ).execute()
   
       # Prints details about the message.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. In the code, replace the following:

   • SPACE: a space name, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.
   • MESSAGE: a message name, which you can obtain from the response body returned after creating a message asynchronously with the Chat API, or with the custom name assigned to the message at creation.

4. In your working directory, build and run the sample:

   python3 chat_message_get_user.py

Python

1. In your working directory, create a file named chat_get_message_app.py.

2. Include the following code in chat_get_message_app.py:

   from google.oauth2 import service_account
   from apiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   CREDENTIALS = (
       service_account.Credentials.from_service_account_file('credentials.json')
       .with_scopes(SCOPES)
   )
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=CREDENTIALS)
   
   # Get a Chat message.
   result = chat.spaces().messages().get(
   
       # The message to get.
       #
       # Replace SPACE with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       #
       # Replace MESSAGE with a message name.
       # Obtain the message name from the response body returned
       # after creating a message asynchronously with Chat REST API.
       name='spaces/SPACE/messages/MESSAGE'
   
     ).execute()
   
   # Print Chat API's response in your command line interface.
   print(result)
   

3. In the code, replace the following:

   • SPACE: the name of the space where the message is posted, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.

   • MESSAGE: the message name, which you can obtain from the response body returned after creating a message asynchronously with the Chat API, or with the custom name assigned to the message at creation.

4. In your working directory, build and run the sample:

   python3 chat_get_message_app.py