Documentation

Google_Service_Licensing_Resource_LicenseAssignments extends Google_Service_Resource
in package

Application

The "licenseAssignments" collection of methods.

Typical usage is: $licensingService = new Google_Service_Licensing(...); $licenseAssignments = $licensingService->licenseAssignments;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Revoke a license. (licenseAssignments.delete)
get() : Google_Service_Licensing_LicenseAssignment: Get a specific user's license by product SKU. (licenseAssignments.get)
insert() : Google_Service_Licensing_LicenseAssignment: Assign a license. (licenseAssignments.insert)
listForProduct() : Google_Service_Licensing_LicenseAssignmentList: List all users assigned licenses for a specific product SKU.
listForProductAndSku() : Google_Service_Licensing_LicenseAssignmentList: List all users assigned licenses for a specific product SKU.
patch() : Google_Service_Licensing_LicenseAssignment: Patch a Licensing info via Apiary Patch Orchestration (licenseAssignments.patch)
update() : Google_Service_Licensing_LicenseAssignment: Reassign a user's product SKU with a different SKU in the same product.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Revoke a license. (licenseAssignments.delete)


    public
                delete(string $productId, string $skuId, string $userId[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$skuId : string: A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
$userId : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

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


    public
                get(string $productId, string $skuId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Licensing_LicenseAssignment

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$skuId : string: A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
$userId : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Licensing_LicenseAssignment —

insert()

Assign a license. (licenseAssignments.insert)


    public
                insert(string $productId, string $skuId, Google_Service_Licensing_LicenseAssignmentInsert $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Licensing_LicenseAssignment

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$skuId : string: A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
$postBody : Google_Service_Licensing_LicenseAssignmentInsert
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Licensing_LicenseAssignment —

listForProduct()

List all users assigned licenses for a specific product SKU.


    public
                listForProduct(string $productId, string $customerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Licensing_LicenseAssignmentList

(licenseAssignments.listForProduct)

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$customerId : string: Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Licensing_LicenseAssignmentList —

listForProductAndSku()

List all users assigned licenses for a specific product SKU.


    public
                listForProductAndSku(string $productId, string $skuId, string $customerId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Licensing_LicenseAssignmentList

(licenseAssignments.listForProductAndSku)

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$skuId : string: A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
$customerId : string: Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Licensing_LicenseAssignmentList —

patch()

Patch a Licensing info via Apiary Patch Orchestration (licenseAssignments.patch)


    public
                patch(string $productId, string $skuId, string $userId, Google_Service_Licensing_LicenseAssignment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Licensing_LicenseAssignment

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$skuId : string: A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
$userId : string: 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.
$postBody : Google_Service_Licensing_LicenseAssignment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Licensing_LicenseAssignment —

update()

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


    public
                update(string $productId, string $skuId, string $userId, Google_Service_Licensing_LicenseAssignment $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Licensing_LicenseAssignment

(licenseAssignments.update)

Parameters

$productId : string: A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.
$skuId : string: A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.
$userId : string: 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.
$postBody : Google_Service_Licensing_LicenseAssignment
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Licensing_LicenseAssignment —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —