איך יוצרים מרחבים משותפים

במדריך הזה מוסבר איך משתמשים ב-method create במשאב Space של Google Chat API כדי ליצור מרחב משותף עם שם.

המשאב Space מייצג מקום שבו אנשים ואפליקציות ל-Chat יכולים לשלוח הודעות, לשתף קבצים ולעבוד יחד. יש כמה סוגים של מרחבים משותפים:

  • צ'אטים אישיים (DM) הם שיחות בין שני משתמשים או משתמש ואפליקציית Chat.
  • צ'אטים קבוצתיים הם שיחות בין שלושה משתמשים או יותר לבין אפליקציות צ'אט.
  • מרחבים עם שמות הם מקומות שבהם אנשים יכולים לשלוח הודעות, לשתף קבצים ולעבוד עליהם בשיתוף פעולה.

מרחב משותף עם שם הוא מקום שבו אנשים שולחים הודעות, משתפים קבצים ומשתפים פעולה. מרחבים משותפים עם שמות יכולים לכלול אפליקציות ל-Chat. מרחבים משותפים עם שם כוללים תכונות נוספות שאין בשיחות קבוצתיות ובצ'אטים אישיים ללא שם, כמו מנהלי מרחבים משותפים, שיכולים להחיל הגדרות ניהוליות ותיאורים, ולהוסיף או להסיר אנשים ואפליקציות. אחרי שיוצרים מרחב משותף עם שם, המשתמש היחיד במרחב המשותף הוא המשתמש המאומת. המרחב המשותף לא כולל אפליקציות או אנשים אחרים, אפילו לא את אפליקציית Chat שיצרה אותו. כדי להוסיף אנשים, אפשר ליצור חברויות במרחב המשותף באמצעות קריאה לשיטה create במשאב Member. אפשר למצוא מידע נוסף במאמר איך יוצרים מינוי.

כדי ליצור מרחב משותף עם שם שכולל כמה משתתפים, צ'אט קבוצתי ללא שם בין שלושה אנשים או יותר, או שיחה בצ'אט אישי בין שני אנשים או אדם ואפליקציית Chat ששולחת את Chat ל-Chat API, צריך להגדיר מרחב.

דרישות מוקדמות

Python

  • Python 3.6 ומעלה
  • הכלי pip לניהול חבילות
  • ספריות הלקוח העדכניות של Google ל-Python. כדי להתקין או לעדכן אותם, מריצים את הפקודה הבאה בממשק שורת הפקודה:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • פרויקט ב-Google Cloud שמופעל ומוגדר בו Google Chat API. במאמר איך מפתחים אפליקציות ב-Google Chat מוסבר איך עושים את זה.
  • הוגדרה הרשאה לאפליקציית Chat. כדי ליצור מרחב משותף, צריך לבצע אימות משתמש עם היקף ההרשאות chat.spaces.create או chat.spaces.

Node.js

  • Node.js ו-npm
  • ספריות הלקוח העדכניות של Google ל-Node.js. כדי להתקין אותם, מריצים את הפקודה הבאה בממשק שורת הפקודה:

    npm install @google-cloud/local-auth @googleapis/chat
    
  • פרויקט ב-Google Cloud שמופעל ומוגדר בו Google Chat API. במאמר איך מפתחים אפליקציות ב-Google Chat מוסבר איך עושים את זה.
  • הוגדרה הרשאה לאפליקציית Chat. כדי ליצור מרחב משותף, צריך לבצע אימות משתמש עם היקף ההרשאות chat.spaces.create או chat.spaces.

יצירת מרחב משותף עם שם

כדי ליצור מרחב משותף עם שם, מזינים את הפרטים הבאים בבקשה:

  • מציינים את היקף ההרשאה chat.spaces.create או chat.spaces.
  • קוראים ל-method create במשאב Space.
  • מגדירים את spaceType לערך SPACE.
  • מגדירים את displayName לשם הגלוי למשתמשים של המרחב המשותף. בדוגמה הבאה, displayName מוגדר להיות API-made.
  • אפשר גם להגדיר מאפייני מרחב אחרים, כמו spaceDetails (תיאור שגלוי למשתמש וקבוצת הנחיות למרחב המשותף).

כדי ליצור מרחב משותף עם שם:

Python

  1. בספריית העבודה, יוצרים קובץ בשם chat_space_create_named.py.
  2. צריך לכלול את הקוד הבא ב-chat_space_create_named.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient.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.spaces.create"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then creates a Chat space.
        '''
    
        # Authenticate with Google Workspace
        # and get user authorization.
        flow = InstalledAppFlow.from_client_secrets_file(
                          'client_secrets.json', SCOPES)
        creds = flow.run_local_server()
    
        # Build a service endpoint for Chat API.
        chat = build('chat', 'v1', credentials=creds)
    
        # 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'
          }
    
          ).execute()
    
        # Prints details about the created space.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. בספריית העבודה, יוצרים ומריצים את הדוגמה:

    python3 chat_space_create_named.py
    

Node.js

  1. בספריית העבודה, יוצרים קובץ בשם create-space.js.
  2. צריך לכלול את הקוד הבא ב-create-space.js:

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Creates a new chat space.
    * @return {!Promise<!Object>}
    */
    async function createSpace() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.spaces.create',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.create(
          {requestBody: {spaceType: 'SPACE', displayName: 'API-made'}});
    }
    
    createSpace().then(console.log);
    
  3. בספריית העבודה, מריצים את הדוגמה:

    node create-space.js
    

המערכת יוצרת מרחב משותף עם שם. כדי לנווט למרחב המשותף, תוכלו להשתמש במזהה המשאב שלו כדי ליצור את כתובת ה-URL שלו. מזהה המשאב מופיע מהמרחב המשותף name בגוף התשובה ב-Google Chat. לדוגמה, אם name של המרחב המשותף הוא spaces/1234567, תוכלו לנווט אליו באמצעות כתובת ה-URL הבאה: https://mail.google.com/chat/u/0/#chat/space/1234567.