Panduan memulai Python
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Buat aplikasi command line Python yang membuat permintaan ke
Google Chat API.
Panduan memulai menjelaskan cara menyiapkan dan menjalankan aplikasi yang memanggil Google Workspace API. Panduan memulai ini menggunakan pendekatan autentikasi yang disederhanakan yang sesuai untuk lingkungan pengujian. Untuk lingkungan produksi, sebaiknya pelajari
autentikasi dan otorisasi
sebelum
memilih kredensial akses
yang sesuai untuk aplikasi Anda.
Panduan memulai ini menggunakan library klien API yang direkomendasikan Google Workspace untuk menangani beberapa detail alur autentikasi dan otorisasi.
Tujuan
- Siapkan lingkungan Anda.
- Instal library klien
- Siapkan contoh.
- Jalankan contoh.
Prasyarat
Untuk menjalankan panduan memulai ini, Anda memerlukan prasyarat berikut:
Menyiapkan lingkungan Anda
Untuk menyelesaikan panduan memulai ini, siapkan lingkungan Anda.
Mengaktifkan API
Sebelum menggunakan Google API, Anda harus mengaktifkannya di project Google Cloud.
Anda dapat mengaktifkan satu atau beberapa API dalam satu project Google Cloud.
Jika Anda menggunakan project Google Cloud baru untuk menyelesaikan panduan memulai ini, konfigurasi
layar izin OAuth. Jika Anda telah menyelesaikan langkah ini untuk project Cloud Anda, lanjutkan ke bagian berikutnya.
-
Di Konsol Google Cloud, buka Menu menu
> Google Auth platform
> Branding.
Buka Branding
-
Jika sudah mengonfigurasi Google Auth platform, Anda dapat mengonfigurasi setelan Layar Izin OAuth berikut di Branding, Audiens, dan Akses Data. Jika Anda melihat pesan yang menyatakan Google Auth platform belum dikonfigurasi, klik Mulai:
- Di bagian Informasi Aplikasi, di Nama aplikasi, masukkan nama untuk aplikasi.
-
Di Email dukungan pengguna, pilih alamat email dukungan yang dapat dihubungi pengguna jika mereka memiliki pertanyaan tentang izin mereka.
-
Klik Berikutnya.
-
Di bagian Audiens, pilih Internal.
-
Klik Berikutnya.
-
Di bagian Informasi Kontak, masukkan Alamat email tempat Anda dapat menerima notifikasi tentang perubahan apa pun pada project Anda.
-
Klik Berikutnya.
-
Di bagian Selesai, tinjau Kebijakan Data Pengguna Layanan Google API dan jika Anda setuju, pilih Saya setuju dengan Google API Services: User Data Policy.
-
Klik Lanjutkan.
-
Klik Buat.
-
Untuk saat ini, Anda dapat melewati penambahan cakupan.
Pada masa mendatang, saat Anda membuat aplikasi untuk digunakan di luar organisasi Google Workspace, Anda harus mengubah Jenis pengguna menjadi Eksternal. Kemudian
tambahkan cakupan otorisasi yang diperlukan aplikasi Anda. Untuk mempelajari lebih lanjut, lihat panduan
Mengonfigurasi izin OAuth selengkapnya.
Mengizinkan kredensial untuk aplikasi desktop
Untuk mengautentikasi pengguna akhir dan mengakses data pengguna di aplikasi Anda, Anda perlu membuat satu atau beberapa ID Klien OAuth 2.0. Client ID digunakan untuk mengidentifikasi
aplikasi tunggal ke server OAuth Google. Jika aplikasi Anda berjalan di beberapa platform, Anda harus membuat client ID terpisah untuk setiap platform.
-
Di Konsol Google Cloud, buka Menu menu
> Google Auth platform
> Clients.
Buka Klien
- Klik Buat Klien.
- Klik Jenis aplikasi > Aplikasi desktop.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
- Simpan file JSON yang didownload sebagai
credentials.json, dan pindahkan
file ke direktori kerja Anda.
Untuk memanggil Google Chat API, Anda harus mengonfigurasi aplikasi Google Chat. Untuk setiap permintaan tulis, Google Chat mengatribusikan aplikasi Google Chat di UI menggunakan informasi berikut.
Di konsol Google Cloud, buka halaman Configuration Chat API:
Buka halaman Konfigurasi Chat API
Di bagian Info aplikasi, masukkan informasi berikut:
- Di kolom Nama aplikasi, masukkan
Chat API quickstart app.
- Di kolom Avatar URL, masukkan
https://developers.google.com/chat/images/quickstart-app-avatar.png.
- Di kolom Description, masukkan
Quickstart for calling the Chat API.
Di bagian Fitur interaktif, klik tombol Aktifkan fitur interaktif
ke posisi nonaktif untuk menonaktifkan fitur interaktif untuk aplikasi Chat.
Klik Simpan.
Instal library klien Google
- Di direktori kerja Anda, buat file bernama
quickstart.py.
Sertakan kode berikut di quickstart.py:
Menjalankan contoh
Di direktori kerja Anda, buat dan jalankan contoh:
python3 quickstart.py
-
Saat pertama kali dijalankan, contoh aplikasi meminta Anda untuk mengotorisasi akses:
-
Jika Anda belum login ke Akun Google Anda, login saat diminta. Jika Anda login ke beberapa akun, pilih satu akun yang akan digunakan untuk otorisasi.
- Klik Setuju.
Aplikasi Python Anda berjalan dan memanggil Google Chat API.
Informasi otorisasi disimpan dalam sistem file, sehingga saat Anda menjalankan kode contoh
pada lain waktu, Anda tidak akan diminta untuk memberikan otorisasi.
Langkah berikutnya
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-29 UTC.
[null,null,["Terakhir diperbarui pada 2025-08-29 UTC."],[[["\u003cp\u003eThis quickstart demonstrates how to create a Python command-line application that utilizes the Google Chat API to list available spaces.\u003c/p\u003e\n"],["\u003cp\u003eBefore running the sample, you'll need to set up your environment, which includes enabling the Google Chat API, configuring the OAuth consent screen, authorizing credentials, and configuring a Google Chat app.\u003c/p\u003e\n"],["\u003cp\u003eThe sample uses the Google client library for Python to handle authentication and interaction with the API; you'll need to install the necessary libraries using pip.\u003c/p\u003e\n"],["\u003cp\u003eAfter configuring the sample code provided, you can run it to authenticate and make requests to the Google Chat API, such as listing spaces based on specified filters.\u003c/p\u003e\n"],["\u003cp\u003eFor production environments, it's recommended to learn more about authentication, authorization, and appropriate access credentials in the provided links before implementing your own applications.\u003c/p\u003e\n"]]],["This content outlines how to set up and run a Python command-line application that interacts with the Google Chat API. Key actions include: enabling the Google Chat API in a Google Cloud project, configuring the OAuth consent screen and client ID, creating a Google Chat app, and installing the necessary client libraries. A `quickstart.py` file is then configured with code, and the sample is run via `python3 quickstart.py`. The first run requires authorizing access through a Google account, with subsequent runs automatically using stored credentials.\n"],null,["Create a Python command-line application that makes requests to the\nGoogle Chat API.\n\nQuickstarts explain how to set up and run an app that calls a\nGoogle Workspace API. This quickstart uses a\nsimplified authentication approach that is appropriate for a testing\nenvironment. For a production environment, we recommend learning about\n[authentication and authorization](/workspace/guides/auth-overview)\nbefore\n[choosing the access credentials](/workspace/guides/create-credentials#choose_the_access_credential_that_is_right_for_you)\nthat are appropriate for your app.\n\nThis quickstart uses Google Workspace's recommended API client libraries\nto handle some details of the authentication and authorization flow.\n\nObjectives\n\n- Set up your environment.\n- Install the client library.\n- Set up the sample.\n- Run the sample.\n\nPrerequisites\n\nTo run this quickstart, you need the following prerequisites:\n\n- Python 3.10.7 or greater\n- The [pip](https://pypi.python.org/pypi/pip) package management tool\n- [A Google Cloud project](/workspace/guides/create-project).\n\n\n- A Business or Enterprise [Google Workspace](//support.google.com/a/answer/6043576) account with access to [Google Chat](//workspace.google.com/products/chat/).\n\n\u003cbr /\u003e\n\nSet up your environment\n\nTo complete this quickstart, set up your environment.\n\nEnable the API Before using Google APIs, you need to turn them on in a Google Cloud project. You can turn on one or more APIs in a single Google Cloud project.\n\n- In the Google Cloud console, enable the Google Chat API.\n\n [Enable the API](https://console.cloud.google.com/flows/enableapi?apiid=chat.googleapis.com)\n\nConfigure the OAuth consent screen\n\nIf you're using a new Google Cloud project to complete this quickstart, configure\nthe OAuth consent screen. If you've already\ncompleted this step for your Cloud project, skip to the next section.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Branding** .\n\n [Go to Branding](https://console.cloud.google.com/auth/branding)\n2. If you have already configured the Google Auth platform, you can configure the following OAuth Consent Screen settings in [Branding](https://console.cloud.google.com/auth/branding), [Audience](https://console.cloud.google.com/auth/audience), and [Data Access](https://console.cloud.google.com/auth/scopes). If you see a message that says **Google Auth platform not configured yet** , click **Get Started**:\n 1. Under **App Information** , in **App name**, enter a name for the app.\n 2. In **User support email**, choose a support email address where users can contact you if they have questions about their consent.\n 3. Click **Next**.\n 4. Under **Audience** , select **Internal**.\n 5. Click **Next**.\n 6. Under **Contact Information** , enter an **Email address** where you can be notified about any changes to your project.\n 7. Click **Next**.\n 8. Under **Finish** , review the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy) and if you agree, select **I agree to the Google API Services: User Data Policy**.\n 9. Click **Continue**.\n 10. Click **Create**.\n3. For now, you can skip adding scopes. In the future, when you create an app for use outside of your Google Workspace organization, you must change the **User type** to **External** . Then add the authorization scopes that your app requires. To learn more, see the full [Configure OAuth consent](/workspace/guides/configure-oauth-consent) guide.\n\nAuthorize credentials for a desktop application To authenticate end users and access user data in your app, you need to create one or more OAuth 2.0 Client IDs. A client ID is used to identify a single app to Google's OAuth servers. If your app runs on multiple platforms, you must create a separate client ID for each platform.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Clients** .\n\n [Go to Clients](https://console.cloud.google.com/auth/clients)\n2. Click **Create Client**.\n3. Click **Application type** \\\u003e **Desktop app**.\n4. In the **Name** field, type a name for the credential. This name is only shown in the Google Cloud console.\n5. Click **Create** .\n\n\n The newly created credential appears under \"OAuth 2.0 Client IDs.\"\n6. Save the downloaded JSON file as `credentials.json`, and move the file to your working directory.\n\nConfigure the Google Chat app\n\nTo call the Google Chat API, you must configure a\nGoogle Chat app. For any write requests, Google Chat\nattributes the Google Chat app in the UI using\nthe following information.\n\n1. In the Google Cloud console, go to the Chat API **Configuration** page:\n\n [Go to Chat API Configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)\n2. Under **Application info**, enter the following information:\n\n 1. In the **App name** field, enter `Chat API quickstart app`.\n 2. In the **Avatar URL** field, enter `https://developers.google.com/chat/images/quickstart-app-avatar.png`.\n 3. In the **Description** field, enter `Quickstart for calling the Chat API`.\n3. Under **Interactive features** , click the **Enable interactive features**\n toggle to the off position to disable interactive features for the\n Chat app.\n\n4. Click **Save**.\n\nInstall the Google client library\n\n- Install the Google client library for Python:\n\n pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib\n\nConfigure the sample\n\n1. In your working directory, create a file named `quickstart.py`.\n2. Include the following code in `quickstart.py`:\n\n\n chat/quickstart/quickstart.py \n [View on GitHub](https://github.com/googleworkspace/python-samples/blob/main/chat/quickstart/quickstart.py) \n\n ```python\n from __future__ import print_function\n\n import os.path\n\n from google.auth.transport.requests import Request\n from google.oauth2.credentials import Credentials\n from google_auth_oauthlib.flow import InstalledAppFlow\n from google.apps import chat_v1 as google_chat\n\n\n # If modifying these scopes, delete the file token.json.\n SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']\n\n\n def main():\n \"\"\"Shows basic usage of the Google Chat API.\n \"\"\"\n creds = None\n # The file token.json stores the user's access and refresh tokens, and is\n # created automatically when the authorization flow completes for the first\n # time.\n if os.path.exists('token.json'):\n creds = Credentials.from_authorized_user_file('token.json', SCOPES)\n # If there are no (valid) credentials available, let the user log in.\n if not creds or not creds.valid:\n if creds and creds.expired and creds.refresh_token:\n creds.refresh(Request())\n else:\n flow = InstalledAppFlow.from_client_secrets_file(\n 'credentials.json', SCOPES)\n creds = flow.run_local_server(port=0)\n # Save the credentials for the next run\n with open('token.json', 'w') as token:\n token.write(creds.to_json())\n\n try:\n # Create a client\n client = google_chat.ChatServiceClient(\n credentials = creds,\n client_options = {\n \"scopes\" : SCOPES\n }\n )\n\n # Initialize request argument(s)\n request = google_chat.ListSpacesRequest(\n # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)\n filter = 'space_type = \"SPACE\"'\n )\n\n # Make the request\n page_result = client.list_spaces(request)\n\n # Handle the response. Iterating over page_result will yield results and\n # resolve additional pages automatically.\n for response in page_result:\n print(response)\n except Exception as error:\n # TODO(developer) - Handle errors from Chat API.\n print(f'An error occurred: {error}')\n\n\n if __name__ == '__main__':\n main()\n ```\n\n \u003cbr /\u003e\n\n \u003cbr /\u003e\n\nRun the sample\n\n1. In your working directory, build and run the sample:\n\n python3 quickstart.py\n\n\u003c!-- --\u003e\n\n2. The first time you run the sample, it prompts you to authorize access:\n 1. If you're not already signed in to your Google Account, sign in when prompted. If you're signed in to multiple accounts, select one account to use for authorization.\n 2. Click **Accept**.\n\n\n Your Python application runs and calls the Google Chat API.\n\n\n Authorization information is stored in the file system, so the next time you run the sample\n code, you aren't prompted for authorization.\n\nNext steps\n\n- [Try the Google Workspace APIs in the APIs explorer](/workspace/explore)\n\n\u003c!-- --\u003e\n\n- [Client library documentation](https://googleapis.dev/python/google-apps-chat/latest/)"]]
