Com exemplos de solicitações e respostas da API Google Workspace Marketplace, este guia mostra como receber detalhes de instalação e licenciamento de apps do Google Workspace Marketplace.
O aplicativo ainda não foi instalado
Solicitação licenseNotification.list
Essa solicitação chama o método licenseNotification.list
para recuperar uma lista
de notificações de licenciamento de um aplicativo específico.
GET /appsmarket/v2/licenseNotification/{applicationId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/licenseNotification/{applicationId}
Corpo da resposta
Como o aplicativo ainda não foi instalado, a resposta a essa solicitação não inclui nenhuma notificação de licenciamento.
{
"kind": "appsmarket#licenseNotificationList",
"nextPageToken": ""
}
O aplicativo é instalado individualmente
Um usuário, usuario1@dominio1.com, instalou o aplicativo individualmente do Google Workspace Marketplace.
Solicitação licenseNotification.list
Essa solicitação chama o
método licenseNotification.list
e recupera a lista de notificações de licenciamento para o aplicativo que foi
instalado pelo usuário.
GET /appsmarket/v2/licenseNotification/{applicationId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/licenseNotification/{applicationId}
Corpo da resposta
Como user1@domain1.com instalou o aplicativo, a resposta inclui uma notificação de licença. A notificação de licença inclui uma notificação de provisionamento porque uma nova licença foi provisionada para user1@domain1.com quando ele instalou o aplicativo.
{
"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}"
}
O aplicativo é instalado pelo admin
O administrador de domain1.com instalou o aplicativo para todos na organização.
userLicense.get request
Essa solicitação chama o método userLicense.get
para conferir o status de licenciamento
de user1@domain1.com e determinar se ele tem permissão para usar o
aplicativo.
GET /appsmarket/v2/userLicense/{applicationId}/{userId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/user1@domain1.com
Corpo da resposta
Como o administrador instalou o aplicativo no domain1.com, a resposta retorna a
licença do usuário para user1@domain1.com, em que enabled
é true
, indicando
que o administrador do domínio para domain1.com ativou o aplicativo para
esse domínio, e state
é ACTIVE
, indicando que user1@domain1.com tem uma
licença válida e pode usar o aplicativo.
{
"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"
}
Solicitação customerLicense.get
Essa solicitação chama o método customerLicense.get
para conferir o status de licenciamento
de domain1.com e determinar se ele tem acesso ao aplicativo.
GET /appsmarket/v2/customerLicense/{applicationId}/{customerId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/customerLicense/{applicationId}/domain1.com
Corpo da resposta
A resposta retorna a
licença do cliente
para domain1.com, em que state
é ACTIVE
, indicando que o cliente tem uma
licença válida.
{
"kind": "appsmarket#customerLicense",
"id": "{CUSTOMER_LICENSE_ID}",
"applicationId": "{APPLICATION_ID}",
"customerId": "domain1.com",
"state": "ACTIVE",
"editions": [
{
"editionId": "default_edition",
"seatCount": -1
}
]
}
O aplicativo só é instalado pelo administrador para uma unidade organizacional (UO) específica do usuário
Agora, o aplicativo só está instalado como administrador para a unidade organizacional de user2@domain1.com. Ele não está mais instalado para todos na organização.
userLicense.get request
Essa solicitação chama o método userLicense.get
para ver o status de licenciamento de user3@domain1.com e determinar se ele tem permissão para usar o aplicativo.
GET /appsmarket/v2/userLicense/{applicationId}/{userId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/user3@domain1.com
Corpo da resposta
Como o aplicativo só está instalado como administrador para user2@domain1.com, a
resposta retorna uma licença de usuário para user3@domain1.com, em que enabled
é
false
, indicando que o administrador do domínio para domain1.com não ativou
o aplicativo para esse domínio, e state
é ACTIVE
, indicando
que o usuário tem uma licença válida e pode usar o aplicativo.
{
"kind": "appsmarket#userLicense",
"enabled": false,
"state": "ACTIVE",
"editionId": "default_edition",
"customerId": "domain1.com",
"applicationId": "{APPLICATION_ID}",
"id": "{USER_LICENSE_ID}",
"userId": "user3@domain1.com"
}
Solicitação userLicense.get
Essa solicitação chama o método userLicense.get
para conferir o status de licenciamento
de user2@domain1.com e determinar se ele tem permissão para usar o
aplicativo.
GET /appsmarket/v2/userLicense/{applicationId}/{userId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/user2@domain1.com
Corpo da resposta
Como o aplicativo é instalado apenas pelo administrador para usuario2@dominio1.com, a resposta retorna uma licença de usuário para usuario2@dominio1.com, em que enabled
é true
e 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"
}
O aplicativo será excluído para todos na organização
O aplicativo foi excluído para todos na organização. O usuário, user1@domain1.com, ainda tem acesso ao aplicativo porque ele foi instalado individualmente.
userLicense.get request
Essa solicitação chama o método userLicense.get
para conferir o status de licenciamento
de user2@domain1.com e determinar se ele tem permissão para usar o
aplicativo.
GET /appsmarket/v2/userLicense/{applicationId}/{userId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/user2@domain1.com
Corpo da resposta
Como o aplicativo foi excluído para todos na organização, a resposta retorna uma licença de usuário para user2@domain1.com, em que enabled
é false
e state
é UNLICENSED
, indicando que o administrador do domínio desse usuário não atribuiu um assento para o aplicativo a esse usuário.
{
"kind": "appsmarket#userLicense",
"enabled": false,
"state": "UNLICENSED",
"applicationId": "{APPLICATION_ID}",
"id": "{USER_LICENSE_ID}",
"userId": "user2@domain1.com"
}
userLicense.get request
Essa solicitação chama o método userLicense.get
para conferir o status de licenciamento
de user1@domain1.com e determinar se ele tem permissão para usar o
aplicativo.
GET /appsmarket/v2/userLicense/{applicationId}/{userId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/userLicense/{applicationId}/user1@domain1.com
Corpo da resposta
Como usuario1@dominio1.com instalou o app individualmente, ele
ainda tem permissão para usá-lo. A resposta retorna uma licença de usuário em que
enabled
é true
e 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"
}
As notificações de licença de todas as ações acima
Solicitação licenseNotification.list
Uma solicitação para o método licenseNotification.list
recupera todas as
notificações de licenciamento do app.
GET /appsmarket/v2/licenseNotification/{applicationId}
curl -H "Authorization: Bearer {TOKEN}" https://appsmarket.googleapis.com/appsmarket/v2/licenseNotification/{applicationId}
Corpo da resposta
A resposta retorna uma lista de notificações de licença para todas as ações realizadas acima.
{
"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}"
}