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:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://chromemanagement.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeChromeManagementService

Returns a new instance of ChromeManagementService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-chromemanagement_v1',
        client_version: Google::Apis::ChromemanagementV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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.



42
43
44
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 42

def key
  @key
end

#quota_userString

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.



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

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



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

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_browsers_needing_attention(customer, org_unit_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeBrowsersNeedingAttentionResponse

Count of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity.

Parameters:

  • customer (String)

    Required. The customer ID or "my_customer" prefixed with "customers/".

  • org_unit_id (String) (defaults to: nil)

    Optional. The ID of the organizational unit. If omitted, all data will 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



319
320
321
322
323
324
325
326
327
328
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 319

def count_customer_report_chrome_browsers_needing_attention(customer, org_unit_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countChromeBrowsersNeedingAttention', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeBrowsersNeedingAttentionResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeBrowsersNeedingAttentionResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_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

#count_customer_report_chrome_crash_events(customer, filter: nil, order_by: nil, org_unit_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeCrashEventsResponse

Get a count of Chrome crash events.

Parameters:

  • customer (String)

    Customer ID.

  • filter (String) (defaults to: nil)

    Query string to filter results, AND-separated fields in EBNF syntax. Supported filter fields: * major_browser_version * minor_browser_version * browser_channel * device_platform * past_number_days Example: major_browser_version = 'M115' AND past_number_days = '28'.

  • order_by (String) (defaults to: nil)

    Field used to order results. Supported order by fields: * browser_version * count * date

  • org_unit_id (String) (defaults to: nil)

    If specified, only count the number of crash events of the devices in this organizational unit.

  • 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



361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 361

def count_customer_report_chrome_crash_events(customer, filter: nil, order_by: nil, org_unit_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countChromeCrashEvents', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeCrashEventsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeCrashEventsResponse
  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['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_devices_reaching_auto_expiration_date(customer, max_aue_date: nil, min_aue_date: nil, org_unit_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse

Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found here.

Parameters:

  • customer (String)

    Required. The customer ID or "my_customer" prefixed with "customers/".

  • max_aue_date (String) (defaults to: nil)

    Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or earlier than the maximum date.

  • min_aue_date (String) (defaults to: nil)

    Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or later than the minimum date.

  • org_unit_id (String) (defaults to: nil)

    Optional. The organizational unit ID, if omitted, will return data for all organizational units.

  • 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



408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 408

def count_customer_report_chrome_devices_reaching_auto_expiration_date(customer, max_aue_date: nil, min_aue_date: nil, org_unit_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countChromeDevicesReachingAutoExpirationDate', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['maxAueDate'] = max_aue_date unless max_aue_date.nil?
  command.query['minAueDate'] = min_aue_date unless min_aue_date.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_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

#count_customer_report_chrome_devices_that_need_attention(customer, org_unit_id: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse

Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/ 10564947

Parameters:

  • customer (String)

    Required. The customer ID or "my_customer" prefixed with "customers/".

  • org_unit_id (String) (defaults to: nil)

    Optional. The ID of the organizational unit. If omitted, all data will be returned.

  • read_mask (String) (defaults to: nil)

    Required. Mask of the fields that should be populated in the returned report.

  • 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



449
450
451
452
453
454
455
456
457
458
459
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 449

def count_customer_report_chrome_devices_that_need_attention(customer, org_unit_id: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countChromeDevicesThatNeedAttention', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.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

#count_customer_report_chrome_hardware_fleet_devices(customer, org_unit_id: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse

Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947

Parameters:

  • customer (String)

    Required. The customer ID or "my_customer".

  • org_unit_id (String) (defaults to: nil)

    Optional. The ID of the organizational unit. If omitted, all data will be returned.

  • read_mask (String) (defaults to: nil)

    Required. Mask of the fields that should be populated in the returned report.

  • 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



488
489
490
491
492
493
494
495
496
497
498
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 488

def count_customer_report_chrome_hardware_fleet_devices(customer, org_unit_id: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countChromeHardwareFleetDevices', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountChromeHardwareFleetDevicesResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['orgUnitId'] = org_unit_id unless org_unit_id.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

#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



531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 531

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 * app_id * manifest_versions

  • 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 * app_id * manifest_versions

  • 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



582
583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 582

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

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

Get a summary of printing done by each printer.

Parameters:

  • customer (String)

    Required. Customer ID prefixed with "customers/" or "customers/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. Note: Only >= and <= comparators are supported in this filter. Supported filter fields: * complete_time

  • order_by (String) (defaults to: nil)

    Field used to order results. If omitted, results will be ordered in ascending order of the 'printer' field. Supported order_by fields: * printer * job_count

    • device_count * user_count
  • 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 response to be returned.

  • printer_org_unit_id (String) (defaults to: nil)

    The ID of the organizational unit for printers. If specified, only data for printers from the specified organizational unit will be returned. If omitted, data for printers from all organizational units will 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



634
635
636
637
638
639
640
641
642
643
644
645
646
647
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 634

def count_customer_report_print_jobs_by_printer(customer, filter: nil, order_by: nil, page_size: nil, page_token: nil, printer_org_unit_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countPrintJobsByPrinter', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountPrintJobsByPrinterResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountPrintJobsByPrinterResponse
  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['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['printerOrgUnitId'] = printer_org_unit_id unless printer_org_unit_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

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

Get a summary of printing done by each user.

Parameters:

  • customer (String)

    Required. Customer ID prefixed with "customers/" or "customers/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. Note: Only >= and <= comparators are supported in this filter. Supported filter fields: * complete_time

  • order_by (String) (defaults to: nil)

    Field used to order results. If omitted, results will be ordered in ascending order of the 'user_email' field. Supported order_by fields: * user_email * job_count * printer_count * device_count

  • 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 response to be returned.

  • printer_org_unit_id (String) (defaults to: nil)

    The ID of the organizational unit for printers. If specified, only print jobs initiated with printers from the specified organizational unit will be counted. If omitted, all print jobs will be counted.

  • 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



686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 686

def count_customer_report_print_jobs_by_user(customer, filter: nil, order_by: nil, page_size: nil, page_token: nil, printer_org_unit_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:countPrintJobsByUser', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountPrintJobsByUserResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1CountPrintJobsByUserResponse
  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['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['printerOrgUnitId'] = printer_org_unit_id unless printer_org_unit_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

#create_customer_telemetry_notification_config(parent, google_chrome_management_v1_telemetry_notification_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1TelemetryNotificationConfig

Create a telemetry notification config.

Parameters:

  • parent (String)

    Required. The parent resource where this notification config will be created. Format: customers/customer``

  • google_chrome_management_v1_telemetry_notification_config_object (Google::Apis::ChromemanagementV1::GoogleChromeManagementV1TelemetryNotificationConfig) (defaults to: nil)
  • 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



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 996

def create_customer_telemetry_notification_config(parent, google_chrome_management_v1_telemetry_notification_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/telemetry/notificationConfigs', options)
  command.request_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1TelemetryNotificationConfig::Representation
  command.request_object = google_chrome_management_v1_telemetry_notification_config_object
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1TelemetryNotificationConfig::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1TelemetryNotificationConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Delete a telemetry notification config.

Parameters:

  • name (String)

    Required. The name of the notification config to delete. Format: customers/ customer/telemetry/notificationConfigs/notification_config``

  • 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



1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 1029

def delete_customer_telemetry_notification_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleProtobufEmpty
  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

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

Get a list of print jobs.

Parameters:

  • customer (String)

    Required. Customer ID prefixed with "customers/" or "customers/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. Note: Only >= and <= comparators are supported for complete_time. Note: Only = comparator supported for user_id and printer_id. Supported filter fields: * complete_time * printer_id * user_id

  • order_by (String) (defaults to: nil)

    Field used to order results. If not specified, results will be ordered in descending order of the complete_time field. Supported order by fields: * title * state * create_time * complete_time * document_page_count * color_mode

    • duplex_mode * printer * user_email
  • page_size (Fixnum) (defaults to: nil)

    The number of print jobs in the page from 0 to 100 inclusive, if page_size is not specified or zero, the size will be 50.

  • page_token (String) (defaults to: nil)

    A page token received from a previous EnumeratePrintJobs call. Provide this to retrieve the subsequent page. If omitted, the first page of results will be returned. When paginating, all other parameters provided to EnumeratePrintJobs must match the call that provided the page token.

  • printer_org_unit_id (String) (defaults to: nil)

    The ID of the organizational unit for printers. If specified, only print jobs submitted to printers from the specified organizational unit will 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



744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 744

def enumerate_customer_report_print_jobs(customer, filter: nil, order_by: nil, page_size: nil, page_token: nil, printer_org_unit_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+customer}/reports:enumeratePrintJobs', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1EnumeratePrintJobsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1EnumeratePrintJobsResponse
  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['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['printerOrgUnitId'] = printer_org_unit_id unless printer_org_unit_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

#fetch_customer_app_devices_requesting_extension(customer, extension_id: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse

Get a list of devices that have requested to install an extension.

Parameters:

  • customer (String)

    Required. The customer ID or "my_customer" prefixed with "customers/".

  • extension_id (String) (defaults to: nil)

    Required. The extension for which we want to find requesting devices.

  • org_unit_id (String) (defaults to: nil)

    The ID of the organizational unit. Only consider devices that directly belong to this org unit, i.e. sub-orgunits are not counted. If omitted, all data will be returned.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of results to return. Maximum and default are 50. Any page size larger than 50 will be coerced to 50.

  • page_token (String) (defaults to: nil)

    Optional. Token to specify the page of the request to be returned. Token expires after 1 day.

  • 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



133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 133

def fetch_customer_app_devices_requesting_extension(customer, extension_id: 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:fetchDevicesRequestingExtension', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FetchDevicesRequestingExtensionResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['extensionId'] = extension_id unless extension_id.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

#fetch_customer_app_users_requesting_extension(customer, extension_id: nil, org_unit_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FetchUsersRequestingExtensionResponse

Get a list of users that have requested to install an extension.

Parameters:

  • customer (String)

    Required. The customer ID or "my_customer" prefixed with "customers/".

  • extension_id (String) (defaults to: nil)

    Required. The extension for which we want to find the requesting users.

  • org_unit_id (String) (defaults to: nil)

    The ID of the organizational unit. Only consider devices that directly belong to this org unit, i.e. sub-orgunits are not counted. If omitted, all data will be returned.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of results to return. Maximum and default are 50. Any page size larger than 50 will be coerced to 50.

  • page_token (String) (defaults to: nil)

    Optional. Token to specify the page of the request to be returned. Token expires after 1 day.

  • 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



179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 179

def fetch_customer_app_users_requesting_extension(customer, extension_id: 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:fetchUsersRequestingExtension', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FetchUsersRequestingExtensionResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1FetchUsersRequestingExtensionResponse
  command.params['customer'] = customer unless customer.nil?
  command.query['extensionId'] = extension_id unless extension_id.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 managed Chrome browser 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



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 799

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



217
218
219
220
221
222
223
224
225
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 217

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



251
252
253
254
255
256
257
258
259
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 251

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



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

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

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

Get telemetry device.

Parameters:

  • name (String)

    Required. Name of the TelemetryDevice to return.

  • read_mask (String) (defaults to: nil)

    Required. Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report

    • boot_performance_report - heartbeat_status_report - network_bandwidth_report
    • peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report
  • 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



846
847
848
849
850
851
852
853
854
855
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 846

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

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

Get telemetry user.

Parameters:

  • name (String)

    Required. Name of the TelemetryUser to return.

  • read_mask (String) (defaults to: nil)

    Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report

  • 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



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 1105

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

#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. Requests that don't specify a "reports_timestamp" value will default to returning only recent reports. Specify "reports_timestamp>=0" to get all report data. Supported filter fields: - org_unit_id - serial_number - device_id - reports_timestamp The "reports_timestamp" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC "Zulu" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", " 1679283943823".

  • page_size (Fixnum) (defaults to: nil)

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

  • 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. Supported read_mask paths are: - name - org_unit_id - device_id - serial_number - cpu_info - cpu_status_report - memory_info - memory_status_report - network_info - network_diagnostics_report - network_status_report - os_update_status - graphics_info - graphics_status_report - battery_info - battery_status_report - storage_info - storage_status_report - thunderbolt_info - audio_status_report

    • boot_performance_report - heartbeat_status_report - network_bandwidth_report
    • peripherals_report - kiosk_app_status_report - app_report - runtime_counters_report
  • 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



903
904
905
906
907
908
909
910
911
912
913
914
915
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 903

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

#list_customer_telemetry_events(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryEventsResponse

List telemetry events.

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. Although this parameter is currently optional, this parameter will be required- please specify at least 1 event type. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC " Zulu" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: "2014-10-02T15: 01:23Z", "2014-10-02T15:01:23.045123456Z", "1679283943823".

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.

  • page_token (String) (defaults to: nil)

    Optional. Token to specify next page in the list.

  • read_mask (String) (defaults to: nil)

    Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event

  • 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



960
961
962
963
964
965
966
967
968
969
970
971
972
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 960

def list_customer_telemetry_events(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/events', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryEventsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryEventsResponse
  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

#list_customer_telemetry_notification_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryNotificationConfigsResponse

List all telemetry notification configs.

Parameters:

  • parent (String)

    Required. The parent which owns the notification configs.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of notification configs to return. The service may return fewer than this value. If unspecified, at most 100 notification configs will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListTelemetryNotificationConfigs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTelemetryNotificationConfigs must match the call that provided the page token.

  • 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



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 1068

def list_customer_telemetry_notification_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/telemetry/notificationConfigs', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryNotificationConfigsResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryNotificationConfigsResponse
  command.params['parent'] = parent unless parent.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

#list_customer_telemetry_users(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryUsersResponse

List all telemetry users.

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)

    Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    Token to specify next page in the list.

  • read_mask (String) (defaults to: nil)

    Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report

  • 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



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
# File 'lib/google/apis/chromemanagement_v1/service.rb', line 1150

def list_customer_telemetry_users(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/users', options)
  command.response_representation = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryUsersResponse::Representation
  command.response_class = Google::Apis::ChromemanagementV1::GoogleChromeManagementV1ListTelemetryUsersResponse
  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