Bir kullanıcının Google Chat alanındaki üyeliğini güncelleme

Bu kılavuzda, update() özellikleri değiştirmek için Google Chat API'nin Membership kaynağındaki yöntem üyeliklerle ilgili bilgileri (ör. alan üyesini alan yöneticisi olarak değiştirme) alan yöneticisini bir alan üyesine dönüştürün.

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

İlgili içeriği oluşturmak için kullanılan Membership kaynak bir gerçek kullanıcının veya Google Chat uygulamasının davet edilip edilmediğini bir alanın parçası olan ya da olmayan

Ön koşullar

Node.js

Üyelik güncelleme

Alan üyeliğini güncellemek için isteğinizde aşağıdaki bilgileri iletin:

  • Yetkilendirme kapsamı belirtin:
  • UpdateMembership() yöntemini çağırın.
  • membership değerini, aşağıdakilerle birlikte Membership örneği olarak iletin:
    • name alanı, güncellenecek üyeliğe (alan kimliği dahil) ayarlandı ve üye kimliği.
    • Güncellenecek üyelik alanları yeni değerlere ayarlanır.
  • Üyeliğin güncellenecek yönlerini belirtmek için updateMask parametresini iletin. Bu parametre şunları içerir:
    • role: Kullanıcının Chat alanında izin verilen rolü. işlem olarak görebilirsiniz. Olası değerler:
      • ROLE_MEMBER: Alanın bir üyesi. Kullanıcı, alana mesaj gönderme gibi temel izinlere sahiptir. 1:1 ve adsız grupta bu rolde herkes rol oynar.
      • ROLE_MANAGER: Alan yöneticisi. Kullanıcı, tüm temel izinlere ve alanı yönetmesine olanak tanıyan yönetici izinlerine (ör. üye ekleme veya kaldırma) sahiptir. Yalnızca spaceType'nin SPACE olduğu alanlarda desteklenir (adlandırılmış alanlar).

Alandaki normal bir üyeyi kullanıcı olarak alan yöneticisi yapma

Aşağıdaki örnekte, role değerini ROLE_MANAGER olarak belirterek normal bir alan üyesini alan yöneticisi yapmak için kullanıcı kimlik doğrulamasını kullanarak Chat API çağrılıyor:

Node.js

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

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

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

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

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

main().catch(console.error);

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

  • SPACE_NAME: Alanın name kimliği. Kimliği, ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.
  • MEMBER_NAME: üyeliğin kimliği name Kimliği öğrenmek için ListMemberships() yöntemi aracılığıyla veya üyelik oluşturulduktan sonra döndürülen yanıt gövdesinden ile eşzamansız olarak kontrol edebilirsiniz.
  • ROLE_NAME: Güncellenen rol (ROLE_MANAGER).

Google Chat API, belirtilen üyeliği alan yöneticisi olarak günceller ve Membership örneği döndürür.

Alan yöneticisini kullanıcı olarak normal üye yapma

Aşağıdaki örnekte, role değerini ROLE_MEMBER olarak belirterek bir alan yöneticisini normal bir alan üyesi yapmak için kullanıcı kimlik doğrulamasını kullanarak Chat API çağrılıyor:

Node.js

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

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

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

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

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

main().catch(console.error);

Örneği çalıştırmak için aşağıdaki kodu değiştirin:

  • SPACE_NAME: alanın kimliği name Kimliği, ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.
  • MEMBER_NAME: üyeliğin kimliği name Kimliği, ListMemberships() yöntemini çağırarak veya Chat API ile asynkron olarak üyelik oluşturduktan sonra döndürülen yanıt gövdesinden alabilirsiniz.
  • ROLE_NAME: Güncellenen rol, ROLE_MEMBER.

Google Chat API, belirtilen üyeliği alan yöneticisi olarak günceller ve Membership örneği döndürür.

Chat uygulamasında normal bir alan üyesini alan yöneticisi yapma

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

API anahtarı oluşturma

Developer Preview API yöntemini çağırmak için API keşif dokümanının herkese açık olmayan geliştirici önizleme 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 > seçeneğini tıklayın. API anahtarı.
  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 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 bölümüne bakın.

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

Aşağıdaki örnekte, uygulama kimlik doğrulaması için role adresini şu şekilde belirterek normal bir alan üyesini alan yöneticisi yapabilirsiniz: body içinde, güncellenmiş üyelik özelliklerini belirten ROLE_MANAGER:

Python

  1. Çalışma dizininizde chat_membership_update_to_manager_app.py adlı bir dosya oluşturun.
  2. chat_membership_update_to_manager_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.memberships"]
    
    def main():
        '''
        Authenticates with Chat API using app authentication,
        then updates a specified space member to change
        it from a regular member to a space manager.
        '''
    
        # 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().members().patch(
    
            # The membership to update, and the updated role.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MEMBERSHIP with a membership name.
            # Obtain the membership name from the membership of Chat API.
            name='spaces/SPACE/members/MEMBERSHIP',
            updateMask='role',
            body={'role': 'ROLE_MANAGER'}
    
          ).execute()
    
        # Prints details about the updated membership.
        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ı.

    • SPACE: bir alan adı; şuradan edinebilirsiniz: spaces.list yöntem API'den veya bir alanın URL'sinden.

    • MEMBERSHIP: Chat API'deki spaces.members.list yönteminden elde edebileceğiniz bir üyelik adı.

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

    python3 chat_membership_update_to_manager_app.py

Chat uygulamasında bir alan yöneticisini normal üye yapma

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

API anahtarı oluşturma

Developer Preview API yöntemini çağırmak için API keşif dokümanının herkese açık olmayan geliştirici önizleme 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 konsolunda Menü'ye gidin > API'lar ve Hizmetler > Kimlik bilgileri.

    Kimlik Bilgileri'ne gidin

  2. Kimlik bilgileri oluştur > seçeneğini tıklayın. API anahtarı.
  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 fazla bilgi için API anahtarı kısıtlamaları uygulama bölümüne bakın.

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

Aşağıdaki örnekte, güncellenmiş üyelik özelliklerini belirten body içinde role değerini ROLE_MEMBER olarak belirterek bir alan yöneticisini normal bir alan üyesi yapmak için uygulama kimlik doğrulamasını kullanarak Chat API çağrılıyor:

Python

  1. Çalışma dizininizde chat_membership_update_to_member_app.py adlı bir dosya oluşturun.
  2. Aşağıdaki kodu chat_membership_update_to_member_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.memberships"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then updates a specified space member to change
        it from a regular member to a space manager.
        '''
    
        # 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().members().patch(
    
            # The membership to update, and the updated role.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MEMBERSHIP with a membership name.
            # Obtain the membership name from the membership of Chat API.
            name='spaces/SPACE/members/MEMBERSHIP',
            updateMask='role',
            body={'role': 'ROLE_MEMBER'}
    
          ).execute()
    
        # Prints details about the updated membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. Kodda aşağıdakileri değiştirin:

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

    • SPACE: bir alan adı; şuradan edinebilirsiniz: spaces.list yöntem API'den veya bir alanın URL'sinden.

    • MEMBERSHIP: Chat API'deki spaces.members.list yönteminden elde edebileceğiniz bir üyelik adı.

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

    python3 chat_membership_update_to_member_app.py

Google Workspace yöneticisi olarak üyelikleri güncelleme

Google Workspace yöneticisiyseniz Google Workspace kuruluşunuzdaki herhangi bir alanın üyeliklerini güncellemek için update()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ı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 başlıklı makaleyi inceleyin.