Class: Google::Apis::AndroiddeviceprovisioningV1::AndroidProvisioningPartnerService

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

Overview

Android Device Provisioning Partner API

Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports.

Examples:

require 'google/apis/androiddeviceprovisioning_v1'

Androiddeviceprovisioning = Google::Apis::AndroiddeviceprovisioningV1 # Alias the module
service = Androiddeviceprovisioning::AndroidProvisioningPartnerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ AndroidProvisioningPartnerService

Returns a new instance of AndroidProvisioningPartnerService



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

def initialize
  super('https://androiddeviceprovisioning.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



39
40
41
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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

def quota_user
  @quota_user
end

Instance Method Details

#claim_device(partner_id, claim_device_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::ClaimDeviceResponse

Claim the device identified by device identifier.

Parameters:

  • partner_id (Fixnum) —

    ID of the partner.

  • claim_device_request_object (Google::Apis::AndroiddeviceprovisioningV1::ClaimDeviceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



171
172
173
174
175
176
177
178
179
180
181
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 171

def claim_device(partner_id, claim_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:claim', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::ClaimDeviceRequest::Representation
  command.request_object = claim_device_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::ClaimDeviceResponse::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::ClaimDeviceResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#claim_partner_device_async(partner_id, claim_devices_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Operation

Claim devices asynchronously.

Parameters:

  • partner_id (Fixnum) —

    Partner ID.

  • claim_devices_request_object (Google::Apis::AndroiddeviceprovisioningV1::ClaimDevicesRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



204
205
206
207
208
209
210
211
212
213
214
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 204

def claim_partner_device_async(partner_id, claim_devices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:claimAsync', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::ClaimDevicesRequest::Representation
  command.request_object = claim_devices_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Operation::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Operation
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_customer(parent, create_customer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Company

A customer for zero-touch enrollment will be created. After a Customer is created, their admins and owners will be able to manage devices on partner.android.com/zerotouch or via their API.

Parameters:

  • parent (String) —

    The parent resource in format `partners/[PARTNER_ID]'.

  • create_customer_request_object (Google::Apis::AndroiddeviceprovisioningV1::CreateCustomerRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



106
107
108
109
110
111
112
113
114
115
116
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 106

def create_customer(parent, create_customer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/customers', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::CreateCustomerRequest::Representation
  command.request_object = create_customer_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Company::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Company
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#find_partner_device_by_identifier(partner_id, find_devices_by_device_identifier_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByDeviceIdentifierResponse

Find devices by device identifier.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



237
238
239
240
241
242
243
244
245
246
247
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 237

def find_partner_device_by_identifier(partner_id, find_devices_by_device_identifier_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:findByIdentifier', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByDeviceIdentifierRequest::Representation
  command.request_object = find_devices_by_device_identifier_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByDeviceIdentifierResponse::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByDeviceIdentifierResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#find_partner_device_by_owner(partner_id, find_devices_by_owner_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerResponse

Find devices by ownership.

Parameters:

  • partner_id (Fixnum) —

    ID of the partner.

  • find_devices_by_owner_request_object (Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    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
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 270

def find_partner_device_by_owner(partner_id, find_devices_by_owner_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:findByOwner', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerRequest::Representation
  command.request_object = find_devices_by_owner_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerResponse::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



73
74
75
76
77
78
79
80
81
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 73

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Operation::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_partner_device(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Device

Get a device.

Parameters:

  • name (String) —

    Resource name in partners/[PARTNER_ID]/devices/[DEVICE_ID].

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



302
303
304
305
306
307
308
309
310
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 302

def get_partner_device(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Device::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Device
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_partner_customers(partner_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::ListCustomersResponse

List the customers that are enrolled to the reseller identified by the partnerId argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.

Parameters:

  • partner_id (Fixnum) —

    The ID of the partner.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



140
141
142
143
144
145
146
147
148
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 140

def list_partner_customers(partner_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/partners/{+partnerId}/customers', options)
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::ListCustomersResponse::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::ListCustomersResponse
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#metadata_partner_device(metadata_owner_id, device_id, update_device_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata

Update the metadata.

Parameters:

  • metadata_owner_id (Fixnum) —

    The owner of the newly set metadata. Set this to the partner ID.

  • device_id (Fixnum) —

    ID of the partner.

  • update_device_metadata_request_object (Google::Apis::AndroiddeviceprovisioningV1::UpdateDeviceMetadataRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 335

def metadata_partner_device(metadata_owner_id, device_id, update_device_metadata_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::UpdateDeviceMetadataRequest::Representation
  command.request_object = update_device_metadata_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata
  command.params['metadataOwnerId'] = metadata_owner_id unless metadata_owner_id.nil?
  command.params['deviceId'] = device_id unless device_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unclaim_device(partner_id, unclaim_device_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Empty

Unclaim the device identified by the device_id or the deviceIdentifier.

Parameters:

  • partner_id (Fixnum) —

    ID of the partner.

  • unclaim_device_request_object (Google::Apis::AndroiddeviceprovisioningV1::UnclaimDeviceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



369
370
371
372
373
374
375
376
377
378
379
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 369

def unclaim_device(partner_id, unclaim_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:unclaim', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::UnclaimDeviceRequest::Representation
  command.request_object = unclaim_device_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Empty::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Empty
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unclaim_partner_device_async(partner_id, unclaim_devices_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Operation

Unclaim devices asynchronously.

Parameters:

  • partner_id (Fixnum) —

    Partner ID.

  • unclaim_devices_request_object (Google::Apis::AndroiddeviceprovisioningV1::UnclaimDevicesRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



402
403
404
405
406
407
408
409
410
411
412
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 402

def unclaim_partner_device_async(partner_id, unclaim_devices_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:unclaimAsync', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::UnclaimDevicesRequest::Representation
  command.request_object = unclaim_devices_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Operation::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Operation
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_partner_device_metadata_async(partner_id, update_device_metadata_in_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AndroiddeviceprovisioningV1::Operation

Set metadata in batch asynchronously.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



435
436
437
438
439
440
441
442
443
444
445
 
# File 'generated/google/apis/androiddeviceprovisioning_v1/service.rb', line 435

def update_partner_device_metadata_async(partner_id, update_device_metadata_in_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/partners/{+partnerId}/devices:updateMetadataAsync', options)
  command.request_representation = Google::Apis::AndroiddeviceprovisioningV1::UpdateDeviceMetadataInBatchRequest::Representation
  command.request_object = update_device_metadata_in_batch_request_object
  command.response_representation = Google::Apis::AndroiddeviceprovisioningV1::Operation::Representation
  command.response_class = Google::Apis::AndroiddeviceprovisioningV1::Operation
  command.params['partnerId'] = partner_id unless partner_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end