class Google::Apis::AndroidmanagementV1::AndroidManagementService
Android Management API
The Android Management API provides remote enterprise management of Android
devices and apps.
@example
require 'google/apis/androidmanagement_v1' Androidmanagement = Google::Apis::AndroidmanagementV1 # Alias the module service = Androidmanagement::AndroidManagementService.new
Attributes
@return [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.
@return [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.
Public Class Methods
# File lib/google/apis/androidmanagement_v1/service.rb, line 46 def initialize super('https://androidmanagement.googleapis.com/', '', client_name: 'google-apis-androidmanagement_v1', client_version: Google::Apis::AndroidmanagementV1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error
value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED. @param [String] name
The name of the operation resource to be cancelled.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 481 def cancel_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates an enterprise. This is the last step in the enterprise signup flow. @param [Google::Apis::AndroidmanagementV1::Enterprise] enterprise_object @param [Boolean] agreement_accepted
Whether the enterprise admin has seen and agreed to the managed Google Play Agreement (https://www.android.com/enterprise/terms/). Always set this to true when creating an EMM-managed enterprise. Do not create the enterprise until the admin has viewed and accepted the agreement.
@param [String] enterprise_token
The enterprise token appended to the callback URL. Only set this when creating a customer-managed enterprise.
@param [String] project_id
The ID of the Google Cloud Platform project which will own the enterprise.
@param [String] signup_url_name
The name of the SignupUrl used to sign up for the enterprise. Only set this when creating a customer-managed enterprise.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Enterprise] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Enterprise]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 85 def create_enterprise(enterprise_object = nil, agreement_accepted: nil, enterprise_token: nil, project_id: nil, signup_url_name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/enterprises', options) command.request_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.response_class = Google::Apis::AndroidmanagementV1::Enterprise command.query['agreementAccepted'] = agreement_accepted unless agreement_accepted.nil? command.query['enterpriseToken'] = enterprise_token unless enterprise_token.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['signupUrlName'] = signup_url_name unless signup_url_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates an enrollment token for a given enterprise. @param [String] parent
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Google::Apis::AndroidmanagementV1::EnrollmentToken] enrollment_token_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::EnrollmentToken] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::EnrollmentToken]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 622 def create_enterprise_enrollment_token(parent, enrollment_token_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/enrollmentTokens', options) command.request_representation = Google::Apis::AndroidmanagementV1::EnrollmentToken::Representation command.request_object = enrollment_token_object command.response_representation = Google::Apis::AndroidmanagementV1::EnrollmentToken::Representation command.response_class = Google::Apis::AndroidmanagementV1::EnrollmentToken command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates a web app. @param [String] parent
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Google::Apis::AndroidmanagementV1::WebApp] web_app_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::WebApp] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::WebApp]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 825 def create_enterprise_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/webApps', options) command.request_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation command.request_object = web_app_object command.response_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation command.response_class = Google::Apis::AndroidmanagementV1::WebApp command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates a web token to access an embeddable managed Google
Play web UI for a given enterprise. @param [String] parent
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Google::Apis::AndroidmanagementV1::WebToken] web_token_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::WebToken] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::WebToken]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 996 def create_enterprise_web_token(parent, web_token_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/webTokens', options) command.request_representation = Google::Apis::AndroidmanagementV1::WebToken::Representation command.request_object = web_token_object command.response_representation = Google::Apis::AndroidmanagementV1::WebToken::Representation command.response_class = Google::Apis::AndroidmanagementV1::WebToken command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Creates an enterprise signup URL. @param [String] callback_url
The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.
@param [String] project_id
The ID of the Google Cloud Platform project which will own the enterprise.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::SignupUrl] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::SignupUrl]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 1035 def create_signup_url(callback_url: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/signupUrls', options) command.response_representation = Google::Apis::AndroidmanagementV1::SignupUrl::Representation command.response_class = Google::Apis::AndroidmanagementV1::SignupUrl command.query['callbackUrl'] = callback_url unless callback_url.nil? command.query['projectId'] = project_id unless project_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
Deletes an enterprise. Only available for EMM-managed enterprises. @param [String] name
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 120 def delete_enterprise(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a device. This operation wipes the device. @param [String] name
The name of the device in the form enterprises/`enterpriseId`/devices/` deviceId`.
@param [Array<String>, String] wipe_data_flags
Optional flags that control the device wiping behavior.
@param [String] wipe_reason_message
Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 300 def delete_enterprise_device(name, wipe_data_flags: nil, wipe_reason_message: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['wipeDataFlags'] = wipe_data_flags unless wipe_data_flags.nil? command.query['wipeReasonMessage'] = wipe_reason_message unless wipe_reason_message.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED. @param [String] name
The name of the operation resource to be deleted.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 514 def delete_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes an enrollment token. This operation invalidates the token, preventing its future use. @param [String] name
The name of the enrollment token in the form enterprises/`enterpriseId`/ enrollmentTokens/`enrollmentTokenId`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 656 def delete_enterprise_enrollment_token(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a policy. This operation is only permitted if no devices are currently referencing the policy. @param [String] name
The name of the policy in the form enterprises/`enterpriseId`/policies/` policyId`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 688 def delete_enterprise_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Deletes a web app. @param [String] name
The name of the web app in the form enterprises/`enterpriseId`/webApps/` packageName`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Empty]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 858 def delete_enterprise_web_app(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Empty::Representation command.response_class = Google::Apis::AndroidmanagementV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets an enterprise. @param [String] name
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Enterprise] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Enterprise]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 150 def get_enterprise(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.response_class = Google::Apis::AndroidmanagementV1::Enterprise command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets info about an application. @param [String] name
The name of the application in the form enterprises/`enterpriseId`/ applications/`package_name`.
@param [String] language_code
The preferred language for localized application info, as a BCP47 tag (e.g. " en-US", "de"). If not specified the default language of the application will be used.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Application] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Application]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 262 def get_enterprise_application(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Application::Representation command.response_class = Google::Apis::AndroidmanagementV1::Application command.params['name'] = name unless name.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
Gets a device. @param [String] name
The name of the device in the form enterprises/`enterpriseId`/devices/` deviceId`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Device] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Device]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 333 def get_enterprise_device(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Device::Representation command.response_class = Google::Apis::AndroidmanagementV1::Device command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. @param [String] name
The name of the operation resource.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 545 def get_enterprise_device_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Operation::Representation command.response_class = Google::Apis::AndroidmanagementV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets a policy. @param [String] name
The name of the policy in the form enterprises/`enterpriseId`/policies/` policyId`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 719 def get_enterprise_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::Policy::Representation command.response_class = Google::Apis::AndroidmanagementV1::Policy command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Gets a web app. @param [String] name
The name of the web app in the form enterprises/`enterpriseId`/webApp/` packageName`.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::WebApp] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::WebApp]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 889 def get_enterprise_web_app(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation command.response_class = Google::Apis::AndroidmanagementV1::WebApp command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Issues a command to a device. The Operation
resource returned contains a Command
in its metadata field. Use the get operation method to get the status of the command. @param [String] name
The name of the device in the form enterprises/`enterpriseId`/devices/` deviceId`.
@param [Google::Apis::AndroidmanagementV1::Command] command_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Operation] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Operation]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 367 def issue_enterprise_device_command(name, command_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:issueCommand', options) command.request_representation = Google::Apis::AndroidmanagementV1::Command::Representation command.request_object = command_object command.response_representation = Google::Apis::AndroidmanagementV1::Operation::Representation command.response_class = Google::Apis::AndroidmanagementV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as “/v1/`name=users/*`/operations” to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. @param [String] name
The name of the operation's parent resource.
@param [String] filter
The standard list filter.
@param [Fixnum] page_size
The standard list page size.
@param [String] page_token
The standard list page token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::ListOperationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::ListOperationsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 588 def list_enterprise_device_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListOperationsResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists devices for a given enterprise. @param [String] parent
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Fixnum] page_size
The requested page size. The actual page size may be fixed to a min or max value.
@param [String] page_token
A token identifying a page of results returned by the server.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::ListDevicesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::ListDevicesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 404 def list_enterprise_devices(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/devices', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListDevicesResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListDevicesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists policies for a given enterprise. @param [String] parent
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Fixnum] page_size
The requested page size. The actual page size may be fixed to a min or max value.
@param [String] page_token
A token identifying a page of results returned by the server.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::ListPoliciesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::ListPoliciesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 754 def list_enterprise_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/policies', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListPoliciesResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListPoliciesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists web apps for a given enterprise. @param [String] parent
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Fixnum] page_size
The requested page size. The actual page size may be fixed to a min or max value.
@param [String] page_token
A token identifying a page of results returned by the server.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::ListWebAppsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::ListWebAppsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 924 def list_enterprise_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/webApps', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListWebAppsResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListWebAppsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Lists EMM-managed enterprises. Only BASIC fields are returned. @param [Fixnum] page_size
The requested page size. The actual page size may be fixed to a min or max value.
@param [String] page_token
A token identifying a page of results returned by the server.
@param [String] project_id
Required. The Cloud project ID of the EMM managing the enterprises.
@param [String] view
Specifies which Enterprise fields to return. This method only supports BASIC.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::ListEnterprisesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::ListEnterprisesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 187 def list_enterprises(page_size: nil, page_token: nil, project_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/enterprises', options) command.response_representation = Google::Apis::AndroidmanagementV1::ListEnterprisesResponse::Representation command.response_class = Google::Apis::AndroidmanagementV1::ListEnterprisesResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['projectId'] = project_id unless project_id.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Updates an enterprise. @param [String] name
The name of the enterprise in the form enterprises/`enterpriseId`.
@param [Google::Apis::AndroidmanagementV1::Enterprise] enterprise_object @param [String] update_mask
The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Enterprise] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Enterprise]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 224 def patch_enterprise(name, enterprise_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidmanagementV1::Enterprise::Representation command.response_class = Google::Apis::AndroidmanagementV1::Enterprise command.params['name'] = name unless name.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
Updates a device. @param [String] name
The name of the device in the form enterprises/`enterpriseId`/devices/` deviceId`.
@param [Google::Apis::AndroidmanagementV1::Device] device_object @param [String] update_mask
The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Device] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Device]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 441 def patch_enterprise_device(name, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::AndroidmanagementV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::AndroidmanagementV1::Device::Representation command.response_class = Google::Apis::AndroidmanagementV1::Device command.params['name'] = name unless name.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
Updates or creates a policy. @param [String] name
The name of the policy in the form enterprises/`enterpriseId`/policies/` policyId`.
@param [Google::Apis::AndroidmanagementV1::Policy] policy_object @param [String] update_mask
The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::Policy]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 791 def patch_enterprise_policy(name, policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::AndroidmanagementV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::AndroidmanagementV1::Policy::Representation command.response_class = Google::Apis::AndroidmanagementV1::Policy command.params['name'] = name unless name.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
Updates a web app. @param [String] name
The name of the web app in the form enterprises/`enterpriseId`/webApps/` packageName`.
@param [Google::Apis::AndroidmanagementV1::WebApp] web_app_object @param [String] update_mask
The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AndroidmanagementV1::WebApp] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AndroidmanagementV1::WebApp]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/androidmanagement_v1/service.rb, line 961 def patch_enterprise_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation command.request_object = web_app_object command.response_representation = Google::Apis::AndroidmanagementV1::WebApp::Representation command.response_class = Google::Apis::AndroidmanagementV1::WebApp command.params['name'] = name unless name.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
Protected Instance Methods
# File lib/google/apis/androidmanagement_v1/service.rb, line 1048 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end