الاطّلاع على تفاصيل حول الاشتراك

يوضّح هذا الدليل كيفية استخدام الأسلوب get() في مورد Membership من Google Chat API للحصول على تفاصيل حول الاشتراك في مساحة.

إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء طريقة get() لاسترداد تفاصيل حول أي اشتراك في مؤسستك على Google Workspace.

يمثّل مورد Membership ما إذا كان مستخدمًا أو تطبيق Google Chat قد تمت دعوته إلى مساحة أو كان جزءًا منها أو غير متواجد فيها.

عند المصادقة باستخدام مصادقة التطبيق، يمكن لتطبيق Chat الحصول على اشتراكات من المساحات التي يمكنه الوصول إليها في Google Chat (على سبيل المثال، المساحات التي يكون فيها عضوًا)، ولكن يتم استبعاد اشتراكات تطبيق Chat، بما في ذلك اشتراكاته الخاصة. عند المصادقة باستخدام مصادقة المستخدم، يتم عرض العضويات من المساحات التي يمكن للمستخدم المُعتمَد الوصول إليها.

المتطلبات الأساسية

Node.js

Python

Java

برمجة تطبيقات

الحصول على تفاصيل حول اشتراك

للحصول على تفاصيل حول اشتراك في Google Chat، يجب إدخال ما يلي في طلبك:

  • باستخدام مصادقة التطبيق، حدِّد نطاق تفويض chat.bot. باستخدام مصادقة المستخدم، حدِّد نطاق التفويض chat.memberships.readonly أو chat.memberships. من بين أفضل الممارسات اختيار النطاق الأكثر تقييدًا الذي يسمح بتشغيل تطبيقك.
  • استدعِ الطريقة GetMembership().
  • يجب اجتياز name من شروط العضوية للحصول على هذه الميزة. احصل على اسم الاشتراك من مرجع الاشتراك في Google Chat.

الحصول على اشتراك من خلال مصادقة المستخدم

في ما يلي كيفية الحصول على اشتراك من خلال مصادقة المستخدم:

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

برمجة تطبيقات

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

تُعرِض Chat API مثيلًا من Membership يتضمّن تفاصيل الاشتراك المحدّد.

الاشتراك في ميزة مصادقة التطبيقات

في ما يلي كيفية الحصول على اشتراك باستخدام مصادقة التطبيق:

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

برمجة تطبيقات

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

تُعرِض Chat API مثيلًا من Membership يتضمّن تفاصيل الاشتراك المحدّد.

الحصول على تفاصيل عن العضويات بصفتك مشرفًا في Google Workspace

إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء طريقة GetMembership() لاسترداد تفاصيل الاشتراك لأي مستخدم في مؤسسة Google Workspace.

لاستدعاء هذه الطريقة بصفتك مشرفًا في Google Workspace، اتّبِع الخطوات التالية:

  • استخدِم طريقة المصادقة للمستخدم، وحدِّد نطاق التفويض الذي يتيح استدعاء الطريقة باستخدام امتيازات المشرف.
  • في طلبك، حدِّد مَعلمة طلب البحث useAdminAccess إلى true.

لمزيد من المعلومات والأمثلة، يُرجى الاطّلاع على إدارة مساحات Google Chat كمشرف في Google Workspace.