class Google::Apis::LicensingV1::LicensingService

Enterprise License Manager API

The Google Enterprise License Manager API's allows you to license apps for all

the users of a domain managed by you.

@example

require 'google/apis/licensing_v1'

Licensing = Google::Apis::LicensingV1 # Alias the module
service = Licensing::LicensingService.new

@see developers.google.com/admin-sdk/licensing/

Attributes

key[RW]

@return [String]

API key. Your API key identifies your project and provides you with API access,
quota, and reports. Required unless you provide an OAuth 2.0 token.
quota_user[RW]

@return [String]

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/licensing_v1/service.rb, line 46
def initialize
  super('https://licensing.googleapis.com/', '',
        client_name: 'google-apis-licensing_v1',
        client_version: Google::Apis::LicensingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Revoke a license. @param [String] product_id

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

@param [String] sku_id

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

@param [String] user_id

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 83
def delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
  command.response_representation = Google::Apis::LicensingV1::Empty::Representation
  command.response_class = Google::Apis::LicensingV1::Empty
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Get a specific user's license by product SKU. @param [String] product_id

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

@param [String] sku_id

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

@param [String] user_id

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::LicenseAssignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 125
def get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
insert_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Assign a license. @param [String] product_id

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

@param [String] sku_id

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

@param [Google::Apis::LicensingV1::LicenseAssignmentInsert] license_assignment_insert_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::LicenseAssignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 162
def insert_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user', options)
  command.request_representation = Google::Apis::LicensingV1::LicenseAssignmentInsert::Representation
  command.request_object = license_assignment_insert_object
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

List all users assigned licenses for a specific product SKU. @param [String] product_id

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

@param [String] customer_id

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.

@param [Fixnum] max_results

The `maxResults` query string determines how many entries are returned on each
page of a large response. This is an optional parameter. The value must be a
positive number.

@param [String] page_token

Token to fetch the next page of data. The `maxResults` query string is related
to the `pageToken` since `maxResults` determines how many entries are returned
on each page. This is an optional query string. If not specified, the server
returns the first page.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::LicenseAssignmentList] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::LicenseAssignmentList]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 209
def list_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apps/licensing/v1/product/{productId}/users', options)
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList
  command.params['productId'] = product_id unless product_id.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

List all users assigned licenses for a specific product SKU. @param [String] product_id

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

@param [String] sku_id

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

@param [String] customer_id

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.

@param [Fixnum] max_results

The `maxResults` query string determines how many entries are returned on each
page of a large response. This is an optional parameter. The value must be a
positive number.

@param [String] page_token

Token to fetch the next page of data. The `maxResults` query string is related
to the `pageToken` since `maxResults` determines how many entries are returned
on each page. This is an optional query string. If not specified, the server
returns the first page.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::LicenseAssignmentList] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::LicenseAssignmentList]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 259
def list_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apps/licensing/v1/product/{productId}/sku/{skuId}/users', options)
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics. @param [String] product_id

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

@param [String] sku_id

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

@param [String] user_id

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.

@param [Google::Apis::LicensingV1::LicenseAssignment] license_assignment_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::LicenseAssignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 305
def patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
  command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.request_object = license_assignment_object
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Reassign a user's product SKU with a different SKU in the same product. @param [String] product_id

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

@param [String] sku_id

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

@param [String] user_id

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.

@param [Google::Apis::LicensingV1::LicenseAssignment] license_assignment_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::LicensingV1::LicenseAssignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::LicensingV1::LicenseAssignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/licensing_v1/service.rb, line 350
def update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}', options)
  command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.request_object = license_assignment_object
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/licensing_v1/service.rb, line 366
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end