Xoá gói thuê bao của Google Workspace

Trang này giải thích cách xoá gói thuê bao Google Workspace bằng phương thức subscriptions.delete().

Khi bạn xoá một gói thuê bao, ứng dụng của bạn sẽ không nhận được sự kiện nào nữa. Nếu một gói thuê bao hết hạn, API Sự kiện của Google Workspace sẽ tự động xoá gói thuê bao đó.

Điều kiện tiên quyết

Apps Script

  • Một dự án Apps Script:
    • Sử dụng dự án Google Cloud thay vì dự án mặc định do Apps Script tạo tự động.
    • Đối với mọi phạm vi mà bạn đã thêm để định cấu hình màn hình đồng ý OAuth, bạn cũng phải thêm các phạm vi đó vào tệp appsscript.json trong dự án Apps Script. Ví dụ:
    • "oauthScopes": [
        "https://www.googleapis.com/auth/chat.messages.readonly"
      ]
          
    • Bật dịch vụ nâng cao Google Workspace Events.

Python

  • Python 3.6 trở lên
  • Công cụ quản lý gói pip
  • Thư viện ứng dụng Google mới nhất cho Python. Để cài đặt hoặc cập nhật các gói này, hãy chạy lệnh sau trong giao diện dòng lệnh:
      pip3 install --upgrade google-api-python-client google-auth-oauthlib
      
  • Gói thuê bao Google Workspace. Để tạo một gói thuê bao, hãy xem phần Tạo gói thuê bao.

  • Yêu cầu xác thực:

    • Để xác thực người dùng, yêu cầu một phạm vi hỗ trợ ít nhất một trong các loại sự kiện cho gói thuê bao. Để xác định phạm vi, hãy xem phần Phạm vi theo loại sự kiện.
    • Để xác thực ứng dụng, bạn cần có phạm vi chat.bot (chỉ dành cho ứng dụng Google Chat).

Xoá gói thuê bao do người dùng uỷ quyền

Mã mẫu sau đây xoá tài nguyên Subscription bằng cách xác thực người dùng.

Cách xoá gói thuê bao:

Apps Script

  1. Trong dự án Apps Script, hãy tạo một tệp tập lệnh mới tên là deleteSubscription và thêm mã sau:

    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);
    }
    

    Thay thế nội dung sau:

    • SUBSCRIPTION_ID: Mã của gói thuê bao. Để lấy mã nhận dạng, bạn có thể sử dụng bất kỳ phương thức nào sau đây:
      • Giá trị của trường uid.
      • Mã nhận dạng của tên tài nguyên được biểu thị trong trường name. Ví dụ: nếu tên tài nguyên là subscriptions/subscription-123, hãy sử dụng subscription-123.
  2. Để xoá gói thuê bao, hãy chạy hàm deleteSubscription trong dự án Apps Script.

Python

  1. Trong thư mục đang hoạt động, hãy tạo một tệp có tên delete_subscription.py rồi thêm mã sau:

    """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)
    

    Thay thế nội dung sau:

    • SCOPE: Phạm vi OAuth hỗ trợ ít nhất một loại sự kiện từ gói thuê bao. Ví dụ: nếu gói thuê bao của bạn nhận được các sự kiện về một phòng Chat đã cập nhật, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: Mã của gói thuê bao. Để lấy mã nhận dạng, bạn có thể sử dụng bất kỳ phương thức nào sau đây:
      • Giá trị của trường uid.
      • Mã nhận dạng của tên tài nguyên được biểu thị trong trường name. Ví dụ: nếu tên tài nguyên là subscriptions/subscription-123, hãy sử dụng subscription-123.
  2. Trong thư mục đang hoạt động, hãy đảm bảo bạn đã lưu trữ thông tin xác thực mã ứng dụng khách OAuth và đặt tên tệp là client_secrets.json. Mẫu mã sử dụng tệp JSON này để xác thực bằng Google Workspace và lấy thông tin xác thực của người dùng. Để biết hướng dẫn, hãy xem phần Tạo thông tin xác thực mã ứng dụng khách OAuth.

  3. Để xoá gói thuê bao, hãy chạy lệnh sau trong dòng lệnh:

    python3 delete_subscription.py
API Sự kiện Google Workspace trả về một thao tác chạy trong thời gian dài chứa thực thể của tài nguyên Subscription.