本指南提供來自 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": ""
}
個別安裝應用程式
使用者 1@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 機構單位安裝的管理員。如此一來,機構中的所有人就不會再安裝該 SDK。
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
,表示 1.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"
}
系統會為機構中的所有人刪除應用程式
系統已為機構中的所有人刪除應用程式。使用者 (<使用者 1>@<網域 1>.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}"
}