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

Trang này giải thích cách xoá một gói thuê bao của Google Workspace bằng 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 bất kỳ 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 của bạn thay vì dự án mặc định được tạo tự động bằng Apps Script.
    • Đối với bất kỳ phạm vi nào mà bạn đã thêm để định cấu hình màn hình xin phép bằng OAuth, bạn cũng phải thêm vào tệp appsscript.json trong dự án Apps Script của bạn. 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
  • Các thư viện ứng dụng mới nhất của Google dành cho Python. Để cài đặt hoặc cập nhật chúng, 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
      
  • Một gói thuê bao của Google Workspace. Để tạo một tài khoản, 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, bạn phải có có 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 bài viết Phạm vi theo loại sự kiện.
    • Để xác thực ứng dụng, bạn phải có phạm vi chat.bot (chỉ dành cho các ứng dụng Google Chat).

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

Mã mẫu sau đây sẽ xoá một Tài nguyên Subscription sử dụng 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 có tên là deleteSubscription rồi 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ế đoạn mã sau:

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

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

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