1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Licensing
  7. \
  8. Resource
  9. \
  10. LicenseAssignments

LicenseAssignments

class LicenseAssignments extends Resource (View source)

The "licenseAssignments" collection of methods.

Typical usage is:

 $licensingService = new Google\Service\Licensing(...);
 $licenseAssignments = $licensingService->licenseAssignments;

Methods

LicensingEmpty
delete(string $productId, string $skuId, string $userId, array $optParams = [])

Revoke a license. (licenseAssignments.delete)

LicenseAssignment
get(string $productId, string $skuId, string $userId, array $optParams = [])

Get a specific user's license by product SKU. (licenseAssignments.get)

LicenseAssignment
insert(string $productId, string $skuId, LicenseAssignmentInsert $postBody, array $optParams = [])

Assign a license. (licenseAssignments.insert)

LicenseAssignmentList
listForProduct(string $productId, string $customerId, array $optParams = [])

List all users assigned licenses for a specific product SKU.

LicenseAssignmentList
listForProductAndSku(string $productId, string $skuId, string $customerId, array $optParams = [])

List all users assigned licenses for a specific product SKU.

LicenseAssignment
patch(string $productId, string $skuId, string $userId, LicenseAssignment $postBody, array $optParams = [])

Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics. (licenseAssignments.patch)

LicenseAssignment
update(string $productId, string $skuId, string $userId, LicenseAssignment $postBody, array $optParams = [])

Reassign a user's product SKU with a different SKU in the same product.

Details

at line 51
LicensingEmpty delete(string $productId, string $skuId, string $userId, array $optParams = [])

Revoke a license. (licenseAssignments.delete)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $skuId

A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
string $userId

The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
array $optParams

Optional parameters.

Return Value

LicensingEmpty

Exceptions

Exception

at line 73
LicenseAssignment get(string $productId, string $skuId, string $userId, array $optParams = [])

Get a specific user's license by product SKU. (licenseAssignments.get)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $skuId

A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
string $userId

The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
array $optParams

Optional parameters.

Return Value

LicenseAssignment

Exceptions

Exception

at line 91
LicenseAssignment insert(string $productId, string $skuId, LicenseAssignmentInsert $postBody, array $optParams = [])

Assign a license. (licenseAssignments.insert)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $skuId

A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
LicenseAssignmentInsert $postBody
array $optParams

Optional parameters.

Return Value

LicenseAssignment

Exceptions

Exception

at line 118
LicenseAssignmentList listForProduct(string $productId, string $customerId, array $optParams = [])

List all users assigned licenses for a specific product SKU.

(licenseAssignments.listForProduct)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $customerId

The customer's unique ID as defined in the Admin console, such as C00000000. If the customer is suspended, the server returns an error.
array $optParams

Optional parameters.

Return Value

LicenseAssignmentList

Exceptions

Exception

at line 147
LicenseAssignmentList listForProductAndSku(string $productId, string $skuId, string $customerId, array $optParams = [])

List all users assigned licenses for a specific product SKU.

(licenseAssignments.listForProductAndSku)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $skuId

A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
string $customerId

The customer's unique ID as defined in the Admin console, such as C00000000. If the customer is suspended, the server returns an error.
array $optParams

Optional parameters.

Return Value

LicenseAssignmentList

Exceptions

Exception

at line 171
LicenseAssignment patch(string $productId, string $skuId, string $userId, LicenseAssignment $postBody, array $optParams = [])

Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics. (licenseAssignments.patch)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $skuId

A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
string $userId

The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
LicenseAssignment $postBody
array $optParams

Optional parameters.

Return Value

LicenseAssignment

Exceptions

Exception

at line 195
LicenseAssignment update(string $productId, string $skuId, string $userId, LicenseAssignment $postBody, array $optParams = [])

Reassign a user's product SKU with a different SKU in the same product.

(licenseAssignments.update)

Parameters

string $productId

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
string $skuId

A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
string $userId

The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.
LicenseAssignment $postBody
array $optParams

Optional parameters.

Return Value

LicenseAssignment

Exceptions

Exception