Class: Google::Apis::AppsmarketV2::AppsmarketService

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

Overview

G Suite Marketplace API

Lets your G Suite Marketplace applications integrate with Google's licensing service

Examples:

require 'google/apis/appsmarket_v2'

Appsmarket = Google::Apis::AppsmarketV2 # Alias the module
service = Appsmarket::AppsmarketService.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

#initialize ⇒ AppsmarketService

Returns a new instance of AppsmarketService.



50
51
52
53
 
# File 'generated/google/apis/appsmarket_v2/service.rb', line 50

def initialize
  super('https://www.googleapis.com/', 'appsmarket/v2/')
  @batch_path = 'batch/appsmarket/v2'
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 'generated/google/apis/appsmarket_v2/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



48
49
50
 
# File 'generated/google/apis/appsmarket_v2/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

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

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

    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:



79
80
81
82
83
84
85
86
87
88
89
 
# File 'generated/google/apis/appsmarket_v2/service.rb', line 79

def get_customer_license(application_id, customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_license(application_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppsmarketV2::UserLicense

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

    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:



157
158
159
160
161
162
163
164
165
166
167
 
# File 'generated/google/apis/appsmarket_v2/service.rb', line 157

def get_user_license(application_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AppsmarketV2::LicenseNotificationList

Parameters:

  • application_id (String) —

    Application Id

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return

  • start_token (String) (defaults to: nil) —

    Pagination token

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

    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:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'generated/google/apis/appsmarket_v2/service.rb', line 119

def list_license_notifications(application_id, max_results: nil, start_token: nil, timestamp: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end