google_api_licensing v0.3.0 GoogleApi.Licensing.V1.Api.LicenseAssignments View Source

API calls for all endpoints tagged LicenseAssignments.

Link to this section Summary

Link to this section Functions

Link to this function

licensing_license_assignments_delete(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ []) View Source

Revoke License.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • sku_id (String.t): Name for sku
  • user_id (String.t): email id or unique Id of the user
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

licensing_license_assignments_get(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • sku_id (String.t): Name for sku
  • user_id (String.t): email id or unique Id of the user
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignment{}} on success {:error, info} on failure

Link to this function

licensing_license_assignments_insert(connection, product_id, sku_id, optional_params \\ [], opts \\ []) View Source

Assign License.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • sku_id (String.t): Name for sku
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (GoogleApi.Licensing.V1.Model.LicenseAssignmentInsert.t):

Returns

{:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignment{}} on success {:error, info} on failure

Link to this function

licensing_license_assignments_list_for_product(connection, product_id, customer_id, optional_params \\ [], opts \\ []) View Source

List license assignments for given product of the customer.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • customer_id (String.t): CustomerId represents the customer for whom licenseassignments are queried
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
    • :pageToken (String.t): Token to fetch the next page.Optional. By default server will return first page

Returns

{:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignmentList{}} on success {:error, info} on failure

Link to this function

licensing_license_assignments_list_for_product_and_sku(connection, product_id, sku_id, customer_id, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • sku_id (String.t): Name for sku
  • customer_id (String.t): CustomerId represents the customer for whom licenseassignments are queried
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
    • :pageToken (String.t): Token to fetch the next page.Optional. By default server will return first page

Returns

{:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignmentList{}} on success {:error, info} on failure

Link to this function

licensing_license_assignments_patch(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ []) View Source

Assign License. This method supports patch semantics.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • sku_id (String.t): Name for sku for which license would be revoked
  • user_id (String.t): email id or unique Id of the user
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (GoogleApi.Licensing.V1.Model.LicenseAssignment.t):

Returns

{:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignment{}} on success {:error, info} on failure

Link to this function

licensing_license_assignments_update(connection, product_id, sku_id, user_id, optional_params \\ [], opts \\ []) View Source

Assign License.

Parameters

  • connection (GoogleApi.Licensing.V1.Connection): Connection to server
  • product_id (String.t): Name for product
  • sku_id (String.t): Name for sku for which license would be revoked
  • user_id (String.t): email id or unique Id of the user
  • optional_params (keyword()): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (GoogleApi.Licensing.V1.Model.LicenseAssignment.t):

Returns

{:ok, %GoogleApi.Licensing.V1.Model.LicenseAssignment{}} on success {:error, info} on failure