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

Bu kılavuzda, Google Chat API'nin Space kaynağında create() yöntemini kullanarak nasıl adlandırılmış alan oluşturacağınız açıklanmaktadır.

Adlandırılmış alan (spaceType simgesinin bulunduğu yer SPACE), kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı bir yerdir. Adlandırılmış alanlar Chat uygulamalarını içerebilir. Adlandırılmış alanlarda, yönetim ayarlarını ve açıklamalarını uygulayabilen, ayrıca kullanıcı ve uygulama ekleyip kaldırabilen alan yöneticileri bulunur.

Farklı türlerde Chat alanları (doğrudan mesajlar veya grup mesajları dahil) oluşturmak için setUp() kaynağında Space 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şturduktan sonra, alanın tek üyesi kimliği doğrulanmış kullanıcı olur. Alana üye eklemek için eklemek istediğiniz her kişi veya uygulama için Membership kaynağında create() yöntemini çağırın. Dilerseniz setUp() yöntemini kullanarak adlandırılmış bir alan oluşturabilir ve aynı anda üyeler ekleyebilirsiniz.

Ön koşullar

Node.js

Python

Java

Apps Komut Dosyası

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

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

  • chat.spaces.create veya chat.spaces yetkilendirme kapsamını belirtin.
  • Aşağıdaki alanlarla space öğesini Space örneği olarak ileterek CreateSpace() yöntemini çağırın:
    • spaceType şu değere ayarlandı: SPACE.
    • displayName, alanın kullanıcı tarafından görülebilen adıyla ayarlanır.
    • İsteğe bağlı olarak, aşağıdaki gibi diğer özellikleri ayarlayın:
      • spaceDetails- Alanla ilgili, kullanıcı tarafından görülebilen bir açıklama ve yönergeler.
      • 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ı olan 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ıyla değiştirin. 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, diğer alan özelliklerini ayarlayın (ör. spaceDetails (alan için kullanıcı tarafından görülebilen açıklama ve yönergeler).

API anahtarı oluşturma

Bir geliştirici önizlemesi API yöntemini çağırmak için API bulma 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ı iletmeniz gerekir.

API anahtarı oluşturmak için uygulamanızın Google Cloud projesini açın ve 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.
    • Uygulamanızın kodunda kullanmak üzere API anahtarınızı kopyalamak için Kopyala'yı tıklayın. API anahtarı, projenizin kimlik bilgilerinin "API anahtarları" bölümünde de bulunabilir.
    • 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 fazla 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'ya 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. Koddaki aşağıdaki yerleri değiştirin:

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

    • CUSTOMER: Alanın müşteri kimliği, customer/{customer} biçiminde. Burada {customer}, ID değeridir. Admin SDK müşteri kaynağındaki. 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 oluşturun ve çalıştırın:

    python3 chat_space_create_named_app.py

Google Chat'te alanı açma

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

Sınırlamalar ve dikkat edilmesi gereken noktalar

  • Uygulama kimlik doğrulaması kullanarak alan oluşturduğunuzda, kimlik doğrulayan Chat uygulaması alanın üyesi olarak eklenir ancak kullanıcı kimlik doğrulamasının aksine 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 seçeneğini managersAllowed olarak ayarlayın.