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

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

アプリのインストールとライセンスの詳細を取得する

このガイドでは、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 は、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 の 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 リクエスト

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

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

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