このドキュメントでは、アカウント レベルの管理者と販売店管理者が Enterprise License Manager API を使用してユーザーのライセンス割り当てを管理する方法について説明します。アカウントのサービス SKU ライセンスを有効にしてユーザーを作成したら、Enterprise License Manager API を使用して、アカウントのユーザーにライセンスを割り当て、更新、取得、削除します。
このバージョンでは、アカウント管理者と販売パートナー管理者が Enterprise License Manager API を使用します。License Management 権限を持つ委任管理者も Enterprise License Manager API を使用できます。
注: Enterprise License Manager API は Google のお客様が使用します。Google サードパーティ製アプリ デベロッパーがライセンスを管理する方法については、Google Workspace Marketplace API をご覧ください。
Enterprise License Manager API は、ウェブサービスに対する Representational State Transfer（RESTful）設計アプローチに基づいています。
ライセンスの管理
ライセンスを割り当てる
この操作の前に、お客様または販売パートナーが Google プロダクトのライセンスを注文し、ユーザーを作成している必要があります。これらのサービス ライセンスのいずれかをこのユーザーに割り当てるには、次の POST HTTP リクエストを使用します。リクエストの承認で説明されているように、Authorization ヘッダーを含めます。プロダクト ID と SKU ID については、API で利用可能なプロダクトと SKU をご覧ください。
POST https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/user
注: ユーザーには、さまざまな Google サービスのライセンスを割り当てることができます。ただし、ユーザーに割り当てられる SKU ライセンスは、プロダクトごとに 1 つだけです。API を使用すると、ユーザーの SKU ライセンスをプロダクト内の別の SKU ライセンスに再割り当てできます。
この例では、メインのメールアドレスが alex@example.com のユーザーに Google-Drive-storage-20GB SKU を割り当てます。
POST https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-20GB/user
JSON リクエスト本文:
{ "userId" : "alex@example.com", }
成功すると、200 HTTP ステータス コードが返されます。発生する可能性のあるエラーコードについては、API のエラーコードをご覧ください。成功すると、ライセンス割り当てステータスが JSON データ形式でレスポンスを返します。
JSON レスポンス
{ "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-20GB/user/alex@example.com", "userId": "alex@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-20GB", "skuName": "Google Drive storage 20 GB", "productName": "Google Drive storage" }
詳細については、licenseAssignments のinsert メソッドのリファレンス ページをご覧ください。
ユーザーの商品 SKU を同じ商品内の別の SKU に再割り当てする
ユーザーのライセンスを同じプロダクト内の新しいライセンス SKU に再割り当てするには、次の PUT HTTP リクエストを使用します。この API はパッチ構文もサポートしています。リクエストの承認で説明されているように、Authorization ヘッダーを含めます。プロダクト ID と SKU ID については、API で利用可能なプロダクトと SKU をご覧ください。
PUT https://www.googleapis.com/apps/licensing/v1/product/productId/sku/the current skuId/user/user's email
この例では、現在の Google-Drive-storage-20GB SKU を Google-Drive-storage-50GB に更新します。現在のライセンス SKU はリクエストの URI にあり、新しいライセンス SKU はリクエストの本文にあります。
PUT https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-20GB/user/alex@example.com
JSON リクエスト本文には次のものが含まれます。
{ "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com", "userId": "alex@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-50GB", "skuName": "Google Drive storage 50 GB", "productName": "Google Drive storage" }
成功すると、200 HTTP ステータス コードが返されます。発生する可能性のあるエラーコードについては、API のエラーコードをご覧ください。成功すると、ライセンス割り当てステータスが JSON データ形式でレスポンスを返します。
JSON レスポンス
{ "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com", "userId": "alex@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-50GB", "skuName": "Google Drive storage 50 GB", "productName": "Google Drive storage" }
詳細については、licenseAssignments の update メソッドと patch メソッドのリファレンス ページをご覧ください。
特定のプロダクトのライセンスが割り当てられているすべてのユーザーを取得する
特定のサービスのすべてのユーザー ライセンスを取得するには、次の GET HTTP リクエストを使用します。リクエストの承認で説明されているように、Authorization ヘッダーを含めます。customerId クエリ文字列は、お客様のプライマリ ドメイン名です。maxResults クエリ文字列によって、API のレスポンスで返されるユーザー ライセンス エントリの数が決まります。
GET https://www.googleapis.com/apps/licensing/v1/product/productId/users?customerId=primary domain name&maxResults=max results per page
プロダクト ID と SKU ID については、API で利用可能なプロダクトと SKU をご覧ください。
この例では、example.com ドメイン内のすべてのユーザーに対して Google-Drive-storage プロダクトのライセンスが割り当てられている結果の最初のページを一覧表示します。
GET https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/users?customerId=example.com&maxResults=2
成功すると、200 HTTP ステータス コードが返されます。考えられるエラーコードについては、API のエラーコードをご覧ください。成功すると、レスポンスは JSON 形式のライセンスリストが返されます。
JSON レスポンス
{ "kind" : "licensing#licenseAssignmentList", "etag": "etag value", "nextPageToken" : "the next page token value", "items": [ { "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com", "userId": "alex@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-50GB", "skuName": "Google Drive storage 50 GB", "productName": "Google Drive storage" }, { "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/user/keshav@example.com", "userId": "keshav@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-200GB", "skuName": "Google Drive storage 200 GB", "productName": "Google Drive storage" }, ... }
詳細については、licenseAssignments の listForProduct メソッドのリファレンス ページをご覧ください。
特定のプロダクト SKU のライセンスが割り当てられているすべてのユーザーを取得する
特定のプロダクト SKU のライセンスを持つすべてのユーザーのリストを取得するには、次の GET HTTP リクエストを使用します。リクエストの承認で説明されているように、Authorization ヘッダーを含めます。customerId クエリ文字列は、お客様のプライマリ ドメイン名です。maxResults クエリ文字列によって、API のレスポンスで返されるユーザー エントリの数を決定します。
GET https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/users?customerId=primary domain name&maxResults=max results per response page
プロダクト ID と SKU ID については、API で利用可能なプロダクトと SKU をご覧ください。
この例では、Google-Drive-storage-200GB SKU のライセンスが割り当てられている example.com ドメイン内のすべてのユーザーの最初のページが返されます。レスポンスには、ページごとに 2 つのユーザー エントリがリストされます。
GET https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/users?customerId=example.com&maxResults=2
成功すると、200 HTTP ステータス コードが返されます。発生する可能性のあるエラーコードについては、API のエラーコードをご覧ください。成功すると、レスポンスは JSON 形式のライセンスリストが返されます。
JSON レスポンス
{ "kind" : "licensing#licenseAssignmentList", "etag": "etag value", "nextPageToken" : "next page token's value", "items": [ { "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/user/alex@example.com", "userId": "alex@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-200GB", "skuName": "Google Drive storage 200 GB", "productName": "Google Drive storage" }, { "kind": "licensing#licenseAssignment", "etags": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/user/mary@example.com", "userId": "mary@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-200GB", "skuName": "Google Drive storage 200 GB", "productName": "Google Drive storage" }, ... }
詳しくは、licenseAssignments の listForProductAndSku メソッド リファレンス ページをご覧ください。
プロダクトの SKU で特定のユーザーのライセンスを取得する
プロダクトの SKU で特定のユーザーのライセンスを取得するには、次の GET HTTP リクエストを使用します。リクエストの承認で説明されているように、Authorization ヘッダーを含めます。プロダクト ID と SKU ID については、API で利用可能なプロダクトと SKU をご覧ください。
GET https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/user/userId
この例では、userId が alex@example.com のユーザーの Google ドライブ ストレージ 50 GB プロダクトの SKU を取得します。
GET https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com
ユーザーがこのライセンスを持っている場合、レスポンスは成功し、200 の HTTP ステータス コードが返されます。考えられるエラーコードについては、API のエラーコードをご覧ください。成功すると、レスポンスでユーザーのライセンスが JSON 形式で返されます。
JSON レスポンス
{ "kind": "licensing#licenseAssignment", "etag": "etag value", "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com", "userId": "keshav@example.com", "productId": "Google-Drive-storage", "skuId": "Google-Drive-storage-50GB", "skuName": "Google Drive storage 50 GB", "productName": "Google Drive storage" }
詳細については、licenseAssignments のget メソッドのリファレンス ページをご覧ください。
ライセンスを削除する
ユーザーからライセンスを割り当て解除するには、次の DELETE HTTP リクエストを使用します。リクエストの承認で説明されているように、Authorization ヘッダーを含めます。プロダクト ID と SKU ID については、API で利用可能なプロダクトと SKU をご覧ください。
DELETE https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/user/userId
この例では、userId が alex@example.com のユーザーから Google-Drive-storage-50GB ライセンスが割り当て解除されています。
DELETE https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com
成功すると、200 HTTP ステータス コードが返されます。考えられるエラーコードについては、API のエラーコードをご覧ください。
詳細については、licenseAssignments のdelete メソッドのリファレンス ページをご覧ください。
エラーコード
リクエストが失敗した場合、レスポンスにはエラーの簡単な説明が含まれます。
| エラーコード | 説明 |
|---|---|
| 400 | 不正なリクエスト - ユーザーのメールアドレスが無効です。 |
| 400 | 不正なリクエスト - SKU/商品が存在しません。 |
| 401 | アクターに、この API を呼び出すための認証情報がありません。 |
| 404 | ユーザーにこのライセンスがない場合は、レスポンスに「not found」エラーコードが返されます。 |
| 412 | 前提条件が満たされていません。このエラーの詳細については、message フィールドを確認してください。例:
|
| 503 | License Manager サービスは使用できません。 |