تعديل مساحة

يوضّح هذا الدليل كيفية استخدام الأسلوب patch() في مورد Space من Google Chat API لتعديل مساحة. يمكنك تعديل مساحة لتغيير سمات عن المساحة، مثل الاسم المعروض الذي يظهر للمستخدمين ووصف المساحة وإرشاداتها.

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

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

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

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

Node.js

Python

Java

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

تعديل مساحة كمستخدم

لتعديل مساحة حالية في Google Chat باستخدام مصادقة المستخدم، عليك إرسال المعلومات التالية في طلبك:

  • حدِّد نطاق تفويض chat.spaces.
  • عليك استدعاء UpdateSpace() . يمكنك في طلبك تحديد الحقل name للمسافة وupdateMask حقلاً يحتوي على حقل واحد أو أكثر مطلوب تعديله، وعلى body بالمساحة المعدّلة المعلومات.

يمكنك تعديل عناصر مثل الاسم المعروض ونوع المساحة وحالة السجلّ أخرى. للاطّلاع على جميع الحقول التي يمكنك تعديلها، اطّلِع على المستندات المرجعية.

في ما يلي كيفية تعديل حقل displayName لمساحة حالية:

Node.js

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

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

// This sample shows how to update a 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: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name']
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_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"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

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

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

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

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

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const space = {
    displayName: 'New space display name'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'displayName';

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask
  });

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

لتنفيذ هذا المثال، استبدِل SPACE_NAME برقم التعريف من حقل name المجموعة. ويمكنك الحصول على المعرّف من خلال استدعاء ListSpaces() أو من عنوان URL الخاص بالمساحة.

تعرض Google Chat API مثيلاً Space تعكس التحديثات.

تعديل مساحة بصفتك مشرفًا في Google Workspace

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

لطلب هذه الطريقة بصفتك مشرف Google Workspace، عليك إجراء ما يلي:

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

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

تعديل مساحة كتطبيق Chat

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

لتعديل مساحة حالية في Google Chat باستخدام مصادقة التطبيقات قم بتمرير ما يلي في طلبك:

  • حدِّد نطاق تفويض chat.app.spaces. باستخدام مصادقة التطبيقات، يمكنك تعديل المساحات التي تم إنشاؤها فقط من تطبيقات Chat
  • عليك استدعاء طريقة patch في مرجع Space. في طلبك، حدِّد حقل المساحة name وحقلupdateMask الذي يتضمّن حقلًا واحدًا أو أكثر لتعديله وحقلbody الذي يتضمّن معلومات المساحة المعدَّلة.

يمكنك تعديل عناصر مثل الاسم المعروض ونوع المساحة وحالة السجلّ وإعدادات الأذونات والمزيد. للاطِّلاع على جميع الحقول التي يمكنك تعديلها، يُرجى مراجعة المستندات المرجعية

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

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

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

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

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

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

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

في ما يلي كيفية تعديل حقل spaceDetails لمساحة حالية:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم "chat_space_update_app.py".
  2. أدرِج الرمز التالي في chat_space_update_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"]
    
    def main():
        '''
        Authenticates with Chat API using app authentication,
        then updates the specified space description and guidelines.
        '''
    
        # 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().patch(
    
          # The space to update, and the updated space details.
          #
          # Replace {space} with a space name.
          # Obtain the space name from the spaces resource of Chat API,
          # or from a space's URL.
          name='spaces/SPACE',
          updateMask='spaceDetails',
          body={
    
            'spaceDetails': {
              'description': 'This description was updated with Chat API!',
              'guidelines': 'These guidelines were updated with Chat API!'
            }
    
          }
    
        ).execute()
    
        # Prints details about the updated space.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. في الرمز، استبدِل ما يلي:

    • API_KEY: مفتاح واجهة برمجة التطبيقات الذي أنشأته لإنشاء نقطة نهاية الخدمة لواجهة برمجة تطبيقات Chat.
    • "SPACE" باسم مساحة التي يمكنك الحصول عليها من طريقة واحدة (spaces.list) في Chat API أو من عنوان URL للمساحة.
  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_space_update_app.py

تعرض Google Chat API مثيلاً مورد واحد (Space) يعكس التحديثات.