جزئیات عضویت را دریافت کنید

این راهنما نحوه استفاده از متد get در منبع Membership از API چت گوگل را برای دریافت جزئیات مربوط به عضویت در یک فضا توضیح می‌دهد.

مالکان و مدیران فضا می‌توانند محدود کنند که چه کسانی می‌توانند لیست اعضا را در یک فضا ببینند . اگر قابلیت مشاهده محدود شده باشد، فراخوانی‌های این متد که با احراز هویت برنامه انجام می‌شوند، فقط عضویت‌هایی را برمی‌گردانند که برای اعضای فضا قابل مشاهده هستند و برای عضویت‌هایی که برای اعضای فضا قابل مشاهده نیستند، خطای PERMISSION_DENIED را برمی‌گردانند. فراخوانی‌های این متد که با احراز هویت کاربر انجام می‌شوند، خطای PERMISSION_DENIED را برمی‌گردانند.

اگر شما مدیر Google Workspace هستید، می‌توانید متد get را برای بازیابی جزئیات مربوط به هرگونه عضویت در سازمان Google Workspace خود فراخوانی کنید.

منبع Membership نشان می‌دهد که آیا یک کاربر انسانی یا برنامه Google Chat به یک فضا دعوت شده، بخشی از آن است یا در آن حضور ندارد.

احراز هویت با احراز هویت برنامه به یک برنامه چت اجازه می‌دهد تا عضویت‌هایی را از فضاهایی که در Google Chat به آنها دسترسی دارد (مثلاً فضاهایی که عضو آنهاست) دریافت کند، اما عضویت‌های برنامه چت، از جمله عضویت‌های خودش را شامل نمی‌شود. احراز هویت با احراز هویت کاربر، عضویت‌هایی را از فضاهایی که کاربر احراز هویت شده به آنها دسترسی دارد، برمی‌گرداند.

پیش‌نیازها

نود جی اس

پایتون

جاوا

اسکریپت برنامه‌ها

جزئیات مربوط به عضویت را دریافت کنید

برای دریافت جزئیات مربوط به عضویت در گوگل چت، موارد زیر را در درخواست خود وارد کنید:

  • با احراز هویت برنامه ، محدوده مجوز chat.bot را مشخص کنید. با احراز هویت کاربر ، محدوده مجوز chat.memberships.readonly یا chat.memberships را مشخص کنید. به عنوان یک روش بهتر، محدودترین محدوده‌ای را انتخاب کنید که همچنان به برنامه شما اجازه عملکرد می‌دهد.
  • متد GetMembership را فراخوانی کنید.
  • برای دریافت، name عضویت را ارسال کنید. نام عضویت را از منبع عضویت گوگل چت دریافت کنید.

با احراز هویت کاربر، عضویت دریافت کنید

در اینجا نحوه دریافت عضویت با احراز هویت کاربر آورده شده است:

نود جی اس

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);
}

await main();

پایتون

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()

جاوا

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));
    }
  }
}

اسکریپت برنامه‌ها

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);
}

برای اجرای این نمونه، موارد زیر را جایگزین کنید:

  • SPACE_NAME : شناسه‌ی name فضا. می‌توانید شناسه را با فراخوانی متد ListSpaces یا از URL فضا به دست آورید.
  • MEMBER_NAME : شناسه‌ای که از name عضو گرفته شده است. می‌توانید با فراخوانی متد ListMemberships شناسه را بدست آورید.

API چت نمونه‌ای از Membership را برمی‌گرداند که جزئیات عضویت مشخص شده را شرح می‌دهد.

با احراز هویت برنامه، عضویت دریافت کنید

در اینجا نحوه دریافت عضویت با احراز هویت برنامه آمده است:

نود جی اس

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);
}

await main();

پایتون

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()

جاوا

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));
    }
  }
}

اسکریپت برنامه‌ها

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);
}

برای اجرای این نمونه، موارد زیر را جایگزین کنید:

  • SPACE_NAME : شناسه‌ی name فضا. می‌توانید شناسه را با فراخوانی متد ListSpaces یا از URL فضا به دست آورید.
  • MEMBER_NAME : شناسه‌ای که از name عضو گرفته شده است. می‌توانید با فراخوانی متد ListMemberships شناسه را بدست آورید.

API چت نمونه‌ای از Membership را برمی‌گرداند که جزئیات عضویت مشخص شده را شرح می‌دهد.

به عنوان مدیر Google Workspace جزئیات عضویت‌ها را دریافت کنید

اگر شما مدیر Google Workspace هستید، می‌توانید متد GetMembership را برای بازیابی جزئیات عضویت هر کاربر در سازمان Google Workspace خود فراخوانی کنید.

برای فراخوانی این روش به عنوان مدیر Google Workspace، موارد زیر را انجام دهید:

  • با استفاده از احراز هویت کاربر، متد را فراخوانی کنید و یک محدوده مجوز مشخص کنید که از فراخوانی متد با استفاده از امتیازات مدیر پشتیبانی کند.
  • در درخواست خود، پارامتر query useAdminAccess را برابر با true قرار دهید.

برای اطلاعات و مثال‌های بیشتر، به مدیریت فضاهای چت گوگل به عنوان مدیر فضای کاری گوگل مراجعه کنید.