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

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

Overview

Google Play EMM API

Manages the deployment of apps to Android Enterprise devices.

Examples:

require 'google/apis/androidenterprise_v1'

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

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAndroidEnterpriseService

Returns a new instance of AndroidEnterpriseService.



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

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

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



362
363
364
365
366
367
368
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 362

def acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: 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,

  1. 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. ** Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1721

def approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#complete_enterprise_signup(completion_token: nil, enterprise_token: nil, fields: nil, quota_user: 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) (defaults to: nil)

    The Completion token initially returned by GenerateSignupUrl.

  • enterprise_token (String) (defaults to: nil)

    The Enterprise token appended to the Callback URL.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



394
395
396
397
398
399
400
401
402
403
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 394

def (completion_token: nil, enterprise_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#create_enrollment_token(enterprise_id, enrollment_token_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::EnrollmentToken

Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on- device API to authenticate the user. The token can be generated for each device or reused across multiple devices.

Parameters:

  • enterprise_id (String)

    Required. The ID of the enterprise.

  • enrollment_token_object (Google::Apis::AndroidenterpriseV1::EnrollmentToken) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



327
328
329
330
331
332
333
334
335
336
337
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 327

def create_enrollment_token(enterprise_id, enrollment_token_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/enrollmentTokens', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::EnrollmentToken::Representation
  command.request_object = enrollment_token_object
  command.response_representation = Google::Apis::AndroidenterpriseV1::EnrollmentToken::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::EnrollmentToken
  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?
  execute_or_queue_command(command, &block)
end

#create_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



429
430
431
432
433
434
435
436
437
438
439
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 429

def create_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Removes an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



920
921
922
923
924
925
926
927
928
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 920

def delete_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: 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. A successful response indicates that a removal request has been sent to the device. The call will be considered successful even if the app is not present on the device (e.g. it was never installed, or was removed by the user).

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1185

def delete_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1343

def delete_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1500
1501
1502
1503
1504
1505
1506
1507
1508
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1500

def delete_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1999
2000
2001
2002
2003
2004
2005
2006
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1999

def delete_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2103

def delete_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2279
2280
2281
2282
2283
2284
2285
2286
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2279

def delete_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_user(enterprise_id, user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2442
2443
2444
2445
2446
2447
2448
2449
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2442

def delete_user(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_webapp(enterprise_id, web_app_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2761
2762
2763
2764
2765
2766
2767
2768
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2761

def delete_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Enrolls an enterprise with the calling EMM.

Parameters:

  • token (String)

    Required. The token provided by the enterprise to register the EMM.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



462
463
464
465
466
467
468
469
470
471
472
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 462

def enroll_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#force_device_report_upload(enterprise_id, user_id, device_id, fields: nil, quota_user: 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. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def force_device_report_upload(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#generate_enterprise_enterprise_upgrade_url(enterprise_id, admin_email: nil, allowed_domains: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::GenerateEnterpriseUpgradeUrlResponse

Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an enterprise for more details.

Parameters:

  • enterprise_id (String)

    Required. The ID of the enterprise.

  • admin_email (String) (defaults to: nil)

    Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If allowedDomains is non-empty then this must belong to one of the allowedDomains.

  • allowed_domains (Array<String>, String) (defaults to: nil)

    Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has *. prefixed to the domain name (e.g. *. example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



510
511
512
513
514
515
516
517
518
519
520
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 510

def generate_enterprise_enterprise_upgrade_url(enterprise_id, admin_email: nil, allowed_domains: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/generateEnterpriseUpgradeUrl', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::GenerateEnterpriseUpgradeUrlResponse::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::GenerateEnterpriseUpgradeUrlResponse
  command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
  command.query['adminEmail'] = admin_email unless admin_email.nil?
  command.query['allowedDomains'] = allowed_domains unless allowed_domains.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Generates a sign-up URL.

Parameters:

  • admin_email (String) (defaults to: nil)

    Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user. If allowedDomains is non-empty then this must belong to one of the allowedDomains.

  • allowed_domains (Array<String>, String) (defaults to: nil)

    Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has *. prefixed to the domain name (e.g. *. example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are always allowed, but will result in the creation of a managed Google Play Accounts enterprise.

  • callback_url (String) (defaults to: nil)

    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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def (admin_email: nil, allowed_domains: nil, callback_url: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/enterprises/signupUrl', options)
  command.response_representation = Google::Apis::AndroidenterpriseV1::SignupInfo::Representation
  command.response_class = Google::Apis::AndroidenterpriseV1::SignupInfo
  command.query['adminEmail'] = admin_email unless admin_email.nil?
  command.query['allowedDomains'] = allowed_domains unless allowed_domains.nil?
  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?
  execute_or_queue_command(command, &block)
end

#generate_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: 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. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • language_code (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1765

def generate_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#generate_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def generate_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_device(enterprise_id, user_id, device_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 115

def get_device(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Checks if a device can access Google apps and services for a user. Returns whether access is "enabled" or "disabled". A "disabled" state prevents the user's Managed Google Account on the device from successfully authenticating with Google. This blocks access to most Google applications and services, including Google Play, as the device cannot prove its entitlement to access them. New devices default to "disabled". Important: Enforcement of this state depends on the following conditions: * The user must be a managed google account. * The enterprise must be a managed google domain. * Third-party Android mobile management must be active in the Google Admin Console for the user's Organizational Unit. If these conditions aren't met, access may still be possible even in a "disabled" state.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def get_device_state(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_enterprise(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



594
595
596
597
598
599
600
601
602
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 594

def get_enterprise(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_enterprise_service_account(enterprise_id, key_type: nil, fields: nil, quota_user: 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. Note: After you create a key, you might need to wait for 60 seconds or more before you perform another operation with the key. If you try to perform an operation with the key immediately after you create the key, and you receive an error, you can retry the request with exponential backoff .

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • key_type (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



639
640
641
642
643
644
645
646
647
648
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 639

def (enterprise_id, key_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_enterprise_store_layout(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



671
672
673
674
675
676
677
678
679
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 671

def get_enterprise_store_layout(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Retrieves details of an entitlement. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



956
957
958
959
960
961
962
963
964
965
966
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 956

def get_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Retrieves details of an enterprise's group license for a product. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1075

def get_group_license(enterprise_id, group_license_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1223

def get_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1381

def get_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1536

def get_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_permission(permission_id, language: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1682

def get_permission(permission_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1801

def get_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1842

def get_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_product_permissions(enterprise_id, product_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def get_product_permissions(enterprise_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2137

def get_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2310

def get_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_user(enterprise_id, user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2509

def get_user(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Retrieves the set of products a user is entitled to access. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2544

def get_user_available_product_set(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#get_webapp(enterprise_id, web_app_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2792

def get_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#insert_serviceaccountkey(enterprise_id, service_account_key_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2033

def insert_serviceaccountkey(enterprise_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#insert_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2172

def insert_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#insert_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2342

def insert_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#insert_user(enterprise_id, user_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2580

def insert_user(enterprise_id, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#insert_webapp(enterprise_id, web_app_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2824

def insert_webapp(enterprise_id, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_devices(enterprise_id, user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



195
196
197
198
199
200
201
202
203
204
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 195

def list_devices(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_enterprises(domain, fields: nil, quota_user: 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)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



705
706
707
708
709
710
711
712
713
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 705

def list_enterprises(domain, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Lists all entitlements for the specified user. Only the ID is set. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



992
993
994
995
996
997
998
999
1000
1001
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 992

def list_entitlements(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Retrieves the IDs of the users who have been granted entitlements under the license. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1143

def list_group_license_users(enterprise_id, group_license_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Retrieves IDs of all products for which the enterprise has a group license. ** Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1108

def list_group_licenses(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1260

def list_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1419

def list_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1571

def list_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

Lists all the managed configurations settings for the specified app.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1648

def list_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::ProductsListResponse

Finds approved products that match a query, or all approved products if there is no query. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • approved (Boolean) (defaults to: nil)

    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) (defaults to: nil)

    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) (defaults to: nil)

    Defines how many results the list operation should return. The default number depends on the resource collection.

  • query (String) (defaults to: nil)

    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) (defaults to: nil)

    Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1926

def list_products(enterprise_id, approved: nil, language: nil, max_results: nil, query: nil, token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_serviceaccountkeys(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2069
2070
2071
2072
2073
2074
2075
2076
2077
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2069

def list_serviceaccountkeys(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2207

def list_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_storelayoutpages(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2374
2375
2376
2377
2378
2379
2380
2381
2382
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2374

def list_storelayoutpages(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_users(enterprise_id, email, fields: nil, quota_user: 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)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2616

def list_users(enterprise_id, email, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#list_webapps(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2856
2857
2858
2859
2860
2861
2862
2863
2864
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2856

def list_webapps(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: 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) (defaults to: nil)

    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. Specifying 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



752
753
754
755
756
757
758
759
760
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 752

def pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2651
2652
2653
2654
2655
2656
2657
2658
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2651

def revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



783
784
785
786
787
788
789
790
791
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 783

def send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::DeviceState

Sets whether a device's access to Google services (including Google Play) is enabled or disabled for the specified user. Setting the state to "enabled" allows the Google Account to access Google services, while "disabled" blocks access by preventing OAuth token issuance. Preconditions for Enforcement: 1. This setting is only effective for Google-managed users. 2. The enterprise must be linked to a Google Managed Domain. 3. Enforcement requires third-party Android mobile management to be enabled within the Google Admin Console for the user's Organizational Unit. If these preconditions are not met, changes to this state may be ignored.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 239

def set_device_state(enterprise_id, user_id, device_id, device_state_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#set_enterprise_account(enterprise_id, enterprise_account_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



815
816
817
818
819
820
821
822
823
824
825
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 815

def (enterprise_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#set_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



854
855
856
857
858
859
860
861
862
863
864
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 854

def set_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  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, 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. ** Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2687

def set_user_available_product_set(enterprise_id, user_id, product_set_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Unapproves the specified product (and the relevant app permissions, if any) ** Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1965
1966
1967
1968
1969
1970
1971
1972
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1965

def unapprove_product(enterprise_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#unenroll_enterprise(enterprise_id, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



886
887
888
889
890
891
892
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 886

def unenroll_enterprise(enterprise_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'androidenterprise/v1/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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Device

Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play. When provisioning a new device, you should set the device policy using this method before adding the managed Google Play Account to the device, otherwise the policy will not be applied for a short period of time after adding the account to the 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.

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

    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=,,...

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def update_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Entitlement

Adds or updates an entitlement to an app for a user. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.

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) (defaults to: nil)

    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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1035

def update_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1301

def update_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1460

def update_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  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, 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 1612

def update_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#update_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2243

def update_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#update_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2407

def update_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#update_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
# File 'lib/google/apis/androidenterprise_v1/service.rb', line 2726

def update_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end

#update_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: 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) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def update_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'androidenterprise/v1/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?
  execute_or_queue_command(command, &block)
end