Bir alanı güncelleme

Bu kılavuzda, bir alanı güncellemek için Google Chat API'nin Space kaynağındaki patch() yönteminin nasıl kullanılacağı açıklanmaktadır. Kullanıcılara görünen görünen adı, açıklaması ve yönergeleri gibi alanla ilgili özellikleri değiştirmek için alanı güncelleyin.

Google Workspace yöneticisiyseniz patch() yöntemini çağırabilirsiniz. tıklayın.

İlgili içeriği oluşturmak için kullanılan Space kaynak kullanıcıların ve Chat uygulamalarının mesaj gönderebildiği, dosya paylaşabilir ve ortak çalışabilirsiniz. Birkaç alan türü vardır:

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

Ön koşullar

Node.js

  • Google Chat alanı. Google Chat API'yi kullanarak alan oluşturmak için Alan oluşturma başlıklı makaleyi inceleyin. Chat'te hesap oluşturmak için: şurayı ziyaret edin: Yardım Merkezi belgeleri.

Python

Java

Apps Komut Dosyası

Kullanıcı olarak bir alanı güncelleme

Google Chat'teki mevcut bir alanı kullanıcı kimlik doğrulamasıyla güncellemek için isteğinizde aşağıdakileri iletin:

  • chat.spaces yetkilendirme kapsamını belirtin.
  • UpdateSpace() yöntemini çağırın. İsteğinizde alan name alanını, güncellenecek bir veya daha fazla alanı içeren updateMask alanını ve güncellenen alan bilgilerini içeren bir body alanı belirtirsiniz.

Görünen ad, alan türü, geçmiş durumu gibi bilgileri güncelleyebilirsiniz. Güncelleyebileceğiniz tüm alanları görmek için referans belgelerini inceleyin.

Mevcut bir alanın displayName alanını güncellemek için:

Node.js

chat/client-libraries/cloud/update-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces'];

// This sample shows how to update a 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: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name']
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_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"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

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

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

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

Apps Komut Dosyası

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const space = {
    displayName: 'New space display name'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'displayName';

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask
  });

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

Bu örneği çalıştırmak için SPACE_NAME alanını alanın name alanındaki kimlikle değiştirin. Kimliği, ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.

Google Chat API, güncellemeleri yansıtan bir Space örneği döndürür.

Google Workspace yöneticisi olarak bir alanı güncelleme

Google Workspace yöneticisiyseniz Google Workspace'inizdeki herhangi bir alanı güncellemek için UpdateSpace() yöntemi kurum içinde tutmaktır.

Bu yöntemi Google Workspace yöneticisi olarak çağırmak için aşağıdakileri yapın:

  • Kullanıcı kimlik doğrulamasını kullanarak yöntemi çağırın ve yöntemin yönetici ayrıcalıkları kullanılarak çağrılmasını destekleyen bir yetkilendirme kapsamı belirtin.
  • İsteğinizde useAdminAccess sorgu parametresini true olarak belirtin.

Daha fazla bilgi ve örnek için Google Chat alanlarını Google Workspace yöneticisi olarak yönetme

Bir alanı Chat uygulaması olarak güncelleme

Uygulama kimlik doğrulaması bir kerelik gerektirir yönetici onayından yararlanabilir.

Google Chat'te mevcut bir alanı uygulama kimlik doğrulamasıyla güncellemek için isteğinizde aşağıdakileri iletin:

  • chat.app.spaces yetkilendirme kapsamını belirtin. Uygulama kimlik doğrulamasıyla yalnızca oluşturulan alanları güncelleyebilirsiniz. .
  • Şunu çağırın: patch yöntem Space kaynağında. İçinde isteğiniz için, boşluk name alanını updateMask Güncellenecek bir veya daha fazla alan ve bir Güncellenen alan bilgileriyle body.

Görünen ad, alan türü, geçmiş durumu, alan adı ve daha fazlası. Güncelleyebileceğiniz tüm alanları görmek için referans dokümanlarına bakın.

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ı 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.
    • API anahtarınızı uygulamanızın kodunda kullanmak için Kopyala'yı seçin. API anahtarı ayrıca "API anahtarları" içinde bulunur kimlik doğrulama bilgileri dahil edilir.
    • Gelişmiş ayarları güncellemek ve kullanımı sınırlandırmak için Anahtarı kısıtla'yı tıklayın ekleyin. 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

Mevcut bir alanın spaceDetails alanını güncellemek için:

Python

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

  2. Aşağıdaki kodu chat_space_update_app.py bölümüne 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"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

    # 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().patch(

      # The space to update, and the updated space details.
      #
      # Replace {space} with a space name.
      # Obtain the space name from the spaces resource of Chat API,
      # or from a space's URL.
      name='spaces/SPACE',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

    # Prints details about the updated 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ı.
    • Bir alan adıyla SPACE şuradan edinebilirsiniz: spaces.list yöntem API'den veya bir alanın URL'sinden.

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

    python3 chat_space_update_app.py

Google Chat API, Space kaynak güncellemelerine göz atın.