Lấy thông tin chi tiết về việc cài đặt ứng dụng và cấp phép

Bằng cách cung cấp các yêu cầu mẫu cho và phản hồi từ API Google Workspace Marketplace, hướng dẫn này sẽ trình bày cách lấy thông tin chi tiết về việc cài đặt và cấp phép ứng dụng trên Google Workspace Marketplace.

Ứng dụng chưa được cài đặt

Yêu cầu LicenseNotification.list

Yêu cầu này gọi phương thức licenseNotification.list để truy xuất danh sách thông báo cấp phép cho một ứng dụng cụ thể.

GET /appsmarket/v2/licenseNotification/{applicationId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/licenseNotification/{applicationId}

Nội dung phản hồi

Vì ứng dụng chưa được cài đặt, nên phản hồi cho yêu cầu này không bao gồm bất kỳ thông báo cấp phép nào.

{
  "kind": "appsmarket#licenseNotificationList",
  "nextPageToken": ""
}

Ứng dụng được cài đặt riêng

Một người dùng ([e-mail]) đã cài đặt riêng ứng dụng qua Google Workspace Marketplace.

Yêu cầu LicenseNotification.list

Yêu cầu này sẽ gọi phương thức licenseNotification.list và truy xuất danh sách các thông báo cấp phép cho ứng dụng mà người dùng đã cài đặt.

GET /appsmarket/v2/licenseNotification/{applicationId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/licenseNotification/{applicationId}

Nội dung phản hồi

Vì [e-mail] đã cài đặt ứng dụng này, nên phản hồi sẽ bao gồm một thông báo giấy phép. Thông báo giấy phép bao gồm thông báo cấp phép kể từ khi giấy phép mới được cấp phép cho [e-mail] khi họ cài đặt ứng dụng.

{
  "kind": "appsmarket#licenseNotificationList",
  "notifications": [
    {
      "kind": "appsmarket#licenseNotification",
      "id": "{LICENSE_NOTIFICATION_ID}",
      "applicationId": "{APPLICATION_ID}",
      "customerId": "[e-mail]",
      "timestamp": "1641318266998",
      "provisions": [
        {
          "kind": "appsmarket#provisionNotification",
          "editionId": "default_edition",
          "seatCount": "1"
        }
      ]
    }
  ],
  "nextPageToken": "{NEXT_PAGE_TOKEN}"
}

Ứng dụng này do quản trị viên cài đặt

Quản trị viên của domain1.com đã cài đặt ứng dụng này cho mọi người trong tổ chức.

yêu cầu userLicense.get

Yêu cầu này sẽ gọi phương thức userLicense.get để lấy trạng thái cấp phép của [e-mail] và xác định xem họ có quyền sử dụng ứng dụng hay không.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/[e-mail]

Nội dung phản hồi

Vì domain1.com đã cài đặt ứng dụng cho quản trị viên, nên phản hồi sẽ trả về giấy phép người dùng cho [e-mail], trong đó enabled là true, cho biết rằng quản trị viên miền của domain1.com đã kích hoạt ứng dụng cho miền này và state là ACTIVE, cho biết rằng [e-mail] có giấy phép hợp lệ và nên được phép sử dụng ứng dụng này.

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "[e-mail]",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "[e-mail]"
}

yêu cầu customerLicense.get

Yêu cầu này gọi phương thức customerLicense.get để lấy trạng thái cấp phép của domain1.com nhằm xác định xem họ có quyền truy cập vào ứng dụng hay không.

GET /appsmarket/v2/customerLicense/{applicationId}/{customerId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/customerLicense/{applicationId}/domain1.com

Nội dung phản hồi

Phản hồi này trả về giấy phép khách hàng cho miền1.com, trong đó state là ACTIVE, cho biết rằng khách hàng có giấy phép hợp lệ.

{
  "kind": "appsmarket#customerLicense",
  "id": "{CUSTOMER_LICENSE_ID}",
  "applicationId": "{APPLICATION_ID}",
  "customerId": "domain1.com",
  "state": "ACTIVE",
  "editions": [
    {
      "editionId": "default_edition",
      "seatCount": -1
    }
  ]
}

Ứng dụng này chỉ do quản trị viên cài đặt cho đơn vị tổ chức (OU) của người dùng cụ thể

Ứng dụng này hiện chỉ được quản trị viên cài đặt cho đơn vị tổ chức của [e-mail]. Ứng dụng này không còn được quản trị viên cài đặt cho mọi người trong tổ chức.

yêu cầu userLicense.get

Yêu cầu này sẽ gọi phương thức userLicense.get để lấy trạng thái cấp phép của [e-mail] và xác định xem họ có quyền sử dụng ứng dụng hay không.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/[e-mail]

Nội dung phản hồi

Vì ứng dụng chỉ được quản trị viên cài đặt cho [e-mail], nên phản hồi sẽ trả về giấy phép người dùng cho [e-mail], trong đó enabled là false, cho biết rằng quản trị viên miền của domain1.com chưa kích hoạt ứng dụng cho miền này và state là ACTIVE, cho biết rằng người dùng có giấy phép hợp lệ và nên được phép sử dụng ứng dụng này.

{
  "kind": "appsmarket#userLicense",
  "enabled": false,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "domain1.com",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "[e-mail]"
}

yêu cầu userLicense.get

Yêu cầu này sẽ gọi phương thức userLicense.get để lấy trạng thái cấp phép của [e-mail] và xác định xem họ có quyền sử dụng ứng dụng hay không.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/[e-mail]

Nội dung phản hồi

Vì ứng dụng chỉ được quản trị viên cài đặt cho [e-mail], nên phản hồi sẽ trả về giấy phép người dùng cho [e-mail], trong đó enabled là true và state là ACTIVE.

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "domain1.com",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "[e-mail]"
}

Ứng dụng sẽ bị xoá đối với mọi người trong tổ chức

Chúng tôi đã xoá ứng dụng này đối với mọi người trong tổ chức. Người dùng, [e-mail], vẫn có quyền truy cập vào ứng dụng vì trước đó họ đã cài đặt riêng ứng dụng.

yêu cầu userLicense.get

Yêu cầu này sẽ gọi phương thức userLicense.get để lấy trạng thái cấp phép của [e-mail] và xác định xem họ có quyền sử dụng ứng dụng hay không.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/[e-mail]

Nội dung phản hồi

Vì ứng dụng đã bị xoá đối với mọi người trong tổ chức, nên phản hồi sẽ trả về giấy phép người dùng cho [e-mail], trong đó enabled là false và state là UNLICENSED, cho biết rằng quản trị viên miền của người dùng này đã không chỉ định giấy phép của ứng dụng cho người dùng này.

{
  "kind": "appsmarket#userLicense",
  "enabled": false,
  "state": "UNLICENSED",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "[e-mail]"
}

yêu cầu userLicense.get

Yêu cầu này sẽ gọi phương thức userLicense.get để lấy trạng thái cấp phép của [e-mail] và xác định xem họ có quyền sử dụng ứng dụng hay không.

GET /appsmarket/v2/userLicense/{applicationId}/{userId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/[e-mail]

Nội dung phản hồi

Vì trước đây [e-mail] đã cài đặt riêng ứng dụng, nên họ vẫn có quyền sử dụng ứng dụng đó. Phản hồi này sẽ trả về một giấy phép người dùng, trong đó enabled là true và state là ACTIVE.

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "[e-mail]",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "[e-mail]"
}

Thông báo về giấy phép từ tất cả những hành động nêu trên

Yêu cầu LicenseNotification.list

Yêu cầu đối với phương thức licenseNotification.list sẽ truy xuất tất cả thông báo cấp phép cho ứng dụng.

GET /appsmarket/v2/licenseNotification/{applicationId}

curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/licenseNotification/{applicationId}

Nội dung phản hồi

Phản hồi này sẽ trả về danh sách thông báo về giấy phép cho tất cả thao tác đã thực hiện ở trên.

{
  "kind": "appsmarket#licenseNotificationList",
  "notifications": [
    {
      "kind": "appsmarket#licenseNotification",
      "id": "{LICENSE_NOTIFICATION_ID}",
      "applicationId": "{APPLICATION_ID}",
      "customerId": "[e-mail]",
      "timestamp": "1641318266998",
      "provisions": [
        {
          "kind": "appsmarket#provisionNotification",
          "editionId": "default_edition",
          "seatCount": "1"
        }
      ]
    },
    {
      "kind": "appsmarket#licenseNotification",
      "id": "{LICENSE_NOTIFICATION_ID}",
      "applicationId": "{APPLICATION_ID}",
      "customerId": "domain1.com",
      "timestamp": "1641318351038",
      "provisions": [
        {
          "kind": "appsmarket#provisionNotification",
          "editionId": "default_edition",
          "seatCount": "-1"
        }
      ]
    },
    {
      "kind": "appsmarket#licenseNotification",
      "id": "{LICENSE_NOTIFICATION_ID}",
      "applicationId": "{APPLICATION_ID}",
      "customerId": "domain1.com",
      "timestamp": "1641318858349",
      "deletes": [
        {
          "kind": "appsmarket#deleteNotification",
          "editionId": "default_edition",
        }
      ]
    },
  ],
  "nextPageToken": "{NEXT_PAGE_TOKEN}"
}