یک فضای نامگذاری شده در Google Chat ایجاد کنید

این راهنما نحوه ایجاد یک فضای نامگذاری شده با استفاده از متد create() در منبع Space از API چت گوگل را توضیح می‌دهد.

یک فضای نامگذاری شده (که در آن spaceType SPACE است) مکانی است که افراد در آن پیام ارسال می‌کنند، فایل‌ها را به اشتراک می‌گذارند و با یکدیگر همکاری می‌کنند. فضاهای نامگذاری شده می‌توانند شامل برنامه‌های چت باشند. فضاهای نامگذاری شده دارای مدیران فضا هستند که می‌توانند تنظیمات مدیریتی و توضیحات را اعمال کنند و افراد و برنامه‌ها را اضافه یا حذف کنند.

برای ایجاد انواع مختلف فضاهای چت (از جمله پیام‌های مستقیم یا پیام‌های گروهی)، از متد setUp() در منبع Space برای ایجاد فضا و اضافه کردن اعضا به طور همزمان استفاده کنید. برای جزئیات بیشتر، Setup a space را ببینید .

پس از ایجاد یک فضای نام‌گذاری‌شده، تنها عضو فضا، کاربر احراز هویت‌شده است. برای افزودن اعضا به فضا، متد create() را در منبع Membership برای هر شخص یا برنامه‌ای که می‌خواهید اضافه کنید، فراخوانی کنید. یا می‌توانید از متد setUp() برای ایجاد یک فضای نام‌گذاری‌شده و افزودن اعضا به آن به‌طور همزمان استفاده کنید.

پیش‌نیازها

نود جی اس

پایتون

جاوا

اسکریپت برنامه‌ها

ایجاد یک فضای نامگذاری شده به عنوان کاربر

برای ایجاد یک فضای نامگذاری شده با احراز هویت کاربر ، موارد زیر را در درخواست خود وارد کنید:

  • دامنه مجوز chat.spaces.create یا chat.spaces را مشخص کنید.
  • متد CreateSpace() فراخوانی کنید و space را به عنوان نمونه‌ای از Space با فیلدهای زیر ارسال کنید:
    • spaceType روی SPACE تنظیم شده است.
    • displayName روی نام قابل مشاهده توسط کاربر برای فضا تنظیم می‌شود.
    • به صورت اختیاری، ویژگی‌های دیگری مانند موارد زیر را تنظیم کنید:
      • spaceDetails - توضیحی قابل مشاهده برای کاربر و مجموعه‌ای از دستورالعمل‌ها برای فضا.
      • predefinedPermissionSettings - مجوزهای از پیش تعریف شده برای فضا. به عنوان مثال، می‌توانید آن را طوری پیکربندی کنید که همه اعضا یا فقط مدیران فضا بتوانند پیام ارسال کنند.

در اینجا نحوه ایجاد یک فضای نامگذاری شده آورده شده است:

نود جی اس

چت/کتابخانه‌های-مشتری/ابر/ایجاد-فضا-کاربر-create-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 create a named 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: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME',
    },
  };

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

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

await main();

پایتون

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

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

جاوا

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

  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))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

اسکریپت برنامه‌ها

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space 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 createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: "SPACE",
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: "DISPLAY_NAME",
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

یک فضای نامگذاری شده به عنوان یک برنامه چت ایجاد کنید

احراز هویت برنامه نیاز به تأیید یک‌باره مدیر دارد.

برای دعوت یا اضافه کردن یک کاربر به فضایی با احراز هویت برنامه ، موارد زیر را در درخواست خود وارد کنید:

  • دامنه مجوز chat.app.spaces.create یا chat.app.spaces را مشخص کنید.
  • متد create را روی منبع Space فراخوانی کنید.
  • spaceType را روی SPACE تنظیم کنید.
  • displayName برابر با نام قابل مشاهده توسط کاربر برای فضا قرار دهید. در مثال زیر، displayName برابر با API-made تنظیم شده است.
  • شناسه مشتری دامنه Google Workspace را با استفاده از فیلد customer مشخص کنید.
  • به صورت اختیاری، سایر ویژگی‌های فضا، مانند spaceDetails (توضیحی قابل مشاهده توسط کاربر و مجموعه‌ای از دستورالعمل‌ها برای فضا) را تنظیم کنید.

اسکریپتی بنویسید که Chat API را فراخوانی کند

در اینجا نحوه ایجاد یک فضای نامگذاری شده آورده شده است:

پایتون

  1. در دایرکتوری کاری خود، فایلی با نام chat_space_create_named_app.py ایجاد کنید.

  2. کد زیر را در chat_space_create_named_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.create"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat space.
    '''

    # 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)

    # 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',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

    # Prints details about the created space.
    print(result)

if __name__ == '__main__':
    main()

  3. در کد، موارد زیر را جایگزین کنید:

    • CUSTOMER : شناسه مشتری دامنه فضا در قالب customer/{customer} که در آن {customer} ID منبع مشتری Admin SDK است. برای ایجاد فضایی در همان سازمان Google Workspace که برنامه چت در آن قرار دارد، customers/my_customer استفاده کنید.

  4. در دایرکتوری کاری خود، نمونه را بسازید و اجرا کنید:

    python3 chat_space_create_named_app.py

فضای موجود در گوگل چت را باز کنید

برای رفتن به فضا، از شناسه منبع فضا برای ساخت URL فضا استفاده کنید. می‌توانید شناسه منبع را از name فضا در بدنه پاسخ Google Chat پیدا کنید. برای مثال، اگر name فضای شما spaces/1234567 باشد، می‌توانید با استفاده از URL زیر به فضا بروید: https://mail.google.com/chat/u/0/#chat/space/1234567 .

محدودیت‌ها و ملاحظات

  • وقتی با استفاده از احراز هویت برنامه ، فضایی ایجاد می‌کنید، برنامه چتِ احراز هویت‌کننده به عنوان عضوی از فضا اضافه می‌شود، اما برخلاف احراز هویت کاربر، به عنوان مدیر فضا اضافه نمی‌شود. به طور پیش‌فرض، همه اعضای فضا می‌توانند برنامه چت را حذف کنند. برای اینکه فقط به مدیران فضا اجازه حذف برنامه چت داده شود، permissionSettings.manageApps را روی managersAllowed تنظیم کنید.