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

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

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

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

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

כדי ליצור מרחב משותף עם כמה משתתפים, שם של צ'אט קבוצתי ללא שם שלושה אנשים או יותר, או שיחה בצ'אט אישי בין שני אנשים אדם מסוים ואפליקציית 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.
  • קוראים לפונקציה אמצעי תשלום אחד (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.