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

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

Overview

Google Play EMM API

Manages the deployment of apps to Android for Work users.

Examples:

require 'google/apis/androidenterprise_v1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeAndroidEnterpriseService

Returns a new instance of AndroidEnterpriseService.


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

def initialize
  super('https://www.googleapis.com/', 'androidenterprise/v1/')
end

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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


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

def key
  @key
end

#quota_userString

Returns 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. Overrides userIp if both are provided.

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. Overrides userIp if both are provided.


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

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.


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

def user_ip
  @user_ip
end

Instance Method Details

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

This method returns an undefined value.

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

Parameters:

  • notification_set_id (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


699
700
701
702
703
704
705
706
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 699

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • approve_product_request_object (Google::Apis::AndroidenterpriseV1::ApproveProductRequest) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


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

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

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

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

Parameters:

  • completion_token (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


736
737
738
739
740
741
742
743
744
745
746
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 736

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

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

Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the Play for Work 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


776
777
778
779
780
781
782
783
784
785
786
787
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 776

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

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

This method returns an undefined value.

Deletes a collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


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

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

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

This method returns an undefined value.

Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


314
315
316
317
318
319
320
321
322
323
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 314

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

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

This method returns an undefined value.

Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.

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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


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

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

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

This method returns an undefined value.

Removes an entitlement to an app for a user and uninstalls it.

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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1328

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


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

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1893

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


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

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • key_id (String)

    The ID of the key.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


2731
2732
2733
2734
2735
2736
2737
2738
2739
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2731

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

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

This method returns an undefined value.

Deletes a cluster.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


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

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

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

This method returns an undefined value.

Deletes a store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


3095
3096
3097
3098
3099
3100
3101
3102
3103
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3095

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

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

This method returns an undefined value.

Deleted an EMM-managed user.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


3324
3325
3326
3327
3328
3329
3330
3331
3332
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3324

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

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

Enrolls an enterprise with the calling EMM.

Parameters:

  • token (String)

    The token provided by the enterprise to register the EMM.

  • enterprise_object (Google::Apis::AndroidenterpriseV1::Enterprise) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


849
850
851
852
853
854
855
856
857
858
859
860
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 849

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

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

Generates a sign-up URL.

Parameters:

  • callback_url (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


892
893
894
895
896
897
898
899
900
901
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 892

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • language_code (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2422

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

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

Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3363

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3403

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

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

Retrieves the details of a collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


355
356
357
358
359
360
361
362
363
364
365
366
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 355

def get_collection_viewer(enterprise_id, collection_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'enterprises/{enterpriseId}/collections/{collectionId}/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['collectionId'] = collection_id unless collection_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves the details of a device.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


573
574
575
576
577
578
579
580
581
582
583
584
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 573

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

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

Retrieves the name and domain of an enterprise.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


927
928
929
930
931
932
933
934
935
936
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 927

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • key_type (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


974
975
976
977
978
979
980
981
982
983
984
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 974

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

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

Returns the store layout for the enterprise. If the store layout has not been set, or if the store layout has no homepageId set, returns a NOT_FOUND error.

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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1011

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

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

Retrieves details of an entitlement.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • entitlement_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1367

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • group_license_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1546

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

Retrieves details of a per-device managed configuration.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1936

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2160

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

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

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

Parameters:

  • permission_id (String)

    The ID of the permission.

  • language (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2331

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

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

  • language (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2463

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

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

Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an administrator 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

Retrieves the Android app permissions required by this app.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2548

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

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

Retrieves details of a cluster.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

Retrieves details of a store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3131

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

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

Retrieves a user's details.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3441

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3479

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

#insert_collection(enterprise_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Collection

Creates a new collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_object (Google::Apis::AndroidenterpriseV1::Collection) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


154
155
156
157
158
159
160
161
162
163
164
165
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 154

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

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

Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.

Parameters:

  • token (String)

    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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1048

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • service_account_key_object (Google::Apis::AndroidenterpriseV1::ServiceAccountKey) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2770

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

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

Inserts a new cluster in a page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • store_cluster_object (Google::Apis::AndroidenterpriseV1::StoreCluster) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2929

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

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

Inserts a new store page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • store_page_object (Google::Apis::AndroidenterpriseV1::StorePage) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3168

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_object (Google::Apis::AndroidenterpriseV1::User) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3521

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

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

Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


396
397
398
399
400
401
402
403
404
405
406
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 396

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

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

Retrieves the IDs of all the collections for 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


612
613
614
615
616
617
618
619
620
621
622
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 612

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

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

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

Parameters:

  • domain (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1089

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

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

List of all entitlements for the specified user. Only the ID is set.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • group_license_id (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1621

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1750

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1979

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2200

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • approved (Boolean) (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)

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

  • query (String) (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)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2604

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

Retrieves the details of all clusters on the specified page.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2969

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

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

Retrieves the details of all pages in the store.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3205

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • email (String)

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

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3562

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

#patch_collection(enterprise_id, collection_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Collection

Updates a collection. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • collection_object (Google::Apis::AndroidenterpriseV1::Collection) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 229

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

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

Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 439

def patch_collection_viewer(enterprise_id, collection_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'enterprises/{enterpriseId}/collections/{collectionId}/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['collectionId'] = collection_id unless collection_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • entitlement_id (String)

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

  • entitlement_object (Google::Apis::AndroidenterpriseV1::Entitlement) (defaults to: nil)
  • install (Boolean) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1453

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • install_id (String)

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

  • install_object (Google::Apis::AndroidenterpriseV1::Install) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1797

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The Android ID of the device.

  • managed_configuration_for_device_id (String)

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

  • managed_configuration_object (Google::Apis::AndroidenterpriseV1::ManagedConfiguration) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2025

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • managed_configuration_for_user_id (String)

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

  • managed_configuration_object (Google::Apis::AndroidenterpriseV1::ManagedConfiguration) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

Updates a cluster. This method supports patch semantics.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • cluster_id (String)

    The ID of the cluster.

  • store_cluster_object (Google::Apis::AndroidenterpriseV1::StoreCluster) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3010

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • page_id (String)

    The ID of the page.

  • store_page_object (Google::Apis::AndroidenterpriseV1::StorePage) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3243

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • user_object (Google::Apis::AndroidenterpriseV1::User) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3605

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

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

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

Parameters:

  • request_mode (String) (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. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


3645
3646
3647
3648
3649
3650
3651
3652
3653
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3645

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

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

Sends a test push 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1180

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

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

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • user_id (String)

    The ID of the user.

  • device_id (String)

    The ID of the device.

  • device_state_object (Google::Apis::AndroidenterpriseV1::DeviceState) (defaults to: nil)
  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


657
658
659
660
661
662
663
664
665
666
667
668
669
670
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 657

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

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

Set 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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1216

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

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

Sets the store layout for the enterprise.

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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1254

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

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

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

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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 3682

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

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

This method returns an undefined value.

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

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • product_id (String)

    The ID of the product.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 2646

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

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

This method returns an undefined value.

Unenrolls an enterprise from the calling EMM.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • fields (String) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:


1291
1292
1293
1294
1295
1296
1297
1298
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 1291

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

#update_collection(enterprise_id, collection_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroidenterpriseV1::Collection

Updates a collection.

Parameters:

  • enterprise_id (String)

    The ID of the enterprise.

  • collection_id (String)

    The ID of the collection.

  • collection_object (Google::Apis::AndroidenterpriseV1::Collection) (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. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'generated/google/apis/androidenterprise_v1/service.rb', line 270

def update_collection(enterprise_id, collection_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'enterprises/{enterpriseId}/collections/{collectionId}', options)
  command.request_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
  command.request_object = collection_object
  command