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 lượt đăng ký, ứ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, Google Workspace Events API sẽ tự động xoá gói đó.

Đ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 do Apps Script tự động tạo.
    • Đối với tất cả các 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ụ: nếu bạn chỉ định phạm vi chat.messages, hãy thêm nội dung sau:
    • "oauthScopes": [
        "https://www.googleapis.com/auth/chat.messages"
      ]
          
    • 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 mới nhất của Google cho Python. Để cài đặt hoặc cập nhật các công cụ 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:

    • Đối với hoạt động xác thực người dùng, cần có 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 một phạm vi, hãy xem phần Phạm vi theo loại sự kiện.
    • Đối với xác thực ứng dụng, yêu cầu 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ẫu mã sau đây sẽ xoá một tài nguyên Subscription bằng phương thức 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ế nội dung sau:

    • SUBSCRIPTION_ID: Mã nhận dạng 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 dùng subscription-123.
  2. Để xoá gói thuê bao, hãy chạy hàm deleteSubscription trong dự án Apps Script của bạn.

Python

  1. Trong thư mục làm việc, hãy tạo một tệp có tên là delete_subscription.py rồi thêm đoạn 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('credentials.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: Một phạm vi OAuth hỗ trợ ít nhất một loại sự kiện trong gói thuê bao. Ví dụ: nếu gói thuê bao của bạn nhận được các sự kiện là không gian Chat mới 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. Để 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 dùng subscription-123.
  2. Trong thư mục làm việc, hãy đảm bảo bạn đã lưu trữ thông tin đăng nhập mã ứng dụng OAuth và đặt tên cho tệp là credentials.json. Mã mẫu sử dụng tệp 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. Để biết hướng dẫn, hãy xem phần Tạo thông tin đăng nhập mã ứng dụng khách OAuth.

  3. Để xoá gói thuê bao, hãy chạy lệnh sau trong thiết bị đầu cuối:

    python3 delete_subscription.py
Google Workspace Events API trả về một thao tác diễn ra trong thời gian dài chứa phiên bản của tài nguyên Subscription.