Get details about a Google Chat space event

This guide explains how to use the get() method on the SpaceEvent resource of the Google Chat API to get details about an event from a Google Chat space.

The SpaceEvent resource represents a change to a space or its child resources, such as messages, reactions, and memberships. To learn about the supported event types, see the eventType field of the SpaceEvent resource reference documentation.

You can request events up to 28 days before the time of the request. The event contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Message resource in the event payload.

To call this method, you must use user authentication. To get an event, the authenticated user must be a member of the space where the event occurred.

Prerequisites

Node.js

Python

Get details about a space event (user authentication)

To get details about a space event in Google Chat, pass the following in your request:

  • Specify an authorization scope that supports the event type in your request. As a best practice, choose the most restrictive scope that still allows your app to function.
  • Call the GetSpaceEvent() method, passing the name of the space event to get.

The following example gets a space event:

Node.js

This Node.js code sample uses the Chat RPC API.

chat/client-libraries/cloud/get-space-event-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
  };

  // Make the request
  const response = await chatClient.getSpaceEvent(request);

  // Handle the response
  console.log(response);
}

await main();

To run this sample, replace the following:

  • SCOPE_NAME: an authorization scope based on the event type. For example, if you are getting a space event about a new membership, use the chat.memberships.readonly scope, formatted as https://www.googleapis.com/auth/chat.memberships.readonly. You can obtain the event type from the ListSpaceEvents() method. To learn how to use this method, see List events from a space.
  • SPACE_NAME: the ID from the space's name. You can obtain the ID by calling the ListSpaces() method or from the space's URL.
  • SPACE_EVENT_NAME: the ID from the space event's name. You can obtain the ID from the ListSpaceEvents() method. To learn how to use this method, see List events from a space.

The Chat API returns an instance of SpaceEvent with details about the event.

Get details about a space event (Chat app authentication)

App authentication requires one-time administrator approval.

To get details about a space event from a space with app authentication using the Chat REST API, pass the following in your request:

  • Specify one or more authorization scopes to support each event type in your request. As a best practice, choose the most restrictive scope that still allows your app to function. To learn more about choosing a scope, see the Authentication and authorization overview.
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
  • Call the get method on the spaceEvents resource.
  • Pass the name of the space to get event details from.

Create an API key

To call a Developer Preview API method, you must use a non-public developer preview version of the API discovery document. To authenticate the request, you must pass an API key.

To create the API Key, open your app's Google Cloud project and do the following:

  1. In the Google Cloud console, go to Menu > APIs & Services > Credentials.

    Go to Credentials

  2. Click Create credentials > API key.
  3. Your new API key is displayed.
    • Click Copy to copy your API key for use in your app's code. The API key can also be found in the "API Keys" section of your project's credentials.
    • To prevent unauthorized use, we recommend restricting where and for which APIs the API key can be used. For more details, see Add API restrictions.

Write a script that calls Chat API

Here's how to get details about a space event with app authentication and the Chat REST API:

Python

This Python code sample uses the Chat REST API.

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

  2. Include the following code in chat_spaceevents_get_app.py:

    from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# Set authorization scopes based on the
# event type. For example, if you are getting a space event
# about a new membership, use the `chat.app.memberships.readonly` scope.
#
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships",
          "https://www.googleapis.com/auth/chat.app.messages.readonly",
          "https://www.googleapis.com/auth/chat.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then lists space events from a specified space.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # Use the service endpoint to call Chat API.
    result = chat.spaces().spaceEvents().get(

        # The space to get event details from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',

    ).execute()

    # Print Chat API's response in your command line interface.
    print(result)

if __name__ == '__main__':
    main()

  3. In the code, replace the following:

    • API_KEY: the API key that you created to build the service endpoint for Chat API.
    • SPACE_NAME: a space name, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.
    • SPACE_EVENT_NAME: the ID from the space event's name. You can obtain the ID from the ListSpaceEvents() method. To learn how to use this method, see List events from a space.

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

    python3 chat_spaceevents_get_app.py

The Chat API returns a list of paginated list of space events about new memberships and messages.