Class: Google::Apis::LicensingV1::LicensingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/licensing_v1/service.rb

Overview

Enterprise License Manager API

The Google Enterprise License Manager API lets you manage Google Workspace and related licenses for all users of a customer that you manage.

Examples:

require 'google/apis/licensing_v1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://licensing.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ LicensingService

Returns a new instance of LicensingService.



48
49
50
51
52
53
 
# File 'lib/google/apis/licensing_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-licensing_v1',
        client_version: Google::Apis::LicensingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



41
42
43
 
# File 'lib/google/apis/licensing_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



46
47
48
 
# File 'lib/google/apis/licensing_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::Empty

Revoke a license.

Parameters:

  • product_id (String) —

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

  • sku_id (String) —

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

  • user_id (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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/google/apis/licensing_v1/service.rb', line 85

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) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

Get a specific user's license by product SKU.

Parameters:

  • product_id (String) —

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

  • sku_id (String) —

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

  • user_id (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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/apis/licensing_v1/service.rb', line 127

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) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

Assign a license.

Parameters:

  • product_id (String) —

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

  • sku_id (String) —

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

  • license_assignment_insert_object (Google::Apis::LicensingV1::LicenseAssignmentInsert) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/google/apis/licensing_v1/service.rb', line 164

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) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList

List all users assigned licenses for a specific product SKU.

Parameters:

  • product_id (String) —

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

  • customer_id (String) —

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

  • max_results (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/google/apis/licensing_v1/service.rb', line 210

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) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList

List all users assigned licenses for a specific product SKU.

Parameters:

  • product_id (String) —

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

  • sku_id (String) —

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

  • customer_id (String) —

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

  • max_results (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# 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) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

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

Parameters:

  • product_id (String) —

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

  • sku_id (String) —

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

  • user_id (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.

  • license_assignment_object (Google::Apis::LicensingV1::LicenseAssignment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# 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) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

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

Parameters:

  • product_id (String) —

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

  • sku_id (String) —

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

  • user_id (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.

  • license_assignment_object (Google::Apis::LicensingV1::LicenseAssignment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# 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