google_api_android_device_provisioning v0.7.0 GoogleApi.AndroidDeviceProvisioning.V1.Api.Partners View Source
API calls for all endpoints tagged Partners
.
Link to this section Summary
Functions
Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
Lists 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.
Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations.
Finds devices by hardware identifiers, such as IMEI.
Finds devices claimed for customers. The results only contain devices
registered to the reseller that's identified by the partnerId
argument.
The customer's devices purchased from other resellers don't appear in the
results.
Gets a device.
Updates reseller metadata associated with the device.
Unclaims a device from a customer and removes it from zero-touch enrollment.
Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read Long‑running batch operations.
Updates the reseller metadata attached to a batch of devices. This method
updates devices asynchronously and returns an Operation
that can be used
to track progress. Read Long‑running batch
operations.
Lists the customers of the vendor.
Lists the vendors of the partner.
Link to this section Functions
androiddeviceprovisioning_partners_customers_create(connection, parent, optional_params \\ [], opts \\ []) View Source
Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- parent (String.t): Required. The parent resource ID in the format
partners/[PARTNER_ID]
that identifies the reseller. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.CreateCustomerRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Company{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_customers_list(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Lists 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
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The ID of the reseller partner.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): The maximum number of results to be returned. If not specified or 0, all
the records are returned.
- :pageToken (String.t): A token identifying a page of results returned by the server.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.ListCustomersResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_claim(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The ID of the reseller partner.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.ClaimDeviceRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.ClaimDeviceResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_claim_async(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The ID of the reseller partner.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.ClaimDevicesRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_find_by_identifier(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Finds devices by hardware identifiers, such as IMEI.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The ID of the reseller partner.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByDeviceIdentifierRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByDeviceIdentifierResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_find_by_owner(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Finds devices claimed for customers. The results only contain devices
registered to the reseller that's identified by the partnerId
argument.
The customer's devices purchased from other resellers don't appear in the
results.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The ID of the reseller partner.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByOwnerRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.FindDevicesByOwnerResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_get(connection, name, optional_params \\ [], opts \\ []) View Source
Gets a device.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- name (String.t): Required. The device API resource name in the format
partners/[PARTNER_ID]/devices/[DEVICE_ID]
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Device{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_metadata(connection, metadata_owner_id, device_id, optional_params \\ [], opts \\ []) View Source
Updates reseller metadata associated with the device.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- metadata_owner_id (String.t): Required. The owner of the newly set metadata. Set this to the partner ID.
- device_id (String.t): Required. The ID of the device.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.UpdateDeviceMetadataRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.DeviceMetadata{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_unclaim(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Unclaims a device from a customer and removes it from zero-touch enrollment.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The ID of the reseller partner.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.UnclaimDeviceRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_unclaim_async(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read Long‑running batch operations.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The reseller partner ID.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.UnclaimDevicesRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_devices_update_metadata_async(connection, partner_id, optional_params \\ [], opts \\ []) View Source
Updates the reseller metadata attached to a batch of devices. This method
updates devices asynchronously and returns an Operation
that can be used
to track progress. Read Long‑running batch
operations.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- partner_id (String.t): Required. The reseller partner ID.
optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.UpdateDeviceMetadataInBatchRequest.t):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Operation{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_vendors_customers_list(connection, parent, optional_params \\ [], opts \\ []) View Source
Lists the customers of the vendor.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- parent (String.t): Required. The resource name in the format
partners/[PARTNER_ID]/vendors/[VENDOR_ID]
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): The maximum number of results to be returned.
- :pageToken (String.t): A token identifying a page of results returned by the server.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.ListVendorCustomersResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_partners_vendors_list(connection, parent, optional_params \\ [], opts \\ []) View Source
Lists the vendors of the partner.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
- parent (String.t): Required. The resource name in the format
partners/[PARTNER_ID]
. optional_params (keyword()): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (integer()): The maximum number of results to be returned.
- :pageToken (String.t): A token identifying a page of results returned by the server.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.ListVendorsResponse{}} on success {:error, info} on failure