Google Chat'te adlandırılmış alan oluşturma

Bu kılavuzda, Google Chat API'nin Space kaynağındaki create() yöntemi kullanılarak adlandırılmış alanın nasıl oluşturulacağı açıklanmaktadır.

Adlandırılmış alan (spaceType simgesinin bulunduğu SPACE), kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı bir yerdir. Adlandırılmış alanlar Chat uygulamaları içerebilir. Adlandırılmış alanların alan yöneticileri vardır. Bu yöneticiler, yönetim ayarlarını uygulayabilir, açıklamalar ekleyebilir, kullanıcı ve uygulama ekleyebilir ya da kaldırabilir.

Farklı Chat alanı türleri (doğrudan mesajlar veya grup mesajları dahil) oluşturmak için Space kaynağındaki setUp() yöntemini kullanarak alanı oluşturun ve aynı anda üye ekleyin. Ayrıntılı bilgi için Alan oluşturma başlıklı makaleyi inceleyin.

Adlandırılmış bir alan oluşturulduktan sonra alanın tek üyesi kimliği doğrulanmış kullanıcıdır. Alana üye eklemek için eklemek istediğiniz her kullanıcı veya uygulama için Membership kaynağında create() yöntemini çağırın. Dilerseniz adlandırılmış bir alan oluşturmak ve aynı anda alana üye eklemek için setUp() yöntemini de kullanabilirsiniz.

Ön koşullar

Node.js

Python

Java

Apps Komut Dosyası

Kullanıcı olarak adlandırılmış alan oluşturma

Kullanıcı kimlik doğrulaması içeren bir adlandırılmış alan oluşturmak için isteğinizde aşağıdakileri iletin:

  • chat.spaces.create veya chat.spaces yetkilendirme kapsamını belirtin.
  • space öğesini aşağıdaki alanlarla birlikte Space örneği olarak göndererek CreateSpace() yöntemini çağırın:
    • spaceType şu değere ayarlandı: SPACE.
    • displayName, alanın kullanıcı tarafından görülebilen adına ayarlanır.
    • İsteğe bağlı olarak aşağıdaki gibi diğer özellikleri de ayarlayabilirsiniz:
      • spaceDetails: Alanla ilgili kullanıcıların görebileceği bir açıklama ve kurallar grubu.
      • predefinedPermissionSettings: Alan için önceden tanımlanmış izinler. Örneğin, tüm üyelerin veya yalnızca alan yöneticilerinin mesaj yayınlayabileceği şekilde yapılandırabilirsiniz.

Adlandırılmış alan oluşturmak için:

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

Python

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

Java

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));
    }
  }
}

Apps Komut Dosyası

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 uygulaması olarak adlandırılmış alan oluşturma

Uygulama kimlik doğrulaması için tek seferlik yönetici onayı gerekir.

Uygulama kimlik doğrulamasının etkin olduğu bir alana kullanıcı davet etmek veya eklemek için isteğinizde aşağıdakileri iletin:

  • chat.app.spaces.create veya chat.app.spaces yetkilendirme kapsamını belirtin.
  • Space kaynağında create yöntemini çağırın.
  • spaceType değerini SPACE olarak ayarlayın.
  • displayName değerini alanın kullanıcı tarafından görülebilen adına ayarlayın. Aşağıdaki örnekte displayName, API-made olarak ayarlanmıştır.
  • customer alanını kullanarak Google Workspace alanının müşteri kimliğini belirtin.
  • İsteğe bağlı olarak spaceDetails (alanla ilgili kullanıcılara görünen bir açıklama ve yönergeler grubu) gibi diğer alan özelliklerini de ayarlayabilirsiniz.

API anahtarı oluşturma

Geliştirici Önizlemesi API yöntemini çağırmak için API keşif belgesinin herkese açık olmayan bir Geliştirici Önizlemesi sürümünü kullanmanız gerekir. İsteğin kimliğini doğrulamak için bir API anahtarı göndermeniz gerekir.

API anahtarını oluşturmak için uygulamanızın Google Cloud projesini açıp aşağıdakileri yapın:

  1. Google Cloud Console'da Menü > API'ler ve Hizmetler > Kimlik bilgileri'ne gidin.

    Kimlik Bilgileri'ne gidin

  2. Kimlik bilgileri oluştur > API anahtarı'nı tıklayın.
  3. Yeni API anahtarınız gösterilir.
    • API anahtarınızı uygulamanızın kodunda kullanmak için Kopyala'yı seçin. API anahtarını, projenizin kimlik bilgilerinin "API anahtarları" bölümünde de bulabilirsiniz.
    • Gelişmiş ayarları güncellemek ve API anahtarınızın kullanımını sınırlamak için Anahtarı kısıtla'yı tıklayın. Daha ayrıntılı bilgi için API anahtarı kısıtlamaları uygulama başlıklı makaleyi inceleyin.

Chat API'yi çağıran bir komut dosyası yazma

Adlandırılmış alan oluşturmak için:

Python

  1. Çalışma dizininizde chat_space_create_named_app.py adlı bir dosya oluşturun.

  2. chat_space_create_named_app.py dosyasına aşağıdaki kodu ekleyin:

    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. Kodda aşağıdakileri değiştirin:

    • API_KEY: Chat API için hizmet uç noktasını oluşturmak üzere oluşturduğunuz API anahtarı.

    • CUSTOMER: Alanın müşteri kimliğidir. customer/{customer} biçimindedir. {customer}, Admin SDK müşteri kaynağındaki ID değerini ifade eder. Chat uygulamasıyla aynı Google Workspace kuruluşunda alan oluşturmak için customers/my_customer simgesini kullanın.

  4. Çalışma dizininizde örneği derleyip çalıştırın:

    python3 chat_space_create_named_app.py

Alanı Google Chat'te açma

Alana gitmek için alanın URL'sini oluşturmak üzere alanın kaynak kimliğini kullanın. name alanındaki kaynak kimliğini Google Chat yanıt gövdesinde bulabilirsiniz. Örneğin, alanınızın name değeri spaces/1234567 ise şu URL'yi kullanarak alana gidebilirsiniz: https://mail.google.com/chat/u/0/#chat/space/1234567.

Sınırlamalar ve dikkat edilmesi gereken hususlar

  • Uygulama kimlik doğrulamasını kullanarak alan oluşturduğunuzda kimlik doğrulaması yapan Chat uygulaması, alanın üyesi olarak eklenir ancak kullanıcı kimlik doğrulamasından farklı olarak alan yöneticisi olarak eklenmez. Varsayılan olarak tüm alan üyeleri Chat uygulamasını kaldırabilir. Yalnızca alan yöneticilerinin Chat uygulamasını kaldırmasına izin vermek için permissionSettings.manageApps değerini managersAllowed olarak ayarlayın.