Acessar detalhes de instalação do app e licenciamento

Com exemplos de solicitações e respostas da API Google Workspace Marketplace, este guia mostra como ter os 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 notificações de licenciamento.

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

O aplicativo é instalado individualmente

Um usuário, [e-mail], instalou o app individualmente pelo 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 do 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 [e-mail] instalou o app, a resposta vai incluir uma notificação de licença. A notificação de licença inclui uma notificação de provisionamento, já que uma nova licença foi provisionada para [e-mail] quando o aplicativo foi instalado.

{
  "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}"
}

O aplicativo é instalado pelo administrador

O administrador de dominio1.com instalou o app para todos na organização.

Solicitação userLicense.get

Essa solicitação chama o método userLicense.get para receber o status de licenciamento de [e-mail] e determinar se ele tem permissão para usar o app.

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

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

Corpo da resposta

Como o domain1.com instalou o aplicativo pelo administrador, a resposta retorna a licença de usuário para [e-mail], em que enabled é true, indicando que o administrador de domínio1.com ativou o aplicativo para o domínio, e state é ACTIVE, indicando que [e-mail] tem uma licença válida e pode usar o app.

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

Solicitação customerLicense.get

Essa solicitação chama o método customerLicense.get para ver 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 de 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 app é instalado apenas pelo administrador para uma unidade organizacional (UO) de um usuário específico.

Agora o aplicativo é instalado apenas pelo administrador para a UO de [e-mail]. Ele não é mais instalado pelo administrador para todos na organização.

Solicitação userLicense.get

Essa solicitação chama o método userLicense.get para receber o status de licenciamento de [e-mail] 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}/[e-mail]

Corpo da resposta

Como o aplicativo só é instalado pelo administrador para [e-mail], a resposta retorna uma licença de usuário para [e-mail], em que enabled é false, indicando que o administrador de domínio1.com não ativou o app para esse domínio e state é ACTIVE, indicando que o usuário tem uma licença válida e pode usar o app.

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

Solicitação userLicense.get

Essa solicitação chama o método userLicense.get para receber o status de licenciamento de [e-mail] e determinar se ele tem permissão para usar o app.

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

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

Corpo da resposta

Como o aplicativo é instalado apenas pelo administrador para [e-mail], a resposta retorna uma licença de usuário para [e-mail], 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": "[e-mail]"
}

O app será excluído para todos na organização

O app foi excluído para todos na organização. O usuário, [e-mail], ainda tem acesso ao app porque ele já foi instalado individualmente.

Solicitação userLicense.get

Essa solicitação chama o método userLicense.get para receber o status de licenciamento de [e-mail] e determinar se ele tem permissão para usar o app.

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

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

Corpo da resposta

Como o app foi excluído para todos na organização, a resposta retorna uma licença de usuário para [e-mail], em que enabled é false e state é UNLICENSED. Isso indica que o administrador do domínio desse usuário não atribuiu uma licença do app a ele.

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

Solicitação userLicense.get

Essa solicitação chama o método userLicense.get para receber o status de licenciamento de [e-mail] e determinar se ele tem permissão para usar o app.

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

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

Corpo da resposta

Como [e-mail] 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": "[e-mail]",
  "applicationId": "{APPLICATION_ID}",
  "id": "{USER_LICENSE_ID}",
  "userId": "[e-mail]"
}

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 aplicativo.

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": "[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}"
}