アプリのインストールとライセンスの詳細を確認

このガイドでは、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 がアプリケーションをインストールしたため、レスポンスには 1 つのライセンス通知が含まれます。ライセンス通知には、ユーザーがアプリケーションをインストールしたときに 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}"
}