Google Chat alanı etkinliğiyle ilgili ayrıntıları alma

Bu kılavuzda, Google Chat API'nin SpaceEvent kaynağında bulunan get() yönteminin, Google Chat alanındaki bir etkinlikle ilgili ayrıntıları almak için nasıl kullanılacağı açıklanmaktadır.

SpaceEvent kaynağı, bir alanda veya alt kaynaklarında (ör. mesajlar, tepkiler ve üyelikler) yapılan bir değişikliği temsil eder. Desteklenen etkinlik türleri hakkında bilgi edinmek için SpaceEvent kaynağının eventType alanıyla ilgili referans belgelerine bakın.

İstek zamanından 28 gün öncesine kadar olan etkinlikleri isteyebilirsiniz. Etkinlik, değişen kaynağın en son sürümünü içerir. Örneğin, yeni bir mesajla ilgili etkinlik isteğinde bulunursanız ancak mesaj daha sonra güncellenirse sunucu, etkinlik yükünde güncellenmiş Message kaynağını döndürür.

Bu yöntemi çağırmak için kullanıcı kimlik doğrulaması kullanmanız gerekir. Bir etkinliği almak için kimliği doğrulanmış kullanıcının, etkinliğin gerçekleştiği alanın üyesi olması gerekir.

Ön koşullar

Node.js

Python

Bir alan etkinliği hakkında ayrıntılı bilgi edinme (kullanıcı kimlik doğrulaması)

Google Chat'teki bir alan etkinliği hakkında ayrıntılı bilgi edinmek için isteğinizde aşağıdakileri iletin:

  • İsteğinizde etkinlik türünü destekleyen bir yetkilendirme kapsamı belirtin. En iyi uygulama olarak, uygulamanızın çalışmasına izin veren en kısıtlı kapsamı seçin.
  • Alınacak alan etkinliğinin name değerini ileterek GetSpaceEvent() yöntemini çağırın.

Aşağıdaki örnekte bir alan etkinliği alınmaktadır:

Node.js

Bu Node.js kod örneğinde Chat RPC API kullanılır.

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

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
  };

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

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

await main();

Bu örneği çalıştırmak için aşağıdakileri değiştirin:

  • SCOPE_NAME: Etkinlik türüne dayalı bir yetkilendirme kapsamı. Örneğin, yeni bir üyelikle ilgili bir alan etkinliği alıyorsanız chat.memberships.readonly kapsamını https://www.googleapis.com/auth/chat.memberships.readonly olarak biçimlendirilmiş şekilde kullanın. Etkinlik türünü ListSpaceEvents() yönteminden alabilirsiniz. Bu yöntemi nasıl kullanacağınızı öğrenmek için Bir alandaki etkinlikleri listeleme başlıklı makaleyi inceleyin.
  • SPACE_NAME: Alanın name kimliği. Kimliği ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.
  • SPACE_EVENT_NAME: Alan etkinliğinin name kimliği. Kimliği ListSpaceEvents() yönteminden alabilirsiniz. Bu yöntemi nasıl kullanacağınızı öğrenmek için Bir alandaki etkinlikleri listeleme başlıklı makaleyi inceleyin.

Chat API, etkinlik hakkında ayrıntılar içeren bir SpaceEvent örneği döndürür.

Bir alan etkinliği hakkında ayrıntılı bilgi edinme (Chat uygulaması kimlik doğrulaması)

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

Chat REST API'yi kullanarak uygulama kimlik doğrulaması olan bir alandaki alan etkinliği hakkında ayrıntılı bilgi edinmek için isteğinize aşağıdakileri ekleyin:

  • İsteğinizdeki her etkinlik türünü desteklemek için bir veya daha fazla yetkilendirme kapsamı belirtin. En iyi uygulama olarak, uygulamanızın çalışmasına izin veren en kısıtlayıcı kapsamı seçin. Kapsam seçme hakkında daha fazla bilgi edinmek için Kimlik doğrulama ve yetkilendirmeye genel bakış başlıklı makaleyi inceleyin.
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
  • get yöntemini spaceEvents kaynağında çağırın.
  • Etkinlik ayrıntılarını almak için alanın name değerini iletin.

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 git

  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ını, projenizin kimlik bilgilerinin "API Anahtarları" bölümünde de bulabilirsiniz.
    • Yetkisiz kullanımı önlemek için API anahtarının nerede ve hangi API'ler için kullanılabileceğini kısıtlamanızı öneririz. Daha fazla bilgi için API kısıtlamaları ekleme başlıklı makaleyi inceleyin.

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

Uygulama kimlik doğrulaması ve Chat REST API ile alan etkinliği hakkında ayrıntılı bilgi edinmek için:

Python

Bu Python kodu örneğinde Chat REST API kullanılır.

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

  2. chat_spaceevents_get_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.
# Set authorization scopes based on the
# event type. For example, if you are getting a space event
# about a new membership, use the `chat.app.memberships.readonly` scope.
#
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships",
          "https://www.googleapis.com/auth/chat.app.messages.readonly",
          "https://www.googleapis.com/auth/chat.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then lists space events from a specified 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().spaceEvents().get(

        # The space to get event details from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',

    ).execute()

    # Print Chat API's response in your command line interface.
    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ı.
    • SPACE_NAME: Chat API'deki spaces.list yöntemiyle veya bir alanın URL'sinden alabileceğiniz alan adı.
    • SPACE_EVENT_NAME: Alan etkinliğinin name kimliği. Kimliği ListSpaceEvents() yönteminden alabilirsiniz. Bu yöntemi nasıl kullanacağınızı öğrenmek için Bir alandaki etkinlikleri listeleme başlıklı makaleyi inceleyin.

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

    python3 chat_spaceevents_get_app.py

Chat API, yeni üyelikler ve mesajlarla ilgili sayfalandırılmış alan etkinlikleri listesi döndürür.