Class: Google::Apis::AndroidenterpriseV1::AndroidEnterpriseService

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

Overview

Google Play EMM API

Manages the deployment of apps to Android for Work users.

Examples:

require 'google/apis/androidenterprise_v1'

Androidenterprise = Google::Apis::AndroidenterpriseV1 # Alias the module
service = Androidenterprise::AndroidEnterpriseService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeAndroidEnterpriseService

Returns a new instance of AndroidEnterpriseService



49
50
51
52
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'androidenterprise/v1/')
  @batch_path = 'batch/androidenterprise/v1'
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.



38
39
40
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.



47
48
49
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Acknowledges notifications that were received from Enterprises. PullNotificationSet to prevent subsequent calls from returning the same notifications.

Parameters:

  • notification_set_id (String)

    The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



378
379
380
381
382
383
384
385
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 378

def acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/acknowledgeNotificationSet', options)
  command.query['notificationSetId'] = notification_set_id unless notification_set_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1, 000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • approve_product_request_object (Google::Apis::AndroidenterpriseV1::ApproveProductRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1954

def approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/approve', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ApproveProductRequest::Representation
  command.request_object = approve_product_request_object
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#complete_enterprise_signup(completion_token: nil, enterprise_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Enterprise

Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.

Parameters:

  • completion_token (String)

    The Completion token initially returned by GenerateSignupUrl.

  • enterprise_token (String)

    The Enterprise token appended to the Callback URL.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



413
414
415
416
417
418
419
420
421
422
423
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 413

def (completion_token: nil, enterprise_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/completeSignup', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise
  command.query['completionToken'] = completion_token unless completion_token.nil?
  command.query['enterpriseToken'] = enterprise_token unless enterprise_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::AdministratorWebToken

Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • administrator_web_token_spec_object (Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



451
452
453
454
455
456
457
458
459
460
461
462
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 451

def create_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/createWebToken', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec::Representation
  command.request_object = administrator_web_token_spec_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::AdministratorWebToken::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::AdministratorWebToken
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes an entitlement to an app for a user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • entitlement_id (String)

    The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



912
913
914
915
916
917
918
919
920
921
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 912

def delete_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['entitlementId'] = entitlement_id unless entitlement_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

    The ID of the product represented by the install, e.g. "app:com.google.android. gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1233

def delete_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['installId'] = install_id unless install_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a per-device managed configuration for an app for the specified device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1451

def delete_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a per-user managed configuration for an app for the specified user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1667

def delete_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • key_id (String)

    The ID of the key.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



2251
2252
2253
2254
2255
2256
2257
2258
2259
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2251

def delete_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/serviceAccountKeys/{keyId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['keyId'] = key_id unless key_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a cluster.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2364

def delete_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



2597
2598
2599
2600
2601
2602
2603
2604
2605
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2597

def delete_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deleted an EMM-managed user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



2814
2815
2816
2817
2818
2819
2820
2821
2822
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2814

def delete_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an existing web app.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • web_app_id (String)

    The ID of the web app.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3276

def delete_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/webApps/{webAppId}', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['webAppId'] = web_app_id unless web_app_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#enroll_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Enterprise

Enrolls an enterprise with the calling EMM.

Parameters:

  • token (String)

    The token provided by the enterprise to register the EMM.

  • enterprise_object (Google::Apis::AndroidenterpriseV1::Enterprise) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def enroll_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/enroll', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation
  command.request_object = enterprise_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise
  command.query['token'] = token unless token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#force_device_report_upload(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 82

def force_device_report_upload(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#generate_enterprise_signup_url(callback_url: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::SignupInfo

Generates a sign-up URL.

Parameters:

  • callback_url (String)

    The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



528
529
530
531
532
533
534
535
536
537
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 528

def (callback_url: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/signupUrl', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::SignupInfo::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::SignupInfo
  command.query['callbackUrl'] = callback_url unless callback_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#generate_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse

Generates a URL that can be rendered in an iframe to display the permissions ( if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • language_code (String)

    The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2000

def generate_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#generate_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::AuthenticationToken

Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2852

def generate_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/authenticationToken', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::AuthenticationToken::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::AuthenticationToken
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#generate_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::UserToken

Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token. This call only works with Google managed accounts.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2891

def generate_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/token', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::UserToken::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::UserToken
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_device(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Device

Retrieves the details of a device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_device(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Device
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_device_state(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::DeviceState

Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



162
163
164
165
166
167
168
169
170
171
172
173
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 162

def get_device_state(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::DeviceState
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Enterprise

Retrieves the name and domain of an enterprise.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



561
562
563
564
565
566
567
568
569
570
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 561

def get_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_enterprise_service_account(enterprise_id, key_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ServiceAccount

Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises. CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • key_type (String)

    The type of credential to return with the service account. Required.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



606
607
608
609
610
611
612
613
614
615
616
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 606

def (enterprise_id, key_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/serviceAccount', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccount::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccount
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['keyType'] = key_type unless key_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_enterprise_store_layout(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreLayout

Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



641
642
643
644
645
646
647
648
649
650
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 641

def get_enterprise_store_layout(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayout
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Entitlement

Retrieves details of an entitlement.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • entitlement_id (String)

    The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



949
950
951
952
953
954
955
956
957
958
959
960
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 949

def get_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['entitlementId'] = entitlement_id unless entitlement_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_group_license(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::GroupLicense

Retrieves details of an enterprise's group license for a product.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • group_license_id (String)

    The ID of the product the group license is for, e.g. "app:com.google.android. gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1120

def get_group_license(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::GroupLicense::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::GroupLicense
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['groupLicenseId'] = group_license_id unless group_license_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Install

Retrieves details of an installation of an app on a device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

    The ID of the product represented by the install, e.g. "app:com.google.android. gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1274

def get_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Install
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['installId'] = install_id unless install_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfiguration

Retrieves details of a per-device managed configuration.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1492

def get_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfiguration

Retrieves details of a per-user managed configuration for an app for the specified user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1706

def get_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_permission(permission_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Permission

Retrieves details of an Android app permission for display to an enterprise admin.

Parameters:

  • permission_id (String)

    The ID of the permission.

  • language (String)

    The BCP47 tag for the user's preferred language (e.g. "en-US", "de")

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1913

def get_permission(permission_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'permissions/{permissionId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Permission::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Permission
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Product

Retrieves details of a product for display to an enterprise admin.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product, e.g. "app:com.google.android.gm".

  • language (String)

    The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2039

def get_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::Product::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Product
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema

Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • language (String)

    The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2083

def get_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_product_permissions(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ProductPermissions

Retrieves the Android app permissions required by this app.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2120

def get_product_permissions(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/permissions', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ProductPermissions::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ProductPermissions
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreCluster

Retrieves details of a cluster.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2401

def get_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StorePage

Retrieves details of a store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2631

def get_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StorePage
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::User

Retrieves a user's details.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2927

def get_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::User
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_available_product_set(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ProductSet

Retrieves the set of products a user is entitled to access.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2963

def get_user_available_product_set(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/availableProductSet', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ProductSet
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::WebApp

Gets an existing web app.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • web_app_id (String)

    The ID of the web app.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3310

def get_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/webApps/{webAppId}', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::WebApp
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['webAppId'] = web_app_id unless web_app_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_serviceaccountkey(enterprise_id, service_account_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ServiceAccountKey

Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • service_account_key_object (Google::Apis::AndroidenterpriseV1::ServiceAccountKey) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2288

def insert_serviceaccountkey(enterprise_id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/serviceAccountKeys', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccountKey
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreCluster

Inserts a new cluster in a page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • store_cluster_object (Google::Apis::AndroidenterpriseV1::StoreCluster) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2439

def insert_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.request_object = store_cluster_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StorePage

Inserts a new store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • store_page_object (Google::Apis::AndroidenterpriseV1::StorePage) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2666

def insert_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/storeLayout/pages', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.request_object = store_page_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StorePage
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_user(enterprise_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::User

Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_object (Google::Apis::AndroidenterpriseV1::User) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3003

def insert_user(enterprise_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/users', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::User
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_webapp(enterprise_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::WebApp

Creates a new web app for the enterprise.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • web_app_object (Google::Apis::AndroidenterpriseV1::WebApp) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3345

def insert_webapp(enterprise_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/webApps', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::WebApp
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_devices(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListDevicesResponse

Retrieves the IDs of all of a user's devices.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



199
200
201
202
203
204
205
206
207
208
209
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 199

def list_devices(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListDevicesResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListDevicesResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_enterprises(domain, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse

Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.

Parameters:

  • domain (String)

    The exact primary domain name of the enterprise to look up.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



678
679
680
681
682
683
684
685
686
687
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 678

def list_enterprises(domain, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse
  command.query['domain'] = domain unless domain.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_entitlements(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse

Lists all entitlements for the specified user. Only the ID is set.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



986
987
988
989
990
991
992
993
994
995
996
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 986

def list_entitlements(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/entitlements', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_group_license_users(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse

Retrieves the IDs of the users who have been granted entitlements under the license.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • group_license_id (String)

    The ID of the product the group license is for, e.g. "app:com.google.android. gm".

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1191

def list_group_license_users(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['groupLicenseId'] = group_license_id unless group_license_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_group_licenses(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse

Retrieves IDs of all products for which the enterprise has a group license.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1154

def list_group_licenses(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListInstallsResponse

Retrieves the details of all apps installed on the specified device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1314

def list_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListInstallsResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListInstallsResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse

Lists all the per-device managed configurations for the specified device. Only the ID is set.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1533

def list_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse

Lists all the per-user managed configurations for the specified user. Only the ID is set.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1744

def list_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse

Lists all the managed configurations settings for the specified app. Only the ID and the name is set.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product for which the managed configurations settings applies to.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1876

def list_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_products(enterprise_id, approved: nil, language: nil, max_results: nil, query: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ProductsListResponse

Finds approved products that match a query, or all approved products if there is no query.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • approved (Boolean)

    Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified.

  • language (String)

    The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language.

  • max_results (Fixnum)

    Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response.

  • query (String)

    The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).

  • token (String)

    A pagination token is contained in a request's response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2174

def list_products(enterprise_id, approved: nil, language: nil, max_results: nil, query: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/products', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ProductsListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ProductsListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['approved'] = approved unless approved.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['query'] = query unless query.nil?
  command.query['token'] = token unless token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_serviceaccountkeys(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse

Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises. SetAccount.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2327

def list_serviceaccountkeys(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/serviceAccountKeys', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse

Retrieves the details of all clusters on the specified page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2477

def list_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_storelayoutpages(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse

Retrieves the details of all pages in the store.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2701

def list_storelayoutpages(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_users(enterprise_id, email, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ListUsersResponse

Looks up a user by primary email address. This is only supported for Google- managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • email (String)

    The exact primary email address of the user to look up.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3042

def list_users(enterprise_id, email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/users', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::ListUsersResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ListUsersResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['email'] = email unless email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_webapps(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::WebAppsListResponse

Retrieves the details of all web apps for a given enterprise.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3380

def list_webapps(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'enterprises/{enterpriseId}/webApps', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::WebAppsListResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::WebAppsListResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Device

Updates the device policy. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • device_object (Google::Apis::AndroidenterpriseV1::Device) (defaults to: nil)
  • update_mask (String)

    Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=< field1>,,...

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 243

def patch_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Device::Representation
  command.request_object = device_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Device
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Entitlement

Adds or updates an entitlement to an app for a user. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • entitlement_id (String)

    The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

  • entitlement_object (Google::Apis::AndroidenterpriseV1::Entitlement) (defaults to: nil)
  • install (Boolean)

    Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1031

def patch_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation
  command.request_object = entitlement_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['entitlementId'] = entitlement_id unless entitlement_id.nil?
  command.query['install'] = install unless install.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Install

Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

    The ID of the product represented by the install, e.g. "app:com.google.android. gm".

  • install_object (Google::Apis::AndroidenterpriseV1::Install) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1359

def patch_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Install::Representation
  command.request_object = install_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Install
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['installId'] = install_id unless install_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfiguration

Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • managed_configuration_object (Google::Apis::AndroidenterpriseV1::ManagedConfiguration) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1577

def patch_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.request_object = managed_configuration_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfiguration

Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • managed_configuration_object (Google::Apis::AndroidenterpriseV1::ManagedConfiguration) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1789

def patch_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.request_object = managed_configuration_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreCluster

Updates a cluster. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • store_cluster_object (Google::Apis::AndroidenterpriseV1::StoreCluster) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2516

def patch_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.request_object = store_cluster_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StorePage

Updates the content of a store page. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • store_page_object (Google::Apis::AndroidenterpriseV1::StorePage) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2737

def patch_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.request_object = store_page_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StorePage
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::User

Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • user_object (Google::Apis::AndroidenterpriseV1::User) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3083

def patch_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/users/{userId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::User
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::WebApp

Updates an existing web app. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • web_app_id (String)

    The ID of the web app.

  • web_app_object (Google::Apis::AndroidenterpriseV1::WebApp) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3416

def patch_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'enterprises/{enterpriseId}/webApps/{webAppId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::WebApp
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['webAppId'] = web_app_id unless web_app_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::NotificationSet

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.

Parameters:

  • request_mode (String)

    The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



731
732
733
734
735
736
737
738
739
740
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 731

def pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/pullNotificationSet', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::NotificationSet::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::NotificationSet
  command.query['requestMode'] = request_mode unless request_mode.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



3124
3125
3126
3127
3128
3129
3130
3131
3132
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3124

def revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/deviceAccess', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#revoke_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Revokes a previously generated token (activation code) for the user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3158

def revoke_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/token', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse

Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



765
766
767
768
769
770
771
772
773
774
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 765

def send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/sendTestPushNotification', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_device_state(enterprise_id, user_id, device_id, device_state_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::DeviceState

Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • device_state_object (Google::Apis::AndroidenterpriseV1::DeviceState) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 290

def set_device_state(enterprise_id, user_id, device_id, device_state_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation
  command.request_object = device_state_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::DeviceState
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_enterprise_account(enterprise_id, enterprise_account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::EnterpriseAccount

Sets the account that will be used to authenticate to the API as the enterprise.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • enterprise_account_object (Google::Apis::AndroidenterpriseV1::EnterpriseAccount) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



800
801
802
803
804
805
806
807
808
809
810
811
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 800

def (enterprise_id,  = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/account', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::EnterpriseAccount::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AndroidenterpriseV1::EnterpriseAccount::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::EnterpriseAccount
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreLayout

Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • store_layout_object (Google::Apis::AndroidenterpriseV1::StoreLayout) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



842
843
844
845
846
847
848
849
850
851
852
853
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 842

def set_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation
  command.request_object = store_layout_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayout
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_user_available_product_set(enterprise_id, user_id, product_set_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ProductSet

Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • product_set_object (Google::Apis::AndroidenterpriseV1::ProductSet) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3195

def set_user_available_product_set(enterprise_id, user_id, product_set_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/availableProductSet', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation
  command.request_object = product_set_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ProductSet
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#unapprove_product(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Unapproves the specified product (and the relevant app permissions, if any)

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



2214
2215
2216
2217
2218
2219
2220
2221
2222
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2214

def unapprove_product(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/unapprove', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['productId'] = product_id unless product_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#unenroll_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Unenrolls an enterprise from the calling EMM.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:



877
878
879
880
881
882
883
884
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 877

def unenroll_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'enterprises/{enterpriseId}/unenroll', options)
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Device

Updates the device policy

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • device_object (Google::Apis::AndroidenterpriseV1::Device) (defaults to: nil)
  • update_mask (String)

    Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=< field1>,,...

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 337

def update_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Device::Representation
  command.request_object = device_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Device
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Entitlement

Adds or updates an entitlement to an app for a user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • entitlement_id (String)

    The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

  • entitlement_object (Google::Apis::AndroidenterpriseV1::Entitlement) (defaults to: nil)
  • install (Boolean)

    Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1079

def update_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation
  command.request_object = entitlement_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['entitlementId'] = entitlement_id unless entitlement_id.nil?
  command.query['install'] = install unless install.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Install

Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

    The ID of the product represented by the install, e.g. "app:com.google.android. gm".

  • install_object (Google::Apis::AndroidenterpriseV1::Install) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1406

def update_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Install::Representation
  command.request_object = install_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::Install
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['installId'] = install_id unless install_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfiguration

Adds or updates a per-device managed configuration for an app for the specified device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • managed_configuration_object (Google::Apis::AndroidenterpriseV1::ManagedConfiguration) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1624

def update_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.request_object = managed_configuration_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ManagedConfiguration

Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

    The ID of the managed configuration (a product ID), e.g. "app:com.google. android.gm".

  • managed_configuration_object (Google::Apis::AndroidenterpriseV1::ManagedConfiguration) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1836

def update_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.request_object = managed_configuration_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StoreCluster

Updates a cluster.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • store_cluster_object (Google::Apis::AndroidenterpriseV1::StoreCluster) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2558

def update_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.request_object = store_cluster_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.params['clusterId'] = cluster_id unless cluster_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::StorePage

Updates the content of a store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • store_page_object (Google::Apis::AndroidenterpriseV1::StorePage) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2776

def update_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.request_object = store_page_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::StorePage
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['pageId'] = page_id unless page_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::User

Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • user_object (Google::Apis::AndroidenterpriseV1::User) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3238

def update_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.request_object = user_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::User
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::WebApp

Updates an existing web app.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • web_app_id (String)

    The ID of the web app.

  • web_app_object (Google::Apis::AndroidenterpriseV1::WebApp) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3455

def update_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'enterprises/{enterpriseId}/webApps/{webAppId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::WebApp
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.params['webAppId'] = web_app_id unless web_app_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end