取得應用程式安裝與授權詳細資料

本指南提供 Google Workspace Marketplace API 的請求和回應範例，說明如何取得 Google Workspace Marketplace 應用程式安裝和授權詳細資料。

尚未安裝應用程式

licenseNotification.list 要求

這項要求會呼叫 licenseNotification.list 方法，擷取特定應用程式的授權通知清單。

GET /appsmarket/v2/licenseNotification/{applicationId}

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

回應主體

由於應用程式尚未安裝，因此對這項要求的回應不包含任何授權通知。

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

個別安裝應用程式

使用者 user1@domain1.com 從 Google Workspace Marketplace 個別安裝應用程式。

LicenseNotification.list 要求

這項要求會呼叫 licenseNotification.list 方法，並擷取使用者已安裝的應用程式的授權通知清單。

GET /appsmarket/v2/licenseNotification/{applicationId}

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

回應主體

由於 user1@domain1.com 安裝了應用程式，回應中會包含一個授權通知。由於在 user1@domain1.com 安裝應用程式時，為其配置了新授權，因此授權通知包含配置通知。

{
  "kind": "appsmarket#licenseNotificationList",
  "notifications": [
    {
      "kind": "appsmarket#licenseNotification",
      "id": "{LICENSE_NOTIFICATION_ID}",
      "applicationId": "{APPLICATION_ID}",
      "customerId": "user1@domain1.com",
      "timestamp": "1641318266998",
      "provisions": [
        {
          "kind": "appsmarket#provisionNotification",
          "editionId": "default_edition",
          "seatCount": "1"
        }
      ]
    }
  ],
  "nextPageToken": "{NEXT_PAGE_TOKEN}"
}

應用程式是由管理員安裝

domain1.com 的管理員為機構中的所有使用者安裝了應用程式。

userLicense.get 要求

這項要求會呼叫 userLicense.get 方法，取得 user1@domain1.com 的授權狀態，並判斷使用者是否有權使用應用程式。

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

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

回應主體

由於 domain1.com 的管理員已安裝應用程式，因此回應會傳回 user1@domain1.com 的使用者授權，其中 enabled 為 true，表示 domain1.com 的網域管理員已為這個網域啟用應用程式，而 state 為 ACTIVE，表示 user1@domain1.com 擁有有效授權，應允許使用應用程式。

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "user1@domain1.com",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "user1@domain1.com"
}

customerLicense.get 要求

這項要求會呼叫 customerLicense.get 方法，取得 domain1.com 的授權狀態，判斷是否有權存取應用程式。

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

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

回應主體

回應會傳回 domain1.com 的客戶授權，其中 state 為 ACTIVE，表示客戶擁有有效的授權。

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

管理員只為特定使用者的機構單位 (OU) 安裝應用程式

應用程式現在只會由管理員為 user2@domain1.com 的 OU 安裝。管理員不再為機構中的所有使用者安裝這個應用程式。

userLicense.get 要求

這項要求會呼叫 userLicense.get 方法，取得 user3@domain1.com 的授權狀態，並判斷使用者是否有權使用應用程式。

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

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

回應主體

由於應用程式僅由管理員安裝給 user2@domain1.com，因此回應會針對 user3@domain1.com 傳回使用者授權，其中 enabled 為 false，表示 domain1.com 的網域管理員未為這個網域啟用應用程式，而 state 為 ACTIVE，表示使用者擁有有效授權，應允許使用應用程式。

{
  "kind": "appsmarket#userLicense",
  "enabled": false,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "domain1.com",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "user3@domain1.com"
}

userLicense.get 要求

這項要求會呼叫 userLicense.get 方法，取得 user2@domain1.com 的授權狀態，並確認是否有權使用應用程式。

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

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

回應主體

由於應用程式僅為 user2@domain1.com 安裝，因此回應會傳回 user2@domain1.com 的使用者授權，其中 enabled 是 true，state 為 ACTIVE。

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "domain1.com",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "user2@domain1.com"
}

系統會為機構中的所有使用者刪除應用程式

已為機構中的所有人刪除此應用程式。使用者 user1@domain1.com 先前已個別安裝應用程式，因此仍可存取該應用程式。

userLicense.get 要求

這項要求會呼叫 userLicense.get 方法，取得 user2@domain1.com 的授權狀態，並判斷使用者是否有權使用應用程式。

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

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

回應主體

由於系統已刪除機構中所有人的應用程式，因此回應會傳回 user2@domain1.com 的使用者授權，其中 enabled 為 false，state 為 UNLICENSED，表示此使用者網域的管理員未將應用程式指派給這位使用者。

{
  "kind": "appsmarket#userLicense",
  "enabled": false,
  "state": "UNLICENSED",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "user2@domain1.com"
}

userLicense.get 要求

這項要求會呼叫 userLicense.get 方法，取得 user1@domain1.com 的授權狀態，並判斷使用者是否有權使用應用程式。

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

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

回應主體

由於 user1@domain1.com 先前已個別安裝應用程式，因此仍有權使用該應用程式。回應會傳回使用者授權，其中 enabled 為 true，state 為 ACTIVE。

{
  "kind": "appsmarket#userLicense",
  "enabled": true,
  "state": "ACTIVE",
  "editionId": "default_edition",
  "customerId": "user1@domain1.com",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "user1@domain1.com"
}

上述所有動作的授權通知

licenseNotification.list 要求

對 licenseNotification.list 方法提出的要求會擷取應用程式的所有授權通知。

GET /appsmarket/v2/licenseNotification/{applicationId}

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

回應主體

回應會傳回上述所有動作的授權通知清單。

{
  "kind": "appsmarket#licenseNotificationList",
  "notifications": [
    {
      "kind": "appsmarket#licenseNotification",
      "id": "{LICENSE_NOTIFICATION_ID}",
      "applicationId": "{APPLICATION_ID}",
      "customerId": "user1@domain1.com",
      "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}"
}