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

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/licensing_v1/service.rb

Overview

Licensing API

Licensing API to view and manage licenses for your domain

Examples:

require 'google/apis/licensing_v1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeLicensingService

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

#keyString

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.


38
39
40
# File 'generated/google/apis/licensing_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    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_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    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.

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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


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}', options)
  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.

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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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}', 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?
  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.

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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', 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?
  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.

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)

    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.

  • 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', 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?
  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.

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)

    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.

  • 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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', 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?
  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.

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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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}', 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?
  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.

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)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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}', 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end