Details zu einer Mitgliedschaft aufrufen

In diesem Leitfaden wird beschrieben, wie Sie mit der Methode get() die Membership-Ressource der Google Chat API verwenden, um Details zur Mitgliedschaft in einem Gruppenbereich abzurufen.

Wenn Sie Google Workspace-Administrator sind, können Sie die Methode get() aufrufen, um Details zu einer Mitgliedschaft in Ihrer Google Workspace-Organisation abzurufen.

Die Ressource Membership gibt an, ob ein Nutzer oder eine Google Chat-App zu einem Gruppenbereich eingeladen wurde, zu einem Gruppenbereich gehört oder nicht zu einem Gruppenbereich gehört.

Wenn eine Chat-App mit der App-Authentifizierung authentifiziert wird, kann sie Mitgliedschaften in Gruppenbereichen abrufen, auf die sie in Google Chat Zugriff hat (z. B. Gruppenbereiche, in denen sie Mitglied ist). Chat-App-Mitgliedschaften, einschließlich der eigenen, werden jedoch ausgeschlossen. Bei der Nutzerauthentifizierung werden Mitgliedschaften in Gruppenbereichen zurückgegeben, auf die der authentifizierte Nutzer Zugriff hat.

Vorbereitung

Node.js

Python

Java

Apps Script

Details zu einer Mitgliedschaft abrufen

Wenn Sie Details zu einer Mitgliedschaft in Google Chat abrufen möchten, geben Sie in Ihrer Anfrage Folgendes an:

  • Geben Sie bei der App-Authentifizierung den Autorisierungsbereich chat.bot an. Geben Sie bei der Nutzerauthentifizierung den Autorisierungsbereich chat.memberships.readonly oder chat.memberships an. Es empfiehlt sich, den möglichst restriktiven Umfang auszuwählen, bei dem Ihre App weiterhin funktioniert.
  • Rufen Sie die Methode GetMembership() auf.
  • Gib die name der gewünschten Mitgliedschaft an. Rufen Sie den Namen der Mitgliedschaft aus der Mitgliedschaftsressource von Google Chat ab.

Mitgliedschaft mit Nutzerauthentifizierung

So kannst du eine Mitgliedschaft mit Nutzerauthentifizierung abschließen:

Node.js

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

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships.readonly'];

// This sample shows how to get membership 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 MEMBER_NAME here
    name: 'spaces/SPACE_NAME/members/MEMBER_NAME'
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/get_membership_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"]

# This sample shows how to get membership with user credential
def get_membership_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.GetMembershipRequest(
        # Replace SPACE_NAME and MEMBER_NAME here
        name = 'spaces/SPACE_NAME/members/MEMBER_NAME',
    )

    # Make the request
    response = client.get_membership(request)

    # Handle the response
    print(response)

get_membership_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMembershipUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetMembershipRequest;
import com.google.chat.v1.Membership;

// This sample shows how to get membership with user credential.
public class GetMembershipUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.memberships.readonly";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      GetMembershipRequest.Builder request = GetMembershipRequest.newBuilder()
        // replace SPACE_NAME and MEMBERSHIP_NAME here
        .setName("spaces/SPACE_NAME/members/MEMBERSHIP_NAME");
      Membership response = chatServiceClient.getMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get membership with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function getMembershipUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MEMBER_NAME here
  const name = 'spaces/SPACE_NAME/members/MEMBER_NAME';

  // Make the request
  const response = Chat.Spaces.Members.get(name);

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

Ersetzen Sie zum Ausführen dieses Beispiels Folgendes:

  • SPACE_NAME: die ID aus der name des Gruppenbereichs. Sie können die ID durch Aufrufen der Methode ListSpaces() oder über die URL des Gruppenbereichs abrufen.
  • MEMBER_NAME: die ID aus der name des Mitglieds. Sie können die ID abrufen, indem Sie die Methode ListMemberships() aufrufen.

Die Chat API gibt eine Instanz von Membership zurück, die Details zur angegebenen Mitgliedschaft enthält.

Mitgliedschaft mit App-Authentifizierung abschließen

So kannst du eine Mitgliedschaft mit App-Authentifizierung abschließen:

Node.js

chat/client-libraries/cloud/get-membership-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to get membership with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

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

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/get_membership_app_cred.py
from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to get membership with app credential
def get_membership_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetMembershipRequest(
        # Replace SPACE_NAME and MEMBER_NAME here
        name = 'spaces/SPACE_NAME/members/MEMBER_NAME',
    )

    # Make the request
    response = client.get_membership(request)

    # Handle the response
    print(response)

get_membership_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMembershipAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetMembershipRequest;
import com.google.chat.v1.Membership;

// This sample shows how to get membership with app credential.
public class GetMembershipAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetMembershipRequest.Builder request = GetMembershipRequest.newBuilder()
        // replace SPACE_NAME and MEMBERSHIP_NAME here
        .setName("spaces/SPACE_NAME/members/MEMBERSHIP_NAME");
      Membership response = chatServiceClient.getMembership(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get membership with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getMembershipAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MEMBER_NAME here
  const name = 'spaces/SPACE_NAME/members/MEMBER_NAME';
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.Members.get(name, parameters, getHeaderWithAppCredentials());

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

Ersetzen Sie zum Ausführen dieses Beispiels Folgendes:

  • SPACE_NAME: die ID aus der name des Gruppenbereichs. Sie können die ID durch Aufrufen der Methode ListSpaces() oder über die URL des Gruppenbereichs abrufen.
  • MEMBER_NAME: die ID aus der name des Mitglieds. Sie können die ID abrufen, indem Sie die Methode ListMemberships() aufrufen.

Die Chat API gibt eine Instanz von Membership zurück, die Details zur angegebenen Mitgliedschaft enthält.

Informationen zu Mitgliedschaften als Google Workspace-Administrator abrufen

Als Google Workspace-Administrator können Sie die Methode GetMembership() aufrufen, um Details zu einer Mitgliedschaft für jeden Nutzer in Ihrer Google Workspace-Organisation abzurufen.

So rufen Sie diese Methode als Google Workspace-Administrator auf:

  • Rufen Sie die Methode mit Nutzerauthentifizierung auf und geben Sie einen Autorisierungsbereich an, der den Aufruf der Methode mit Administratorberechtigungen unterstützt.
  • Geben Sie in Ihrer Anfrage den Abfrageparameter useAdminAccess an true an.

Weitere Informationen und Beispiele finden Sie unter Google Chat-Gruppenbereiche als Google Workspace-Administrator verwalten.