Class: Google::Apis::AppsmarketV2::GoogleWorkspaceMarketplaceAPIService

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

Overview

G Suite Marketplace API

Lets your Google Workspace Marketplace applications integrate with Google's licensing and billing services.

Examples:

require 'google/apis/appsmarket_v2'

Appsmarket = Google::Apis::AppsmarketV2 # Alias the module
service = Appsmarket::GoogleWorkspaceMarketplaceAPIService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GoogleWorkspaceMarketplaceAPIService

Returns a new instance of GoogleWorkspaceMarketplaceAPIService.



46
47
48
49
50
51
 
# File 'lib/google/apis/appsmarket_v2/service.rb', line 46

def initialize
  super('https://appsmarket.googleapis.com/', '',
        client_name: 'google-apis-appsmarket_v2',
        client_version: Google::Apis::AppsmarketV2::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.



39
40
41
 
# File 'lib/google/apis/appsmarket_v2/service.rb', line 39

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.



44
45
46
 
# File 'lib/google/apis/appsmarket_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#get_customer_license(application_id, customer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppsmarketV2::CustomerLicense

Get the status of a license for a customer to determine if they have access for a given app.

Parameters:

  • application_id (String) —

    Application Id

  • customer_id (String) —

    Customer Id

  • 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



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/appsmarket_v2/service.rb', line 76

def get_customer_license(application_id, customer_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'appsmarket/v2/customerLicense/{applicationId}/{customerId}', options)
  command.response_representation = Google::Apis::AppsmarketV2::CustomerLicense::Representation
  command.response_class = Google::Apis::AppsmarketV2::CustomerLicense
  command.params['applicationId'] = application_id unless application_id.nil?
  command.params['customerId'] = customer_id unless customer_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_user_license(application_id, user_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppsmarketV2::UserLicense

Get the user's licensing status for their permission to use a given app.

Parameters:

  • application_id (String) —

    Application Id

  • user_id (String) —

    User Id

  • 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



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/apis/appsmarket_v2/service.rb', line 146

def get_user_license(application_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'appsmarket/v2/userLicense/{applicationId}/{userId}', options)
  command.response_representation = Google::Apis::AppsmarketV2::UserLicense::Representation
  command.response_class = Google::Apis::AppsmarketV2::UserLicense
  command.params['applicationId'] = application_id unless application_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

#list_license_notifications(application_id, max_results: nil, start_token: nil, timestamp: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppsmarketV2::LicenseNotificationList

Get a list of licensing notifications with regards to a given app.

Parameters:

  • application_id (String) —

    Application Id

  • max_results (Fixnum) (defaults to: nil)
  • start_token (String) (defaults to: nil)
  • timestamp (Fixnum) (defaults to: nil) —

    Timestamp in milliseconds since epoch

  • 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



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/google/apis/appsmarket_v2/service.rb', line 111

def list_license_notifications(application_id, max_results: nil, start_token: nil, timestamp: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'appsmarket/v2/licenseNotification/{applicationId}', options)
  command.response_representation = Google::Apis::AppsmarketV2::LicenseNotificationList::Representation
  command.response_class = Google::Apis::AppsmarketV2::LicenseNotificationList
  command.params['applicationId'] = application_id unless application_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-token'] = start_token unless start_token.nil?
  command.query['timestamp'] = timestamp unless timestamp.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end