Class: Google::Apis::ChromemanagementV1::ChromeManagementService

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

Overview

Chrome Management API

The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser devices.

Examples:

require 'google/apis/chromemanagement_v1'

Chromemanagement = Google::Apis::ChromemanagementV1 # Alias the module
service = Chromemanagement::ChromeManagementService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChromeManagementService

Returns a new instance of ChromeManagementService.



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

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



40
41
42
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 40

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.



45
46
47
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#count_customer_app_chrome_app_requests(customer, order_by: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeAppRequestsResponse

Generate summary of app installation requests.

Parameters:

  • customer (String) —

    Required. Customer id or "my_customer" to use the customer associated to the account making the request.

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

    Field used to order results. Supported fields: * request_count * latest_request_time

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

    The ID of the organizational unit.

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

    Maximum number of results to return. Maximum and default are 50, anything above will be coerced to 50.

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

    Token to specify the page of the request to be returned.

  • 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



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 85

def count_customer_app_chrome_app_requests(customer, order_by: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/apps:countChromeAppRequests', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeAppRequestsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeAppRequestsResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#count_customer_report_chrome_versions(customer, filter: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeVersionsResponse

Generate report of installed Chrome versions.

Parameters:

  • customer (String) —

    Required. Customer id or "my_customer" to use the customer associated to the account making the request.

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

    Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date

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

    The ID of the organizational unit.

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

    Maximum number of results to return. Maximum and default are 100.

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

    Token to specify the page of the request to be returned.

  • 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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 232

def count_customer_report_chrome_versions(customer, filter: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countChromeVersions', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeVersionsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeVersionsResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#count_customer_report_installed_apps(customer, filter: nil, order_by: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountInstalledAppsResponse

Generate report of app installations.

Parameters:

  • customer (String) —

    Required. Customer id or "my_customer" to use the customer associated to the account making the request.

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

    Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name

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

    Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count

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

    The ID of the organizational unit.

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

    Maximum number of results to return. Maximum and default are 100.

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

    Token to specify the page of the request to be returned.

  • 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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 281

def count_customer_report_installed_apps(customer, filter: nil, order_by: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countInstalledApps', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountInstalledAppsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountInstalledAppsResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#find_customer_report_installed_app_devices(customer, app_id: nil, app_type: nil, filter: nil, order_by: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FindInstalledAppDevicesResponse

Generate report of devices that have a specified app installed.

Parameters:

  • customer (String) —

    Required. Customer id or "my_customer" to use the customer associated to the account making the request.

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

    Unique identifier of the app. For Chrome apps and extensions, the 32-character id (e.g. ehoadneljpdggcbbknedodolkkjodefl). For Android apps, the package name (e.g. com.evernote).

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

    Type of the app.

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

    Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date

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

    Field used to order results. Supported order by fields: * machine * device_id

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

    The ID of the organizational unit.

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

    Maximum number of results to return. Maximum and default are 100.

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

    Token to specify the page of the request to be returned.

  • 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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 335

def find_customer_report_installed_app_devices(customer, app_id: nil, app_type: nil, filter: nil, order_by: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:findInstalledAppDevices', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FindInstalledAppDevicesResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FindInstalledAppDevicesResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['appId'] = app_id unless app_id.nil?
  command.query['appType'] = app_type unless app_type.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.nil?
  command.query['pageSize'] = page_size unless page_size.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?
  execute_or_queue_command(command, &block)
end

#get_customer_app_android(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails

Get a specific app for a customer by its resource name.

Parameters:

  • name (String) —

    Required. The app for which details are being queried. Examples: "customers/ my_customer/apps/chrome/gmbmikajjgmnabiglmofipeabaddhgne@2.1.2" for the Save to Google Drive Chrome extension version 2.1.2, "customers/my_customer/apps/ android/com.google.android.apps.docs" for the Google Drive Android app's latest version.

  • 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



123
124
125
126
127
128
129
130
131
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 123

def get_customer_app_android(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails
  command.params['name'] = name unless name.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_customer_app_chrome(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails

Get a specific app for a customer by its resource name.

Parameters:

  • name (String) —

    Required. The app for which details are being queried. Examples: "customers/ my_customer/apps/chrome/gmbmikajjgmnabiglmofipeabaddhgne@2.1.2" for the Save to Google Drive Chrome extension version 2.1.2, "customers/my_customer/apps/ android/com.google.android.apps.docs" for the Google Drive Android app's latest version.

  • 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



157
158
159
160
161
162
163
164
165
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 157

def get_customer_app_chrome(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails
  command.params['name'] = name unless name.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_customer_app_web(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails

Get a specific app for a customer by its resource name.

Parameters:

  • name (String) —

    Required. The app for which details are being queried. Examples: "customers/ my_customer/apps/chrome/gmbmikajjgmnabiglmofipeabaddhgne@2.1.2" for the Save to Google Drive Chrome extension version 2.1.2, "customers/my_customer/apps/ android/com.google.android.apps.docs" for the Google Drive Android app's latest version.

  • 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



191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 191

def get_customer_app_web(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1AppDetails
  command.params['name'] = name unless name.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_customer_telemetry_devices(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryDevicesResponse

List all telemetry devices.

Parameters:

  • parent (String) —

    Required. Customer id or "my_customer" to use the customer associated to the account making the request.

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

    Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number - device_id

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

    Maximum number of results to return. Default value is 100. Maximum value is 200.

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

    Token to specify next page in the list.

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

    Required. Read mask to specify which fields to return.

  • 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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 383

def list_customer_telemetry_devices(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/telemetry/devices', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryDevicesResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryDevicesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end