إنشاء مساحة

يشرح هذا الدليل كيفية استخدام create() على المورد Space من Google Chat API لإنشاء مساحة مُعنوَنة.

يمثّل مورد Space مكانًا يمكن فيه للمستخدمين وتطبيقات Chat إرسال الرسائل ومشاركة الملفات والتعاون. هناك عدة أنواع من المساحات:

  • الرسائل المباشرة هي محادثات بين مستخدمَين أو مستخدم وأحد تطبيقات Chat.
  • المحادثات الجماعية هي محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat.
  • المساحات المُعنونة هي أماكن دائمة يرسل من خلالها المستخدمون الرسائل ويشاركون الملفات والتعاون.

المساحة المعنوَنة هي مكان يرسل فيه الأشخاص الرسائل ويشاركون الملفات والتعاون. يمكن أن تتضمّن المساحات المُسمّاة تطبيقات Chat. المساحات المُعنونة تضمين ميزات إضافية لا تتضمن المحادثات الجماعية والرسائل المباشرة غير متاحة لهم، مثل مدراء المساحات الذين يمكنهم تطبيق الإعدادات الإدارية والأوصاف وإضافة أو إزالة الأشخاص والتطبيقات. بعد إنشاء مساحة مُعنوَنة، ويكون العضو الوحيد في المساحة هو المستخدم الذي تمت مصادقته. لا تشمل المساحة مستخدمين أو تطبيقات أخرى، ولا حتى تطبيق Chat الذي أنشأها. لإضافة أعضاء إلى مساحة، يمكنك الاطّلاع على أنشئ عضوية.

لإنشاء مساحة مُسمّاة تضم عدة أعضاء، وهي محادثة جماعية بدون اسم بين أو ثلاثة أشخاص أو أكثر، أو محادثة مباشرة بين شخصين، أو الشخص وتطبيق Chat الذي يتصل Chat API: إعداد مساحة بدلاً من ذلك.

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

Node.js

Python

Java

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

إنشاء مساحة مُعنوَنة كمستخدم

لإنشاء مساحة مُسمّاة باستخدام مصادقة المستخدم، ضبط ما يلي في طلبك:

  • حدِّد نطاق التفويض chat.spaces.create أو chat.spaces.
  • عليك استدعاء CreateSpace() لتمرير space كمثيل Space مع الحقول التالية:
    • تم ضبط spaceType على ‎SPACE.
    • displayName تم ضبطه على اسم المساحة المرئي للمستخدم
    • يمكنك اختياريًا ضبط سمات أخرى، مثل ما يلي:
      • spaceDetails- وصف مرئي للمستخدم ومجموعة من الإرشادات المساحة.
      • predefinedPermissionSettings: الأذونات المحدّدة مسبقًا للمساحة على سبيل المثال، يمكنك ضبط الإعدادات بحيث يتمكّن جميع الأعضاء أو مديرو المساحة فقط من نشر الرسائل.

في ما يلي كيفية إنشاء مساحة مُسمّاة:

Node.js

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

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

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

  // Initialize request argument(s)
  const request = {
    space: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_space_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.spaces.create"]

def create_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

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

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

إنشاء مساحة مُسمّاة كتطبيق Chat

تتطلّب مصادقة التطبيق الحصول على موافقة المشرف لمرة واحدة.

لدعوة مستخدم أو إضافته إلى مساحة باستخدام مصادقة التطبيق، Pass ما يلي في طلبك:

  • حدِّد نطاق التفويضchat.app.spaces.create أو chat.app.spaces.
  • استخدِم طريقة create في مورد Space.
  • اضبط spaceType على SPACE.
  • ضبط displayName إلى اسم المساحة المرئي للمستخدمين في المثال التالي، displayName تم ضبطها على API-made.
  • حدِّد رقم تعريف العميل لنطاق Google Workspace باستخدام الحقل customer.
  • يمكنك اختياريًا ضبط سمات أخرى للمساحة، مثل spaceDetails (وصف يظهر للمستخدم ومجموعة من الإرشادات للمساحة).

إنشاء مفتاح واجهة برمجة التطبيقات

لاستدعاء طريقة واجهة برمجة التطبيقات في "معاينة المطوّر"، يجب استخدام إصدار غير متاح للجميع من "معاينة المطوّر" لمستند استكشاف واجهة برمجة التطبيقات. لمصادقة الطلب، يجب إدخال مفتاح واجهة برمجة التطبيقات.

لإنشاء مفتاح واجهة برمجة التطبيقات، افتح مشروع تطبيقك على Google Cloud واتّبِع الخطوات التالية:

  1. في وحدة التحكّم في Google Cloud، انتقِل إلى القائمة . > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.

    الانتقال إلى بيانات الاعتماد

  2. انقر على إنشاء بيانات الاعتماد >. مفتاح واجهة برمجة التطبيقات.
  3. يتم عرض مفتاح واجهة برمجة التطبيقات الجديد.
    • انقر على "نسخ ". لنسخ مفتاح واجهة برمجة التطبيقات لاستخدامه في رمز تطبيقك يمكن أيضًا أن يكون مفتاح واجهة برمجة التطبيقات التي تم العثور عليها في "مفاتيح واجهة برمجة التطبيقات" في بيانات اعتماد مشروعك.
    • انقر على تقييد المفتاح لتعديل الإعدادات المتقدّمة والحد من الاستخدام. لمفتاح واجهة برمجة التطبيقات. لمزيد من التفاصيل، يُرجى الاطّلاع على فرض قيود على مفاتيح واجهة برمجة التطبيقات.

كتابة نص برمجي يستدعي Chat API

إليك كيفية إنشاء مساحة مُعنوَنة:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم "chat_space_create_named_app.py".
  2. أدرِج الرمز التالي في chat_space_create_named_app.py:

    from google.oauth2 import service_account
    from apiclient.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.app.spaces.create"]
    
    def main():
        '''
        Authenticates with Chat API using app authentication,
        then creates a Chat 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().create(
    
          # Details about the space to create.
          body = {
    
            # To create a named space, set spaceType to SPACE.
            'spaceType': 'SPACE',
    
            # The user-visible name of the space.
            'displayName': 'API-made',
    
            # The customer ID of the Workspace domain.
            'customer': 'CUSTOMER'
          }
    
          ).execute()
    
        # Prints details about the created space.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. في الرمز، استبدِل ما يلي:

    • API_KEY: مفتاح واجهة برمجة التطبيقات الذي أنشأته لإنشاء نقطة نهاية الخدمة لواجهة برمجة التطبيقات Chat API.

    • CUSTOMER: رقم تعريف العميل لنطاق ال مساحة بالتنسيق customer/{customer} حيث يكون {customer} هو ID من مرجع العميل في حزمة SDK للمشرف. لإنشاء مساحة في مؤسسة Google Workspace نفسها تطبيق Chat، استخدِم "customers/my_customer".

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_space_create_named_app.py
    

فتح المساحة في Google Chat

للانتقال إلى المساحة، استخدِم رقم تعريف المورد الخاص بالمساحة. لإنشاء عنوان URL للمساحة. يمكنك العثور على رقم تعريف المورد من المساحة. name في نص استجابة Google Chat. على سبيل المثال، إذا كان name لمساحة معيّنة هو spaces/1234567، يمكنك الانتقال إلى المساحة باستخدام عنوان URL التالي: https://mail.google.com/chat/u/0/#chat/space/1234567.