Menghapus langganan Google Workspace

Halaman ini menjelaskan cara menghapus langganan Google Workspace menggunakan subscriptions.delete() .

Saat Anda menghapus langganan, aplikasi Anda tidak lagi menerima peristiwa apa pun. Jika masa berlaku langganan habis, Google Workspace Events API akan otomatis menghapusnya.

Prasyarat

Apps Script

  • Project Apps Script:
    • Gunakan project Google Cloud Anda, bukan project default yang dibuat otomatis oleh Apps Script.
    • Untuk cakupan apa pun yang ditambahkan untuk mengonfigurasi layar izin OAuth, Anda juga harus menambahkan 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.

  • Memerlukan autentikasi:

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

Menghapus langganan yang diizinkan oleh pengguna

Contoh kode berikut menghapus Referensi Subscription menggunakan otentikasi pengguna.

Untuk menghapus langganan:

Apps Script

  1. Di project Apps Script, buat file skrip baru bernama deleteSubscription dan tambahkan kode berikut:

    function deleteSubscription() {
      // The name of the subscription to delete.
      const name = 'subscriptions/SUBSCRIPTION_ID';
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.remove(name);
      console.log(response);
    }
    

    Ganti kode berikut:

    • SUBSCRIPTION_ID: ID langganan. Untuk mendapatkan ID, Anda dapat menggunakan salah satu cara berikut:
      • Nilai atribut Kolom uid.
      • ID nama resource yang direpresentasikan dalam Kolom name. Misalnya, jika nama resource adalah subscriptions/subscription-123, gunakan subscription-123.
  2. Untuk menghapus langganan, jalankan fungsi deleteSubscription di Project Apps Script.

Python

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

    """Delete 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'
    response = service.subscriptions().delete(name=NAME).execute()
    print(response)
    

    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 atribut Kolom uid.
      • ID nama resource yang direpresentasikan dalam Kolom name. Misalnya, jika nama resource adalah subscriptions/subscription-123, gunakan subscription-123.
  2. Di direktori kerja, pastikan Anda telah menyimpan client ID OAuth kredensial, dan menamai file client_secrets.json. Contoh kode menggunakan JSON ini untuk melakukan autentikasi dengan Google Workspace dan mendapatkan kredensial pengguna. Untuk petunjuk, lihat Membuat client ID OAuth kredensial.

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

    python3 delete_subscription.py
    
Google Workspace Events API menampilkan operasi yang berjalan lama yang berisi instance resource Subscription.