ClaimDeviceRequest: Request message to claim a device on behalf of a customer.
type ClaimDeviceRequest struct {
// ConfigurationId: Optional. The ID of the configuration applied to the device
// section.
ConfigurationId int64 `json:"configurationId,omitempty,string"`
// CustomerId: The ID of the customer for whom the device is being claimed.
CustomerId int64 `json:"customerId,omitempty,string"`
// DeviceIdentifier: Required. Required. The device identifier of the device to
// claim.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// DeviceMetadata: Optional. The metadata to attach to the device.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// GoogleWorkspaceCustomerId: The Google Workspace customer ID.
GoogleWorkspaceCustomerId string `json:"googleWorkspaceCustomerId,omitempty"`
// PreProvisioningToken: Optional. Must and can only be set for Chrome OS
// devices.
PreProvisioningToken string `json:"preProvisioningToken,omitempty"`
// SectionType: Required. The section type of the device's provisioning record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
// "SECTION_TYPE_SIM_LOCK" - SIM-lock section type.
// "SECTION_TYPE_ZERO_TOUCH" - Zero-touch enrollment section type.
SectionType string `json:"sectionType,omitempty"`
// SimlockProfileId: Optional. Must and can only be set when
// DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique
// identifier of the SimLock profile.
SimlockProfileId int64 `json:"simlockProfileId,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "ConfigurationId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConfigurationId") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ClaimDeviceRequest) MarshalJSON() ([]byte, error)
ClaimDeviceResponse: Response message containing device id of the claim.
type ClaimDeviceResponse struct {
// DeviceId: The device ID of the claimed device.
DeviceId int64 `json:"deviceId,omitempty,string"`
// DeviceName: The resource name of the device in the format
// `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
DeviceName string `json:"deviceName,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ClaimDeviceResponse) MarshalJSON() ([]byte, error)
ClaimDevicesRequest: Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.
type ClaimDevicesRequest struct {
// Claims: Required. A list of device claims.
Claims []*PartnerClaim `json:"claims,omitempty"`
// ForceSendFields is a list of field names (e.g. "Claims") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Claims") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ClaimDevicesRequest) MarshalJSON() ([]byte, error)
Company: A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
type Company struct {
// AdminEmails: Optional. Email address of customer's users in the admin role.
// Each email address must be associated with a Google Account.
AdminEmails []string `json:"adminEmails,omitempty"`
// CompanyId: Output only. The ID of the company. Assigned by the server.
CompanyId int64 `json:"companyId,omitempty,string"`
// CompanyName: Required. The name of the company. For example _XYZ Corp_.
// Displayed to the company's employees in the zero-touch enrollment portal.
CompanyName string `json:"companyName,omitempty"`
// GoogleWorkspaceAccount: Output only. The Google Workspace account associated
// with this customer. Only used for customer Companies.
GoogleWorkspaceAccount *GoogleWorkspaceAccount `json:"googleWorkspaceAccount,omitempty"`
// LanguageCode: Input only. The preferred locale of the customer represented
// as a BCP47 language code. This field is validated on input and requests
// containing unsupported language codes will be rejected. Supported language
// codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN)
// Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK)
// (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German
// (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it)
// Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese
// (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es)
// Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr)
// Ukrainian (uk) Vietnamese (vi)
LanguageCode string `json:"languageCode,omitempty"`
// Name: Output only. The API resource name of the company. The resource name
// is one of the following formats: *
// `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` *
// `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` *
// `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned
// by the server.
Name string `json:"name,omitempty"`
// OwnerEmails: Required. Input only. Email address of customer's users in the
// owner role. At least one `owner_email` is required. Owners share the same
// access as admins but can also add, delete, and edit your organization's
// portal users.
OwnerEmails []string `json:"ownerEmails,omitempty"`
// SkipWelcomeEmail: Input only. If set to true, welcome email will not be sent
// to the customer. It is recommended to skip the welcome email if devices will
// be claimed with additional DEVICE_PROTECTION service, as the customer will
// receive separate emails at device claim time. This field is ignored if this
// is not a Zero-touch customer.
SkipWelcomeEmail bool `json:"skipWelcomeEmail,omitempty"`
// TermsStatus: Output only. Whether any user from the company has accepted the
// latest Terms of Service (ToS). See TermsStatus.
//
// Possible values:
// "TERMS_STATUS_UNSPECIFIED" - Default value. This value should never be set
// if the enum is present.
// "TERMS_STATUS_NOT_ACCEPTED" - None of the company's users have accepted
// the ToS.
// "TERMS_STATUS_ACCEPTED" - One (or more) of the company's users has
// accepted the ToS.
// "TERMS_STATUS_STALE" - None of the company's users has accepted the
// current ToS but at least one user accepted a previous ToS.
TermsStatus string `json:"termsStatus,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdminEmails") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdminEmails") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Company) MarshalJSON() ([]byte, error)
Configuration: A configuration collects the provisioning options for Android devices. Each configuration combines the following: * The EMM device policy controller (DPC) installed on the devices. * EMM policies enforced on the devices. * Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases.
type Configuration struct {
// CompanyName: Required. The name of the organization. Zero-touch enrollment
// shows this organization name to device users during device provisioning.
CompanyName string `json:"companyName,omitempty"`
// ConfigurationId: Output only. The ID of the configuration. Assigned by the
// server.
ConfigurationId int64 `json:"configurationId,omitempty,string"`
// ConfigurationName: Required. A short name that describes the configuration's
// purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch
// enrollment portal displays this name to IT admins.
ConfigurationName string `json:"configurationName,omitempty"`
// ContactEmail: Required. The email address that device users can contact to
// get help. Zero-touch enrollment shows this email address to device users
// before device provisioning. The value is validated on input.
ContactEmail string `json:"contactEmail,omitempty"`
// ContactPhone: Required. The telephone number that device users can call,
// using another device, to get help. Zero-touch enrollment shows this number
// to device users before device provisioning. Accepts numerals, spaces, the
// plus sign, hyphens, and parentheses.
ContactPhone string `json:"contactPhone,omitempty"`
// CustomMessage: A message, containing one or two sentences, to help device
// users get help or give them more details about what’s happening to their
// device. Zero-touch enrollment shows this message before the device is
// provisioned.
CustomMessage string `json:"customMessage,omitempty"`
// DpcExtras: The JSON-formatted EMM provisioning extras that are passed to the
// DPC.
DpcExtras string `json:"dpcExtras,omitempty"`
// DpcResourcePath: Required. The resource name of the selected DPC (device
// policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list
// the supported DPCs, call `customers.dpcs.list`.
DpcResourcePath string `json:"dpcResourcePath,omitempty"`
// ForcedResetTime: Optional. The timeout before forcing factory reset the
// device if the device doesn't go through provisioning in the setup wizard,
// usually due to lack of network connectivity during setup wizard. Ranges from
// 0-6 hours, with 2 hours being the default if unset.
ForcedResetTime string `json:"forcedResetTime,omitempty"`
// IsDefault: Required. Whether this is the default configuration that
// zero-touch enrollment applies to any new devices the organization purchases
// in the future. Only one customer configuration can be the default. Setting
// this value to `true`, changes the previous default configuration's
// `isDefault` value to `false`.
IsDefault bool `json:"isDefault,omitempty"`
// Name: Output only. The API resource name in the format
// `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the
// server.
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CompanyName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CompanyName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Configuration) MarshalJSON() ([]byte, error)
CreateCustomerRequest: Request message to create a customer.
type CreateCustomerRequest struct {
// Customer: Required. The company data to populate the new customer. Must
// contain a value for `companyName` and at least one `owner_email` that's
// associated with a Google Account. The values for `companyId` and `name` must
// be empty.
Customer *Company `json:"customer,omitempty"`
// ForceSendFields is a list of field names (e.g. "Customer") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Customer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CreateCustomerRequest) MarshalJSON() ([]byte, error)
CustomerApplyConfigurationRequest: Request message for customer to assign a configuration to device.
type CustomerApplyConfigurationRequest struct {
// Configuration: Required. The configuration applied to the device in the
// format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
Configuration string `json:"configuration,omitempty"`
// Device: Required. The device the configuration is applied to. There are
// custom validations in ApplyConfigurationRequestValidator
Device *DeviceReference `json:"device,omitempty"`
// ForceSendFields is a list of field names (e.g. "Configuration") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Configuration") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerApplyConfigurationRequest) MarshalJSON() ([]byte, error)
CustomerListConfigurationsResponse: Response message of customer's listing configuration.
type CustomerListConfigurationsResponse struct {
// Configurations: The configurations.
Configurations []*Configuration `json:"configurations,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Configurations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Configurations") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerListConfigurationsResponse) MarshalJSON() ([]byte, error)
CustomerListCustomersResponse: Response message for listing my customers.
type CustomerListCustomersResponse struct {
// Customers: The customer accounts the calling user is a member of.
Customers []*Company `json:"customers,omitempty"`
// NextPageToken: A token used to access the next page of results. Omitted if
// no further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Customers") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Customers") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerListCustomersResponse) MarshalJSON() ([]byte, error)
CustomerListDevicesResponse: Response message of customer's liting devices.
type CustomerListDevicesResponse struct {
// Devices: The customer's devices.
Devices []*Device `json:"devices,omitempty"`
// NextPageToken: A token used to access the next page of results. Omitted if
// no further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Devices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerListDevicesResponse) MarshalJSON() ([]byte, error)
CustomerListDpcsResponse: Response message of customer's listing DPCs.
type CustomerListDpcsResponse struct {
// Dpcs: The list of DPCs available to the customer that support zero-touch
// enrollment.
Dpcs []*Dpc `json:"dpcs,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Dpcs") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Dpcs") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerListDpcsResponse) MarshalJSON() ([]byte, error)
CustomerRemoveConfigurationRequest: Request message for customer to remove the configuration from device.
type CustomerRemoveConfigurationRequest struct {
// Device: Required. The device to remove the configuration from. There are
// custom validations in RemoveConfigurationRequestValidator
Device *DeviceReference `json:"device,omitempty"`
// ForceSendFields is a list of field names (e.g. "Device") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Device") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerRemoveConfigurationRequest) MarshalJSON() ([]byte, error)
CustomerUnclaimDeviceRequest: Request message for customer to unclaim a device.
type CustomerUnclaimDeviceRequest struct {
// Device: Required. The device to unclaim. There are custom validations in
// UnclaimDeviceRequestValidator.
Device *DeviceReference `json:"device,omitempty"`
// ForceSendFields is a list of field names (e.g. "Device") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Device") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerUnclaimDeviceRequest) MarshalJSON() ([]byte, error)
type CustomersConfigurationsCreateCall struct {
// contains filtered or unexported fields
}
func (c *CustomersConfigurationsCreateCall) Context(ctx context.Context) *CustomersConfigurationsCreateCall
Context sets the context to be used in this call's Do method.
func (c *CustomersConfigurationsCreateCall) Do(opts ...googleapi.CallOption) (*Configuration, error)
Do executes the "androiddeviceprovisioning.customers.configurations.create" call. Any non-2xx status code is an error. Response headers are in either *Configuration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersConfigurationsCreateCall) Fields(s ...googleapi.Field) *CustomersConfigurationsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersConfigurationsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type CustomersConfigurationsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *CustomersConfigurationsDeleteCall) Context(ctx context.Context) *CustomersConfigurationsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *CustomersConfigurationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "androiddeviceprovisioning.customers.configurations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersConfigurationsDeleteCall) Fields(s ...googleapi.Field) *CustomersConfigurationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersConfigurationsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type CustomersConfigurationsGetCall struct {
// contains filtered or unexported fields
}
func (c *CustomersConfigurationsGetCall) Context(ctx context.Context) *CustomersConfigurationsGetCall
Context sets the context to be used in this call's Do method.
func (c *CustomersConfigurationsGetCall) Do(opts ...googleapi.CallOption) (*Configuration, error)
Do executes the "androiddeviceprovisioning.customers.configurations.get" call. Any non-2xx status code is an error. Response headers are in either *Configuration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersConfigurationsGetCall) Fields(s ...googleapi.Field) *CustomersConfigurationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersConfigurationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersConfigurationsGetCall) IfNoneMatch(entityTag string) *CustomersConfigurationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type CustomersConfigurationsListCall struct {
// contains filtered or unexported fields
}
func (c *CustomersConfigurationsListCall) Context(ctx context.Context) *CustomersConfigurationsListCall
Context sets the context to be used in this call's Do method.
func (c *CustomersConfigurationsListCall) Do(opts ...googleapi.CallOption) (*CustomerListConfigurationsResponse, error)
Do executes the "androiddeviceprovisioning.customers.configurations.list" call. Any non-2xx status code is an error. Response headers are in either *CustomerListConfigurationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersConfigurationsListCall) Fields(s ...googleapi.Field) *CustomersConfigurationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersConfigurationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersConfigurationsListCall) IfNoneMatch(entityTag string) *CustomersConfigurationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type CustomersConfigurationsPatchCall struct {
// contains filtered or unexported fields
}
func (c *CustomersConfigurationsPatchCall) Context(ctx context.Context) *CustomersConfigurationsPatchCall
Context sets the context to be used in this call's Do method.
func (c *CustomersConfigurationsPatchCall) Do(opts ...googleapi.CallOption) (*Configuration, error)
Do executes the "androiddeviceprovisioning.customers.configurations.patch" call. Any non-2xx status code is an error. Response headers are in either *Configuration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersConfigurationsPatchCall) Fields(s ...googleapi.Field) *CustomersConfigurationsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersConfigurationsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersConfigurationsPatchCall) UpdateMask(updateMask string) *CustomersConfigurationsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read FieldMask (/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation.
type CustomersConfigurationsService struct {
// contains filtered or unexported fields
}
func NewCustomersConfigurationsService(s *Service) *CustomersConfigurationsService
func (r *CustomersConfigurationsService) Create(parent string, configuration *Configuration) *CustomersConfigurationsCreateCall
Create: Creates a new configuration. Once created, a customer can apply the configuration to devices.
func (r *CustomersConfigurationsService) Delete(name string) *CustomersConfigurationsDeleteCall
Delete: Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.
func (r *CustomersConfigurationsService) Get(name string) *CustomersConfigurationsGetCall
Get: Gets the details of a configuration.
func (r *CustomersConfigurationsService) List(parent string) *CustomersConfigurationsListCall
List: Lists a customer's configurations.
func (r *CustomersConfigurationsService) Patch(name string, configuration *Configuration) *CustomersConfigurationsPatchCall
Patch: Updates a configuration's field values.
type CustomersDevicesApplyConfigurationCall struct {
// contains filtered or unexported fields
}
func (c *CustomersDevicesApplyConfigurationCall) Context(ctx context.Context) *CustomersDevicesApplyConfigurationCall
Context sets the context to be used in this call's Do method.
func (c *CustomersDevicesApplyConfigurationCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "androiddeviceprovisioning.customers.devices.applyConfiguration" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersDevicesApplyConfigurationCall) Fields(s ...googleapi.Field) *CustomersDevicesApplyConfigurationCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersDevicesApplyConfigurationCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type CustomersDevicesGetCall struct {
// contains filtered or unexported fields
}
func (c *CustomersDevicesGetCall) Context(ctx context.Context) *CustomersDevicesGetCall
Context sets the context to be used in this call's Do method.
func (c *CustomersDevicesGetCall) Do(opts ...googleapi.CallOption) (*Device, error)
Do executes the "androiddeviceprovisioning.customers.devices.get" call. Any non-2xx status code is an error. Response headers are in either *Device.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersDevicesGetCall) Fields(s ...googleapi.Field) *CustomersDevicesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersDevicesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersDevicesGetCall) IfNoneMatch(entityTag string) *CustomersDevicesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type CustomersDevicesListCall struct {
// contains filtered or unexported fields
}
func (c *CustomersDevicesListCall) Context(ctx context.Context) *CustomersDevicesListCall
Context sets the context to be used in this call's Do method.
func (c *CustomersDevicesListCall) Do(opts ...googleapi.CallOption) (*CustomerListDevicesResponse, error)
Do executes the "androiddeviceprovisioning.customers.devices.list" call. Any non-2xx status code is an error. Response headers are in either *CustomerListDevicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersDevicesListCall) Fields(s ...googleapi.Field) *CustomersDevicesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersDevicesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersDevicesListCall) IfNoneMatch(entityTag string) *CustomersDevicesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *CustomersDevicesListCall) PageSize(pageSize int64) *CustomersDevicesListCall
PageSize sets the optional parameter "pageSize": The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
func (c *CustomersDevicesListCall) PageToken(pageToken string) *CustomersDevicesListCall
PageToken sets the optional parameter "pageToken": A token specifying which result page to return.
func (c *CustomersDevicesListCall) Pages(ctx context.Context, f func(*CustomerListDevicesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type CustomersDevicesRemoveConfigurationCall struct {
// contains filtered or unexported fields
}
func (c *CustomersDevicesRemoveConfigurationCall) Context(ctx context.Context) *CustomersDevicesRemoveConfigurationCall
Context sets the context to be used in this call's Do method.
func (c *CustomersDevicesRemoveConfigurationCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "androiddeviceprovisioning.customers.devices.removeConfiguration" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersDevicesRemoveConfigurationCall) Fields(s ...googleapi.Field) *CustomersDevicesRemoveConfigurationCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersDevicesRemoveConfigurationCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type CustomersDevicesService struct {
// contains filtered or unexported fields
}
func NewCustomersDevicesService(s *Service) *CustomersDevicesService
func (r *CustomersDevicesService) ApplyConfiguration(parent string, customerapplyconfigurationrequest *CustomerApplyConfigurationRequest) *CustomersDevicesApplyConfigurationCall
ApplyConfiguration: Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.
func (r *CustomersDevicesService) Get(name string) *CustomersDevicesGetCall
Get: Gets the details of a device.
func (r *CustomersDevicesService) List(parent string) *CustomersDevicesListCall
List: Lists a customer's devices.
func (r *CustomersDevicesService) RemoveConfiguration(parent string, customerremoveconfigurationrequest *CustomerRemoveConfigurationRequest) *CustomersDevicesRemoveConfigurationCall
RemoveConfiguration: Removes a configuration from device.
func (r *CustomersDevicesService) Unclaim(parent string, customerunclaimdevicerequest *CustomerUnclaimDeviceRequest) *CustomersDevicesUnclaimCall
Unclaim: Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.
type CustomersDevicesUnclaimCall struct {
// contains filtered or unexported fields
}
func (c *CustomersDevicesUnclaimCall) Context(ctx context.Context) *CustomersDevicesUnclaimCall
Context sets the context to be used in this call's Do method.
func (c *CustomersDevicesUnclaimCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "androiddeviceprovisioning.customers.devices.unclaim" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersDevicesUnclaimCall) Fields(s ...googleapi.Field) *CustomersDevicesUnclaimCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersDevicesUnclaimCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type CustomersDpcsListCall struct {
// contains filtered or unexported fields
}
func (c *CustomersDpcsListCall) Context(ctx context.Context) *CustomersDpcsListCall
Context sets the context to be used in this call's Do method.
func (c *CustomersDpcsListCall) Do(opts ...googleapi.CallOption) (*CustomerListDpcsResponse, error)
Do executes the "androiddeviceprovisioning.customers.dpcs.list" call. Any non-2xx status code is an error. Response headers are in either *CustomerListDpcsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersDpcsListCall) Fields(s ...googleapi.Field) *CustomersDpcsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersDpcsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersDpcsListCall) IfNoneMatch(entityTag string) *CustomersDpcsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type CustomersDpcsService struct {
// contains filtered or unexported fields
}
func NewCustomersDpcsService(s *Service) *CustomersDpcsService
func (r *CustomersDpcsService) List(parent string) *CustomersDpcsListCall
List: Lists the DPCs (device policy controllers) that support zero-touch enrollment.
type CustomersListCall struct {
// contains filtered or unexported fields
}
func (c *CustomersListCall) Context(ctx context.Context) *CustomersListCall
Context sets the context to be used in this call's Do method.
func (c *CustomersListCall) Do(opts ...googleapi.CallOption) (*CustomerListCustomersResponse, error)
Do executes the "androiddeviceprovisioning.customers.list" call. Any non-2xx status code is an error. Response headers are in either *CustomerListCustomersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *CustomersListCall) Fields(s ...googleapi.Field) *CustomersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *CustomersListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *CustomersListCall) IfNoneMatch(entityTag string) *CustomersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *CustomersListCall) PageSize(pageSize int64) *CustomersListCall
PageSize sets the optional parameter "pageSize": The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).
func (c *CustomersListCall) PageToken(pageToken string) *CustomersListCall
PageToken sets the optional parameter "pageToken": A token specifying which result page to return. This field has custom validations in ListCustomersRequestValidator
func (c *CustomersListCall) Pages(ctx context.Context, f func(*CustomerListCustomersResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type CustomersService struct {
Configurations *CustomersConfigurationsService
Devices *CustomersDevicesService
Dpcs *CustomersDpcsService
// contains filtered or unexported fields
}
func NewCustomersService(s *Service) *CustomersService
func (r *CustomersService) List() *CustomersListCall
List: Lists the user's customer accounts.
Device: An Android or Chrome OS device registered for zero-touch enrollment.
type Device struct {
// Claims: Output only. The provisioning claims for a device. Devices claimed
// for zero-touch enrollment have a claim with the type
// `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or
// `partners.devices.unclaimAsync` to remove the device from zero-touch
// enrollment.
Claims []*DeviceClaim `json:"claims,omitempty"`
// Configuration: Not available to resellers.
Configuration string `json:"configuration,omitempty"`
// DeviceId: Output only. The ID of the device. Assigned by the server.
DeviceId int64 `json:"deviceId,omitempty,string"`
// DeviceIdentifier: The hardware IDs that identify a manufactured device. To
// learn more, read Identifiers
// (https://developers.google.com/zero-touch/guides/identifiers).
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// DeviceMetadata: The metadata attached to the device. Structured as key-value
// pairs. To learn more, read Device metadata
// (https://developers.google.com/zero-touch/guides/metadata).
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// Name: Output only. The API resource name in the format
// `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Claims") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Claims") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Device) MarshalJSON() ([]byte, error)
DeviceClaim: A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read Claim devices for customers (/zero-touch/guides/how-it-works#claim).
type DeviceClaim struct {
// AdditionalService: The Additional service registered for the device.
//
// Possible values:
// "ADDITIONAL_SERVICE_UNSPECIFIED" - No additional service.
// "DEVICE_PROTECTION" - Device protection service, also known as Android
// Enterprise Essentials. To claim a device with the device protection service
// you must enroll with the partnership team.
AdditionalService string `json:"additionalService,omitempty"`
// GoogleWorkspaceCustomerId: The ID of the Google Workspace account that owns
// the Chrome OS device.
GoogleWorkspaceCustomerId string `json:"googleWorkspaceCustomerId,omitempty"`
// OwnerCompanyId: The ID of the Customer that purchased the device.
OwnerCompanyId int64 `json:"ownerCompanyId,omitempty,string"`
// ResellerId: The ID of the reseller that claimed the device.
ResellerId int64 `json:"resellerId,omitempty,string"`
// SectionType: Output only. The type of claim made on the device.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
// "SECTION_TYPE_SIM_LOCK" - SIM-lock section type.
// "SECTION_TYPE_ZERO_TOUCH" - Zero-touch enrollment section type.
SectionType string `json:"sectionType,omitempty"`
// VacationModeExpireTime: The timestamp when the device will exit ‘vacation
// mode’. This value is present iff the device is in 'vacation mode'.
VacationModeExpireTime string `json:"vacationModeExpireTime,omitempty"`
// VacationModeStartTime: The timestamp when the device was put into
// ‘vacation mode’. This value is present iff the device is in 'vacation
// mode'.
VacationModeStartTime string `json:"vacationModeStartTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdditionalService") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AdditionalService") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceClaim) MarshalJSON() ([]byte, error)
DeviceIdentifier: Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers (https://developers.google.com/zero-touch/guides/identifiers).
type DeviceIdentifier struct {
// ChromeOsAttestedDeviceId: An identifier provided by OEMs, carried through
// the production and sales process. Only applicable to Chrome OS devices.
ChromeOsAttestedDeviceId string `json:"chromeOsAttestedDeviceId,omitempty"`
// DeviceType: The type of the device
//
// Possible values:
// "DEVICE_TYPE_UNSPECIFIED" - Device type is not specified.
// "DEVICE_TYPE_ANDROID" - Android device
// "DEVICE_TYPE_CHROME_OS" - Chrome OS device
DeviceType string `json:"deviceType,omitempty"`
// Imei: The device’s IMEI number. Validated on input.
Imei string `json:"imei,omitempty"`
// Manufacturer: The device manufacturer’s name. Matches the device's
// built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values
// are listed in Android manufacturers
// (/zero-touch/resources/manufacturer-names#manufacturers-names).
Manufacturer string `json:"manufacturer,omitempty"`
// Meid: The device’s MEID number.
Meid string `json:"meid,omitempty"`
// Model: The device model's name. Allowed values are listed in Android models
// (/zero-touch/resources/manufacturer-names#model-names) and Chrome OS models
// (https://support.google.com/chrome/a/answer/10130175#identify_compatible).
Model string `json:"model,omitempty"`
// SerialNumber: The manufacturer's serial number for the device. This value
// might not be unique across different device models.
SerialNumber string `json:"serialNumber,omitempty"`
// ForceSendFields is a list of field names (e.g. "ChromeOsAttestedDeviceId")
// to unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ChromeOsAttestedDeviceId") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceIdentifier) MarshalJSON() ([]byte, error)
DeviceMetadata: Metadata entries that can be attached to a `Device`. To learn more, read Device metadata (https://developers.google.com/zero-touch/guides/metadata).
type DeviceMetadata struct {
// Entries: Metadata entries recorded as key-value pairs.
Entries map[string]string `json:"entries,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Entries") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Entries") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceMetadata) MarshalJSON() ([]byte, error)
DeviceReference: A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read Identifiers (https://developers.google.com/zero-touch/guides/identifiers).
type DeviceReference struct {
// DeviceId: The ID of the device.
DeviceId int64 `json:"deviceId,omitempty,string"`
// DeviceIdentifier: The hardware IDs of the device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeviceReference) MarshalJSON() ([]byte, error)
DevicesLongRunningOperationMetadata: Tracks the status of a long-running operation to asynchronously update a batch of reseller metadata attached to devices. To learn more, read Long‑running batch operations (/zero-touch/guides/how-it-works#operations).
type DevicesLongRunningOperationMetadata struct {
// DevicesCount: The number of metadata updates in the operation. This might be
// different from the number of updates in the request if the API can't parse
// some of the updates.
DevicesCount int64 `json:"devicesCount,omitempty"`
// ProcessingStatus: The processing status of the operation.
//
// Possible values:
// "BATCH_PROCESS_STATUS_UNSPECIFIED" - Invalid code. Shouldn't be used.
// "BATCH_PROCESS_PENDING" - Pending.
// "BATCH_PROCESS_IN_PROGRESS" - In progress.
// "BATCH_PROCESS_PROCESSED" - Processed. This doesn't mean all items were
// processed successfully, you should check the `response` field for the result
// of every item.
ProcessingStatus string `json:"processingStatus,omitempty"`
// Progress: The processing progress of the operation. Measured as a number
// from 0 to 100. A value of 10O doesn't always mean the operation
// completed—check for the inclusion of a `done` field.
Progress int64 `json:"progress,omitempty"`
// ForceSendFields is a list of field names (e.g. "DevicesCount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DevicesCount") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DevicesLongRunningOperationMetadata) MarshalJSON() ([]byte, error)
DevicesLongRunningOperationResponse: Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read Long‑running batch operations (/zero-touch/guides/how-it-works#operations).
type DevicesLongRunningOperationResponse struct {
// PerDeviceStatus: The processing status for each device in the operation. One
// `PerDeviceStatus` per device. The list order matches the items in the
// original request.
PerDeviceStatus []*OperationPerDevice `json:"perDeviceStatus,omitempty"`
// SuccessCount: A summary of how many items in the operation the server
// processed successfully. Updated as the operation progresses.
SuccessCount int64 `json:"successCount,omitempty"`
// ForceSendFields is a list of field names (e.g. "PerDeviceStatus") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PerDeviceStatus") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DevicesLongRunningOperationResponse) MarshalJSON() ([]byte, error)
Dpc: An EMM's DPC (device policy controller (http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play.
type Dpc struct {
// DpcName: Output only. The title of the DPC app in Google Play. For example,
// _Google Apps Device Policy_. Useful in an application's user interface.
DpcName string `json:"dpcName,omitempty"`
// Name: Output only. The API resource name in the format
// `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain
// a reference to a DPC across customer accounts, persist and match the last
// path component (`DPC_ID`).
Name string `json:"name,omitempty"`
// PackageName: Output only. The DPC's Android application ID that looks like a
// Java package name. Zero-touch enrollment installs the DPC app onto a device
// using this identifier.
PackageName string `json:"packageName,omitempty"`
// ForceSendFields is a list of field names (e.g. "DpcName") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DpcName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Dpc) MarshalJSON() ([]byte, error)
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
FindDevicesByDeviceIdentifierRequest: Request to find devices.
type FindDevicesByDeviceIdentifierRequest struct {
// DeviceIdentifier: Required. Required. The device identifier to search for.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// Limit: Required. The maximum number of devices to show in a page of results.
// Must be between 1 and 100 inclusive.
Limit int64 `json:"limit,omitempty,string"`
// PageToken: A token specifying which result page to return.
PageToken string `json:"pageToken,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceIdentifier") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceIdentifier") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FindDevicesByDeviceIdentifierRequest) MarshalJSON() ([]byte, error)
FindDevicesByDeviceIdentifierResponse: Response containing found devices.
type FindDevicesByDeviceIdentifierResponse struct {
// Devices: Found devices.
Devices []*Device `json:"devices,omitempty"`
// NextPageToken: A token used to access the next page of results. Omitted if
// no further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalSize: The total count of items in the list irrespective of pagination.
TotalSize int64 `json:"totalSize,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Devices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FindDevicesByDeviceIdentifierResponse) MarshalJSON() ([]byte, error)
FindDevicesByOwnerRequest: Request to find devices by customers.
type FindDevicesByOwnerRequest struct {
// CustomerId: The list of customer IDs to search for.
CustomerId googleapi.Int64s `json:"customerId,omitempty"`
// GoogleWorkspaceCustomerId: The list of IDs of Google Workspace accounts to
// search for.
GoogleWorkspaceCustomerId []string `json:"googleWorkspaceCustomerId,omitempty"`
// Limit: Required. The maximum number of devices to show in a page of results.
// Must be between 1 and 100 inclusive.
Limit int64 `json:"limit,omitempty,string"`
// PageToken: A token specifying which result page to return.
PageToken string `json:"pageToken,omitempty"`
// SectionType: Required. The section type of the device's provisioning record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
// "SECTION_TYPE_SIM_LOCK" - SIM-lock section type.
// "SECTION_TYPE_ZERO_TOUCH" - Zero-touch enrollment section type.
SectionType string `json:"sectionType,omitempty"`
// ForceSendFields is a list of field names (e.g. "CustomerId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CustomerId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FindDevicesByOwnerRequest) MarshalJSON() ([]byte, error)
FindDevicesByOwnerResponse: Response containing found devices.
type FindDevicesByOwnerResponse struct {
// Devices: The customer's devices.
Devices []*Device `json:"devices,omitempty"`
// NextPageToken: A token used to access the next page of results. Omitted if
// no further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalSize: The total count of items in the list irrespective of pagination.
TotalSize int64 `json:"totalSize,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Devices") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Devices") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FindDevicesByOwnerResponse) MarshalJSON() ([]byte, error)
GetDeviceSimLockStateRequest: Request to get a device's SIM lock status.
type GetDeviceSimLockStateRequest struct {
// DeviceIdentifier: Required. Required. The device identifier to search for.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceIdentifier") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceIdentifier") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetDeviceSimLockStateRequest) MarshalJSON() ([]byte, error)
GetDeviceSimLockStateResponse: Response containing a device's SimLock state.
type GetDeviceSimLockStateResponse struct {
// Possible values:
// "SIM_LOCK_STATE_UNSPECIFIED" - Invalid code. Shouldn't be used.
// "UNLOCKED" - Device is not SIM locked.
// "LOCKED_TO_PARTNER" - Device is SIM locked to the partner querying SIM
// lock state.
// "LOCKED_TO_OTHER_PARTNER" - Device is SIM locked to a different partner.
SimLockState string `json:"simLockState,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "SimLockState") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SimLockState") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetDeviceSimLockStateResponse) MarshalJSON() ([]byte, error)
GoogleWorkspaceAccount: A Google Workspace customer.
type GoogleWorkspaceAccount struct {
// CustomerId: Required. The customer ID.
CustomerId string `json:"customerId,omitempty"`
// PreProvisioningTokens: Output only. The pre-provisioning tokens previously
// used to claim devices.
PreProvisioningTokens []string `json:"preProvisioningTokens,omitempty"`
// ForceSendFields is a list of field names (e.g. "CustomerId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CustomerId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleWorkspaceAccount) MarshalJSON() ([]byte, error)
ListCustomersResponse: Response message of all customers related to this partner.
type ListCustomersResponse struct {
// Customers: List of customers related to this reseller partner.
Customers []*Company `json:"customers,omitempty"`
// NextPageToken: A token to retrieve the next page of results. Omitted if no
// further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalSize: The total count of items in the list irrespective of pagination.
TotalSize int64 `json:"totalSize,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Customers") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Customers") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListCustomersResponse) MarshalJSON() ([]byte, error)
ListVendorCustomersResponse: Response message to list customers of the vendor.
type ListVendorCustomersResponse struct {
// Customers: List of customers of the vendor.
Customers []*Company `json:"customers,omitempty"`
// NextPageToken: A token to retrieve the next page of results. Omitted if no
// further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalSize: The total count of items in the list irrespective of pagination.
TotalSize int64 `json:"totalSize,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Customers") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Customers") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListVendorCustomersResponse) MarshalJSON() ([]byte, error)
ListVendorsResponse: Response message to list vendors of the partner.
type ListVendorsResponse struct {
// NextPageToken: A token to retrieve the next page of results. Omitted if no
// further results are available.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalSize: The total count of items in the list irrespective of pagination.
TotalSize int64 `json:"totalSize,omitempty"`
// Vendors: List of vendors of the reseller partner. Fields `name`, `companyId`
// and `companyName` are populated to the Company object.
Vendors []*Company `json:"vendors,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListVendorsResponse) MarshalJSON() ([]byte, error)
Operation: This resource represents a long-running operation that is the result of a network API call.
type Operation struct {
// Done: If the value is `false`, it means the operation is still in progress.
// If `true`, the operation is completed, and either `error` or `response` is
// available.
Done bool `json:"done,omitempty"`
// Error: This field will always be not set if the operation is created by
// `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error
// information for each device is set in
// `response.perDeviceStatus.result.status`.
Error *Status `json:"error,omitempty"`
// Metadata: This field will contain a `DevicesLongRunningOperationMetadata`
// object if the operation is created by `claimAsync`, `unclaimAsync`, or
// `updateMetadataAsync`.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: The server-assigned name, which is only unique within the same service
// that originally returns it. If you use the default HTTP mapping, the `name`
// should be a resource name ending with `operations/{unique_id}`.
Name string `json:"name,omitempty"`
// Response: This field will contain a `DevicesLongRunningOperationResponse`
// object if the operation is created by `claimAsync`, `unclaimAsync`, or
// `updateMetadataAsync`.
Response googleapi.RawMessage `json:"response,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Done") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
OperationPerDevice: A task for each device in the operation. Corresponds to each device change in the request.
type OperationPerDevice struct {
// Claim: A copy of the original device-claim request received by the server.
Claim *PartnerClaim `json:"claim,omitempty"`
// Result: The processing result for each device.
Result *PerDeviceStatusInBatch `json:"result,omitempty"`
// Unclaim: A copy of the original device-unclaim request received by the
// server.
Unclaim *PartnerUnclaim `json:"unclaim,omitempty"`
// UpdateMetadata: A copy of the original metadata-update request received by
// the server.
UpdateMetadata *UpdateMetadataArguments `json:"updateMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "Claim") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Claim") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *OperationPerDevice) MarshalJSON() ([]byte, error)
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "androiddeviceprovisioning.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService(s *Service) *OperationsService
func (r *OperationsService) Get(name string) *OperationsGetCall
Get: 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.
- name: The name of the operation resource.
PartnerClaim: Identifies one claim request.
type PartnerClaim struct {
// ConfigurationId: Optional. The ID of the configuration applied to the device
// section.
ConfigurationId int64 `json:"configurationId,omitempty,string"`
// CustomerId: The ID of the customer for whom the device is being claimed.
CustomerId int64 `json:"customerId,omitempty,string"`
// DeviceIdentifier: Required. Required. Device identifier of the device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// DeviceMetadata: Required. The metadata to attach to the device at claim.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// GoogleWorkspaceCustomerId: The Google Workspace customer ID.
GoogleWorkspaceCustomerId string `json:"googleWorkspaceCustomerId,omitempty"`
// PreProvisioningToken: Optional. Must and can only be set for Chrome OS
// devices.
PreProvisioningToken string `json:"preProvisioningToken,omitempty"`
// SectionType: Required. The section type of the device's provisioning record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
// "SECTION_TYPE_SIM_LOCK" - SIM-lock section type.
// "SECTION_TYPE_ZERO_TOUCH" - Zero-touch enrollment section type.
SectionType string `json:"sectionType,omitempty"`
// SimlockProfileId: Optional. Must and can only be set when
// DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique
// identifier of the SimLock profile.
SimlockProfileId int64 `json:"simlockProfileId,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "ConfigurationId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConfigurationId") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PartnerClaim) MarshalJSON() ([]byte, error)
PartnerUnclaim: Identifies one unclaim request.
type PartnerUnclaim struct {
// DeviceId: Required. Device ID of the device.
DeviceId int64 `json:"deviceId,omitempty,string"`
// DeviceIdentifier: Required. Device identifier of the device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// SectionType: Required. The section type of the device's provisioning record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
// "SECTION_TYPE_SIM_LOCK" - SIM-lock section type.
// "SECTION_TYPE_ZERO_TOUCH" - Zero-touch enrollment section type.
SectionType string `json:"sectionType,omitempty"`
// VacationModeDays: Optional. The duration of the vacation unlock starting
// from when the request is processed. (1 day is treated as 24 hours)
VacationModeDays int64 `json:"vacationModeDays,omitempty"`
// VacationModeExpireTime: Optional. The expiration time of the vacation
// unlock.
VacationModeExpireTime string `json:"vacationModeExpireTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PartnerUnclaim) MarshalJSON() ([]byte, error)
type PartnersCustomersCreateCall struct {
// contains filtered or unexported fields
}
func (c *PartnersCustomersCreateCall) Context(ctx context.Context) *PartnersCustomersCreateCall
Context sets the context to be used in this call's Do method.
func (c *PartnersCustomersCreateCall) Do(opts ...googleapi.CallOption) (*Company, error)
Do executes the "androiddeviceprovisioning.partners.customers.create" call. Any non-2xx status code is an error. Response headers are in either *Company.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersCustomersCreateCall) Fields(s ...googleapi.Field) *PartnersCustomersCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersCustomersCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersCustomersListCall struct {
// contains filtered or unexported fields
}
func (c *PartnersCustomersListCall) Context(ctx context.Context) *PartnersCustomersListCall
Context sets the context to be used in this call's Do method.
func (c *PartnersCustomersListCall) Do(opts ...googleapi.CallOption) (*ListCustomersResponse, error)
Do executes the "androiddeviceprovisioning.partners.customers.list" call. Any non-2xx status code is an error. Response headers are in either *ListCustomersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersCustomersListCall) Fields(s ...googleapi.Field) *PartnersCustomersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersCustomersListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PartnersCustomersListCall) IfNoneMatch(entityTag string) *PartnersCustomersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *PartnersCustomersListCall) PageSize(pageSize int64) *PartnersCustomersListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to be returned. If not specified or 0, all the records are returned.
func (c *PartnersCustomersListCall) PageToken(pageToken string) *PartnersCustomersListCall
PageToken sets the optional parameter "pageToken": A token identifying a page of results returned by the server.
func (c *PartnersCustomersListCall) Pages(ctx context.Context, f func(*ListCustomersResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type PartnersCustomersService struct {
// contains filtered or unexported fields
}
func NewPartnersCustomersService(s *Service) *PartnersCustomersService
func (r *PartnersCustomersService) Create(parent string, createcustomerrequest *CreateCustomerRequest) *PartnersCustomersCreateCall
Create: 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.
func (r *PartnersCustomersService) List(partnerId int64) *PartnersCustomersListCall
List: 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.
- partnerId: The ID of the reseller partner.
type PartnersDevicesClaimAsyncCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesClaimAsyncCall) Context(ctx context.Context) *PartnersDevicesClaimAsyncCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesClaimAsyncCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "androiddeviceprovisioning.partners.devices.claimAsync" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesClaimAsyncCall) Fields(s ...googleapi.Field) *PartnersDevicesClaimAsyncCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesClaimAsyncCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersDevicesClaimCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesClaimCall) Context(ctx context.Context) *PartnersDevicesClaimCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesClaimCall) Do(opts ...googleapi.CallOption) (*ClaimDeviceResponse, error)
Do executes the "androiddeviceprovisioning.partners.devices.claim" call. Any non-2xx status code is an error. Response headers are in either *ClaimDeviceResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesClaimCall) Fields(s ...googleapi.Field) *PartnersDevicesClaimCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesClaimCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersDevicesFindByIdentifierCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesFindByIdentifierCall) Context(ctx context.Context) *PartnersDevicesFindByIdentifierCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesFindByIdentifierCall) Do(opts ...googleapi.CallOption) (*FindDevicesByDeviceIdentifierResponse, error)
Do executes the "androiddeviceprovisioning.partners.devices.findByIdentifier" call. Any non-2xx status code is an error. Response headers are in either *FindDevicesByDeviceIdentifierResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesFindByIdentifierCall) Fields(s ...googleapi.Field) *PartnersDevicesFindByIdentifierCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesFindByIdentifierCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PartnersDevicesFindByIdentifierCall) Pages(ctx context.Context, f func(*FindDevicesByDeviceIdentifierResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type PartnersDevicesFindByOwnerCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesFindByOwnerCall) Context(ctx context.Context) *PartnersDevicesFindByOwnerCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesFindByOwnerCall) Do(opts ...googleapi.CallOption) (*FindDevicesByOwnerResponse, error)
Do executes the "androiddeviceprovisioning.partners.devices.findByOwner" call. Any non-2xx status code is an error. Response headers are in either *FindDevicesByOwnerResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesFindByOwnerCall) Fields(s ...googleapi.Field) *PartnersDevicesFindByOwnerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesFindByOwnerCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PartnersDevicesFindByOwnerCall) Pages(ctx context.Context, f func(*FindDevicesByOwnerResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type PartnersDevicesGetCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesGetCall) Context(ctx context.Context) *PartnersDevicesGetCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesGetCall) Do(opts ...googleapi.CallOption) (*Device, error)
Do executes the "androiddeviceprovisioning.partners.devices.get" call. Any non-2xx status code is an error. Response headers are in either *Device.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesGetCall) Fields(s ...googleapi.Field) *PartnersDevicesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PartnersDevicesGetCall) IfNoneMatch(entityTag string) *PartnersDevicesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type PartnersDevicesGetSimLockStateCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesGetSimLockStateCall) Context(ctx context.Context) *PartnersDevicesGetSimLockStateCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesGetSimLockStateCall) Do(opts ...googleapi.CallOption) (*GetDeviceSimLockStateResponse, error)
Do executes the "androiddeviceprovisioning.partners.devices.getSimLockState" call. Any non-2xx status code is an error. Response headers are in either *GetDeviceSimLockStateResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesGetSimLockStateCall) Fields(s ...googleapi.Field) *PartnersDevicesGetSimLockStateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesGetSimLockStateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersDevicesMetadataCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesMetadataCall) Context(ctx context.Context) *PartnersDevicesMetadataCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesMetadataCall) Do(opts ...googleapi.CallOption) (*DeviceMetadata, error)
Do executes the "androiddeviceprovisioning.partners.devices.metadata" call. Any non-2xx status code is an error. Response headers are in either *DeviceMetadata.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesMetadataCall) Fields(s ...googleapi.Field) *PartnersDevicesMetadataCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesMetadataCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersDevicesService struct {
// contains filtered or unexported fields
}
func NewPartnersDevicesService(s *Service) *PartnersDevicesService
func (r *PartnersDevicesService) Claim(partnerId int64, claimdevicerequest *ClaimDeviceRequest) *PartnersDevicesClaimCall
Claim: 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.
- partnerId: The ID of the reseller partner.
func (r *PartnersDevicesService) ClaimAsync(partnerId int64, claimdevicesrequest *ClaimDevicesRequest) *PartnersDevicesClaimAsyncCall
ClaimAsync: Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read Long‑running batch operations (/zero-touch/guides/how-it-works#operations).
- partnerId: The ID of the reseller partner.
func (r *PartnersDevicesService) FindByIdentifier(partnerId int64, finddevicesbydeviceidentifierrequest *FindDevicesByDeviceIdentifierRequest) *PartnersDevicesFindByIdentifierCall
FindByIdentifier: Finds devices by hardware identifiers, such as IMEI.
- partnerId: The ID of the reseller partner.
func (r *PartnersDevicesService) FindByOwner(partnerId int64, finddevicesbyownerrequest *FindDevicesByOwnerRequest) *PartnersDevicesFindByOwnerCall
FindByOwner: 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.
- partnerId: The ID of the reseller partner.
func (r *PartnersDevicesService) Get(name string) *PartnersDevicesGetCall
Get: Gets a device.
func (r *PartnersDevicesService) GetSimLockState(partnerId int64, getdevicesimlockstaterequest *GetDeviceSimLockStateRequest) *PartnersDevicesGetSimLockStateCall
GetSimLockState: Gets a device's SIM lock state.
- partnerId: The ID of the partner.
func (r *PartnersDevicesService) Metadata(metadataOwnerId int64, deviceId int64, updatedevicemetadatarequest *UpdateDeviceMetadataRequest) *PartnersDevicesMetadataCall
Metadata: Updates reseller metadata associated with the device. Android devices only.
func (r *PartnersDevicesService) Unclaim(partnerId int64, unclaimdevicerequest *UnclaimDeviceRequest) *PartnersDevicesUnclaimCall
Unclaim: Unclaims a device from a customer and removes it from zero-touch enrollment.
- partnerId: The ID of the reseller partner.
func (r *PartnersDevicesService) UnclaimAsync(partnerId int64, unclaimdevicesrequest *UnclaimDevicesRequest) *PartnersDevicesUnclaimAsyncCall
UnclaimAsync: Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read Long‑running batch operations (/zero-touch/guides/how-it-works#operations).
- partnerId: The reseller partner ID.
func (r *PartnersDevicesService) UpdateMetadataAsync(partnerId int64, updatedevicemetadatainbatchrequest *UpdateDeviceMetadataInBatchRequest) *PartnersDevicesUpdateMetadataAsyncCall
UpdateMetadataAsync: 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 (/zero-touch/guides/how-it-works#operations). Android Devices only.
- partnerId: The reseller partner ID.
type PartnersDevicesUnclaimAsyncCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesUnclaimAsyncCall) Context(ctx context.Context) *PartnersDevicesUnclaimAsyncCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesUnclaimAsyncCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "androiddeviceprovisioning.partners.devices.unclaimAsync" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesUnclaimAsyncCall) Fields(s ...googleapi.Field) *PartnersDevicesUnclaimAsyncCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesUnclaimAsyncCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersDevicesUnclaimCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesUnclaimCall) Context(ctx context.Context) *PartnersDevicesUnclaimCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesUnclaimCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "androiddeviceprovisioning.partners.devices.unclaim" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesUnclaimCall) Fields(s ...googleapi.Field) *PartnersDevicesUnclaimCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesUnclaimCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersDevicesUpdateMetadataAsyncCall struct {
// contains filtered or unexported fields
}
func (c *PartnersDevicesUpdateMetadataAsyncCall) Context(ctx context.Context) *PartnersDevicesUpdateMetadataAsyncCall
Context sets the context to be used in this call's Do method.
func (c *PartnersDevicesUpdateMetadataAsyncCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "androiddeviceprovisioning.partners.devices.updateMetadataAsync" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersDevicesUpdateMetadataAsyncCall) Fields(s ...googleapi.Field) *PartnersDevicesUpdateMetadataAsyncCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersDevicesUpdateMetadataAsyncCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PartnersService struct {
Customers *PartnersCustomersService
Devices *PartnersDevicesService
Vendors *PartnersVendorsService
// contains filtered or unexported fields
}
func NewPartnersService(s *Service) *PartnersService
type PartnersVendorsCustomersListCall struct {
// contains filtered or unexported fields
}
func (c *PartnersVendorsCustomersListCall) Context(ctx context.Context) *PartnersVendorsCustomersListCall
Context sets the context to be used in this call's Do method.
func (c *PartnersVendorsCustomersListCall) Do(opts ...googleapi.CallOption) (*ListVendorCustomersResponse, error)
Do executes the "androiddeviceprovisioning.partners.vendors.customers.list" call. Any non-2xx status code is an error. Response headers are in either *ListVendorCustomersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersVendorsCustomersListCall) Fields(s ...googleapi.Field) *PartnersVendorsCustomersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersVendorsCustomersListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PartnersVendorsCustomersListCall) IfNoneMatch(entityTag string) *PartnersVendorsCustomersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *PartnersVendorsCustomersListCall) PageSize(pageSize int64) *PartnersVendorsCustomersListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to be returned.
func (c *PartnersVendorsCustomersListCall) PageToken(pageToken string) *PartnersVendorsCustomersListCall
PageToken sets the optional parameter "pageToken": A token identifying a page of results returned by the server.
func (c *PartnersVendorsCustomersListCall) Pages(ctx context.Context, f func(*ListVendorCustomersResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type PartnersVendorsCustomersService struct {
// contains filtered or unexported fields
}
func NewPartnersVendorsCustomersService(s *Service) *PartnersVendorsCustomersService
func (r *PartnersVendorsCustomersService) List(parent string) *PartnersVendorsCustomersListCall
List: Lists the customers of the vendor.
type PartnersVendorsListCall struct {
// contains filtered or unexported fields
}
func (c *PartnersVendorsListCall) Context(ctx context.Context) *PartnersVendorsListCall
Context sets the context to be used in this call's Do method.
func (c *PartnersVendorsListCall) Do(opts ...googleapi.CallOption) (*ListVendorsResponse, error)
Do executes the "androiddeviceprovisioning.partners.vendors.list" call. Any non-2xx status code is an error. Response headers are in either *ListVendorsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PartnersVendorsListCall) Fields(s ...googleapi.Field) *PartnersVendorsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PartnersVendorsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PartnersVendorsListCall) IfNoneMatch(entityTag string) *PartnersVendorsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *PartnersVendorsListCall) PageSize(pageSize int64) *PartnersVendorsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to be returned.
func (c *PartnersVendorsListCall) PageToken(pageToken string) *PartnersVendorsListCall
PageToken sets the optional parameter "pageToken": A token identifying a page of results returned by the server.
func (c *PartnersVendorsListCall) Pages(ctx context.Context, f func(*ListVendorsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type PartnersVendorsService struct {
Customers *PartnersVendorsCustomersService
// contains filtered or unexported fields
}
func NewPartnersVendorsService(s *Service) *PartnersVendorsService
func (r *PartnersVendorsService) List(parent string) *PartnersVendorsListCall
List: Lists the vendors of the partner.
- parent: The resource name in the format `partners/[PARTNER_ID]`.
PerDeviceStatusInBatch: Captures the processing status for each device in the operation.
type PerDeviceStatusInBatch struct {
// DeviceId: If processing succeeds, the device ID of the device.
DeviceId int64 `json:"deviceId,omitempty,string"`
// ErrorIdentifier: If processing fails, the error type.
ErrorIdentifier string `json:"errorIdentifier,omitempty"`
// ErrorMessage: If processing fails, a developer message explaining what went
// wrong.
ErrorMessage string `json:"errorMessage,omitempty"`
// Status: The result status of the device after processing.
//
// Possible values:
// "SINGLE_DEVICE_STATUS_UNSPECIFIED" - Invalid code. Shouldn't be used.
// "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR" - Unknown error. We don't expect this
// error to occur here.
// "SINGLE_DEVICE_STATUS_OTHER_ERROR" - Other error. We know/expect this
// error, but there's no defined error code for the error.
// "SINGLE_DEVICE_STATUS_SUCCESS" - Success.
// "SINGLE_DEVICE_STATUS_PERMISSION_DENIED" - Permission denied.
// "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER" - Invalid device
// identifier.
// "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE" - Invalid section type.
// "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" - This section is claimed by
// another company.
// "SINGLE_DEVICE_STATUS_INVALID_TOKEN" - Invalid pre-provisioning token.
// "SINGLE_DEVICE_STATUS_REVOKED_TOKEN" - Revoked pre-provisioning token.
// "SINGLE_DEVICE_STATUS_DEVICE_LIMIT_EXCEEDED" - Status used to indicate a
// failure due to a device limit being exceeded
Status string `json:"status,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PerDeviceStatusInBatch) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Customers *CustomersService
Operations *OperationsService
Partners *PartnersService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
type Status struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in English. Any
// user-facing error message should be localized and sent in the
// google.rpc.Status.details field, or localized by the client.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
UnclaimDeviceRequest: Request message to unclaim a device.
type UnclaimDeviceRequest struct {
// DeviceId: Required. The device ID returned by `ClaimDevice`.
DeviceId int64 `json:"deviceId,omitempty,string"`
// DeviceIdentifier: Required. The device identifier you used when you claimed
// this device.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// SectionType: Required. The section type of the device's provisioning record.
//
// Possible values:
// "SECTION_TYPE_UNSPECIFIED" - Unspecified section type.
// "SECTION_TYPE_SIM_LOCK" - SIM-lock section type.
// "SECTION_TYPE_ZERO_TOUCH" - Zero-touch enrollment section type.
SectionType string `json:"sectionType,omitempty"`
// VacationModeDays: The duration of the vacation unlock starting from when the
// request is processed. (1 day is treated as 24 hours)
VacationModeDays int64 `json:"vacationModeDays,omitempty"`
// VacationModeExpireTime: The expiration time of the vacation unlock.
VacationModeExpireTime string `json:"vacationModeExpireTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UnclaimDeviceRequest) MarshalJSON() ([]byte, error)
UnclaimDevicesRequest: Request to unclaim devices asynchronously in batch.
type UnclaimDevicesRequest struct {
// Unclaims: Required. The list of devices to unclaim.
Unclaims []*PartnerUnclaim `json:"unclaims,omitempty"`
// ForceSendFields is a list of field names (e.g. "Unclaims") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Unclaims") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UnclaimDevicesRequest) MarshalJSON() ([]byte, error)
UpdateDeviceMetadataInBatchRequest: Request to update device metadata in batch.
type UpdateDeviceMetadataInBatchRequest struct {
// Updates: Required. The list of metadata updates.
Updates []*UpdateMetadataArguments `json:"updates,omitempty"`
// ForceSendFields is a list of field names (e.g. "Updates") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Updates") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UpdateDeviceMetadataInBatchRequest) MarshalJSON() ([]byte, error)
UpdateDeviceMetadataRequest: Request to set metadata for a device.
type UpdateDeviceMetadataRequest struct {
// DeviceMetadata: Required. The metadata to attach to the device.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceMetadata") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceMetadata") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UpdateDeviceMetadataRequest) MarshalJSON() ([]byte, error)
UpdateMetadataArguments: Identifies metadata updates to one device.
type UpdateMetadataArguments struct {
// DeviceId: Required. Device ID of the device.
DeviceId int64 `json:"deviceId,omitempty,string"`
// DeviceIdentifier: Required. Device identifier.
DeviceIdentifier *DeviceIdentifier `json:"deviceIdentifier,omitempty"`
// DeviceMetadata: Required. The metadata to update.
DeviceMetadata *DeviceMetadata `json:"deviceMetadata,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeviceId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeviceId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UpdateMetadataArguments) MarshalJSON() ([]byte, error)