הגדרת מרחב משותף עם כל מי שיצטרף למרחב המשותף

במדריך הזה מוסבר איך להשתמש setUp() במשאב Space של Google Chat API כדי להגדיר Google Chat המרחב המשותף. כשיוצרים מרחב משותף, המערכת מוסיפה אליו משתמשים ספציפיים.

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

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

כשמגדירים מרחב משותף, כדאי להביא בחשבון את הנקודות הבאות:

  • המשתמש ששלח את השיחה (המאומת) יתווסף אוטומטית למרחב המשותף, כך שאתם לא צריך לציין בבקשה את החברות של המשתמש.
  • כשיוצרים צ'אט אישי, אם יש שני משתמשים בצ'אט אישי, הצ'אט מוחזר. אם לא, נוצרת צ'אט.
  • כשיוצרים צ'אט קבוצתי, אם לא הזנתם את האנשים שצוינו בבקשה נוספו בהצלחה לצ'אט הקבוצתי (למשל, בעיה בהרשאות), ואז יכול להיות שייווצר צ'אט קבוצתי ריק (כולל רק את המשתמש המתקשר).
  • אין לך אפשרות להגדיר מרחבים עם תשובות לשרשורים או לצרף אנשים שלא מהארגון שלך Google Workspace
  • חברויות כפולות (כולל המשתמש הקורא) שצוינו בבקשה מסוננות במקום לגרום לשגיאה בבקשה.

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

Node.js

Python

Java

Apps Script

הגדרת מרחב משותף

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

  • מציינים את היקף ההרשאה chat.spaces.create או chat.spaces.
  • קוראים לפונקציה SetUpSpace() .
  • מעבירים את space כמכונה של Space עם כל השדות הנדרשים, כמו displayName או spaceType.
  • מעבירים את memberships כמערך של Membership במקרים שונים. בכל אחד מהמופעים:
    • מציינים את users/{user} כדי להוסיף משתמש אנושי כחבר במרחב המשותף, כאשר {user} הוא {person_id} של person מ-People API, או המזהה של user ב-Directory API. לדוגמה, אם המשתמש ב-People API‏ resourceName הוא people/123456789, אפשר להוסיף אותו למרחב המשותף על ידי הוספת חברות עם users/123456789 כ-member.name.
    • מציינים את הערך groups/{group} כדי להוסיף קבוצה כחברה במרחב המשותף, כאשר {group} הוא מזהה הקבוצה שאליה רוצים ליצור חברות. המזהה של הקבוצה ניתן לאחזר באמצעות Cloud Identity API. לדוגמה, אם Cloud Identity API מחזיר קבוצה בשם groups/123456789, צריך להגדיר את membership.groupMember.name לערך groups/123456789. אי אפשר להוסיף קבוצות מ-Google Groups לצ'אט קבוצתי או לצ'אט אישי, אלא רק למרחב משותף בעל שם.

כדי ליצור צ'אט אישי בין המשתמש מבצע הקריאה לבין משתמש אנושי אחר, צריך לציין את החברות של המשתמש האנושי בבקשה.

כדי ליצור שיחה פרטית בין המשתמש הקורא לאפליקציה הקוראת, מגדירים את הערך של space.singleUserBotDm כ-true ולא מציינים חברויות. אפשר אפשר להשתמש בשיטה הזו רק כדי להגדיר צ'אט אישי באפליקציית השיחות. כדי להוסיף את השיחה באפליקציה שלכם במרחב משותף או בצ'אט קיים בין שני משתמשים אנושיים: יוצרים מינוי.

בדוגמה הבאה נוצר מרחב משותף בשם, ומשתמשים בשני משתמשים אנושיים (המשתמש המאומת ומשתמש נוסף) כחברים במרחב המשותף.

Node.js

chat/client-libraries/cloud/set-up-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 set up a named space with one initial member
// 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'
    },
    memberships: [{
      member: {
        // Replace USER_NAME here.
        name: 'users/USER_NAME',
        type: 'HUMAN'
      }
    }]
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/set_up_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 set_up_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.SetUpSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        },
        memberships = [{
            "member": {
                # Replace USER_NAME here.
                "name": 'users/USER_NAME',
                "type_": 'HUMAN'
            }
        }]
    )

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

    # Handle the response
    print(response)

set_up_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/SetUpSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SetUpSpaceRequest;
import com.google.chat.v1.Space;
import com.google.chat.v1.User;

// This sample shows how to set up a named space with one initial member with
// user credential.
public class SetUpSpaceUserCred {

  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))) {
      SetUpSpaceRequest.Builder request = SetUpSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"))
        .addAllMemberships(ImmutableList.of(Membership.newBuilder()
          .setMember(User.newBuilder()
            // Replace USER_NAME here.
            .setName("users/USER_NAME")
            .setType(User.Type.HUMAN)).build()));
      Space response = chatServiceClient.setUpSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to set up a named space with one initial member 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 setUpSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };
  const memberships = [{
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  }];

  // Make the request
  const response = Chat.Spaces.setup({ space: space, memberships: memberships });

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

כדי להריץ את הדוגמה, מחליפים את מה שכתוב בשדות הבאים:

  • DISPLAY_NAME: השם המוצג של המרחב החדש.
  • USER_NAME: המזהה של המשתמש השני שצריך לכלול עבור חברות ב-Google.

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