Python hızlı başlangıç kılavuzu

Google Chat API'ye istek gönderen bir Python komut satırı uygulaması oluşturun.

Hızlı başlangıç kılavuzlarında, Google Workspace API'sini çağıran bir uygulamanın nasıl ayarlanacağı ve çalıştırılacağı açıklanır. Bu hızlı başlangıç kılavuzunda, test ortamı için uygun olan basitleştirilmiş bir kimlik doğrulama yaklaşımı kullanılmaktadır. Üretim ortamı için, uygulamanıza uygun erişim kimlik bilgilerini seçmeden önce kimlik doğrulama ve yetkilendirme hakkında bilgi edinmenizi öneririz.

Bu hızlı başlangıç kılavuzunda, kimlik doğrulama ve yetkilendirme akışının bazı ayrıntılarını işlemek için Google Workspace'in önerdiği API istemci kitaplıkları kullanılır.

Hedefler

  • Ortamınızı ayarlayın.
  • İstemci kitaplığını yükleyin.
  • Numuneyi ayarlayın.
  • Örneği çalıştırın.

Ön koşullar

Bu hızlı başlangıcı çalıştırmak için aşağıdaki ön koşulları karşılamanız gerekir:

Ortamınızı ayarlama

Bu hızlı başlangıcı tamamlamak için ortamınızı ayarlayın.

API'yi etkinleştirme

Google API'lerini kullanmadan önce bir Google Cloud projesinde etkinleştirmeniz gerekir. Tek bir Google Cloud projesinde bir veya daha fazla API'yi etkinleştirebilirsiniz.

Bu hızlı başlangıcı tamamlamak için yeni bir Google Cloud projesi kullanıyorsanız OAuth izin ekranını yapılandırın. Cloud projeniz için bu adımı daha önce tamamladıysanız sonraki bölüme geçin.

  1. Google Cloud Console'da Menü > Google Auth platform > Markalama'ya gidin.

    Markalama'ya gidin

  2. Google Auth platformyapılandırdıysanız Markalama, Kitle ve Veri Erişimi'nde aşağıdaki OAuth kullanıcı rızası ekranı ayarlarını yapılandırabilirsiniz. Google Auth platform henüz yapılandırılmadı mesajını görürseniz Başlayın'ı tıklayın:
    1. Uygulama Bilgileri bölümündeki Uygulama adı alanına uygulamanın adını girin.
    2. Kullanıcı destek e-postası bölümünde, kullanıcıların rızalarıyla ilgili soruları olduğunda sizinle iletişime geçebileceği bir destek e-posta adresi seçin.
    3. İleri'yi tıklayın.
    4. Kitle bölümünde Dahili'yi seçin.
    5. İleri'yi tıklayın.
    6. İletişim bilgileri bölümünde, projenizde yapılan değişikliklerle ilgili bildirim alabileceğiniz bir e-posta adresi girin.
    7. İleri'yi tıklayın.
    8. Bitir bölümünde Google API Hizmetleri Kullanıcı Verileri Politikası'nı inceleyin ve kabul ediyorsanız Google API Hizmetleri: Kullanıcı Verileri Politikası'nı kabul ediyorum'u seçin.
    9. Devam'ı tıklayın.
    10. Oluştur'u tıklayın.
  3. Şimdilik kapsam eklemeyi atlayabilirsiniz. Gelecekte Google Workspace kuruluşunuzun dışında kullanılacak bir uygulama oluşturduğunuzda Kullanıcı türü'nü Harici olarak değiştirmeniz gerekir. Ardından, uygulamanızın gerektirdiği yetkilendirme kapsamlarını ekleyin. Daha fazla bilgi için OAuth iznini yapılandırma başlıklı kılavuzun tamamını inceleyin.

Bir masaüstü uygulaması için kimlik bilgilerini yetkilendirme

Uygulamanızda son kullanıcıların kimliğini doğrulamak ve kullanıcı verilerine erişmek için bir veya daha fazla OAuth 2.0 istemci kimliği oluşturmanız gerekir. İstemci kimliği, tek bir uygulamanın Google OAuth sunucularına tanıtılması için kullanılır. Uygulamanız birden fazla platformda çalışıyorsa her platform için ayrı bir istemci kimliği oluşturmanız gerekir.
  1. Google Cloud Console'da Menü > Google Auth platform > İstemciler'e gidin.

    Müşteriler'e gidin.

  2. Create Client'ı (İstemci Oluştur) tıklayın.
  3. Uygulama türü > Masaüstü uygulaması'nı tıklayın.
  4. Ad alanına, kimliğin adını yazın. Bu ad yalnızca Google Cloud Console'da gösterilir.
  5. Oluştur'u tıklayın.

    Yeni oluşturulan kimlik bilgisi, "OAuth 2.0 İstemci Kimlikleri" bölümünde görünür.

  6. İndirilen JSON dosyasını credentials.json olarak kaydedin ve dosyayı çalışma dizininize taşıyın.

Google Chat uygulamasını yapılandırma

Google Chat API'yi çağırmak için bir Google Chat uygulaması yapılandırmanız gerekir. Google Chat, tüm yazma istekleri için kullanıcı arayüzünde Google Chat uygulamasını aşağıdaki bilgileri kullanarak ilişkilendirir.

  1. Google Cloud Console'da Chat API Yapılandırma sayfasına gidin:

    Chat API Yapılandırma sayfasına gidin

  2. Application info (Uygulama bilgileri) bölümünde aşağıdaki bilgileri girin:

    1. Uygulama adı alanına Chat API quickstart app girin.
    2. Avatar URL'si alanına https://developers.google.com/chat/images/quickstart-app-avatar.png girin.
    3. Açıklama alanına Quickstart for calling the Chat API girin.

  3. Etkileşimli özellikler bölümünde, Etkileşimli özellikleri etkinleştir açma/kapatma düğmesini kapalı konuma getirerek Chat uygulamasında etkileşimli özellikleri devre dışı bırakın.

  4. Kaydet'i tıklayın.

Google istemci kitaplığını yükleme

  • Python için Google istemci kitaplığını yükleyin:

    pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib

Örneği yapılandırma

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

  2. quickstart.py'ya aşağıdaki kodu ekleyin:

    chat/quickstart/quickstart.py
    from __future__ import print_function

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from google.apps import chat_v1 as google_chat


# If modifying these scopes, delete the file token.json.
SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']


def main():
    """Shows basic usage of the Google Chat API.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.json', 'w') as token:
            token.write(creds.to_json())

    try:
        # Create a client
        client = google_chat.ChatServiceClient(
            credentials = creds,
            client_options = {
                "scopes" : SCOPES
            }
        )

        # Initialize request argument(s)
        request = google_chat.ListSpacesRequest(
            # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
            filter = 'space_type = "SPACE"'
        )

        # Make the request
        page_result = client.list_spaces(request)

        # Handle the response. Iterating over page_result will yield results and
        # resolve additional pages automatically.
        for response in page_result:
            print(response)
    except Exception as error:
        # TODO(developer) - Handle errors from Chat API.
        print(f'An error occurred: {error}')


if __name__ == '__main__':
    main()

Örneği çalıştırma

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

    python3 quickstart.py
  1. Örneği ilk kez çalıştırdığınızda erişimi yetkilendirmeniz istenir:
    1. Google Hesabınızda henüz oturum açmadıysanız istendiğinde oturum açın. Birden fazla hesapta oturum açtıysanız yetkilendirme için kullanılacak bir hesap seçin.
    2. Kabul et'i tıklayın.

    Python uygulamanız çalışıyor ve Google Chat API'sini çağırıyor.

    Yetkilendirme bilgileri dosya sisteminde depolandığı için örnek kodu bir sonraki çalıştırmanızda yetkilendirme istenmez.

Sonraki adımlar