Google Chat alanı oluşturma ve üye ekleme

Bu kılavuzda, Google Chat API'nin Space kaynağındaki setUp() yönteminin nasıl kullanılarak Chat alanı oluşturulacağı ve bu alana üye ekleneceği açıklanmaktadır.

Space kaynağı, kullanıcıların ve Chat uygulamalarının mesaj gönderebileceği, dosya paylaşabileceği ve ortak çalışabileceği bir yeri temsil eder. Birkaç alan türü vardır:

  • Doğrudan mesajlar (DM'ler), iki kullanıcı veya bir kullanıcı ile Chat uygulaması arasındaki görüşmelerdir.
  • Grup sohbetleri, üç veya daha fazla kullanıcı ile Chat uygulamaları arasındaki görüşmelerdir.
  • Adlandırılmış alanlar, kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı kalıcı yerlerdir.

Aşağıdakilerden herhangi birini yapmak için setUp() yöntemini kullanabilirsiniz:

  • İlk üyelerin yer aldığı bir alan adı oluşturun.
  • İki kullanıcı arasında doğrudan mesaj oluşturun.
  • Birden fazla kişi arasında grup mesajı oluşturun.

Alan oluştururken aşağıdakileri göz önünde bulundurun:

  • Arayan (kimliği doğrulanmış) kullanıcı otomatik olarak alana eklenir. Bu nedenle, istekte kullanıcının üyeliğini belirtmeniz gerekmez.
  • Doğrudan mesaj (DM) oluştururken iki kullanıcı arasında DM varsa DM döndürülür. Aksi takdirde DM oluşturulur.
  • Grup sohbeti oluştururken istekte belirtilen üyeliklerden hiçbiri grup sohbetinize başarıyla eklenemezse (ör. izin sorunu) yalnızca arayan kullanıcıyı içeren boş bir grup sohbeti oluşturulabilir.
  • Konu zinciri içeren alanlar oluşturamaz veya Google Workspace dışından kullanıcı ekleyemezsiniz.
  • İstekte sağlanan yinelenen üyelikler (arayan kullanıcı dahil), istek hatasına neden olmak yerine filtrelenir.

Ön koşullar

Node.js

Python

Java

Apps Komut Dosyası

Alan oluşturma

Alan oluşturmak için isteğinize aşağıdakileri ekleyin:

  • chat.spaces.create veya chat.spaces yetkilendirme kapsamını belirtin.
  • SetUpSpace() yöntemini çağırın.
  • space'ü displayName veya spaceType gibi gerekli tüm alanlarla birlikte Space örneği olarak iletin.
  • memberships öğesini Membership örneklerinin dizisi olarak iletin. Her örnek için:
    • Gerçek bir kullanıcıyı alan üyesi olarak eklemek için users/{user} değerini belirtin. Bu durumda {user}, People API'deki person için {person_id} veya Directory API'deki user kimliğidir. Örneğin, People API kişisi resourceName people/123456789 ise member.name olarak users/123456789 içeren bir üyelik ekleyerek kullanıcıyı alana ekleyebilirsiniz.
    • Alan üyesi olarak grup eklemek için groups/{group} değerini belirtin. Burada {group}, üyelik oluşturmak istediğiniz grup kimliğidir. Grup kimliği, Cloud Identity API kullanılarak alınabilir. Örneğin, Cloud Identity API groups/123456789 adlı bir grup döndürüyorsa membership.groupMember.name değerini groups/123456789 olarak ayarlayın. Google Grupları, grup sohbetlerine veya DM'lere değil, yalnızca adlandırılmış alanlara eklenebilir.

Arayan kullanıcı ile başka bir gerçek kullanıcı arasında DM oluşturmak için isteğinizde gerçek kullanıcının üyeliğini belirtin.

Arayan kullanıcı ile arayan uygulama arasında DM oluşturmak için space.singleUserBotDm değerini true olarak ayarlayın ve herhangi bir üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla DM oluşturmak için kullanabilirsiniz. Arama uygulamasını bir alanın üyesi olarak veya iki gerçek kullanıcı arasındaki mevcut bir DM'ye eklemek için üyelik oluşturma bölümüne bakın.

Aşağıdaki örnekte, adlandırılmış bir alan ve bu alana iki gerçek kullanıcı (kimliği doğrulanmış kullanıcı ve başka bir kullanıcı) için bir üyelik oluşturulur.

Node.js

chat/client-libraries/cloud/set-up-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 set up a named space with one initial member
// 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'
    },
    memberships: [{
      member: {
        // Replace USER_NAME here.
        name: 'users/USER_NAME',
        type: 'HUMAN'
      }
    }]
  };

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

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

main().catch(console.error);

Python

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

    # Initialize request argument(s)
    request = google_chat.SetUpSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        },
        memberships = [{
            "member": {
                # Replace USER_NAME here.
                "name": 'users/USER_NAME',
                "type_": 'HUMAN'
            }
        }]
    )

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

    # Handle the response
    print(response)

set_up_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/SetUpSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SetUpSpaceRequest;
import com.google.chat.v1.Space;
import com.google.chat.v1.User;

// This sample shows how to set up a named space with one initial member with
// user credential.
public class SetUpSpaceUserCred {

  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))) {
      SetUpSpaceRequest.Builder request = SetUpSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"))
        .addAllMemberships(ImmutableList.of(Membership.newBuilder()
          .setMember(User.newBuilder()
            // Replace USER_NAME here.
            .setName("users/USER_NAME")
            .setType(User.Type.HUMAN)).build()));
      Space response = chatServiceClient.setUpSpace(request.build());

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

Apps Komut Dosyası

chat/advanced-service/Main.gs
/**
 * This sample shows how to set up a named space with one initial member 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 setUpSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };
  const memberships = [{
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  }];

  // Make the request
  const response = Chat.Spaces.setup({ space: space, memberships: memberships });

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

Sana Özel içeriğini çalıştırmak için aşağıdakileri değiştirin:

  • DISPLAY_NAME: Yeni alanın görünen adıdır.
  • USER_NAME: Üyelik eklenecek diğer kullanıcının kimliği.

Alana gitmek için alanın URL'sini oluşturmak üzere alanın kaynak kimliğini kullanın. Kaynak kimliğini, Google Chat yanıt metnindeki name alanından alabilirsiniz. Ö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.