Bir alanı güncelleme

Bu kılavuzda, Google Chat API'nin Space kaynağında bulunan patch() yönteminin bir alanı güncellemek için nasıl kullanılacağı açıklanmaktadır. Bir alanla ilgili kullanıcılar tarafından görünen ad, açıklama ve kurallar gibi özellikleri değiştirmek için alanı güncelleyin.

Google Workspace yöneticisiyseniz Google Workspace kuruluşunuzdaki mevcut alanları güncellemek için patch() yöntemini çağırabilirsiniz.

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

  • Doğrudan mesajlar (DM), iki kullanıcı veya bir kullanıcı ile bir Chat uygulaması arasındaki görüşmelerdir.
  • Grup sohbetleri, üç veya daha fazla kullanıcı ile sohbet 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.

Ön koşullar

Node.js

Python

Java

Apps Komut Dosyası

Bir alanı kullanıcı olarak güncelleme

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

  • chat.spaces yetkilendirme kapsamını belirtin.
  • UpdateSpace() yöntemini çağırın. İsteğinizde name alanı, güncellenecek bir veya daha fazla alan içeren updateMask alanı ve güncellenmiş 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 belgelerine bakın.

Mevcut bir alanın displayName alanını şu şekilde güncelleyebilirsiniz:

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 yerine alanın name alanındaki kimliği girin. 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 alanı güncelleme

Google Workspace yöneticisiyseniz Google Workspace kuruluşunuzdaki herhangi bir alanı güncellemek için UpdateSpace() yöntemini çağırabilirsiniz.

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

  • Kullanıcı kimlik doğrulamasıyla 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 Workspace yöneticisi olarak Google Chat alanlarını yönetme başlıklı makaleyi inceleyin.

Bir alanı Chat uygulaması olarak güncelleme

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

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

  • chat.app.spaces yetkilendirme kapsamını belirtin. Uygulama kimlik doğrulamasıyla yalnızca Chat uygulamaları tarafından oluşturulan alanları güncelleyebilirsiniz.
  • Space kaynağında patch yöntemini çağırın. İsteğinizde name alanı, güncellenecek bir veya daha fazla alan içeren updateMask alanı ve güncellenmiş alan bilgilerini içeren bir body belirtirsiniz.

Görünen ad, alan türü, geçmiş durumu ve izin ayarları gibi bilgileri güncelleyebilirsiniz. Güncelleyebileceğiniz tüm alanları görmek için referans belgelerine bakın.

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

Mevcut bir alanın spaceDetails alanını şu şekilde güncelleyebilirsiniz:

Python

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

  2. chat_space_update_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"]

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)

    # 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. Koddaki aşağıdaki yerleri değiştirin:

    • SPACE ile alan adını kullanarak. Alan adını Chat API'deki spaces.list yönteminden veya bir alanın URL'sinden alabilirsiniz.

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

    python3 chat_space_update_app.py

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

Sınırlamalar ve dikkat edilmesi gereken noktalar