یک فضا ایجاد کنید

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

منبع Space مکانی را نشان می‌دهد که در آن افراد و برنامه‌های چت می‌توانند پیام ارسال کنند، فایل‌ها را به اشتراک بگذارند و با هم همکاری کنند. چند نوع فضا وجود دارد:

  • پیام‌های مستقیم (DM) مکالمات بین دو کاربر یا یک کاربر و یک برنامه چت هستند.
  • چت گروهی مکالمه بین سه یا چند کاربر و برنامه های چت است.
  • فضاهای نام‌گذاری شده مکان‌هایی هستند که افراد در آن پیام می‌فرستند، فایل‌ها را به اشتراک می‌گذارند و همکاری می‌کنند.

فضای نامگذاری شده مکانی است که در آن افراد پیام می فرستند، فایل ها را به اشتراک می گذارند و با هم همکاری می کنند. فضاهای نامگذاری شده می توانند شامل برنامه های چت باشند. فضاهای نامگذاری شده شامل ویژگی‌های اضافی هستند که مکالمات گروهی و پیام‌های مستقیم بدون نام از آن‌ها برخوردار نیستند، مانند مدیران فضا که می‌توانند تنظیمات اداری، توضیحات، و اضافه یا حذف افراد و برنامه‌ها را اعمال کنند. پس از ایجاد یک فضای نامگذاری شده، تنها عضو فضا، کاربر تایید شده است. فضا شامل افراد یا برنامه‌های دیگر نمی‌شود. نه حتی برنامه چت که آن را ایجاد می کند. برای افزودن اعضا به یک فضا، به ایجاد عضویت مراجعه کنید.

برای ایجاد فضایی با نام با چند عضو - یک گپ گروهی بدون نام بین سه یا چند نفر، یا یک مکالمه پیام مستقیم بین دو نفر، یا یک شخص و برنامه Chat که Chat API را فرا می‌خواند - به جای آن یک فاصله تنظیم کنید .

پیش نیازها

Node.js

پایتون

جاوا

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

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

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

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

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

Node.js

chat/client-libraries/cloud/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);
}

main().catch(console.error);

پایتون

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 (توضیحات قابل مشاهده توسط کاربر و مجموعه‌ای از دستورالعمل‌ها برای فضا) را تنظیم کنید.

یک کلید API ایجاد کنید

برای فراخوانی یک روش API پیش‌نمایش برنامه‌نویس، باید از یک نسخه پیش‌نمایش برنامه‌نویس غیرعمومی سند کشف API استفاده کنید. برای احراز هویت درخواست، باید یک کلید API ارسال کنید.

برای ایجاد کلید API، پروژه Google Cloud برنامه خود را باز کنید و کارهای زیر را انجام دهید:

  1. در کنسول Google Cloud، به منو > APIs & Services > Credentials بروید.

    به Credentials بروید

  2. روی ایجاد اعتبارنامه > کلید API کلیک کنید.
  3. کلید API جدید شما نمایش داده می شود.
    • روی Copy کلیک کنید تا کلید API خود را برای استفاده در کد برنامه خود کپی کنید. کلید API را می‌توانید در بخش «کلیدهای API» اعتبار پروژه‌تان پیدا کنید.
    • برای به‌روزرسانی تنظیمات پیشرفته و محدود کردن استفاده از کلید API، روی Restrict key کلیک کنید. برای جزئیات بیشتر، به اعمال محدودیت‌های کلید API مراجعه کنید.

اسکریپتی بنویسید که 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, 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().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. در کد زیر را جایگزین کنید:

    • API_KEY : کلید API که برای ساختن نقطه پایانی سرویس برای Chat API ایجاد کردید.

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

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

    python3 chat_space_create_named_app.py

فضا را در Google Chat باز کنید

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