Enterprise License Manager API v1

Version: 5.3

Enterprise License Manager API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Licensing API to view and manage license for your domain. Google documentation.

1 API Parameters

2 Resources

2.1 licenseAssignments

(require gapi/macro)

(require-gapi-doc "licensing.v1.js")

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: 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.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: 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. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 licenseAssignments

procedure
(licensing-licenseAssignments-get #:productId productId
#:skuId skuId
#:userId userId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  skuId : string?
  userId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get license assignment of a particular product and sku for a user

productId: Name for product

skuId: Name for sku

userId: email id or unique Id of the user

procedure
(licensing-licenseAssignments-listForProduct
#:productId productId
#:customerId customerId
[ #:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  customerId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List license assignments for given product of the customer.

productId: Name for product

customerId: CustomerId represents the customer for whom licenseassignments are queried

maxResults: Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.

pageToken: Token to fetch the next page.Optional. By default server will return first page

procedure
(licensing-licenseAssignments-listForProductAndSku
#:productId productId
#:skuId skuId
#:customerId customerId
[ #:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  skuId : string?
  customerId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List license assignments for given product and sku of the customer.

productId: Name for product

skuId: Name for sku

customerId: CustomerId represents the customer for whom licenseassignments are queried

maxResults: Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.

pageToken: Token to fetch the next page.Optional. By default server will return first page

procedure
(licensing-licenseAssignments-insert
#:productId productId
#:skuId skuId
[ #:userId userId
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  skuId : string?
  userId : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Assign License.

productId: Name for product

skuId: Name for sku

userId: Email id of the user

procedure
(licensing-licenseAssignments-patch #:productId productId
#:skuId skuId
#:userId userId
[ #:etags etags
#:kind kind
#:selfLink selfLink
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  skuId : string?
  userId : string?
  etags : string? = 'N/A
  kind : string? = 'N/A
  selfLink : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Assign License. This method supports patch semantics.

productId: Name for product

skuId: Name for sku for which license would be revoked

userId: email id or unique Id of the user

etags: ETag of the resource.

kind: Identifies the resource as a LicenseAssignment.

selfLink: Link to this page.

procedure
(licensing-licenseAssignments-update
#:productId productId
#:skuId skuId
#:userId userId
[ #:etags etags
#:kind kind
#:selfLink selfLink
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  skuId : string?
  userId : string?
  etags : string? = 'N/A
  kind : string? = 'N/A
  selfLink : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Assign License.

productId: Name for product

skuId: Name for sku for which license would be revoked

userId: email id or unique Id of the user

etags: ETag of the resource.

kind: Identifies the resource as a LicenseAssignment.

selfLink: Link to this page.

procedure
(licensing-licenseAssignments-delete
#:productId productId
#:skuId skuId
#:userId userId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  productId : string?
  skuId : string?
  userId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Revoke License.

productId: Name for product

skuId: Name for sku

userId: email id or unique Id of the user