Memperbarui atau memperpanjang langganan Google Workspace

Halaman ini menjelaskan cara memperpanjang langganan Google Workspace menggunakan metode subscriptions.update(). Anda dapat menggunakan metode ini untuk memperbarui waktu habis masa berlaku langganan, termasuk memperpanjang langganan untuk waktu habis masa berlaku maksimum yang memungkinkan, atau untuk memperbarui daftar jenis peristiwa yang akan diterima tentang resource target.

Apps Script

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

Python

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

Memperpanjang langganan Google Workspace

Di bagian ini, Anda menggunakan metode subscriptions.update() Google Workspace Events API untuk memperpanjang langganan hingga waktu habis masa berlaku maksimumnya. Untuk menentukan waktu habis masa berlaku maksimum, Anda memperbarui kolom ttl dari resource Subscription ke 0.

Waktu habis masa berlaku maksimum bergantung pada data resource yang disertakan dalam payload peristiwa. Untuk mempelajari waktu habis masa berlaku lebih lanjut, lihat Data peristiwa untuk peristiwa Google Workspace.

Untuk memperpanjang langganan Google Workspace:

Apps Script

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

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

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.patch({
    ttl: '0s',
  }, name);
  console.log(response);
}

    Ganti kode berikut:

    • SUBSCRIPTION_ID: ID langganan. Untuk mendapatkan ID, Anda dapat menggunakan salah satu opsi 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 memperbarui langganan Google Workspace, jalankan fungsi updateSubscription di project Apps Script Anda.

Python

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

    """Update subscription."""

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

# Specify required scopes.
SCOPES = [SCOPES]

# 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,
)

BODY = {
    'ttl': {'seconds': 0},
}
NAME = 'subscriptions/SUBSCRIPTION_ID'
response = (
    service.subscriptions()
    .patch(name=NAME, updateMask='ttl', body=BODY)
    .execute()
)
print(response)

    Ganti kode berikut:

    • SCOPES: Satu atau beberapa cakupan OAuth yang mendukung setiap jenis peristiwa untuk langganan. Diformat sebagai array string. Untuk mencantumkan beberapa cakupan, pisahkan dengan koma. Misalnya, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • SUBSCRIPTION_ID: ID langganan. Untuk mendapatkan ID, Anda dapat menggunakan salah satu opsi 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 mengautentikasi dengan Google Workspace dan mendapatkan kredensial pengguna. Untuk mengetahui petunjuknya, lihat Membuat kredensial client ID OAuth.

  3. Untuk memperbarui langganan Google Workspace, jalankan perintah berikut di terminal Anda:

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

Untuk mendapatkan detail tentang resource Subscription yang diperbarui, gunakan metode operations.get() dan tentukan resource Operation yang ditampilkan dari permintaan subscriptions.update() Anda. Jika tidak, jika Anda menentukan resource Operation dari versi langganan sebelumnya, respons akan kosong.