Mendapatkan detail tentang langganan Google Workspace

Halaman ini menjelaskan cara mendapatkan detail tentang langganan Google Workspace menggunakan metode subscriptions.get().

Saat Anda memanggil metode ini dengan autentikasi pengguna, metode tersebut akan menampilkan detail tentang langganan yang diizinkan oleh pengguna. Saat Anda menggunakan autentikasi aplikasi, metode ini dapat menampilkan detail tentang langganan apa pun untuk aplikasi.

Prasyarat

Apps Script

  • Project Apps Script:
    • Gunakan project Google Cloud Anda, bukan project default yang dibuat otomatis oleh Apps Script.
    • Untuk setiap cakupan yang ditambahkan untuk mengonfigurasi layar izin OAuth, Anda juga harus menambahkan cakupan tersebut ke file appsscript.json di project Apps Script Anda. Contoh: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • Aktifkan layanan lanjutan Google Workspace Events.

Python

  • Python 3.6 atau yang lebih baru
  • Alat pengelolaan paket pip
  • Library klien Google terbaru untuk Python. Untuk menginstal atau mengupdatenya, jalankan perintah berikut di antarmuka command line Anda: 
      pip3 install --upgrade google-api-python-client google-auth-oauthlib

  • Langganan Google Workspace. Untuk membuatnya, lihat Membuat langganan.

  • Mewajibkan autentikasi:

    • Untuk autentikasi pengguna, diperlukan cakupan yang mendukung setidaknya salah satu jenis peristiwa untuk langganan. Untuk mengidentifikasi cakupan, lihat Cakupan menurut jenis peristiwa.
    • Untuk autentikasi aplikasi, diperlukan cakupan chat.bot (khusus aplikasi Google Chat).

Mendapatkan langganan yang diotorisasi oleh pengguna

Contoh kode berikut mendapatkan detail tentang resource Subscription menggunakan autentikasi pengguna. Saat diautentikasi sebagai pengguna, metode ini akan menampilkan langganan yang diizinkan oleh pengguna untuk dibuat oleh aplikasi.

Untuk mendapatkan langganan yang diotorisasi oleh pengguna:

Apps Script

  1. Pada project Apps Script Anda, buat file skrip baru bernama getSubscription dan tambahkan kode berikut:

    function getSubscription() {
  // The name of the subscription to get.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const subscription = WorkspaceEvents.Subscriptions.get(name);
  console.log(subscription);
}

    Ganti kode berikut:

    • SUBSCRIPTION_ID: ID langganan. Untuk mendapatkan ID, Anda dapat menggunakan salah satu cara berikut:
      • Nilai kolom uid.
      • ID nama resource yang direpresentasikan di kolom name. Misalnya, jika nama resource adalah subscriptions/subscription-123, gunakan subscription-123.

  2. Untuk mendapatkan langganan, jalankan fungsi getSubscription di project Apps Script Anda.

Python

  1. Di direktori kerja, buat file bernama get_subscription.py dan tambahkan kode berikut:

    """Get subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = ['SCOPE']

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
subscription = service.subscriptions().get(name=NAME).execute()
print(subscription)

    Ganti kode berikut:

    • SCOPE: Cakupan OAuth yang mendukung setidaknya satu jenis peristiwa dari langganan. Misalnya, jika langganan Anda menerima peristiwa ruang Chat yang diperbarui, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: ID langganan. Untuk mendapatkan ID, Anda dapat menggunakan salah satu cara berikut:
      • Nilai kolom uid.
      • ID nama resource yang direpresentasikan di kolom name. Misalnya, jika nama resource adalah subscriptions/subscription-123, gunakan subscription-123.

  2. Di direktori kerja, pastikan Anda telah menyimpan kredensial client ID OAuth dan memberi nama file client_secrets.json. Contoh kode menggunakan file JSON ini untuk melakukan autentikasi dengan Google Workspace dan mendapatkan kredensial pengguna. Untuk mengetahui petunjuknya, lihat Membuat kredensial client ID OAuth.

  3. Untuk mendapatkan langganan, jalankan perintah berikut di terminal Anda:

    python3 get_subscription.py