5 分でよろしいですか？簡単なオンラインアンケートにご回答いただき、Google Workspace Marketplace のドキュメントの改善にご協力ください。

このページは Cloud Translation API によって翻訳されました。

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

このガイドでは、Google Workspace Marketplace API へのリクエストとレスポンスの例を示しながら、Google Workspace Marketplace アプリのインストールとライセンスの詳細を取得する方法について説明します。

アプリはまだインストールされていません

ライセンス通知.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 から個別にアプリケーションをインストールしました。

ライセンス通知.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 は、user1@domain1.com に有効なライセンスがあり、アプリケーションの使用を許可する必要があることを示しています。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"
}

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 の組織部門に対して管理者のみがインストールされるようになりました。組織内の全員に管理者がインストールされることはなくなりました。

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 リクエスト

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 リクエスト

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

上記のすべてのアクションからのライセンス通知

ライセンス通知.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}"
}