Class: Google::Apis::LicensingV1::LicensingService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::LicensingV1::LicensingService
- Defined in:
- generated/google/apis/licensing_v1/service.rb
Overview
Licensing API
Licensing API to view and manage licenses for your domain
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
An opaque string that represents a user for quota purposes.
-
#user_ip ⇒ String
Deprecated.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Revoke a license.
-
#get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Get a specific user's license by product SKU.
-
#initialize ⇒ LicensingService
constructor
A new instance of LicensingService.
-
#insert_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Assign a license.
-
#list_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList
List all users assigned licenses for a specific product SKU.
-
#list_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList
List all users assigned licenses for a specific product SKU.
-
#patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Reassign a user's product SKU with a different SKU in the same product.
-
#update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Reassign a user's product SKU with a different SKU in the same product.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ LicensingService
Returns a new instance of LicensingService.
49 50 51 52 |
# File 'generated/google/apis/licensing_v1/service.rb', line 49 def initialize super('https://www.googleapis.com/', 'apps/licensing/v1/product/') @batch_path = 'batch/licensing/v1' 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.
38 39 40 |
# File 'generated/google/apis/licensing_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/licensing_v1/service.rb', line 43 def quota_user @quota_user end |
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
47 48 49 |
# File 'generated/google/apis/licensing_v1/service.rb', line 47 def user_ip @user_ip end |
Instance Method Details
#delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Revoke a license.
87 88 89 90 91 92 93 94 95 96 |
# File 'generated/google/apis/licensing_v1/service.rb', line 87 def delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{productId}/sku/{skuId}/user/{userId}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Get a specific user's license by product SKU.
131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'generated/google/apis/licensing_v1/service.rb', line 131 def get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{productId}/sku/{skuId}/user/{userId}', ) 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? command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Assign a license.
171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'generated/google/apis/licensing_v1/service.rb', line 171 def insert_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{productId}/sku/{skuId}/user', ) 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? command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList
List all users assigned licenses for a specific product SKU.
221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'generated/google/apis/licensing_v1/service.rb', line 221 def list_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{productId}/users', ) 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? command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList
List all users assigned licenses for a specific product SKU.
274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'generated/google/apis/licensing_v1/service.rb', line 274 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, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{productId}/sku/{skuId}/users', ) 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? command.query['userIp'] = user_ip unless user_ip.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, user_ip: 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.
324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'generated/google/apis/licensing_v1/service.rb', line 324 def patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{productId}/sku/{skuId}/user/{userId}', ) 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? command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment
Reassign a user's product SKU with a different SKU in the same product.
373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'generated/google/apis/licensing_v1/service.rb', line 373 def update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{productId}/sku/{skuId}/user/{userId}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |