עדכון מרחב משותף

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

אדמינים ב-Google Workspace יכולים להפעיל את השיטה patch() כדי לעדכן כל מרחב משותף קיים בארגון שלהם ב-Google Workspace.

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

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

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

Node.js

Python

Java

Apps Script

עדכון מרחב משותף כמשתמשים

כדי לעדכן מרחב קיים ב-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));
    }
  }
}

Apps Script

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. עם אימות אפליקציות אפשר לעדכן רק מרחבים משותפים שנוצרו מאפליקציות צ'אט.
  • קוראים לmethod‏ patch במשאב Space. בבקשה, מציינים את השדה name של המרחב המשותף, את השדה updateMask עם שדה אחד או יותר לעדכון ואת השדה body עם פרטי המרחב המשותף המעודכנים.

אפשר לעדכן פרטים כמו השם המוצג, סוג המרחב, מצב ההיסטוריה, הגדרות ההרשאות ועוד. כדי לראות את כל השדות שאפשר לעדכן: במאמרי העזרה.

יצירה של מפתח API

כדי לשלוח קריאה ל-method של Developer Preview API, צריך להשתמש בגרסת תצוגה מקדימה למפתחים שאינה ציבורית של מסמך הגילוי של ה-API. כדי לאמת את הבקשה, צריך להעביר מפתח API.

כדי ליצור את מפתח ה-API, פותחים את הפרויקט של האפליקציה ב-Google Cloud ומבצעים את הפעולות הבאות:

  1. במסוף Google Cloud, נכנסים לתפריט > ממשקי API ו Services (שירותים) > פרטי כניסה.

    כניסה לדף Credentials

  2. לוחצים על יצירת פרטי כניסה >. API key.
  3. מפתח ה-API החדש מוצג.
    • לוחצים על סמל ההעתקה כדי להעתיק את מפתח ה-API לשימוש בקוד של האפליקציה. מפתח ה-API יכול להיות גם נמצא ב'מפתחות API'. בפרטי הכניסה של הפרויקט.
    • לוחצים על Restrict key כדי לעדכן את ההגדרות המתקדמות ולהגביל את השימוש במפתח ה-API. פרטים נוספים זמינים במאמר החלת הגבלות על מפתחות API.

כתיבת סקריפט שמפעיל את 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: מפתח ה-API שיצרתם כדי ליצור נקודת הקצה של השירות ל-Chat API.
    • SPACE עם שם של מרחב, שאפשר לקבל אמצעי תשלום אחד (spaces.list) מ-Chat API או מכתובת ה-URL של מרחב משותף.

  4. בספריית העבודה, יוצרים ומריצים את הדוגמה:

    python3 chat_space_update_app.py

Google Chat API מחזיר מופע של משאב אחד (Space) שמשקף את