Movatterモバイル変換


[0]ホーム

URL:


admin

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:318

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package admin provides access to the Admin SDK API.

For product documentation, see:https://developers.google.com/workspace/admin/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/admin/directory/v1"...ctx := context.Background()adminService, err := admin.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

adminService, err := admin.NewService(ctx, option.WithScopes(admin.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

adminService, err := admin.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)adminService, err := admin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, add, edit, and permanently delete the printers that your organization// can use with ChromeAdminChromePrintersScope = "https://www.googleapis.com/auth/admin.chrome.printers"// See the printers that your organization can use with ChromeAdminChromePrintersReadonlyScope = "https://www.googleapis.com/auth/admin.chrome.printers.readonly"// View and manage customer related informationAdminDirectoryCustomerScope = "https://www.googleapis.com/auth/admin.directory.customer"// View customer related informationAdminDirectoryCustomerReadonlyScope = "https://www.googleapis.com/auth/admin.directory.customer.readonly"// View and manage your ChromeOS devices' metadataAdminDirectoryDeviceChromeosScope = "https://www.googleapis.com/auth/admin.directory.device.chromeos"// View your ChromeOS devices' metadataAdminDirectoryDeviceChromeosReadonlyScope = "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"// View and manage your mobile devices' metadataAdminDirectoryDeviceMobileScope = "https://www.googleapis.com/auth/admin.directory.device.mobile"// Manage your mobile devices by performing administrative tasksAdminDirectoryDeviceMobileActionScope = "https://www.googleapis.com/auth/admin.directory.device.mobile.action"// View your mobile devices' metadataAdminDirectoryDeviceMobileReadonlyScope = "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"// View and manage the provisioning of domains for your customersAdminDirectoryDomainScope = "https://www.googleapis.com/auth/admin.directory.domain"// View domains related to your customersAdminDirectoryDomainReadonlyScope = "https://www.googleapis.com/auth/admin.directory.domain.readonly"// View and manage the provisioning of groups on your domainAdminDirectoryGroupScope = "https://www.googleapis.com/auth/admin.directory.group"// View and manage group subscriptions on your domainAdminDirectoryGroupMemberScope = "https://www.googleapis.com/auth/admin.directory.group.member"// View group subscriptions on your domainAdminDirectoryGroupMemberReadonlyScope = "https://www.googleapis.com/auth/admin.directory.group.member.readonly"// View groups on your domainAdminDirectoryGroupReadonlyScope = "https://www.googleapis.com/auth/admin.directory.group.readonly"// View and manage organization units on your domainAdminDirectoryOrgunitScope = "https://www.googleapis.com/auth/admin.directory.orgunit"// View organization units on your domainAdminDirectoryOrgunitReadonlyScope = "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"// View and manage the provisioning of calendar resources on your domainAdminDirectoryResourceCalendarScope = "https://www.googleapis.com/auth/admin.directory.resource.calendar"// View calendar resources on your domainAdminDirectoryResourceCalendarReadonlyScope = "https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly"// Manage delegated admin roles for your domainAdminDirectoryRolemanagementScope = "https://www.googleapis.com/auth/admin.directory.rolemanagement"// View delegated admin roles for your domainAdminDirectoryRolemanagementReadonlyScope = "https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly"// View and manage the provisioning of users on your domainAdminDirectoryUserScope = "https://www.googleapis.com/auth/admin.directory.user"// View and manage user aliases on your domainAdminDirectoryUserAliasScope = "https://www.googleapis.com/auth/admin.directory.user.alias"// View user aliases on your domainAdminDirectoryUserAliasReadonlyScope = "https://www.googleapis.com/auth/admin.directory.user.alias.readonly"// See info about users on your domainAdminDirectoryUserReadonlyScope = "https://www.googleapis.com/auth/admin.directory.user.readonly"// Manage data access permissions for users on your domainAdminDirectoryUserSecurityScope = "https://www.googleapis.com/auth/admin.directory.user.security"// View and manage the provisioning of user schemas on your domainAdminDirectoryUserschemaScope = "https://www.googleapis.com/auth/admin.directory.userschema"// View user schemas on your domainAdminDirectoryUserschemaReadonlyScope = "https://www.googleapis.com/auth/admin.directory.userschema.readonly"// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAlias

type Alias struct {Aliasstring `json:"alias,omitempty"`Etagstring `json:"etag,omitempty"`Idstring `json:"id,omitempty"`Kindstring `json:"kind,omitempty"`PrimaryEmailstring `json:"primaryEmail,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Alias") 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. "Alias") 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:"-"`}

Alias: JSON template for Alias object in Directory API.

func (Alias)MarshalJSON

func (sAlias) MarshalJSON() ([]byte,error)

typeAliases

type Aliases struct {Aliases []interface{} `json:"aliases,omitempty"`Etagstring        `json:"etag,omitempty"`Kindstring        `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Aliases") 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. "Aliases") 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:"-"`}

Aliases: JSON response template to list aliases in Directory API.

func (Aliases)MarshalJSON

func (sAliases) MarshalJSON() ([]byte,error)

typeAsp

type Asp struct {// CodeId: The unique ID of the ASP.CodeIdint64 `json:"codeId,omitempty"`// CreationTime: The time when the ASP was created. Expressed in Unix time// (https://en.wikipedia.org/wiki/Epoch_time) format.CreationTimeint64 `json:"creationTime,omitempty,string"`// Etag: ETag of the ASP.Etagstring `json:"etag,omitempty"`// Kind: The type of the API resource. This is always `admin#directory#asp`.Kindstring `json:"kind,omitempty"`// LastTimeUsed: The time when the ASP was last used. Expressed in Unix time// (https://en.wikipedia.org/wiki/Epoch_time) format.LastTimeUsedint64 `json:"lastTimeUsed,omitempty,string"`// Name: The name of the application that the user, represented by their// `userId`, entered when the ASP was created.Namestring `json:"name,omitempty"`// UserKey: The unique ID of the user who issued the ASP.UserKeystring `json:"userKey,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CodeId") 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. "CodeId") 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:"-"`}

Asp: An application-specific password (ASP) is used with applications thatdo not accept a verification code when logging into the application oncertain devices. The ASP access code is used instead of the login andpassword you commonly use when accessing an application through a browser.For more information about ASPs and how to create one, see the help center(https://support.google.com/a/answer/2537800#asp).

func (Asp)MarshalJSON

func (sAsp) MarshalJSON() ([]byte,error)

typeAsps

type Asps struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: A list of ASP resources.Items []*Asp `json:"items,omitempty"`// Kind: The type of the API resource. This is always// `admin#directory#aspList`.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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 (Asps)MarshalJSON

func (sAsps) MarshalJSON() ([]byte,error)

typeAspsDeleteCall

type AspsDeleteCall struct {// contains filtered or unexported fields}

func (*AspsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*AspsDeleteCall)Do

Do executes the "directory.asps.delete" call.

func (*AspsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AspsDeleteCall)Header

func (c *AspsDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAspsGetCall

type AspsGetCall struct {// contains filtered or unexported fields}

func (*AspsGetCall)Context

func (c *AspsGetCall) Context(ctxcontext.Context) *AspsGetCall

Context sets the context to be used in this call's Do method.

func (*AspsGetCall)Do

func (c *AspsGetCall) Do(opts ...googleapi.CallOption) (*Asp,error)

Do executes the "directory.asps.get" call.Any non-2xx status code is an error. Response headers are in either*Asp.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AspsGetCall)Fields

func (c *AspsGetCall) Fields(s ...googleapi.Field) *AspsGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AspsGetCall)Header

func (c *AspsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AspsGetCall)IfNoneMatch

func (c *AspsGetCall) IfNoneMatch(entityTagstring) *AspsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAspsListCall

type AspsListCall struct {// contains filtered or unexported fields}

func (*AspsListCall)Context

func (c *AspsListCall) Context(ctxcontext.Context) *AspsListCall

Context sets the context to be used in this call's Do method.

func (*AspsListCall)Do

func (c *AspsListCall) Do(opts ...googleapi.CallOption) (*Asps,error)

Do executes the "directory.asps.list" call.Any non-2xx status code is an error. Response headers are in either*Asps.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AspsListCall)Fields

func (c *AspsListCall) Fields(s ...googleapi.Field) *AspsListCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AspsListCall)Header

func (c *AspsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AspsListCall)IfNoneMatch

func (c *AspsListCall) IfNoneMatch(entityTagstring) *AspsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAspsService

type AspsService struct {// contains filtered or unexported fields}

funcNewAspsService

func NewAspsService(s *Service) *AspsService

func (*AspsService)Delete

func (r *AspsService) Delete(userKeystring, codeIdint64) *AspsDeleteCall

Delete: Deletes an ASP issued by a user.

  • codeId: The unique ID of the ASP to be deleted.
  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*AspsService)Get

func (r *AspsService) Get(userKeystring, codeIdint64) *AspsGetCall

Get: Gets information about an ASP issued by a user.

  • codeId: The unique ID of the ASP.
  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*AspsService)List

func (r *AspsService) List(userKeystring) *AspsListCall

List: Lists the ASPs issued by a user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

typeAuxiliaryMessageadded inv0.42.0

type AuxiliaryMessage struct {// AuxiliaryMessage: Human readable message in English. Example: "Given printer// is invalid or no longer supported."AuxiliaryMessagestring `json:"auxiliaryMessage,omitempty"`// FieldMask: Field that this message concerns.FieldMaskstring `json:"fieldMask,omitempty"`// Severity: Message severity//// Possible values://   "SEVERITY_UNSPECIFIED" - Message type unspecified.//   "SEVERITY_INFO" - Message of severity: info.//   "SEVERITY_WARNING" - Message of severity: warning.//   "SEVERITY_ERROR" - Message of severity: error.Severitystring `json:"severity,omitempty"`// ForceSendFields is a list of field names (e.g. "AuxiliaryMessage") 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. "AuxiliaryMessage") 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:"-"`}

AuxiliaryMessage: Auxiliary message about issues with printers or settings.Example: {message_type:AUXILIARY_MESSAGE_WARNING, field_mask:make_and_model,message:"Given printer is invalid or no longer supported."}

func (AuxiliaryMessage)MarshalJSONadded inv0.42.0

func (sAuxiliaryMessage) MarshalJSON() ([]byte,error)

typeBacklightInfoadded inv0.169.0

type BacklightInfo struct {// Brightness: Output only. Current brightness of the backlight, between 0 and// max_brightness.Brightnessint64 `json:"brightness,omitempty"`// MaxBrightness: Output only. Maximum brightness for the backlight.MaxBrightnessint64 `json:"maxBrightness,omitempty"`// Path: Output only. Path to this backlight on the system. Useful if the// caller needs to correlate with other information.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Brightness") 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. "Brightness") 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:"-"`}

BacklightInfo: Information about the device's backlights.

func (BacklightInfo)MarshalJSONadded inv0.169.0

func (sBacklightInfo) MarshalJSON() ([]byte,error)

typeBatchChangeChromeOsDeviceStatusRequestadded inv0.155.0

type BatchChangeChromeOsDeviceStatusRequest struct {// ChangeChromeOsDeviceStatusAction: Required. The action to take on the// ChromeOS device in order to change its status.//// Possible values://   "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED" - Default value. Value// is unused.//   "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION" - Deprovisions a// ChromeOS device. If you have ChromeOS devices that are no longer being used// in your organization, you should deprovision them so that you’re no longer// managing them. Deprovisioning the device removes all policies that were on// the device as well as device-level printers and the ability to use the// device as a kiosk. Depending on the upgrade that’s associated with the// device this action might release the license back into the license pool;// which allows you to use the license on a different device.//   "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE" - Disables a ChromeOS// device. Use this action if a user loses their device or it’s stolen, this// makes it such that the device is still managed, so it will still receive// policies, but no one can use it. Depending on the upgrade that’s// associated with the device this action might release the license back into// the license pool; which allows you to use the license on a different device.//   "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE" - Reenables a ChromeOS// device to be used after being disabled. Reenables the device once it's no// longer lost or it's been recovered. This allows the device to be used again.// Depending on the upgrade associated with the device this might consume one// license from the license pool, meaning that if there aren't enough licenses// available the operation will fail.ChangeChromeOsDeviceStatusActionstring `json:"changeChromeOsDeviceStatusAction,omitempty"`// DeprovisionReason: Optional. The reason behind a device deprovision. Must be// provided if 'changeChromeOsDeviceStatusAction' is set to// 'CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. Otherwise, omit this// field.//// Possible values://   "DEPROVISION_REASON_UNSPECIFIED" - The deprovision reason is unknown.//   "DEPROVISION_REASON_SAME_MODEL_REPLACEMENT" - Same model replacement. You// have return materials authorization (RMA) or you are replacing a// malfunctioning device under warranty with the same device model.//   "DEPROVISION_REASON_UPGRADE" - The device was upgraded.//   "DEPROVISION_REASON_DOMAIN_MOVE" - The device's domain was changed.//   "DEPROVISION_REASON_SERVICE_EXPIRATION" - Service expired for the device.//   "DEPROVISION_REASON_OTHER" - The device was deprovisioned for a legacy// reason that is no longer supported.//   "DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT" - Different model// replacement. You are replacing this device with an upgraded or newer device// model.//   "DEPROVISION_REASON_RETIRING_DEVICE" - Retiring from fleet. You are// donating, discarding, or otherwise removing the device from use.//   "DEPROVISION_REASON_UPGRADE_TRANSFER" - ChromeOS Flex upgrade transfer.// This is a ChromeOS Flex device that you are replacing with a Chromebook// within a year.//   "DEPROVISION_REASON_NOT_REQUIRED" - A reason was not required. For// example, the licenses were returned to the customer's license pool.//   "DEPROVISION_REASON_REPAIR_CENTER" - The device was deprovisioned by the// Repair Service Center. Can only be set by Repair Service Center during RMA.DeprovisionReasonstring `json:"deprovisionReason,omitempty"`// DeviceIds: Required. List of the IDs of the ChromeOS devices to change.// Maximum 50.DeviceIds []string `json:"deviceIds,omitempty"`// ForceSendFields is a list of field names (e.g.// "ChangeChromeOsDeviceStatusAction") 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.// "ChangeChromeOsDeviceStatusAction") to include in API requests with the JSON// null value. By default, fields with empty values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-NullFields for// more details.NullFields []string `json:"-"`}

BatchChangeChromeOsDeviceStatusRequest: A request for changing the status ofa batch of ChromeOS devices.

func (BatchChangeChromeOsDeviceStatusRequest)MarshalJSONadded inv0.155.0

typeBatchChangeChromeOsDeviceStatusResponseadded inv0.155.0

type BatchChangeChromeOsDeviceStatusResponse struct {// ChangeChromeOsDeviceStatusResults: The results for each of the ChromeOS// devices provided in the request.ChangeChromeOsDeviceStatusResults []*ChangeChromeOsDeviceStatusResult `json:"changeChromeOsDeviceStatusResults,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g.// "ChangeChromeOsDeviceStatusResults") 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.// "ChangeChromeOsDeviceStatusResults") to include in API requests with the// JSON null value. By default, fields with empty values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-NullFields for// more details.NullFields []string `json:"-"`}

BatchChangeChromeOsDeviceStatusResponse: The response of changing the statusof a batch of ChromeOS devices.

func (BatchChangeChromeOsDeviceStatusResponse)MarshalJSONadded inv0.155.0

typeBatchCreatePrintServersRequestadded inv0.98.0

type BatchCreatePrintServersRequest struct {// Requests: Required. A list of `PrintServer` resources to be created (max// `50` per batch).Requests []*CreatePrintServerRequest `json:"requests,omitempty"`// ForceSendFields is a list of field names (e.g. "Requests") 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. "Requests") 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:"-"`}

BatchCreatePrintServersRequest: Request to add multiple new print servers ina batch.

func (BatchCreatePrintServersRequest)MarshalJSONadded inv0.98.0

func (sBatchCreatePrintServersRequest) MarshalJSON() ([]byte,error)

typeBatchCreatePrintServersResponseadded inv0.98.0

type BatchCreatePrintServersResponse struct {// Failures: A list of create failures. `PrintServer` IDs are not populated, as// print servers were not created.Failures []*PrintServerFailureInfo `json:"failures,omitempty"`// PrintServers: A list of successfully created print servers with their IDs// populated.PrintServers []*PrintServer `json:"printServers,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Failures") 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. "Failures") 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 (BatchCreatePrintServersResponse)MarshalJSONadded inv0.98.0

func (sBatchCreatePrintServersResponse) MarshalJSON() ([]byte,error)

typeBatchCreatePrintersRequestadded inv0.42.0

type BatchCreatePrintersRequest struct {// Requests: A list of Printers to be created. Max 50 at a time.Requests []*CreatePrinterRequest `json:"requests,omitempty"`// ForceSendFields is a list of field names (e.g. "Requests") 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. "Requests") 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:"-"`}

BatchCreatePrintersRequest: Request for adding new printers in batch.

func (BatchCreatePrintersRequest)MarshalJSONadded inv0.42.0

func (sBatchCreatePrintersRequest) MarshalJSON() ([]byte,error)

typeBatchCreatePrintersResponseadded inv0.42.0

type BatchCreatePrintersResponse struct {// Failures: A list of create failures. Printer IDs are not populated, as// printer were not created.Failures []*FailureInfo `json:"failures,omitempty"`// Printers: A list of successfully created printers with their IDs populated.Printers []*Printer `json:"printers,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Failures") 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. "Failures") 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:"-"`}

BatchCreatePrintersResponse: Response for adding new printers in batch.

func (BatchCreatePrintersResponse)MarshalJSONadded inv0.42.0

func (sBatchCreatePrintersResponse) MarshalJSON() ([]byte,error)

typeBatchDeletePrintServersRequestadded inv0.98.0

type BatchDeletePrintServersRequest struct {// PrintServerIds: A list of print server IDs that should be deleted (max `100`// per batch).PrintServerIds []string `json:"printServerIds,omitempty"`// ForceSendFields is a list of field names (e.g. "PrintServerIds") 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. "PrintServerIds") 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:"-"`}

BatchDeletePrintServersRequest: Request to delete multiple existing printservers in a batch.

func (BatchDeletePrintServersRequest)MarshalJSONadded inv0.98.0

func (sBatchDeletePrintServersRequest) MarshalJSON() ([]byte,error)

typeBatchDeletePrintServersResponseadded inv0.98.0

type BatchDeletePrintServersResponse struct {// FailedPrintServers: A list of update failures.FailedPrintServers []*PrintServerFailureInfo `json:"failedPrintServers,omitempty"`// PrintServerIds: A list of print server IDs that were successfully deleted.PrintServerIds []string `json:"printServerIds,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "FailedPrintServers") 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. "FailedPrintServers") 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 (BatchDeletePrintServersResponse)MarshalJSONadded inv0.98.0

func (sBatchDeletePrintServersResponse) MarshalJSON() ([]byte,error)

typeBatchDeletePrintersRequestadded inv0.42.0

type BatchDeletePrintersRequest struct {// PrinterIds: A list of Printer.id that should be deleted. Max 100 at a time.PrinterIds []string `json:"printerIds,omitempty"`// ForceSendFields is a list of field names (e.g. "PrinterIds") 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. "PrinterIds") 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:"-"`}

BatchDeletePrintersRequest: Request for deleting existing printers in batch.

func (BatchDeletePrintersRequest)MarshalJSONadded inv0.42.0

func (sBatchDeletePrintersRequest) MarshalJSON() ([]byte,error)

typeBatchDeletePrintersResponseadded inv0.42.0

type BatchDeletePrintersResponse struct {// FailedPrinters: A list of update failures.FailedPrinters []*FailureInfo `json:"failedPrinters,omitempty"`// PrinterIds: A list of Printer.id that were successfully deleted.PrinterIds []string `json:"printerIds,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "FailedPrinters") 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. "FailedPrinters") 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:"-"`}

BatchDeletePrintersResponse: Response for deleting existing printers inbatch.

func (BatchDeletePrintersResponse)MarshalJSONadded inv0.42.0

func (sBatchDeletePrintersResponse) MarshalJSON() ([]byte,error)

typeBluetoothAdapterInfoadded inv0.254.0

type BluetoothAdapterInfo struct {// Address: Output only. The MAC address of the adapter.Addressstring `json:"address,omitempty"`// NumConnectedDevices: Output only. The number of devices connected to this// adapter.NumConnectedDevicesint64 `json:"numConnectedDevices,omitempty"`// ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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:"-"`}

BluetoothAdapterInfo: Information about a device's Bluetooth adapter.

func (BluetoothAdapterInfo)MarshalJSONadded inv0.254.0

func (sBluetoothAdapterInfo) MarshalJSON() ([]byte,error)

typeBuilding

type Building struct {// Address: The postal address of the building. See `PostalAddress`// (/my-business/reference/rest/v4/PostalAddress) for details. Note that only a// single address line and region code are required.Address *BuildingAddress `json:"address,omitempty"`// BuildingId: Unique identifier for the building. The maximum length is 100// characters.BuildingIdstring `json:"buildingId,omitempty"`// BuildingName: The building name as seen by users in Calendar. Must be unique// for the customer. For example, "NYC-CHEL". The maximum length is 100// characters.BuildingNamestring `json:"buildingName,omitempty"`// Coordinates: The geographic coordinates of the center of the building,// expressed as latitude and longitude in decimal degrees.Coordinates *BuildingCoordinates `json:"coordinates,omitempty"`// Description: A brief description of the building. For example, "Chelsea// Market".Descriptionstring `json:"description,omitempty"`// Etags: ETag of the resource.Etagsstring `json:"etags,omitempty"`// FloorNames: The display names for all floors in this building. The floors// are expected to be sorted in ascending order, from lowest floor to highest// floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must// contain at least one entry.FloorNames []string `json:"floorNames,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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:"-"`}

Building: Public API: Resources.buildings

func (Building)MarshalJSON

func (sBuilding) MarshalJSON() ([]byte,error)

typeBuildingAddressadded inv0.2.0

type BuildingAddress struct {// AddressLines: Unstructured address lines describing the lower levels of an// address.AddressLines []string `json:"addressLines,omitempty"`// AdministrativeArea: Optional. Highest administrative subdivision which is// used for postal addresses of a country or region.AdministrativeAreastring `json:"administrativeArea,omitempty"`// LanguageCode: Optional. BCP-47 language code of the contents of this address// (if known).LanguageCodestring `json:"languageCode,omitempty"`// Locality: Optional. Generally refers to the city/town portion of the// address. Examples: US city, IT comune, UK post town. In regions of the world// where localities are not well defined or do not fit into this structure// well, leave locality empty and use addressLines.Localitystring `json:"locality,omitempty"`// PostalCode: Optional. Postal code of the address.PostalCodestring `json:"postalCode,omitempty"`// RegionCode: Required. CLDR region code of the country/region of the address.RegionCodestring `json:"regionCode,omitempty"`// Sublocality: Optional. Sublocality of the address.Sublocalitystring `json:"sublocality,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressLines") 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. "AddressLines") 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:"-"`}

BuildingAddress: Public API: Resources.buildings

func (BuildingAddress)MarshalJSONadded inv0.2.0

func (sBuildingAddress) MarshalJSON() ([]byte,error)

typeBuildingCoordinates

type BuildingCoordinates struct {// Latitude: Latitude in decimal degrees.Latitudefloat64 `json:"latitude,omitempty"`// Longitude: Longitude in decimal degrees.Longitudefloat64 `json:"longitude,omitempty"`// ForceSendFields is a list of field names (e.g. "Latitude") 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. "Latitude") 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:"-"`}

BuildingCoordinates: Public API: Resources.buildings

func (BuildingCoordinates)MarshalJSON

func (sBuildingCoordinates) MarshalJSON() ([]byte,error)

func (*BuildingCoordinates)UnmarshalJSON

func (s *BuildingCoordinates) UnmarshalJSON(data []byte)error

typeBuildings

type Buildings struct {// Buildings: The Buildings in this page of results.Buildings []*Building `json:"buildings,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `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. "Buildings") 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. "Buildings") 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:"-"`}

Buildings: Public API: Resources.buildings

func (Buildings)MarshalJSON

func (sBuildings) MarshalJSON() ([]byte,error)

typeByteUsageadded inv0.205.0

type ByteUsage struct {// CapacityBytes: Output only. The total capacity value, in bytes.CapacityBytesint64 `json:"capacityBytes,omitempty,string"`// UsedBytes: Output only. The current usage value, in bytes.UsedBytesint64 `json:"usedBytes,omitempty,string"`// ForceSendFields is a list of field names (e.g. "CapacityBytes") 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. "CapacityBytes") 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:"-"`}

ByteUsage: Represents a data capacity with some amount of current usage inbytes.

func (ByteUsage)MarshalJSONadded inv0.205.0

func (sByteUsage) MarshalJSON() ([]byte,error)

typeCalendarResource

type CalendarResource struct {// BuildingId: Unique ID for the building a resource is located in.BuildingIdstring `json:"buildingId,omitempty"`// Capacity: Capacity of a resource, number of seats in a room.Capacityint64 `json:"capacity,omitempty"`// Etags: ETag of the resource.Etagsstring `json:"etags,omitempty"`// FeatureInstances: Instances of features for the calendar resource.FeatureInstances interface{} `json:"featureInstances,omitempty"`// FloorName: Name of the floor a resource is located on.FloorNamestring `json:"floorName,omitempty"`// FloorSection: Name of the section within a floor a resource is located in.FloorSectionstring `json:"floorSection,omitempty"`// GeneratedResourceName: The read-only auto-generated name of the calendar// resource which includes metadata about the resource such as building name,// floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)".GeneratedResourceNamestring `json:"generatedResourceName,omitempty"`// Kind: The type of the resource. For calendar resources, the value is// `admin#directory#resources#calendars#CalendarResource`.Kindstring `json:"kind,omitempty"`// ResourceCategory: The category of the calendar resource. Either// CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN.ResourceCategorystring `json:"resourceCategory,omitempty"`// ResourceDescription: Description of the resource, visible only to admins.ResourceDescriptionstring `json:"resourceDescription,omitempty"`// ResourceEmail: The read-only email for the calendar resource. Generated as// part of creating a new calendar resource.ResourceEmailstring `json:"resourceEmail,omitempty"`// ResourceId: The unique ID for the calendar resource.ResourceIdstring `json:"resourceId,omitempty"`// ResourceName: The name of the calendar resource. For example, "Training Room// 1A".ResourceNamestring `json:"resourceName,omitempty"`// ResourceType: The type of the calendar resource, intended for non-room// resources.ResourceTypestring `json:"resourceType,omitempty"`// UserVisibleDescription: Description of the resource, visible to users and// admins.UserVisibleDescriptionstring `json:"userVisibleDescription,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BuildingId") 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. "BuildingId") 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:"-"`}

CalendarResource: Public API: Resources.calendars

func (CalendarResource)MarshalJSON

func (sCalendarResource) MarshalJSON() ([]byte,error)

typeCalendarResources

type CalendarResources struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: The CalendarResources in this page of results.Items []*CalendarResource `json:"items,omitempty"`// Kind: Identifies this as a collection of CalendarResources. This is always// `admin#directory#resources#calendars#calendarResourcesList`.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `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. "Etag") 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. "Etag") 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:"-"`}

CalendarResources: Public API: Resources.calendars

func (CalendarResources)MarshalJSON

func (sCalendarResources) MarshalJSON() ([]byte,error)

typeChangeChromeOsDeviceStatusResultadded inv0.155.0

type ChangeChromeOsDeviceStatusResult struct {// DeviceId: The unique ID of the ChromeOS device.DeviceIdstring `json:"deviceId,omitempty"`// Error: The error result of the operation in case of failure.Error *Status `json:"error,omitempty"`// Response: The device could change its status successfully.Response *ChangeChromeOsDeviceStatusSucceeded `json:"response,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:"-"`}

ChangeChromeOsDeviceStatusResult: The result of a single ChromeOS device fora Change state operation.

func (ChangeChromeOsDeviceStatusResult)MarshalJSONadded inv0.155.0

func (sChangeChromeOsDeviceStatusResult) MarshalJSON() ([]byte,error)

typeChangeChromeOsDeviceStatusSucceededadded inv0.155.0

type ChangeChromeOsDeviceStatusSucceeded struct {}

ChangeChromeOsDeviceStatusSucceeded: Response for a successful ChromeOSdevice status change.

typeChannel

type Channel struct {// Address: The address where notifications are delivered for this channel.Addressstring `json:"address,omitempty"`// Expiration: Date and time of notification channel expiration, expressed as a// Unix timestamp, in milliseconds. Optional.Expirationint64 `json:"expiration,omitempty,string"`// Id: A UUID or similar unique string that identifies this channel.Idstring `json:"id,omitempty"`// Kind: Identifies this as a notification channel used to watch for changes to// a resource, which is `api#channel`.Kindstring `json:"kind,omitempty"`// Params: Additional parameters controlling delivery channel behavior.// Optional. For example, `params.ttl` specifies the time-to-live in seconds// for the notification channel, where the default is 2 hours and the maximum// TTL is 2 days.Params map[string]string `json:"params,omitempty"`// Payload: A Boolean value to indicate whether payload is wanted. Optional.Payloadbool `json:"payload,omitempty"`// ResourceId: An opaque ID that identifies the resource being watched on this// channel. Stable across different API versions.ResourceIdstring `json:"resourceId,omitempty"`// ResourceUri: A version-specific identifier for the watched resource.ResourceUristring `json:"resourceUri,omitempty"`// Token: An arbitrary string delivered to the target address with each// notification delivered over this channel. Optional.Tokenstring `json:"token,omitempty"`// Type: The type of delivery mechanism used for this channel.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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:"-"`}

Channel: An notification channel used to watch for resource changes.

func (Channel)MarshalJSON

func (sChannel) MarshalJSON() ([]byte,error)

typeChannelsService

type ChannelsService struct {// contains filtered or unexported fields}

funcNewChannelsService

func NewChannelsService(s *Service) *ChannelsService

func (*ChannelsService)Stop

func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall

Stop: Stops watching resources through this channel.

typeChannelsStopCall

type ChannelsStopCall struct {// contains filtered or unexported fields}

func (*ChannelsStopCall)Context

Context sets the context to be used in this call's Do method.

func (*ChannelsStopCall)Do

Do executes the "admin.channels.stop" call.

func (*ChannelsStopCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChannelsStopCall)Header

func (c *ChannelsStopCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeChromeOsDevice

type ChromeOsDevice struct {// ActiveTimeRanges: A list of active time ranges (Read-only).ActiveTimeRanges []*ChromeOsDeviceActiveTimeRanges `json:"activeTimeRanges,omitempty"`// AnnotatedAssetId: The asset identifier as noted by an administrator or// specified during enrollment.AnnotatedAssetIdstring `json:"annotatedAssetId,omitempty"`// AnnotatedLocation: The address or location of the device as noted by the// administrator. Maximum length is `200` characters. Empty values are allowed.AnnotatedLocationstring `json:"annotatedLocation,omitempty"`// AnnotatedUser: The user of the device as noted by the administrator. Maximum// length is 100 characters. Empty values are allowed.AnnotatedUserstring `json:"annotatedUser,omitempty"`// AutoUpdateExpiration: (Read-only) The timestamp after which the device will// stop receiving Chrome updates or support. Please use "autoUpdateThrough"// instead.AutoUpdateExpirationint64 `json:"autoUpdateExpiration,omitempty,string"`// AutoUpdateThrough: Output only. The timestamp after which the device will// stop receiving Chrome updates or support.AutoUpdateThroughstring `json:"autoUpdateThrough,omitempty"`// BacklightInfo: Output only. Contains backlight information for the device.BacklightInfo []*BacklightInfo `json:"backlightInfo,omitempty"`// BluetoothAdapterInfo: Output only. Information about Bluetooth adapters of// the device.BluetoothAdapterInfo []*BluetoothAdapterInfo `json:"bluetoothAdapterInfo,omitempty"`// BootMode: The boot mode for the device. The possible values are: *// `Verified`: The device is running a valid version of the Chrome OS. * `Dev`:// The devices's developer hardware switch is enabled. When booted, the device// has a command line shell. For an example of a developer switch, see the// Chromebook developer information// (https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).BootModestring `json:"bootMode,omitempty"`// ChromeOsType: Output only. Chrome OS type of the device.//// Possible values://   "chromeOsTypeUnspecified" - Chrome OS Type unspecified.//   "chromeOsFlex" - Chrome OS Type Chrome OS Flex.//   "chromeOs" - Chrome OS Type Chrome OS.ChromeOsTypestring `json:"chromeOsType,omitempty"`// CpuInfo: Information regarding CPU specs in the device.CpuInfo []*ChromeOsDeviceCpuInfo `json:"cpuInfo,omitempty"`// CpuStatusReports: Reports of CPU utilization and temperature (Read-only)CpuStatusReports []*ChromeOsDeviceCpuStatusReports `json:"cpuStatusReports,omitempty"`// DeprovisionReason: (Read-only) Deprovision reason.//// Possible values://   "DEPROVISION_REASON_UNSPECIFIED" - The deprovision reason is unknown.//   "DEPROVISION_REASON_SAME_MODEL_REPLACEMENT" - Same model replacement. You// have return materials authorization (RMA) or you are replacing a// malfunctioning device under warranty with the same device model.//   "DEPROVISION_REASON_UPGRADE" - The device was upgraded.//   "DEPROVISION_REASON_DOMAIN_MOVE" - The device's domain was changed.//   "DEPROVISION_REASON_SERVICE_EXPIRATION" - Service expired for the device.//   "DEPROVISION_REASON_OTHER" - The device was deprovisioned for a legacy// reason that is no longer supported.//   "DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT" - Different model// replacement. You are replacing this device with an upgraded or newer device// model.//   "DEPROVISION_REASON_RETIRING_DEVICE" - Retiring from fleet. You are// donating, discarding, or otherwise removing the device from use.//   "DEPROVISION_REASON_UPGRADE_TRANSFER" - ChromeOS Flex upgrade transfer.// This is a ChromeOS Flex device that you are replacing with a Chromebook// within a year.//   "DEPROVISION_REASON_NOT_REQUIRED" - A reason was not required. For// example, the licenses were returned to the customer's license pool.//   "DEPROVISION_REASON_REPAIR_CENTER" - The device was deprovisioned by the// Repair Service Center. Can only be set by Repair Service Center during RMA.DeprovisionReasonstring `json:"deprovisionReason,omitempty"`// DeviceFiles: A list of device files to download (Read-only)DeviceFiles []*ChromeOsDeviceDeviceFiles `json:"deviceFiles,omitempty"`// DeviceId: The unique ID of the Chrome device.DeviceIdstring `json:"deviceId,omitempty"`// DeviceLicenseType: Output only. Device license type.//// Possible values://   "deviceLicenseTypeUnspecified" - The license type is unknown.//   "enterprise" - The device is bundled with a perpetual Chrome Enterprise// Upgrade.//   "enterpriseUpgrade" - The device has an annual standalone Chrome// Enterprise Upgrade.//   "educationUpgrade" - The device has a perpetual standalone Chrome// Education Upgrade.//   "education" - The device is bundled with a perpetual Chrome Education// Upgrade.//   "kioskUpgrade" - The device has an annual Kiosk Upgrade.//   "enterpriseUpgradePerpetual" - Indicates that the device is consuming a// standalone, perpetual Chrome Enterprise Upgrade, a Chrome Enterprise// license.//   "enterpriseUpgradeFixedTerm" - Indicates that the device is consuming a// standalone, fixed-term Chrome Enterprise Upgrade, a Chrome Enterprise// license.//   "educationUpgradePerpetual" - Indicates that the device is consuming a// standalone, perpetual Chrome Education Upgrade(AKA Chrome EDU perpetual// license).//   "educationUpgradeFixedTerm" - Indicates that the device is consuming a// standalone, fixed-term Chrome Education Upgrade(AKA Chrome EDU fixed-term// license).DeviceLicenseTypestring `json:"deviceLicenseType,omitempty"`// DiskSpaceUsage: Output only. How much disk space the device has available// and is currently using.DiskSpaceUsage *ByteUsage `json:"diskSpaceUsage,omitempty"`// DiskVolumeReports: Reports of disk space and other info about// mounted/connected volumes.DiskVolumeReports []*ChromeOsDeviceDiskVolumeReports `json:"diskVolumeReports,omitempty"`// DockMacAddress: (Read-only) Built-in MAC address for the docking station// that the device connected to. Factory sets Media access control address (MAC// address) assigned for use by a dock. It is reserved specifically for MAC// pass through device policy. The format is twelve (12) hexadecimal digits// without any delimiter (uppercase letters). This is only relevant for some// devices.DockMacAddressstring `json:"dockMacAddress,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// EthernetMacAddress: The device's MAC address on the ethernet network// interface.EthernetMacAddressstring `json:"ethernetMacAddress,omitempty"`// EthernetMacAddress0: (Read-only) MAC address used by the Chromebook’s// internal ethernet port, and for onboard network (ethernet) interface. The// format is twelve (12) hexadecimal digits without any delimiter (uppercase// letters). This is only relevant for some devices.EthernetMacAddress0string `json:"ethernetMacAddress0,omitempty"`// ExtendedSupportEligible: Output only. Whether or not the device requires the// extended support opt in.ExtendedSupportEligiblebool `json:"extendedSupportEligible,omitempty"`// ExtendedSupportEnabled: Output only. Whether extended support policy is// enabled on the device.ExtendedSupportEnabledbool `json:"extendedSupportEnabled,omitempty"`// ExtendedSupportStart: Output only. Date of the device when extended support// policy for automatic updates starts.ExtendedSupportStartstring `json:"extendedSupportStart,omitempty"`// FanInfo: Output only. Fan information for the device.FanInfo []*FanInfo `json:"fanInfo,omitempty"`// FirmwareVersion: The Chrome device's firmware version.FirmwareVersionstring `json:"firmwareVersion,omitempty"`// FirstEnrollmentTime: Date and time for the first time the device was// enrolled.FirstEnrollmentTimestring `json:"firstEnrollmentTime,omitempty"`// Kind: The type of resource. For the Chromeosdevices resource, the value is// `admin#directory#chromeosdevice`.Kindstring `json:"kind,omitempty"`// LastDeprovisionTimestamp: (Read-only) Date and time for the last deprovision// of the device.LastDeprovisionTimestampstring `json:"lastDeprovisionTimestamp,omitempty"`// LastEnrollmentTime: Date and time the device was last enrolled (Read-only)LastEnrollmentTimestring `json:"lastEnrollmentTime,omitempty"`// LastKnownNetwork: Contains last known network (Read-only)LastKnownNetwork []*ChromeOsDeviceLastKnownNetwork `json:"lastKnownNetwork,omitempty"`// LastSync: Date and time the device was last synchronized with the policy// settings in the G Suite administrator control panel (Read-only)LastSyncstring `json:"lastSync,omitempty"`// MacAddress: The device's wireless MAC address. If the device does not have// this information, it is not included in the response.MacAddressstring `json:"macAddress,omitempty"`// ManufactureDate: (Read-only) The date the device was manufactured in// yyyy-mm-dd format.ManufactureDatestring `json:"manufactureDate,omitempty"`// Meid: The Mobile Equipment Identifier (MEID) or the International Mobile// Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A// MEID/IMEI is typically used when adding a device to a wireless carrier's// post-pay service plan. If the device does not have this information, this// property is not included in the response. For more information on how to// export a MEID/IMEI list, see the Developer's Guide// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid).Meidstring `json:"meid,omitempty"`// Model: The device's model information. If the device does not have this// information, this property is not included in the response.Modelstring `json:"model,omitempty"`// Notes: Notes about this device added by the administrator. This property can// be searched (https://support.google.com/chrome/a/answer/1698333) with the// list// (https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list)// method's `query` parameter. Maximum length is 500 characters. Empty values// are allowed.Notesstring `json:"notes,omitempty"`// OrderNumber: The device's order number. Only devices directly purchased from// Google have an order number.OrderNumberstring `json:"orderNumber,omitempty"`// OrgUnitId: The unique ID of the organizational unit. orgUnitPath is the// human readable version of orgUnitId. While orgUnitPath may change by// renaming an organizational unit within the path, orgUnitId is unchangeable// for one organizational unit. This property can be updated// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou)// using the API. For more information about how to create an organizational// structure for your device, see the administration help center// (https://support.google.com/a/answer/182433).OrgUnitIdstring `json:"orgUnitId,omitempty"`// OrgUnitPath: The full parent path with the organizational unit's name// associated with the device. Path names are case insensitive. If the parent// organizational unit is the top-level organization, it is represented as a// forward slash, `/`. This property can be updated// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou)// using the API. For more information about how to create an organizational// structure for your device, see the administration help center// (https://support.google.com/a/answer/182433).OrgUnitPathstring `json:"orgUnitPath,omitempty"`// OsUpdateStatus: The status of the OS updates for the device.OsUpdateStatus *OsUpdateStatus `json:"osUpdateStatus,omitempty"`// OsVersion: The Chrome device's operating system version.OsVersionstring `json:"osVersion,omitempty"`// OsVersionCompliance: Output only. Device policy compliance status of the OS// version.//// Possible values://   "complianceUnspecified" - Compliance status unspecified.//   "compliant" - Compliance status compliant.//   "pending" - Compliance status pending.//   "notCompliant" - Compliance status not compliant.OsVersionCompliancestring `json:"osVersionCompliance,omitempty"`// PlatformVersion: The Chrome device's platform version.PlatformVersionstring `json:"platformVersion,omitempty"`// RecentUsers: A list of recent device users, in descending order, by last// login time.RecentUsers []*ChromeOsDeviceRecentUsers `json:"recentUsers,omitempty"`// ScreenshotFiles: A list of screenshot files to download. Type is always// "SCREENSHOT_FILE". (Read-only)ScreenshotFiles []*ChromeOsDeviceScreenshotFiles `json:"screenshotFiles,omitempty"`// SerialNumber: The Chrome device serial number entered when the device was// enabled. This value is the same as the Admin console's *Serial Number* in// the *Chrome OS Devices* tab.SerialNumberstring `json:"serialNumber,omitempty"`// Status: The status of the device.Statusstring `json:"status,omitempty"`// SupportEndDate: Final date the device will be supported (Read-only)SupportEndDatestring `json:"supportEndDate,omitempty"`// SystemRamFreeReports: Reports of amounts of available RAM memory (Read-only)SystemRamFreeReports []*ChromeOsDeviceSystemRamFreeReports `json:"systemRamFreeReports,omitempty"`// SystemRamTotal: Total RAM on the device [in bytes] (Read-only)SystemRamTotalint64 `json:"systemRamTotal,omitempty,string"`// TpmVersionInfo: Trusted Platform Module (TPM) (Read-only)TpmVersionInfo *ChromeOsDeviceTpmVersionInfo `json:"tpmVersionInfo,omitempty"`// WillAutoRenew: Determines if the device will auto renew its support after// the support end date. This is a read-only property.WillAutoRenewbool `json:"willAutoRenew,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ActiveTimeRanges") 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. "ActiveTimeRanges") 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:"-"`}

ChromeOsDevice: Google Chrome devices run on the Chrome OS(https://support.google.com/chromeos). For more information about common APItasks, see the Developer's Guide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices).

func (ChromeOsDevice)MarshalJSON

func (sChromeOsDevice) MarshalJSON() ([]byte,error)

typeChromeOsDeviceAction

type ChromeOsDeviceAction struct {// Action: Action to be taken on the Chrome OS device.Actionstring `json:"action,omitempty"`// DeprovisionReason: Only used when the action is `deprovision`. With the// `deprovision` action, this field is required. *Note*: The deprovision reason// is audited because it might have implications on licenses for perpetual// subscription customers.DeprovisionReasonstring `json:"deprovisionReason,omitempty"`// ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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:"-"`}

ChromeOsDeviceAction: Data about an update to the status of a Chrome OSdevice.

func (ChromeOsDeviceAction)MarshalJSON

func (sChromeOsDeviceAction) MarshalJSON() ([]byte,error)

typeChromeOsDeviceActiveTimeRanges

type ChromeOsDeviceActiveTimeRanges struct {// ActiveTime: Duration of usage in milliseconds.ActiveTimeint64 `json:"activeTime,omitempty"`// Date: Date of usageDatestring `json:"date,omitempty"`// ForceSendFields is a list of field names (e.g. "ActiveTime") 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. "ActiveTime") 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 (ChromeOsDeviceActiveTimeRanges)MarshalJSON

func (sChromeOsDeviceActiveTimeRanges) MarshalJSON() ([]byte,error)

typeChromeOsDeviceCpuInfoadded inv0.59.0

type ChromeOsDeviceCpuInfo struct {// Architecture: The CPU architecture.Architecturestring `json:"architecture,omitempty"`// LogicalCpus: Information for the Logical CPUsLogicalCpus []*ChromeOsDeviceCpuInfoLogicalCpus `json:"logicalCpus,omitempty"`// MaxClockSpeedKhz: The max CPU clock speed in kHz.MaxClockSpeedKhzint64 `json:"maxClockSpeedKhz,omitempty"`// Model: The CPU model name.Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Architecture") 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. "Architecture") 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:"-"`}

ChromeOsDeviceCpuInfo: CPU specs for a CPU.

func (ChromeOsDeviceCpuInfo)MarshalJSONadded inv0.59.0

func (sChromeOsDeviceCpuInfo) MarshalJSON() ([]byte,error)

typeChromeOsDeviceCpuInfoLogicalCpusadded inv0.59.0

type ChromeOsDeviceCpuInfoLogicalCpus struct {// CStates: C-States indicate the power consumption state of the CPU. For more// information look at documentation published by the CPU maker.CStates []*ChromeOsDeviceCpuInfoLogicalCpusCStates `json:"cStates,omitempty"`// CurrentScalingFrequencyKhz: Current frequency the CPU is running at.CurrentScalingFrequencyKhzint64 `json:"currentScalingFrequencyKhz,omitempty"`// IdleDuration: Idle time since last boot.IdleDurationstring `json:"idleDuration,omitempty"`// MaxScalingFrequencyKhz: Maximum frequency the CPU is allowed to run at, by// policy.MaxScalingFrequencyKhzint64 `json:"maxScalingFrequencyKhz,omitempty"`// ForceSendFields is a list of field names (e.g. "CStates") 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. "CStates") 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:"-"`}

ChromeOsDeviceCpuInfoLogicalCpus: Status of a single logical CPU.

func (ChromeOsDeviceCpuInfoLogicalCpus)MarshalJSONadded inv0.59.0

func (sChromeOsDeviceCpuInfoLogicalCpus) MarshalJSON() ([]byte,error)

typeChromeOsDeviceCpuInfoLogicalCpusCStatesadded inv0.59.0

type ChromeOsDeviceCpuInfoLogicalCpusCStates struct {// DisplayName: Name of the state.DisplayNamestring `json:"displayName,omitempty"`// SessionDuration: Time spent in the state since the last reboot.SessionDurationstring `json:"sessionDuration,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}

ChromeOsDeviceCpuInfoLogicalCpusCStates: Status of a single C-state.C-states are various modes the CPU can transition to in order to use more orless power.

func (ChromeOsDeviceCpuInfoLogicalCpusCStates)MarshalJSONadded inv0.59.0

typeChromeOsDeviceCpuStatusReports

type ChromeOsDeviceCpuStatusReports struct {// CpuTemperatureInfo: A list of CPU temperature samples.CpuTemperatureInfo           []*ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo `json:"cpuTemperatureInfo,omitempty"`CpuUtilizationPercentageInfo []int64                                             `json:"cpuUtilizationPercentageInfo,omitempty"`// ReportTime: Date and time the report was received.ReportTimestring `json:"reportTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CpuTemperatureInfo") 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. "CpuTemperatureInfo") 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 (ChromeOsDeviceCpuStatusReports)MarshalJSON

func (sChromeOsDeviceCpuStatusReports) MarshalJSON() ([]byte,error)

typeChromeOsDeviceCpuStatusReportsCpuTemperatureInfo

type ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo struct {// Label: CPU labelLabelstring `json:"label,omitempty"`// Temperature: Temperature in Celsius degrees.Temperatureint64 `json:"temperature,omitempty"`// ForceSendFields is a list of field names (e.g. "Label") 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. "Label") 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 (ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo)MarshalJSON

typeChromeOsDeviceDeviceFiles

type ChromeOsDeviceDeviceFiles struct {// CreateTime: Date and time the file was createdCreateTimestring `json:"createTime,omitempty"`// DownloadUrl: File download URLDownloadUrlstring `json:"downloadUrl,omitempty"`// Name: File nameNamestring `json:"name,omitempty"`// Type: File typeTypestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 (ChromeOsDeviceDeviceFiles)MarshalJSON

func (sChromeOsDeviceDeviceFiles) MarshalJSON() ([]byte,error)

typeChromeOsDeviceDiskVolumeReports

type ChromeOsDeviceDiskVolumeReports struct {// VolumeInfo: Disk volumesVolumeInfo []*ChromeOsDeviceDiskVolumeReportsVolumeInfo `json:"volumeInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "VolumeInfo") 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. "VolumeInfo") 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 (ChromeOsDeviceDiskVolumeReports)MarshalJSON

func (sChromeOsDeviceDiskVolumeReports) MarshalJSON() ([]byte,error)

typeChromeOsDeviceDiskVolumeReportsVolumeInfo

type ChromeOsDeviceDiskVolumeReportsVolumeInfo struct {// StorageFree: Free disk space [in bytes]StorageFreeint64 `json:"storageFree,omitempty,string"`// StorageTotal: Total disk space [in bytes]StorageTotalint64 `json:"storageTotal,omitempty,string"`// VolumeId: Volume idVolumeIdstring `json:"volumeId,omitempty"`// ForceSendFields is a list of field names (e.g. "StorageFree") 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. "StorageFree") 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 (ChromeOsDeviceDiskVolumeReportsVolumeInfo)MarshalJSON

typeChromeOsDeviceLastKnownNetworkadded inv0.29.0

type ChromeOsDeviceLastKnownNetwork struct {// IpAddress: The IP address.IpAddressstring `json:"ipAddress,omitempty"`// WanIpAddress: The WAN IP address.WanIpAddressstring `json:"wanIpAddress,omitempty"`// ForceSendFields is a list of field names (e.g. "IpAddress") 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. "IpAddress") 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:"-"`}

ChromeOsDeviceLastKnownNetwork: Information for an ip address.

func (ChromeOsDeviceLastKnownNetwork)MarshalJSONadded inv0.29.0

func (sChromeOsDeviceLastKnownNetwork) MarshalJSON() ([]byte,error)

typeChromeOsDeviceRecentUsers

type ChromeOsDeviceRecentUsers struct {// Email: The user's email address. This is only present if the user type is// `USER_TYPE_MANAGED`.Emailstring `json:"email,omitempty"`// Type: The type of the user.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Email") 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. "Email") 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:"-"`}

ChromeOsDeviceRecentUsers: A list of recent device users, in descendingorder, by last login time.

func (ChromeOsDeviceRecentUsers)MarshalJSON

func (sChromeOsDeviceRecentUsers) MarshalJSON() ([]byte,error)

typeChromeOsDeviceScreenshotFilesadded inv0.42.0

type ChromeOsDeviceScreenshotFiles struct {// CreateTime: Date and time the file was createdCreateTimestring `json:"createTime,omitempty"`// DownloadUrl: File download URLDownloadUrlstring `json:"downloadUrl,omitempty"`// Name: File nameNamestring `json:"name,omitempty"`// Type: File typeTypestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 (ChromeOsDeviceScreenshotFiles)MarshalJSONadded inv0.42.0

func (sChromeOsDeviceScreenshotFiles) MarshalJSON() ([]byte,error)

typeChromeOsDeviceSystemRamFreeReports

type ChromeOsDeviceSystemRamFreeReports struct {// ReportTime: Date and time the report was received.ReportTimestring           `json:"reportTime,omitempty"`SystemRamFreeInfogoogleapi.Int64s `json:"systemRamFreeInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "ReportTime") 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. "ReportTime") 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 (ChromeOsDeviceSystemRamFreeReports)MarshalJSON

typeChromeOsDeviceTpmVersionInfo

type ChromeOsDeviceTpmVersionInfo struct {// Family: TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2"// -> 312e3200 TPM 2.0: "2.0" -> 322e3000Familystring `json:"family,omitempty"`// FirmwareVersion: TPM firmware version.FirmwareVersionstring `json:"firmwareVersion,omitempty"`// Manufacturer: TPM manufacturer code.Manufacturerstring `json:"manufacturer,omitempty"`// SpecLevel: TPM specification level. See Library Specification for TPM 2.0// and Main Specification for TPM 1.2.SpecLevelstring `json:"specLevel,omitempty"`// TpmModel: TPM model number.TpmModelstring `json:"tpmModel,omitempty"`// VendorSpecific: Vendor-specific information such as Vendor ID.VendorSpecificstring `json:"vendorSpecific,omitempty"`// ForceSendFields is a list of field names (e.g. "Family") 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. "Family") 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:"-"`}

ChromeOsDeviceTpmVersionInfo: Trusted Platform Module (TPM) (Read-only)

func (ChromeOsDeviceTpmVersionInfo)MarshalJSON

func (sChromeOsDeviceTpmVersionInfo) MarshalJSON() ([]byte,error)

typeChromeOsDevices

type ChromeOsDevices struct {// Chromeosdevices: A list of Chrome OS Device objects.Chromeosdevices []*ChromeOsDevice `json:"chromeosdevices,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// NextPageToken: Token used to access the next page of this result. To access// the next page, use this token's value in the `pageToken` query string of// this request.NextPageTokenstring `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. "Chromeosdevices") 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. "Chromeosdevices") 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 (ChromeOsDevices)MarshalJSON

func (sChromeOsDevices) MarshalJSON() ([]byte,error)

typeChromeOsMoveDevicesToOu

type ChromeOsMoveDevicesToOu struct {// DeviceIds: Chrome OS devices to be moved to OUDeviceIds []string `json:"deviceIds,omitempty"`// ForceSendFields is a list of field names (e.g. "DeviceIds") 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. "DeviceIds") 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 (ChromeOsMoveDevicesToOu)MarshalJSON

func (sChromeOsMoveDevicesToOu) MarshalJSON() ([]byte,error)

typeChromeosdevicesActionCall

type ChromeosdevicesActionCall struct {// contains filtered or unexported fields}

func (*ChromeosdevicesActionCall)Context

Context sets the context to be used in this call's Do method.

func (*ChromeosdevicesActionCall)Do

Do executes the "directory.chromeosdevices.action" call.

func (*ChromeosdevicesActionCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChromeosdevicesActionCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeChromeosdevicesGetCall

type ChromeosdevicesGetCall struct {// contains filtered or unexported fields}

func (*ChromeosdevicesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ChromeosdevicesGetCall)Do

Do executes the "directory.chromeosdevices.get" call.Any non-2xx status code is an error. Response headers are in either*ChromeOsDevice.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ChromeosdevicesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChromeosdevicesGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ChromeosdevicesGetCall)IfNoneMatch

func (c *ChromeosdevicesGetCall) IfNoneMatch(entityTagstring) *ChromeosdevicesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ChromeosdevicesGetCall)Projection

func (c *ChromeosdevicesGetCall) Projection(projectionstring) *ChromeosdevicesGetCall

Projection sets the optional parameter "projection": Determines whether theresponse contains the full list of properties or only a subset.

Possible values:

"BASIC" - Includes only the basic metadata fields (e.g., deviceId,

serialNumber, status, and user)

"FULL" - Includes all metadata fields

typeChromeosdevicesListCall

type ChromeosdevicesListCall struct {// contains filtered or unexported fields}

func (*ChromeosdevicesListCall)Context

Context sets the context to be used in this call's Do method.

func (*ChromeosdevicesListCall)Do

Do executes the "directory.chromeosdevices.list" call.Any non-2xx status code is an error. Response headers are in either*ChromeOsDevices.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ChromeosdevicesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChromeosdevicesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ChromeosdevicesListCall)IfNoneMatch

func (c *ChromeosdevicesListCall) IfNoneMatch(entityTagstring) *ChromeosdevicesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ChromeosdevicesListCall)IncludeChildOrgunitsadded inv0.60.0

func (c *ChromeosdevicesListCall) IncludeChildOrgunits(includeChildOrgunitsbool) *ChromeosdevicesListCall

IncludeChildOrgunits sets the optional parameter "includeChildOrgunits":Return devices from all child orgunits, as well as the specified org unit.If this is set to true, 'orgUnitPath' must be provided.

func (*ChromeosdevicesListCall)MaxResults

func (c *ChromeosdevicesListCall) MaxResults(maxResultsint64) *ChromeosdevicesListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return. Value should not exceed 300.

func (*ChromeosdevicesListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Device property to use forsorting results.

Possible values:

"annotatedLocation" - Chrome device location as annotated by the

administrator.

"annotatedUser" - Chromebook user as annotated by administrator."lastSync" - The date and time the Chrome device was last synchronized

with the policy settings in the Admin console.

"notes" - Chrome device notes as annotated by the administrator."serialNumber" - The Chrome device serial number entered when the device

was enabled.

"status" - Chrome device status. For more information, see the <a

[chromeosdevices](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices.html).

func (*ChromeosdevicesListCall)OrgUnitPath

func (c *ChromeosdevicesListCall) OrgUnitPath(orgUnitPathstring) *ChromeosdevicesListCall

OrgUnitPath sets the optional parameter "orgUnitPath": The full path of theorganizational unit (minus the leading `/`) or its unique ID.

func (*ChromeosdevicesListCall)PageToken

PageToken sets the optional parameter "pageToken": The `pageToken` queryparameter is used to request the next page of query results. The follow-onrequest's `pageToken` query parameter is the `nextPageToken` from yourprevious response.

func (*ChromeosdevicesListCall)Pages

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.

func (*ChromeosdevicesListCall)Projection

func (c *ChromeosdevicesListCall) Projection(projectionstring) *ChromeosdevicesListCall

Projection sets the optional parameter "projection": Determines whether theresponse contains the full list of properties or only a subset.

Possible values:

"BASIC" - Includes only the basic metadata fields (e.g., deviceId,

serialNumber, status, and user)

"FULL" - Includes all metadata fields

func (*ChromeosdevicesListCall)Query

Query sets the optional parameter "query": Search string in the format givenathttps://developers.google.com/workspace/admin/directory/v1/list-query-operators

func (*ChromeosdevicesListCall)SortOrder

SortOrder sets the optional parameter "sortOrder": Whether to return resultsin ascending or descending order. Must be used with the `orderBy` parameter.

Possible values:

"ASCENDING" - Ascending order."DESCENDING" - Descending order.

typeChromeosdevicesMoveDevicesToOuCall

type ChromeosdevicesMoveDevicesToOuCall struct {// contains filtered or unexported fields}

func (*ChromeosdevicesMoveDevicesToOuCall)Context

Context sets the context to be used in this call's Do method.

func (*ChromeosdevicesMoveDevicesToOuCall)Do

Do executes the "directory.chromeosdevices.moveDevicesToOu" call.

func (*ChromeosdevicesMoveDevicesToOuCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChromeosdevicesMoveDevicesToOuCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeChromeosdevicesPatchCall

type ChromeosdevicesPatchCall struct {// contains filtered or unexported fields}

func (*ChromeosdevicesPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ChromeosdevicesPatchCall)Do

Do executes the "directory.chromeosdevices.patch" call.Any non-2xx status code is an error. Response headers are in either*ChromeOsDevice.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ChromeosdevicesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChromeosdevicesPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ChromeosdevicesPatchCall)Projection

Projection sets the optional parameter "projection": Determines whether theresponse contains the full list of properties or only a subset.

Possible values:

"BASIC" - Includes only the basic metadata fields (e.g., deviceId,

serialNumber, status, and user)

"FULL" - Includes all metadata fields

typeChromeosdevicesService

type ChromeosdevicesService struct {// contains filtered or unexported fields}

funcNewChromeosdevicesService

func NewChromeosdevicesService(s *Service) *ChromeosdevicesService

func (*ChromeosdevicesService)Action

func (r *ChromeosdevicesService) Action(customerIdstring, resourceIdstring, chromeosdeviceaction *ChromeOsDeviceAction) *ChromeosdevicesActionCall

Action: Use BatchChangeChromeOsDeviceStatus(https://developers.google.com/workspace/admin/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus)instead. Takes an action that affects a Chrome OS Device. This includesdeprovisioning, disabling, and re-enabling devices. *Warning:* *Deprovisioning a device will stop device policy syncing and removedevice-level printers. After a device is deprovisioned, it must be wipedbefore it can be re-enrolled. * Lost or stolen devices should use thedisable action. * Re-enabling a disabled device will consume a devicelicense. If you do not have sufficient licenses available when completingthe re-enable action, you will receive an error. For more information aboutdeprovisioning and disabling devices, visit the help center(https://support.google.com/chrome/a/answer/3523633).

func (*ChromeosdevicesService)Get

func (r *ChromeosdevicesService) Get(customerIdstring, deviceIdstring) *ChromeosdevicesGetCall

Get: Retrieves a Chrome OS device's properties.

func (*ChromeosdevicesService)List

List: Retrieves a paginated list of Chrome OS devices within an account.

func (*ChromeosdevicesService)MoveDevicesToOu

func (r *ChromeosdevicesService) MoveDevicesToOu(customerIdstring, orgUnitPathstring, chromeosmovedevicestoou *ChromeOsMoveDevicesToOu) *ChromeosdevicesMoveDevicesToOuCall

MoveDevicesToOu: Moves or inserts multiple Chrome OS devices to anorganizational unit. You can move up to 50 devices at once.

- customerId: Immutable. ID of the Google Workspace account.- orgUnitPath: Full path of the target organizational unit or its ID.

func (*ChromeosdevicesService)Patch

func (r *ChromeosdevicesService) Patch(customerIdstring, deviceIdstring, chromeosdevice *ChromeOsDevice) *ChromeosdevicesPatchCall

Patch: Updates a device's updatable properties, such as `annotatedUser`,`annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. Thismethod supports patch semantics(https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).

func (*ChromeosdevicesService)Update

func (r *ChromeosdevicesService) Update(customerIdstring, deviceIdstring, chromeosdevice *ChromeOsDevice) *ChromeosdevicesUpdateCall

Update: Updates a device's updatable properties, such as `annotatedUser`,`annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.

typeChromeosdevicesUpdateCall

type ChromeosdevicesUpdateCall struct {// contains filtered or unexported fields}

func (*ChromeosdevicesUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*ChromeosdevicesUpdateCall)Do

Do executes the "directory.chromeosdevices.update" call.Any non-2xx status code is an error. Response headers are in either*ChromeOsDevice.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ChromeosdevicesUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ChromeosdevicesUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ChromeosdevicesUpdateCall)Projection

Projection sets the optional parameter "projection": Determines whether theresponse contains the full list of properties or only a subset.

Possible values:

"BASIC" - Includes only the basic metadata fields (e.g., deviceId,

serialNumber, status, and user)

"FULL" - Includes all metadata fields

typeCreatePrintServerRequestadded inv0.98.0

type CreatePrintServerRequest struct {// Parent: Required. The unique ID// (https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers)// of the customer's Google Workspace account. Format: `customers/{id}`Parentstring `json:"parent,omitempty"`// PrintServer: Required. A print server to create. If you want to place the// print server under a specific organizational unit (OU), then populate the// `org_unit_id`. Otherwise the print server is created under the root OU. The// `org_unit_id` can be retrieved using the Directory API// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units).PrintServer *PrintServer `json:"printServer,omitempty"`// ForceSendFields is a list of field names (e.g. "Parent") 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. "Parent") 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:"-"`}

CreatePrintServerRequest: Request for adding a new print server.

func (CreatePrintServerRequest)MarshalJSONadded inv0.98.0

func (sCreatePrintServerRequest) MarshalJSON() ([]byte,error)

typeCreatePrinterRequestadded inv0.42.0

type CreatePrinterRequest struct {// Parent: Required. The name of the customer. Format: customers/{customer_id}Parentstring `json:"parent,omitempty"`// Printer: Required. A printer to create. If you want to place the printer// under particular OU then populate printer.org_unit_id filed. Otherwise the// printer will be placed under root OU.Printer *Printer `json:"printer,omitempty"`// ForceSendFields is a list of field names (e.g. "Parent") 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. "Parent") 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:"-"`}

CreatePrinterRequest: Request for adding a new printer.

func (CreatePrinterRequest)MarshalJSONadded inv0.42.0

func (sCreatePrinterRequest) MarshalJSON() ([]byte,error)

typeCustomer

type Customer struct {// AlternateEmail: The customer's secondary contact email address. This email// address cannot be on the same domain as the `customerDomain`AlternateEmailstring `json:"alternateEmail,omitempty"`// CustomerCreationTime: The customer's creation time (Readonly)CustomerCreationTimestring `json:"customerCreationTime,omitempty"`// CustomerDomain: The customer's primary domain name string. Do not include// the `www` prefix when creating a new customer.CustomerDomainstring `json:"customerDomain,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Id: The unique ID for the customer's Google Workspace account. (Readonly)Idstring `json:"id,omitempty"`// Kind: Identifies the resource as a customer. Value:// `admin#directory#customer`Kindstring `json:"kind,omitempty"`// Language: The customer's ISO 639-2 language code. See the Language Codes// (https://developers.google.com/workspace/admin/directory/v1/languages) page// for the list of supported codes. Valid language codes outside the supported// set will be accepted by the API but may lead to unexpected behavior. The// default value is `en`.Languagestring `json:"language,omitempty"`// PhoneNumber: The customer's contact phone number in E.164// (https://en.wikipedia.org/wiki/E.164) format.PhoneNumberstring `json:"phoneNumber,omitempty"`// PostalAddress: The customer's postal address information.PostalAddress *CustomerPostalAddress `json:"postalAddress,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AlternateEmail") 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. "AlternateEmail") 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 (Customer)MarshalJSON

func (sCustomer) MarshalJSON() ([]byte,error)

typeCustomerDevicesChromeosBatchChangeStatusCalladded inv0.155.0

type CustomerDevicesChromeosBatchChangeStatusCall struct {// contains filtered or unexported fields}

func (*CustomerDevicesChromeosBatchChangeStatusCall)Contextadded inv0.155.0

Context sets the context to be used in this call's Do method.

func (*CustomerDevicesChromeosBatchChangeStatusCall)Doadded inv0.155.0

Do executes the "admin.customer.devices.chromeos.batchChangeStatus" call.Any non-2xx status code is an error. Response headers are in either*BatchChangeChromeOsDeviceStatusResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomerDevicesChromeosBatchChangeStatusCall)Fieldsadded inv0.155.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomerDevicesChromeosBatchChangeStatusCall)Headeradded inv0.155.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomerDevicesChromeosCommandsGetCalladded inv0.34.0

type CustomerDevicesChromeosCommandsGetCall struct {// contains filtered or unexported fields}

func (*CustomerDevicesChromeosCommandsGetCall)Contextadded inv0.34.0

Context sets the context to be used in this call's Do method.

func (*CustomerDevicesChromeosCommandsGetCall)Doadded inv0.34.0

Do executes the "admin.customer.devices.chromeos.commands.get" call.Any non-2xx status code is an error. Response headers are in either*DirectoryChromeosdevicesCommand.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomerDevicesChromeosCommandsGetCall)Fieldsadded inv0.34.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomerDevicesChromeosCommandsGetCall)Headeradded inv0.34.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomerDevicesChromeosCommandsGetCall)IfNoneMatchadded inv0.34.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeCustomerDevicesChromeosCommandsServiceadded inv0.34.0

type CustomerDevicesChromeosCommandsService struct {// contains filtered or unexported fields}

funcNewCustomerDevicesChromeosCommandsServiceadded inv0.34.0

func NewCustomerDevicesChromeosCommandsService(s *Service) *CustomerDevicesChromeosCommandsService

func (*CustomerDevicesChromeosCommandsService)Getadded inv0.34.0

Get: Gets command data a specific command issued to the device.

- commandId: Immutable. ID of Chrome OS Device Command.- customerId: Immutable. ID of the Google Workspace account.- deviceId: Immutable. ID of Chrome OS Device.

typeCustomerDevicesChromeosIssueCommandCalladded inv0.34.0

type CustomerDevicesChromeosIssueCommandCall struct {// contains filtered or unexported fields}

func (*CustomerDevicesChromeosIssueCommandCall)Contextadded inv0.34.0

Context sets the context to be used in this call's Do method.

func (*CustomerDevicesChromeosIssueCommandCall)Doadded inv0.34.0

Do executes the "admin.customer.devices.chromeos.issueCommand" call.Any non-2xx status code is an error. Response headers are in either*DirectoryChromeosdevicesIssueCommandResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomerDevicesChromeosIssueCommandCall)Fieldsadded inv0.34.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomerDevicesChromeosIssueCommandCall)Headeradded inv0.34.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomerDevicesChromeosServiceadded inv0.34.0

type CustomerDevicesChromeosService struct {Commands *CustomerDevicesChromeosCommandsService// contains filtered or unexported fields}

funcNewCustomerDevicesChromeosServiceadded inv0.34.0

func NewCustomerDevicesChromeosService(s *Service) *CustomerDevicesChromeosService

func (*CustomerDevicesChromeosService)BatchChangeStatusadded inv0.155.0

func (r *CustomerDevicesChromeosService) BatchChangeStatus(customerIdstring, batchchangechromeosdevicestatusrequest *BatchChangeChromeOsDeviceStatusRequest) *CustomerDevicesChromeosBatchChangeStatusCall

BatchChangeStatus: Changes the status of a batch of ChromeOS devices. Formore information about changing a ChromeOS device state Repair, repurpose,or retire ChromeOS devices(https://support.google.com/chrome/a/answer/3523633).

- customerId: Immutable ID of the Google Workspace account.

func (*CustomerDevicesChromeosService)IssueCommandadded inv0.34.0

func (r *CustomerDevicesChromeosService) IssueCommand(customerIdstring, deviceIdstring, directorychromeosdevicesissuecommandrequest *DirectoryChromeosdevicesIssueCommandRequest) *CustomerDevicesChromeosIssueCommandCall

IssueCommand: Issues a command for the device to execute.

- customerId: Immutable. ID of the Google Workspace account.- deviceId: Immutable. ID of Chrome OS Device.

typeCustomerDevicesServiceadded inv0.34.0

type CustomerDevicesService struct {Chromeos *CustomerDevicesChromeosService// contains filtered or unexported fields}

funcNewCustomerDevicesServiceadded inv0.34.0

func NewCustomerDevicesService(s *Service) *CustomerDevicesService

typeCustomerPostalAddress

type CustomerPostalAddress struct {// AddressLine1: A customer's physical address. The address can be composed of// one to three lines.AddressLine1string `json:"addressLine1,omitempty"`// AddressLine2: Address line 2 of the address.AddressLine2string `json:"addressLine2,omitempty"`// AddressLine3: Address line 3 of the address.AddressLine3string `json:"addressLine3,omitempty"`// ContactName: The customer contact's name.ContactNamestring `json:"contactName,omitempty"`// CountryCode: This is a required property. For `countryCode` information see// the ISO 3166 country code elements// (https://www.iso.org/iso/country_codes.htm).CountryCodestring `json:"countryCode,omitempty"`// Locality: Name of the locality. An example of a locality value is the city// of `San Francisco`.Localitystring `json:"locality,omitempty"`// OrganizationName: The company or company division name.OrganizationNamestring `json:"organizationName,omitempty"`// PostalCode: The postal code. A postalCode example is a postal zip code such// as `10009`. This is in accordance with - http:// //portablecontacts.net/draft-spec.html#address_element.PostalCodestring `json:"postalCode,omitempty"`// Region: Name of the region. An example of a region value is `NY` for the// state of New York.Regionstring `json:"region,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressLine1") 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. "AddressLine1") 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 (CustomerPostalAddress)MarshalJSON

func (sCustomerPostalAddress) MarshalJSON() ([]byte,error)

typeCustomerServiceadded inv0.34.0

type CustomerService struct {Devices *CustomerDevicesService// contains filtered or unexported fields}

funcNewCustomerServiceadded inv0.34.0

func NewCustomerService(s *Service) *CustomerService

typeCustomersChromePrintServersBatchCreatePrintServersCalladded inv0.98.0

type CustomersChromePrintServersBatchCreatePrintServersCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersBatchCreatePrintServersCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersBatchCreatePrintServersCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.batchCreatePrintServers" call.Any non-2xx status code is an error. Response headers are in either*BatchCreatePrintServersResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomersChromePrintServersBatchCreatePrintServersCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersBatchCreatePrintServersCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintServersBatchDeletePrintServersCalladded inv0.98.0

type CustomersChromePrintServersBatchDeletePrintServersCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersBatchDeletePrintServersCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersBatchDeletePrintServersCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.batchDeletePrintServers" call.Any non-2xx status code is an error. Response headers are in either*BatchDeletePrintServersResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomersChromePrintServersBatchDeletePrintServersCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersBatchDeletePrintServersCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintServersCreateCalladded inv0.98.0

type CustomersChromePrintServersCreateCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersCreateCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersCreateCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.create" call.Any non-2xx status code is an error. Response headers are in either*PrintServer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintServersCreateCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersCreateCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintServersDeleteCalladded inv0.98.0

type CustomersChromePrintServersDeleteCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersDeleteCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersDeleteCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintServersDeleteCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersDeleteCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintServersGetCalladded inv0.98.0

type CustomersChromePrintServersGetCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersGetCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersGetCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.get" call.Any non-2xx status code is an error. Response headers are in either*PrintServer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintServersGetCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersGetCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintServersGetCall)IfNoneMatchadded inv0.98.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeCustomersChromePrintServersListCalladded inv0.98.0

type CustomersChromePrintServersListCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersListCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersListCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.list" call.Any non-2xx status code is an error. Response headers are in either*ListPrintServersResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomersChromePrintServersListCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersListCall)Filteradded inv0.98.0

Filter sets the optional parameter "filter": Search query in CommonExpression Language syntax (https://github.com/google/cel-spec). Supportedfilters are `display_name`, `description`, and `uri`. Example:`printServer.displayName=='marketing-queue'`.

func (*CustomersChromePrintServersListCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintServersListCall)IfNoneMatchadded inv0.98.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*CustomersChromePrintServersListCall)OrderByadded inv0.98.0

OrderBy sets the optional parameter "orderBy": Sort order for results.Supported values are `display_name`, `description`, or `create_time`.Default order is ascending, but descending order can be returned byappending "desc" to the `order_by` field. For instance,`orderBy=='description desc'` returns the print servers sorted bydescription in descending order.

func (*CustomersChromePrintServersListCall)OrgUnitIdadded inv0.98.0

OrgUnitId sets the optional parameter "orgUnitId": If `org_unit_id` ispresent in the request, only print servers owned or inherited by theorganizational unit (OU) are returned. If the `PrintServer` resource's`org_unit_id` matches the one in the request, the OU owns the server. If`org_unit_id` is not specified in the request, all print servers arereturned or filtered against.

func (*CustomersChromePrintServersListCall)PageSizeadded inv0.98.0

PageSize sets the optional parameter "pageSize": The maximum number ofobjects to return (default `100`, max `100`). The service might return fewerthan this value.

func (*CustomersChromePrintServersListCall)PageTokenadded inv0.98.0

PageToken sets the optional parameter "pageToken": A generated token topaginate results (the `next_page_token` from a previous call).

func (*CustomersChromePrintServersListCall)Pagesadded inv0.98.0

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.

typeCustomersChromePrintServersPatchCalladded inv0.98.0

type CustomersChromePrintServersPatchCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintServersPatchCall)Contextadded inv0.98.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintServersPatchCall)Doadded inv0.98.0

Do executes the "admin.customers.chrome.printServers.patch" call.Any non-2xx status code is an error. Response headers are in either*PrintServer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintServersPatchCall)Fieldsadded inv0.98.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintServersPatchCall)Headeradded inv0.98.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintServersPatchCall)UpdateMaskadded inv0.98.0

UpdateMask sets the optional parameter "updateMask": The list of fields toupdate. Some fields are read-only and cannot be updated. Values forunspecified fields are patched.

typeCustomersChromePrintServersServiceadded inv0.98.0

type CustomersChromePrintServersService struct {// contains filtered or unexported fields}

funcNewCustomersChromePrintServersServiceadded inv0.98.0

func NewCustomersChromePrintServersService(s *Service) *CustomersChromePrintServersService

func (*CustomersChromePrintServersService)BatchCreatePrintServersadded inv0.98.0

BatchCreatePrintServers: Creates multiple print servers.

func (*CustomersChromePrintServersService)BatchDeletePrintServersadded inv0.98.0

BatchDeletePrintServers: Deletes multiple print servers.

func (*CustomersChromePrintServersService)Createadded inv0.98.0

Create: Creates a print server.

func (*CustomersChromePrintServersService)Deleteadded inv0.98.0

Delete: Deletes a print server.

  • name: The name of the print server to be deleted. Format:`customers/{customer.id}/chrome/printServers/{print_server.id}`.

func (*CustomersChromePrintServersService)Getadded inv0.98.0

Get: Returns a print server's configuration.

func (*CustomersChromePrintServersService)Listadded inv0.98.0

List: Lists print server configurations.

func (*CustomersChromePrintServersService)Patchadded inv0.98.0

Patch: Updates a print server's configuration.

  • name: Identifier. Resource name of the print server. Leave empty whencreating. Format: `customers/{customer.id}/printServers/{print_server.id}`.

typeCustomersChromePrintersBatchCreatePrintersCalladded inv0.42.0

type CustomersChromePrintersBatchCreatePrintersCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersBatchCreatePrintersCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersBatchCreatePrintersCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.batchCreatePrinters" call.Any non-2xx status code is an error. Response headers are in either*BatchCreatePrintersResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomersChromePrintersBatchCreatePrintersCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersBatchCreatePrintersCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintersBatchDeletePrintersCalladded inv0.42.0

type CustomersChromePrintersBatchDeletePrintersCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersBatchDeletePrintersCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersBatchDeletePrintersCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.batchDeletePrinters" call.Any non-2xx status code is an error. Response headers are in either*BatchDeletePrintersResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomersChromePrintersBatchDeletePrintersCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersBatchDeletePrintersCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintersCreateCalladded inv0.42.0

type CustomersChromePrintersCreateCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersCreateCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersCreateCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.create" call.Any non-2xx status code is an error. Response headers are in either*Printer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintersCreateCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersCreateCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintersDeleteCalladded inv0.42.0

type CustomersChromePrintersDeleteCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersDeleteCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersDeleteCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintersDeleteCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersDeleteCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersChromePrintersGetCalladded inv0.42.0

type CustomersChromePrintersGetCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersGetCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersGetCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.get" call.Any non-2xx status code is an error. Response headers are in either*Printer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintersGetCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersGetCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintersGetCall)IfNoneMatchadded inv0.42.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeCustomersChromePrintersListCalladded inv0.42.0

type CustomersChromePrintersListCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersListCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersListCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.list" call.Any non-2xx status code is an error. Response headers are in either*ListPrintersResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CustomersChromePrintersListCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersListCall)Filteradded inv0.42.0

Filter sets the optional parameter "filter": Search query. Search syntax isshared between this api and Admin Console printers pages.

func (*CustomersChromePrintersListCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintersListCall)IfNoneMatchadded inv0.42.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*CustomersChromePrintersListCall)OrderByadded inv0.69.0

OrderBy sets the optional parameter "orderBy": The order to sort results by.Must be one of display_name, description, make_and_model, or create_time.Default order is ascending, but descending order can be returned byappending "desc" to the order_by field. For instance, "description desc"will return the printers sorted by description in descending order.

func (*CustomersChromePrintersListCall)OrgUnitIdadded inv0.42.0

OrgUnitId sets the optional parameter "orgUnitId": Organization Unit that wewant to list the printers for. When org_unit is not present in the requestthen all printers of the customer are returned (or filtered). When org_unitis present in the request then only printers available to this OU will bereturned (owned or inherited). You may see if printer is owned or inheritedfor this OU by looking at Printer.org_unit_id.

func (*CustomersChromePrintersListCall)PageSizeadded inv0.42.0

PageSize sets the optional parameter "pageSize": The maximum number ofobjects to return. The service may return fewer than this value.

func (*CustomersChromePrintersListCall)PageTokenadded inv0.42.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous call.

func (*CustomersChromePrintersListCall)Pagesadded inv0.42.0

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.

typeCustomersChromePrintersListPrinterModelsCalladded inv0.42.0

type CustomersChromePrintersListPrinterModelsCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersListPrinterModelsCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersListPrinterModelsCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.listPrinterModels" call.Any non-2xx status code is an error. Response headers are in either*ListPrinterModelsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CustomersChromePrintersListPrinterModelsCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersListPrinterModelsCall)Filteradded inv0.42.0

Filter sets the optional parameter "filter": Filer to list only models by agiven manufacturer in format: "manufacturer:Brother". Search syntax isshared between this api and Admin Console printers pages.

func (*CustomersChromePrintersListPrinterModelsCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintersListPrinterModelsCall)IfNoneMatchadded inv0.42.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*CustomersChromePrintersListPrinterModelsCall)PageSizeadded inv0.42.0

PageSize sets the optional parameter "pageSize": The maximum number ofobjects to return. The service may return fewer than this value.

func (*CustomersChromePrintersListPrinterModelsCall)PageTokenadded inv0.42.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous call.

func (*CustomersChromePrintersListPrinterModelsCall)Pagesadded inv0.42.0

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.

typeCustomersChromePrintersPatchCalladded inv0.42.0

type CustomersChromePrintersPatchCall struct {// contains filtered or unexported fields}

func (*CustomersChromePrintersPatchCall)ClearMaskadded inv0.42.0

ClearMask sets the optional parameter "clearMask": The list of fields to becleared. Note, some of the fields are read only and cannot be updated.Values for not specified fields will be patched.

func (*CustomersChromePrintersPatchCall)Contextadded inv0.42.0

Context sets the context to be used in this call's Do method.

func (*CustomersChromePrintersPatchCall)Doadded inv0.42.0

Do executes the "admin.customers.chrome.printers.patch" call.Any non-2xx status code is an error. Response headers are in either*Printer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersChromePrintersPatchCall)Fieldsadded inv0.42.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersChromePrintersPatchCall)Headeradded inv0.42.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersChromePrintersPatchCall)UpdateMaskadded inv0.42.0

UpdateMask sets the optional parameter "updateMask": The list of fields tobe updated. Note, some of the fields are read only and cannot be updated.Values for not specified fields will be patched.

typeCustomersChromePrintersServiceadded inv0.42.0

type CustomersChromePrintersService struct {// contains filtered or unexported fields}

funcNewCustomersChromePrintersServiceadded inv0.42.0

func NewCustomersChromePrintersService(s *Service) *CustomersChromePrintersService

func (*CustomersChromePrintersService)BatchCreatePrintersadded inv0.42.0

BatchCreatePrinters: Creates printers under given Organization Unit.

- parent: The name of the customer. Format: customers/{customer_id}.

func (*CustomersChromePrintersService)BatchDeletePrintersadded inv0.42.0

BatchDeletePrinters: Deletes printers in batch.

- parent: The name of the customer. Format: customers/{customer_id}.

func (*CustomersChromePrintersService)Createadded inv0.42.0

Create: Creates a printer under given Organization Unit.

- parent: The name of the customer. Format: customers/{customer_id}.

func (*CustomersChromePrintersService)Deleteadded inv0.42.0

Delete: Deletes a `Printer`.

  • name: The name of the printer to be updated. Format:customers/{customer_id}/chrome/printers/{printer_id}.

func (*CustomersChromePrintersService)Getadded inv0.42.0

Get: Returns a `Printer` resource (printer's config).

  • name: The name of the printer to retrieve. Format:customers/{customer_id}/chrome/printers/{printer_id}.

func (*CustomersChromePrintersService)Listadded inv0.42.0

List: List printers configs.

  • parent: The name of the customer who owns this collection of printers.Format: customers/{customer_id}.

func (*CustomersChromePrintersService)ListPrinterModelsadded inv0.42.0

ListPrinterModels: Lists the supported printer models.

  • parent: The name of the customer who owns this collection of printers.Format: customers/{customer_id}.

func (*CustomersChromePrintersService)Patchadded inv0.42.0

Patch: Updates a `Printer` resource.

  • name: Identifier. The resource name of the Printer object, in the formatcustomers/{customer-id}/printers/{printer-id} (During printer creationleave empty).

typeCustomersChromeServiceadded inv0.42.0

type CustomersChromeService struct {PrintServers *CustomersChromePrintServersServicePrinters *CustomersChromePrintersService// contains filtered or unexported fields}

funcNewCustomersChromeServiceadded inv0.42.0

func NewCustomersChromeService(s *Service) *CustomersChromeService

typeCustomersGetCall

type CustomersGetCall struct {// contains filtered or unexported fields}

func (*CustomersGetCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomersGetCall)Do

Do executes the "directory.customers.get" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersGetCall)Header

func (c *CustomersGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomersGetCall)IfNoneMatch

func (c *CustomersGetCall) IfNoneMatch(entityTagstring) *CustomersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeCustomersPatchCall

type CustomersPatchCall struct {// contains filtered or unexported fields}

func (*CustomersPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomersPatchCall)Do

Do executes the "directory.customers.patch" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersPatchCall)Header

func (c *CustomersPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomersService

type CustomersService struct {Chrome *CustomersChromeService// contains filtered or unexported fields}

funcNewCustomersService

func NewCustomersService(s *Service) *CustomersService

func (*CustomersService)Get

func (r *CustomersService) Get(customerKeystring) *CustomersGetCall

Get: Retrieves a customer.

- customerKey: Id of the customer to be retrieved.

func (*CustomersService)Patch

func (r *CustomersService) Patch(customerKeystring, customer *Customer) *CustomersPatchCall

Patch: Patches a customer.

- customerKey: Id of the customer to be updated.

func (*CustomersService)Update

func (r *CustomersService) Update(customerKeystring, customer *Customer) *CustomersUpdateCall

Update: Updates a customer.

- customerKey: Id of the customer to be updated.

typeCustomersUpdateCall

type CustomersUpdateCall struct {// contains filtered or unexported fields}

func (*CustomersUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomersUpdateCall)Do

Do executes the "directory.customers.update" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersUpdateCall)Header

func (c *CustomersUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeDirectoryChromeosdevicesCommandadded inv0.34.0

type DirectoryChromeosdevicesCommand struct {// CommandExpireTime: The time at which the command will expire. If the device// doesn't execute the command within this time the command will become// expired.CommandExpireTimestring `json:"commandExpireTime,omitempty"`// CommandId: Unique ID of a device command.CommandIdint64 `json:"commandId,omitempty,string"`// CommandResult: The result of the command execution.CommandResult *DirectoryChromeosdevicesCommandResult `json:"commandResult,omitempty"`// IssueTime: The timestamp when the command was issued by the admin.IssueTimestring `json:"issueTime,omitempty"`// Payload: The payload that the command specified, if any.Payloadstring `json:"payload,omitempty"`// State: Indicates the command state.//// Possible values://   "STATE_UNSPECIFIED" - The command status was unspecified.//   "PENDING" - An unexpired command not yet sent to the client.//   "EXPIRED" - The command didn't get executed by the client within the// expected time.//   "CANCELLED" - The command is cancelled by admin while in PENDING.//   "SENT_TO_CLIENT" - The command has been sent to the client.//   "ACKED_BY_CLIENT" - The client has responded that it received the command.//   "EXECUTED_BY_CLIENT" - The client has (un)successfully executed the// command.Statestring `json:"state,omitempty"`// Type: The type of the command.//// Possible values://   "COMMAND_TYPE_UNSPECIFIED" - The command type was unspecified.//   "REBOOT" - Reboot the device. Can be issued to Kiosk and managed guest// session devices, and regular devices running ChromeOS version 113 or later.//   "TAKE_A_SCREENSHOT" - Take a screenshot of the device. Only available if// the device is in Kiosk Mode.//   "SET_VOLUME" - Set the volume of the device. Can only be issued to Kiosk// and managed guest session devices.//   "WIPE_USERS" - Wipe all the users off of the device. Executing this// command in the device will remove all user profile data, but it will keep// device policy and enrollment.//   "REMOTE_POWERWASH" - Wipes the device by performing a power wash.// Executing this command in the device will remove all data including user// policies, device policies and enrollment policies. Warning: This will revert// the device back to a factory state with no enrollment unless the device is// subject to forced or auto enrollment. Use with caution, as this is an// irreversible action!//   "DEVICE_START_CRD_SESSION" - Starts a Chrome Remote Desktop session.//   "CAPTURE_LOGS" - Capture the system logs of a kiosk device. The logs can// be downloaded from the downloadUrl link present in `deviceFiles` field of// [chromeosdevices](https://developers.google.com/workspace/admin/directory/ref// erence/rest/v1/chromeosdevices)//   "FETCH_CRD_AVAILABILITY_INFO" - Fetches available type(s) of Chrome Remote// Desktop sessions (private or shared) that can be used to remotely connect to// the device.//   "FETCH_SUPPORT_PACKET" - Fetch support packet from a device remotely.// Support packet is a zip archive that contains various system logs and debug// data from a ChromeOS device. The support packet can be downloaded from the// downloadURL link present in the `deviceFiles` field of// [`chromeosdevices`](https://developers.google.com/workspace/admin/directory/r// eference/rest/v1/chromeosdevices)Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CommandExpireTime") 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. "CommandExpireTime") 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:"-"`}

DirectoryChromeosdevicesCommand: Information regarding a command that wasissued to a device.

func (DirectoryChromeosdevicesCommand)MarshalJSONadded inv0.34.0

func (sDirectoryChromeosdevicesCommand) MarshalJSON() ([]byte,error)

typeDirectoryChromeosdevicesCommandResultadded inv0.34.0

type DirectoryChromeosdevicesCommandResult struct {// CommandResultPayload: The payload for the command result. The following// commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a// stringified JSON object in the form: { "url": url }. The provided URL links// to the Chrome Remote Desktop session and requires authentication using only// the `email` associated with the command's issuance. *// `FETCH_CRD_AVAILABILITY_INFO`: Payload is a stringified JSON object in the// form: { "deviceIdleTimeInSeconds": number, "userSessionType": string,// "remoteSupportAvailability": string, "remoteAccessAvailability": string }.// The "remoteSupportAvailability" field is set to "AVAILABLE" if `shared` CRD// session to the device is available. The "remoteAccessAvailability" field is// set to "AVAILABLE" if `private` CRD session to the device is available.CommandResultPayloadstring `json:"commandResultPayload,omitempty"`// ErrorMessage: The error message with a short explanation as to why the// command failed. Only present if the command failed.ErrorMessagestring `json:"errorMessage,omitempty"`// ExecuteTime: The time at which the command was executed or failed to// execute.ExecuteTimestring `json:"executeTime,omitempty"`// Result: The result of the command.//// Possible values://   "COMMAND_RESULT_TYPE_UNSPECIFIED" - The command result was unspecified.//   "IGNORED" - The command was ignored as obsolete.//   "FAILURE" - The command could not be executed successfully.//   "SUCCESS" - The command was successfully executed.Resultstring `json:"result,omitempty"`// ForceSendFields is a list of field names (e.g. "CommandResultPayload") 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. "CommandResultPayload") 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:"-"`}

DirectoryChromeosdevicesCommandResult: The result of executing a command.

func (DirectoryChromeosdevicesCommandResult)MarshalJSONadded inv0.34.0

typeDirectoryChromeosdevicesIssueCommandRequestadded inv0.34.0

type DirectoryChromeosdevicesIssueCommandRequest struct {// CommandType: The type of command.//// Possible values://   "COMMAND_TYPE_UNSPECIFIED" - The command type was unspecified.//   "REBOOT" - Reboot the device. Can be issued to Kiosk and managed guest// session devices, and regular devices running ChromeOS version 113 or later.//   "TAKE_A_SCREENSHOT" - Take a screenshot of the device. Only available if// the device is in Kiosk Mode.//   "SET_VOLUME" - Set the volume of the device. Can only be issued to Kiosk// and managed guest session devices.//   "WIPE_USERS" - Wipe all the users off of the device. Executing this// command in the device will remove all user profile data, but it will keep// device policy and enrollment.//   "REMOTE_POWERWASH" - Wipes the device by performing a power wash.// Executing this command in the device will remove all data including user// policies, device policies and enrollment policies. Warning: This will revert// the device back to a factory state with no enrollment unless the device is// subject to forced or auto enrollment. Use with caution, as this is an// irreversible action!//   "DEVICE_START_CRD_SESSION" - Starts a Chrome Remote Desktop session.//   "CAPTURE_LOGS" - Capture the system logs of a kiosk device. The logs can// be downloaded from the downloadUrl link present in `deviceFiles` field of// [chromeosdevices](https://developers.google.com/workspace/admin/directory/ref// erence/rest/v1/chromeosdevices)//   "FETCH_CRD_AVAILABILITY_INFO" - Fetches available type(s) of Chrome Remote// Desktop sessions (private or shared) that can be used to remotely connect to// the device.//   "FETCH_SUPPORT_PACKET" - Fetch support packet from a device remotely.// Support packet is a zip archive that contains various system logs and debug// data from a ChromeOS device. The support packet can be downloaded from the// downloadURL link present in the `deviceFiles` field of// [`chromeosdevices`](https://developers.google.com/workspace/admin/directory/r// eference/rest/v1/chromeosdevices)CommandTypestring `json:"commandType,omitempty"`// Payload: The payload for the command, provide it only if command supports// it. The following commands support adding payload: * `SET_VOLUME`: Payload// is a stringified JSON object in the form: { "volume": 50 }. The volume has// to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload// is optionally a stringified JSON object in the form: { "ackedUserPresence":// true, "crdSessionType": string }. `ackedUserPresence` is a boolean. By// default, `ackedUserPresence` is set to `false`. To start a Chrome Remote// Desktop session for an active device, set `ackedUserPresence` to `true`.// `crdSessionType` can only select from values `private` (which grants the// remote admin exclusive control of the ChromeOS device) or `shared` (which// allows the admin and the local user to share control of the ChromeOS// device). If not set, `crdSessionType` defaults to `shared`. The// `FETCH_CRD_AVAILABILITY_INFO` command can be used to determine available// session types on the device. * `REBOOT`: Payload is a stringified JSON// object in the form: { "user_session_delay_seconds": 300 }. The// `user_session_delay_seconds` is the amount of seconds to wait before// rebooting the device if a user is logged in. It has to be an integer in the// range [0,300]. When payload is not present for reboot, 0 delay is the// default. Note: This only applies if an actual user is logged in, including a// Guest. If the device is in the login screen or in Kiosk mode the value is// not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`:// Payload is optionally a stringified JSON object in the form:// {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string,// "issueDescription": optional_issue_description_string,// "requestedDataCollectors": []}} The list of available `data_collector_enums`// are as following: Chrome System Information (1), Crash IDs (2), Memory// Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device// Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9),// Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12),// ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14),// Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs// (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS// Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS// Virtual Keyboard (22), ChromeOS Network Health (23). See more details in// help article (https://support.google.com/chrome/a?p=remote-log).Payloadstring `json:"payload,omitempty"`// ForceSendFields is a list of field names (e.g. "CommandType") 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. "CommandType") 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:"-"`}

DirectoryChromeosdevicesIssueCommandRequest: A request for issuing acommand.

func (DirectoryChromeosdevicesIssueCommandRequest)MarshalJSONadded inv0.34.0

typeDirectoryChromeosdevicesIssueCommandResponseadded inv0.34.0

type DirectoryChromeosdevicesIssueCommandResponse struct {// CommandId: The unique ID of the issued command, used to retrieve the command// status.CommandIdint64 `json:"commandId,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CommandId") 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. "CommandId") 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:"-"`}

DirectoryChromeosdevicesIssueCommandResponse: A response for issuing acommand.

func (DirectoryChromeosdevicesIssueCommandResponse)MarshalJSONadded inv0.34.0

typeDirectoryUsersCreateGuestRequestadded inv0.257.0

type DirectoryUsersCreateGuestRequest struct {// PrimaryGuestEmail: Immutable. External email of the guest user being// created.PrimaryGuestEmailstring `json:"primaryGuestEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "PrimaryGuestEmail") 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. "PrimaryGuestEmail") 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:"-"`}

DirectoryUsersCreateGuestRequest: Directory users guest creation requestmessage.

func (DirectoryUsersCreateGuestRequest)MarshalJSONadded inv0.257.0

func (sDirectoryUsersCreateGuestRequest) MarshalJSON() ([]byte,error)

typeDomainAlias

type DomainAlias struct {// CreationTime: The creation time of the domain alias. (Read-only).CreationTimeint64 `json:"creationTime,omitempty,string"`// DomainAliasName: The domain alias name.DomainAliasNamestring `json:"domainAliasName,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// ParentDomainName: The parent domain name that the domain alias is associated// with. This can either be a primary or secondary domain name within a// customer.ParentDomainNamestring `json:"parentDomainName,omitempty"`// Verified: Indicates the verification state of a domain alias. (Read-only)Verifiedbool `json:"verified,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreationTime") 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. "CreationTime") 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 (DomainAlias)MarshalJSON

func (sDomainAlias) MarshalJSON() ([]byte,error)

typeDomainAliases

type DomainAliases struct {// DomainAliases: A list of domain alias objects.DomainAliases []*DomainAlias `json:"domainAliases,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DomainAliases") 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. "DomainAliases") 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 (DomainAliases)MarshalJSON

func (sDomainAliases) MarshalJSON() ([]byte,error)

typeDomainAliasesDeleteCall

type DomainAliasesDeleteCall struct {// contains filtered or unexported fields}

func (*DomainAliasesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainAliasesDeleteCall)Do

Do executes the "directory.domainAliases.delete" call.

func (*DomainAliasesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainAliasesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeDomainAliasesGetCall

type DomainAliasesGetCall struct {// contains filtered or unexported fields}

func (*DomainAliasesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainAliasesGetCall)Do

Do executes the "directory.domainAliases.get" call.Any non-2xx status code is an error. Response headers are in either*DomainAlias.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*DomainAliasesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainAliasesGetCall)Header

func (c *DomainAliasesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*DomainAliasesGetCall)IfNoneMatch

func (c *DomainAliasesGetCall) IfNoneMatch(entityTagstring) *DomainAliasesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeDomainAliasesInsertCall

type DomainAliasesInsertCall struct {// contains filtered or unexported fields}

func (*DomainAliasesInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainAliasesInsertCall)Do

Do executes the "directory.domainAliases.insert" call.Any non-2xx status code is an error. Response headers are in either*DomainAlias.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*DomainAliasesInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainAliasesInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeDomainAliasesListCall

type DomainAliasesListCall struct {// contains filtered or unexported fields}

func (*DomainAliasesListCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainAliasesListCall)Do

Do executes the "directory.domainAliases.list" call.Any non-2xx status code is an error. Response headers are in either*DomainAliases.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*DomainAliasesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainAliasesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*DomainAliasesListCall)IfNoneMatch

func (c *DomainAliasesListCall) IfNoneMatch(entityTagstring) *DomainAliasesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*DomainAliasesListCall)ParentDomainName

func (c *DomainAliasesListCall) ParentDomainName(parentDomainNamestring) *DomainAliasesListCall

ParentDomainName sets the optional parameter "parentDomainName": Name of theparent domain for which domain aliases are to be fetched.

typeDomainAliasesService

type DomainAliasesService struct {// contains filtered or unexported fields}

funcNewDomainAliasesService

func NewDomainAliasesService(s *Service) *DomainAliasesService

func (*DomainAliasesService)Delete

func (r *DomainAliasesService) Delete(customerstring, domainAliasNamestring) *DomainAliasesDeleteCall

Delete: Deletes a domain Alias of the customer.

- customer: Immutable ID of the Google Workspace account.- domainAliasName: Name of domain alias to be retrieved.

func (*DomainAliasesService)Get

func (r *DomainAliasesService) Get(customerstring, domainAliasNamestring) *DomainAliasesGetCall

Get: Retrieves a domain alias of the customer.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.
  • domainAliasName: Name of domain alias to be retrieved.

func (*DomainAliasesService)Insert

func (r *DomainAliasesService) Insert(customerstring, domainalias *DomainAlias) *DomainAliasesInsertCall

Insert: Inserts a domain alias of the customer.

- customer: Immutable ID of the Google Workspace account.

func (*DomainAliasesService)List

List: Lists the domain aliases of the customer.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.

typeDomains

type Domains struct {// CreationTime: Creation time of the domain. Expressed in Unix time// (https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).CreationTimeint64 `json:"creationTime,omitempty,string"`// DomainAliases: A list of domain alias objects. (Read-only)DomainAliases []*DomainAlias `json:"domainAliases,omitempty"`// DomainName: The domain name of the customer.DomainNamestring `json:"domainName,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// IsPrimary: Indicates if the domain is a primary domain (Read-only).IsPrimarybool `json:"isPrimary,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// Verified: Indicates the verification state of a domain. (Read-only).Verifiedbool `json:"verified,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreationTime") 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. "CreationTime") 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 (Domains)MarshalJSON

func (sDomains) MarshalJSON() ([]byte,error)

typeDomains2

type Domains2 struct {// Domains: A list of domain objects.Domains []*Domains `json:"domains,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Domains") 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. "Domains") 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 (Domains2)MarshalJSON

func (sDomains2) MarshalJSON() ([]byte,error)

typeDomainsDeleteCall

type DomainsDeleteCall struct {// contains filtered or unexported fields}

func (*DomainsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainsDeleteCall)Do

Do executes the "directory.domains.delete" call.

func (*DomainsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainsDeleteCall)Header

func (c *DomainsDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeDomainsGetCall

type DomainsGetCall struct {// contains filtered or unexported fields}

func (*DomainsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainsGetCall)Do

Do executes the "directory.domains.get" call.Any non-2xx status code is an error. Response headers are in either*Domains.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*DomainsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainsGetCall)Header

func (c *DomainsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*DomainsGetCall)IfNoneMatch

func (c *DomainsGetCall) IfNoneMatch(entityTagstring) *DomainsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeDomainsInsertCall

type DomainsInsertCall struct {// contains filtered or unexported fields}

func (*DomainsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainsInsertCall)Do

Do executes the "directory.domains.insert" call.Any non-2xx status code is an error. Response headers are in either*Domains.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*DomainsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainsInsertCall)Header

func (c *DomainsInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeDomainsListCall

type DomainsListCall struct {// contains filtered or unexported fields}

func (*DomainsListCall)Context

Context sets the context to be used in this call's Do method.

func (*DomainsListCall)Do

Do executes the "directory.domains.list" call.Any non-2xx status code is an error. Response headers are in either*Domains2.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*DomainsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*DomainsListCall)Header

func (c *DomainsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*DomainsListCall)IfNoneMatch

func (c *DomainsListCall) IfNoneMatch(entityTagstring) *DomainsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeDomainsService

type DomainsService struct {// contains filtered or unexported fields}

funcNewDomainsService

func NewDomainsService(s *Service) *DomainsService

func (*DomainsService)Delete

func (r *DomainsService) Delete(customerstring, domainNamestring) *DomainsDeleteCall

Delete: Deletes a domain of the customer.

- customer: Immutable ID of the Google Workspace account.- domainName: Name of domain to be deleted.

func (*DomainsService)Get

func (r *DomainsService) Get(customerstring, domainNamestring) *DomainsGetCall

Get: Retrieves a domain of the customer.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.
  • domainName: Name of domain to be retrieved.

func (*DomainsService)Insert

func (r *DomainsService) Insert(customerstring, domains *Domains) *DomainsInsertCall

Insert: Inserts a domain of the customer.

- customer: Immutable ID of the Google Workspace account.

func (*DomainsService)List

func (r *DomainsService) List(customerstring) *DomainsListCall

List: Lists the domains of the customer.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.

typeEmptyadded inv0.42.0

type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeFailureInfoadded inv0.42.0

type FailureInfo struct {// ErrorCode: Canonical code for why the update failed to apply.//// Possible values://   "OK" - Not an error; returned on success. HTTP Mapping: 200 OK//   "CANCELLED" - The operation was cancelled, typically by the caller. HTTP// Mapping: 499 Client Closed Request//   "UNKNOWN" - Unknown error. For example, this error may be returned when a// `Status` value received from another address space belongs to an error space// that is not known in this address space. Also errors raised by APIs that do// not return enough error information may be converted to this error. HTTP// Mapping: 500 Internal Server Error//   "INVALID_ARGUMENT" - The client specified an invalid argument. Note that// this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates// arguments that are problematic regardless of the state of the system (e.g.,// a malformed file name). HTTP Mapping: 400 Bad Request//   "DEADLINE_EXCEEDED" - The deadline expired before the operation could// complete. For operations that change the state of the system, this error may// be returned even if the operation has completed successfully. For example, a// successful response from a server could have been delayed long enough for// the deadline to expire. HTTP Mapping: 504 Gateway Timeout//   "NOT_FOUND" - Some requested entity (e.g., file or directory) was not// found. Note to server developers: if a request is denied for an entire class// of users, such as gradual feature rollout or undocumented allowlist,// `NOT_FOUND` may be used. If a request is denied for some users within a// class of users, such as user-based access control, `PERMISSION_DENIED` must// be used. HTTP Mapping: 404 Not Found//   "ALREADY_EXISTS" - The entity that a client attempted to create (e.g.,// file or directory) already exists. HTTP Mapping: 409 Conflict//   "PERMISSION_DENIED" - The caller does not have permission to execute the// specified operation. `PERMISSION_DENIED` must not be used for rejections// caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for// those errors). `PERMISSION_DENIED` must not be used if the caller can not be// identified (use `UNAUTHENTICATED` instead for those errors). This error code// does not imply the request is valid or the requested entity exists or// satisfies other pre-conditions. HTTP Mapping: 403 Forbidden//   "UNAUTHENTICATED" - The request does not have valid authentication// credentials for the operation. HTTP Mapping: 401 Unauthorized//   "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a// per-user quota, or perhaps the entire file system is out of space. HTTP// Mapping: 429 Too Many Requests//   "FAILED_PRECONDITION" - The operation was rejected because the system is// not in a state required for the operation's execution. For example, the// directory to be deleted is non-empty, an rmdir operation is applied to a// non-directory, etc. Service implementors can use the following guidelines to// decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use// `UNAVAILABLE` if the client can retry just the failing call. (b) Use// `ABORTED` if the client should retry at a higher level. For example, when a// client-specified test-and-set fails, indicating the client should restart a// read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client// should not retry until the system state has been explicitly fixed. For// example, if an "rmdir" fails because the directory is non-empty,// `FAILED_PRECONDITION` should be returned since the client should not retry// unless the files are deleted from the directory. HTTP Mapping: 400 Bad// Request//   "ABORTED" - The operation was aborted, typically due to a concurrency// issue such as a sequencer check failure or transaction abort. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 409 Conflict//   "OUT_OF_RANGE" - The operation was attempted past the valid range. E.g.,// seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error// indicates a problem that may be fixed if the system state changes. For// example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to// read at an offset that is not in the range [0,2^32-1], but it will generate// `OUT_OF_RANGE` if asked to read from an offset past the current file size.// There is a fair bit of overlap between `FAILED_PRECONDITION` and// `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error)// when it applies so that callers who are iterating through a space can easily// look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping:// 400 Bad Request//   "UNIMPLEMENTED" - The operation is not implemented or is not// supported/enabled in this service. HTTP Mapping: 501 Not Implemented//   "INTERNAL" - Internal errors. This means that some invariants expected by// the underlying system have been broken. This error code is reserved for// serious errors. HTTP Mapping: 500 Internal Server Error//   "UNAVAILABLE" - The service is currently unavailable. This is most likely// a transient condition, which can be corrected by retrying with a backoff.// Note that it is not always safe to retry non-idempotent operations. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable//   "DATA_LOSS" - Unrecoverable data loss or corruption. HTTP Mapping: 500// Internal Server ErrorErrorCodestring `json:"errorCode,omitempty"`// ErrorMessage: Failure reason message.ErrorMessagestring `json:"errorMessage,omitempty"`// Printer: Failed printer.Printer *Printer `json:"printer,omitempty"`// PrinterId: Id of a failed printer.PrinterIdstring `json:"printerId,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorCode") 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. "ErrorCode") 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:"-"`}

FailureInfo: Info about failures

func (FailureInfo)MarshalJSONadded inv0.42.0

func (sFailureInfo) MarshalJSON() ([]byte,error)

typeFanInfoadded inv0.179.0

type FanInfo struct {// SpeedRpm: Output only. Fan speed in RPM.SpeedRpmint64 `json:"speedRpm,omitempty"`// ForceSendFields is a list of field names (e.g. "SpeedRpm") 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. "SpeedRpm") 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:"-"`}

FanInfo: Information about the device's fan.

func (FanInfo)MarshalJSONadded inv0.179.0

func (sFanInfo) MarshalJSON() ([]byte,error)

typeFeature

type Feature struct {// Etags: ETag of the resource.Etagsstring `json:"etags,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// Name: The name of the feature.Namestring `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. "Etags") 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. "Etags") 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:"-"`}

Feature: JSON template for Feature object in Directory API.

func (Feature)MarshalJSON

func (sFeature) MarshalJSON() ([]byte,error)

typeFeatureInstance

type FeatureInstance struct {// Feature: The feature that this is an instance of. A calendar resource may// have multiple instances of a feature.Feature *Feature `json:"feature,omitempty"`// ForceSendFields is a list of field names (e.g. "Feature") 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. "Feature") 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:"-"`}

FeatureInstance: JSON template for a feature instance.

func (FeatureInstance)MarshalJSON

func (sFeatureInstance) MarshalJSON() ([]byte,error)

typeFeatureRename

type FeatureRename struct {// NewName: New name of the feature.NewNamestring `json:"newName,omitempty"`// ForceSendFields is a list of field names (e.g. "NewName") 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. "NewName") 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 (FeatureRename)MarshalJSON

func (sFeatureRename) MarshalJSON() ([]byte,error)

typeFeatures

type Features struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Features: The Features in this page of results.Features []*Feature `json:"features,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `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. "Etag") 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. "Etag") 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:"-"`}

Features: Public API: Resources.features

func (Features)MarshalJSON

func (sFeatures) MarshalJSON() ([]byte,error)

typeGroup

type Group struct {// AdminCreated: Read-only. Value is `true` if this group was created by an// administrator rather than a user.AdminCreatedbool `json:"adminCreated,omitempty"`// Aliases: Read-only. The list of a group's alias email addresses. To add,// update, or remove a group's aliases, use the `groups.aliases` methods. If// edited in a group's POST or PUT request, the edit is ignored.Aliases []string `json:"aliases,omitempty"`// Description: An extended description to help users determine the purpose of// a group. For example, you can include information about who should join the// group, the types of messages to send to the group, links to FAQs about the// group, or related groups. Maximum length is `4,096` characters.Descriptionstring `json:"description,omitempty"`// DirectMembersCount: The number of users that are direct members of the// group. If a group is a member (child) of this group (the parent), members of// the child group are not counted in the `directMembersCount` property of the// parent group.DirectMembersCountint64 `json:"directMembersCount,omitempty,string"`// Email: The group's email address. If your account has multiple domains,// select the appropriate domain for the email address. The `email` must be// unique. This property is required when creating a group. Group email// addresses are subject to the same character usage rules as usernames, see// the help center (https://support.google.com/a/answer/9193374) for details.Emailstring `json:"email,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Id: Read-only. The unique ID of a group. A group `id` can be used as a group// request URI's `groupKey`.Idstring `json:"id,omitempty"`// Kind: The type of the API resource. For Groups resources, the value is// `admin#directory#group`.Kindstring `json:"kind,omitempty"`// Name: The group's display name.Namestring `json:"name,omitempty"`// NonEditableAliases: Read-only. The list of the group's non-editable alias// email addresses that are outside of the account's primary domain or// subdomains. These are functioning email addresses used by the group. This is// a read-only property returned in the API's response for a group. If edited// in a group's POST or PUT request, the edit is ignored.NonEditableAliases []string `json:"nonEditableAliases,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AdminCreated") 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. "AdminCreated") 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:"-"`}

Group: Google Groups provide your users the ability to send messages togroups of people using the group's email address. For more information aboutcommon tasks, see the Developer's Guide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups).For information about other types of groups, see the Cloud Identity GroupsAPI documentation (https://cloud.google.com/identity/docs/groups). Note: Theuser calling the API (or being impersonated by a service account) must havean assigned role(https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles)that includes Admin API Groups permissions, such as Super Admin or GroupsAdmin.

func (Group)MarshalJSON

func (sGroup) MarshalJSON() ([]byte,error)

typeGroupAliasadded inv0.93.0

type GroupAlias struct {// Alias: The alias email address.Aliasstring `json:"alias,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Id: The unique ID of the group.Idstring `json:"id,omitempty"`// Kind: The type of the API resource. For Alias resources, the value is// `admin#directory#alias`.Kindstring `json:"kind,omitempty"`// PrimaryEmail: The primary email address of the group.PrimaryEmailstring `json:"primaryEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "Alias") 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. "Alias") 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:"-"`}

GroupAlias: The Directory API manages aliases, which are alternative emailaddresses.

func (GroupAlias)MarshalJSONadded inv0.93.0

func (sGroupAlias) MarshalJSON() ([]byte,error)

typeGroups

type Groups struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Groups: A list of group objects.Groups []*Group `json:"groups,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// NextPageToken: Token used to access next page of this result.NextPageTokenstring `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. "Etag") 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. "Etag") 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 (Groups)MarshalJSON

func (sGroups) MarshalJSON() ([]byte,error)

typeGroupsAliasesDeleteCall

type GroupsAliasesDeleteCall struct {// contains filtered or unexported fields}

func (*GroupsAliasesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsAliasesDeleteCall)Do

Do executes the "directory.groups.aliases.delete" call.

func (*GroupsAliasesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsAliasesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeGroupsAliasesInsertCall

type GroupsAliasesInsertCall struct {// contains filtered or unexported fields}

func (*GroupsAliasesInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsAliasesInsertCall)Do

Do executes the "directory.groups.aliases.insert" call.Any non-2xx status code is an error. Response headers are in either*Alias.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsAliasesInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsAliasesInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeGroupsAliasesListCall

type GroupsAliasesListCall struct {// contains filtered or unexported fields}

func (*GroupsAliasesListCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsAliasesListCall)Do

Do executes the "directory.groups.aliases.list" call.Any non-2xx status code is an error. Response headers are in either*Aliases.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsAliasesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsAliasesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*GroupsAliasesListCall)IfNoneMatch

func (c *GroupsAliasesListCall) IfNoneMatch(entityTagstring) *GroupsAliasesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeGroupsAliasesService

type GroupsAliasesService struct {// contains filtered or unexported fields}

funcNewGroupsAliasesService

func NewGroupsAliasesService(s *Service) *GroupsAliasesService

func (*GroupsAliasesService)Delete

Delete: Removes an alias.

  • alias: The alias to be removed.
  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*GroupsAliasesService)Insert

func (r *GroupsAliasesService) Insert(groupKeystring, alias *Alias) *GroupsAliasesInsertCall

Insert: Adds an alias for the group.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*GroupsAliasesService)List

List: Lists all aliases for a group.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

typeGroupsDeleteCall

type GroupsDeleteCall struct {// contains filtered or unexported fields}

func (*GroupsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsDeleteCall)Do

Do executes the "directory.groups.delete" call.

func (*GroupsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsDeleteCall)Header

func (c *GroupsDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeGroupsGetCall

type GroupsGetCall struct {// contains filtered or unexported fields}

func (*GroupsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsGetCall)Do

func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Group,error)

Do executes the "directory.groups.get" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsGetCall)Fields

func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsGetCall)Header

func (c *GroupsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*GroupsGetCall)IfNoneMatch

func (c *GroupsGetCall) IfNoneMatch(entityTagstring) *GroupsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeGroupsInsertCall

type GroupsInsertCall struct {// contains filtered or unexported fields}

func (*GroupsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsInsertCall)Do

Do executes the "directory.groups.insert" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsInsertCall)Header

func (c *GroupsInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeGroupsListCall

type GroupsListCall struct {// contains filtered or unexported fields}

func (*GroupsListCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsListCall)Customer

func (c *GroupsListCall) Customer(customerstring) *GroupsListCall

Customer sets the optional parameter "customer": The unique ID for thecustomer's Google Workspace account. In case of a multi-domain account, tofetch all groups for a customer, use this field instead of `domain`. You canalso use the `my_customer` alias to represent your account's `customerId`.The `customerId` is also returned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain` parameter.

func (*GroupsListCall)Do

Do executes the "directory.groups.list" call.Any non-2xx status code is an error. Response headers are in either*Groups.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsListCall)Domain

func (c *GroupsListCall) Domain(domainstring) *GroupsListCall

Domain sets the optional parameter "domain": The domain name. Use this fieldto get groups from only one domain. To return all domains for a customeraccount, use the `customer` query parameter instead.

func (*GroupsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsListCall)Header

func (c *GroupsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*GroupsListCall)IfNoneMatch

func (c *GroupsListCall) IfNoneMatch(entityTagstring) *GroupsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*GroupsListCall)MaxResults

func (c *GroupsListCall) MaxResults(maxResultsint64) *GroupsListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return. Max allowed value is 200.

func (*GroupsListCall)OrderBy

func (c *GroupsListCall) OrderBy(orderBystring) *GroupsListCall

OrderBy sets the optional parameter "orderBy": Column to use for sortingresults

Possible values:

"email" - Email of the group.

func (*GroupsListCall)PageToken

func (c *GroupsListCall) PageToken(pageTokenstring) *GroupsListCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage in the list

func (*GroupsListCall)Pages

func (c *GroupsListCall) Pages(ctxcontext.Context, f func(*Groups)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.

func (*GroupsListCall)Query

func (c *GroupsListCall) Query(querystring) *GroupsListCall

Query sets the optional parameter "query": Query string search. Contains oneor more search clauses, each with a field, operator, and value. For completedocumentation, go to Search for groups(https://developers.google.com/workspace/admin/directory/v1/guides/search-groups).

func (*GroupsListCall)SortOrder

func (c *GroupsListCall) SortOrder(sortOrderstring) *GroupsListCall

SortOrder sets the optional parameter "sortOrder": Whether to return resultsin ascending or descending order. Only of use when orderBy is also used

Possible values:

"ASCENDING" - Ascending order."DESCENDING" - Descending order.

func (*GroupsListCall)UserKey

func (c *GroupsListCall) UserKey(userKeystring) *GroupsListCall

UserKey sets the optional parameter "userKey": Email or immutable ID of theuser if only those groups are to be listed, the given user is a member of.If it's an ID, it should match with the ID of the user object. Cannot beused with the `customer` parameter.

typeGroupsPatchCall

type GroupsPatchCall struct {// contains filtered or unexported fields}

func (*GroupsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsPatchCall)Do

Do executes the "directory.groups.patch" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsPatchCall)Header

func (c *GroupsPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeGroupsService

type GroupsService struct {Aliases *GroupsAliasesService// contains filtered or unexported fields}

funcNewGroupsService

func NewGroupsService(s *Service) *GroupsService

func (*GroupsService)Delete

func (r *GroupsService) Delete(groupKeystring) *GroupsDeleteCall

Delete: Deletes a group.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*GroupsService)Get

func (r *GroupsService) Get(groupKeystring) *GroupsGetCall

Get: Retrieves a group's properties.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*GroupsService)Insert

func (r *GroupsService) Insert(group *Group) *GroupsInsertCall

Insert: Creates a group.

func (*GroupsService)List

func (r *GroupsService) List() *GroupsListCall

List: Retrieves all groups of a domain or of a user given a userKey(paginated).

func (*GroupsService)Patch

func (r *GroupsService) Patch(groupKeystring, group *Group) *GroupsPatchCall

Patch: Updates a group's properties. This method supports patch semantics(https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*GroupsService)Update

func (r *GroupsService) Update(groupKeystring, group *Group) *GroupsUpdateCall

Update: Updates a group's properties.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

typeGroupsUpdateCall

type GroupsUpdateCall struct {// contains filtered or unexported fields}

func (*GroupsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*GroupsUpdateCall)Do

Do executes the "directory.groups.update" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsUpdateCall)Header

func (c *GroupsUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeGuestAccountInfoadded inv0.257.0

type GuestAccountInfo struct {// PrimaryGuestEmail: Immutable. The guest's external email.PrimaryGuestEmailstring `json:"primaryGuestEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "PrimaryGuestEmail") 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. "PrimaryGuestEmail") 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:"-"`}

GuestAccountInfo: Account info specific to Guest users.

func (GuestAccountInfo)MarshalJSONadded inv0.257.0

func (sGuestAccountInfo) MarshalJSON() ([]byte,error)

typeListPrintServersResponseadded inv0.98.0

type ListPrintServersResponse struct {// NextPageToken: A token that can be sent as `page_token` in a request to// retrieve the next page. If this field is omitted, there are no subsequent// pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// PrintServers: List of print servers.PrintServers []*PrintServer `json:"printServers,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 (ListPrintServersResponse)MarshalJSONadded inv0.98.0

func (sListPrintServersResponse) MarshalJSON() ([]byte,error)

typeListPrinterModelsResponseadded inv0.42.0

type ListPrinterModelsResponse struct {// NextPageToken: A token, which can be sent as `page_token` to retrieve the// next page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// PrinterModels: Printer models that are currently allowed to be configured// for ChromeOs. Some printers may be added or removed over time.PrinterModels []*PrinterModel `json:"printerModels,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:"-"`}

ListPrinterModelsResponse: Response for listing allowed printer models.

func (ListPrinterModelsResponse)MarshalJSONadded inv0.42.0

func (sListPrinterModelsResponse) MarshalJSON() ([]byte,error)

typeListPrintersResponseadded inv0.42.0

type ListPrintersResponse struct {// NextPageToken: A token, which can be sent as `page_token` to retrieve the// next page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// Printers: List of printers. If `org_unit_id` was given in the request, then// only printers visible for this OU will be returned. If `org_unit_id` was not// given in the request, then all printers will be returned.Printers []*Printer `json:"printers,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:"-"`}

ListPrintersResponse: Response for listing printers.

func (ListPrintersResponse)MarshalJSONadded inv0.42.0

func (sListPrintersResponse) MarshalJSON() ([]byte,error)

typeMember

type Member struct {// DeliverySettings: Defines mail delivery preferences of member. This field is// only supported by `insert`, `update`, and `get` methods.DeliverySettingsstring `json:"delivery_settings,omitempty"`// Email: The member's email address. A member can be a user or another group.// This property is required when adding a member to a group. The `email` must// be unique and cannot be an alias of another group. If the email address is// changed, the API automatically reflects the email address changes.Emailstring `json:"email,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Id: The unique ID of the group member. A member `id` can be used as a member// request URI's `memberKey`.Idstring `json:"id,omitempty"`// Kind: The type of the API resource. For Members resources, the value is// `admin#directory#member`.Kindstring `json:"kind,omitempty"`// Role: The member's role in a group. The API returns an error for cycles in// group memberships. For example, if `group1` is a member of `group2`,// `group2` cannot be a member of `group1`. For more information about a// member's role, see the administration help center// (https://support.google.com/a/answer/167094).Rolestring `json:"role,omitempty"`// Status: Status of member (Immutable)Statusstring `json:"status,omitempty"`// Type: The type of group member.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DeliverySettings") 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. "DeliverySettings") 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:"-"`}

Member: A Google Groups member can be a user or another group. This membercan be inside or outside of your account's domains. For more informationabout common group member tasks, see the Developer's Guide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).

func (Member)MarshalJSON

func (sMember) MarshalJSON() ([]byte,error)

typeMembers

type Members struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// Members: A list of member objects.Members []*Member `json:"members,omitempty"`// NextPageToken: Token used to access next page of this result.NextPageTokenstring `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. "Etag") 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. "Etag") 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 (Members)MarshalJSON

func (sMembers) MarshalJSON() ([]byte,error)

typeMembersDeleteCall

type MembersDeleteCall struct {// contains filtered or unexported fields}

func (*MembersDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersDeleteCall)Do

Do executes the "directory.members.delete" call.

func (*MembersDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersDeleteCall)Header

func (c *MembersDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMembersGetCall

type MembersGetCall struct {// contains filtered or unexported fields}

func (*MembersGetCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersGetCall)Do

Do executes the "directory.members.get" call.Any non-2xx status code is an error. Response headers are in either*Member.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MembersGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersGetCall)Header

func (c *MembersGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MembersGetCall)IfNoneMatch

func (c *MembersGetCall) IfNoneMatch(entityTagstring) *MembersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeMembersHasMember

type MembersHasMember struct {// IsMember: Output only. Identifies whether the given user is a member of the// group. Membership can be direct or nested.IsMemberbool `json:"isMember,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "IsMember") 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. "IsMember") 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:"-"`}

MembersHasMember: JSON template for Has Member response in Directory API.

func (MembersHasMember)MarshalJSON

func (sMembersHasMember) MarshalJSON() ([]byte,error)

typeMembersHasMemberCall

type MembersHasMemberCall struct {// contains filtered or unexported fields}

func (*MembersHasMemberCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersHasMemberCall)Do

Do executes the "directory.members.hasMember" call.Any non-2xx status code is an error. Response headers are in either*MembersHasMember.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MembersHasMemberCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersHasMemberCall)Header

func (c *MembersHasMemberCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MembersHasMemberCall)IfNoneMatch

func (c *MembersHasMemberCall) IfNoneMatch(entityTagstring) *MembersHasMemberCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeMembersInsertCall

type MembersInsertCall struct {// contains filtered or unexported fields}

func (*MembersInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersInsertCall)Do

Do executes the "directory.members.insert" call.Any non-2xx status code is an error. Response headers are in either*Member.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MembersInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersInsertCall)Header

func (c *MembersInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMembersListCall

type MembersListCall struct {// contains filtered or unexported fields}

func (*MembersListCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersListCall)Do

Do executes the "directory.members.list" call.Any non-2xx status code is an error. Response headers are in either*Members.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MembersListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersListCall)Header

func (c *MembersListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MembersListCall)IfNoneMatch

func (c *MembersListCall) IfNoneMatch(entityTagstring) *MembersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MembersListCall)IncludeDerivedMembership

func (c *MembersListCall) IncludeDerivedMembership(includeDerivedMembershipbool) *MembersListCall

IncludeDerivedMembership sets the optional parameter"includeDerivedMembership": Whether to list indirect memberships. Default:false.

func (*MembersListCall)MaxResults

func (c *MembersListCall) MaxResults(maxResultsint64) *MembersListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return. Max allowed value is 200.

func (*MembersListCall)PageToken

func (c *MembersListCall) PageToken(pageTokenstring) *MembersListCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage in the list.

func (*MembersListCall)Pages

func (c *MembersListCall) Pages(ctxcontext.Context, f func(*Members)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.

func (*MembersListCall)Roles

func (c *MembersListCall) Roles(rolesstring) *MembersListCall

Roles sets the optional parameter "roles": The `roles` query parameterallows you to retrieve group members by role. Allowed values are `OWNER`,`MANAGER`, and `MEMBER`.

typeMembersPatchCall

type MembersPatchCall struct {// contains filtered or unexported fields}

func (*MembersPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersPatchCall)Do

Do executes the "directory.members.patch" call.Any non-2xx status code is an error. Response headers are in either*Member.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MembersPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersPatchCall)Header

func (c *MembersPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMembersService

type MembersService struct {// contains filtered or unexported fields}

funcNewMembersService

func NewMembersService(s *Service) *MembersService

func (*MembersService)Delete

func (r *MembersService) Delete(groupKeystring, memberKeystring) *MembersDeleteCall

Delete: Removes a member from a group.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.
  • memberKey: Identifies the group member in the API request. A group membercan be a user or another group. The value can be the member's (group oruser) primary email address, alias, or unique ID.

func (*MembersService)Get

func (r *MembersService) Get(groupKeystring, memberKeystring) *MembersGetCall

Get: Retrieves a group member's properties.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.
  • memberKey: Identifies the group member in the API request. A group membercan be a user or another group. The value can be the member's (group oruser) primary email address, alias, or unique ID.

func (*MembersService)HasMember

func (r *MembersService) HasMember(groupKeystring, memberKeystring) *MembersHasMemberCall

HasMember: Checks whether the given user is a member of the group.Membership can be direct or nested, but if nested, the `memberKey` and`groupKey` must be entities in the same domain or an `Invalid input` erroris returned. To check for nested memberships that include entities outsideof the group's domain, use the `checkTransitiveMembership()`(https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership)method in the Cloud Identity Groups API.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.
  • memberKey: Identifies the user member in the API request. The value can bethe user's primary email address, alias, or unique ID.

func (*MembersService)Insert

func (r *MembersService) Insert(groupKeystring, member *Member) *MembersInsertCall

Insert: Adds a user to the specified group.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*MembersService)List

func (r *MembersService) List(groupKeystring) *MembersListCall

List: Retrieves a paginated list of all members in a group. This methodtimes out after 60 minutes. For more information, see Troubleshoot errorcodes(https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.

func (*MembersService)Patch

func (r *MembersService) Patch(groupKeystring, memberKeystring, member *Member) *MembersPatchCall

Patch: Updates the membership properties of a user in the specified group.This method supports patch semantics(https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.
  • memberKey: Identifies the group member in the API request. A group membercan be a user or another group. The value can be the member's (group oruser) primary email address, alias, or unique ID.

func (*MembersService)Update

func (r *MembersService) Update(groupKeystring, memberKeystring, member *Member) *MembersUpdateCall

Update: Updates the membership of a user in the specified group.

  • groupKey: Identifies the group in the API request. The value can be thegroup's email address, group alias, or the unique group ID.
  • memberKey: Identifies the group member in the API request. A group membercan be a user or another group. The value can be the member's (group oruser) primary email address, alias, or unique ID.

typeMembersUpdateCall

type MembersUpdateCall struct {// contains filtered or unexported fields}

func (*MembersUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*MembersUpdateCall)Do

Do executes the "directory.members.update" call.Any non-2xx status code is an error. Response headers are in either*Member.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MembersUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MembersUpdateCall)Header

func (c *MembersUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMobileDevice

type MobileDevice struct {// AdbStatus: Adb (USB debugging) enabled or disabled on device (Read-only)AdbStatusbool `json:"adbStatus,omitempty"`// Applications: The list of applications installed on an Android mobile// device. It is not applicable to Google Sync and iOS devices. The list// includes any Android applications that access Google Workspace data. When// updating an applications list, it is important to note that updates replace// the existing list. If the Android device has two existing applications and// the API updates the list with five applications, the is now the updated list// of five applications.Applications []*MobileDeviceApplications `json:"applications,omitempty"`// BasebandVersion: The device's baseband version.BasebandVersionstring `json:"basebandVersion,omitempty"`// BootloaderVersion: Mobile Device Bootloader version (Read-only)BootloaderVersionstring `json:"bootloaderVersion,omitempty"`// Brand: Mobile Device Brand (Read-only)Brandstring `json:"brand,omitempty"`// BuildNumber: The device's operating system build number.BuildNumberstring `json:"buildNumber,omitempty"`// DefaultLanguage: The default locale used on the device.DefaultLanguagestring `json:"defaultLanguage,omitempty"`// DeveloperOptionsStatus: Developer options enabled or disabled on device// (Read-only)DeveloperOptionsStatusbool `json:"developerOptionsStatus,omitempty"`// DeviceCompromisedStatus: The compromised device status.DeviceCompromisedStatusstring `json:"deviceCompromisedStatus,omitempty"`// DeviceId: The serial number for a Google Sync mobile device. For Android and// iOS devices, this is a software generated unique identifier.DeviceIdstring `json:"deviceId,omitempty"`// DevicePasswordStatus: DevicePasswordStatus (Read-only)DevicePasswordStatusstring `json:"devicePasswordStatus,omitempty"`// Email: The list of the owner's email addresses. If your application needs// the current list of user emails, use the get// (https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html)// method. For additional information, see the retrieve a user// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user)// method.Email []string `json:"email,omitempty"`// EncryptionStatus: Mobile Device Encryption Status (Read-only)EncryptionStatusstring `json:"encryptionStatus,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// FirstSync: Date and time the device was first synchronized with the policy// settings in the G Suite administrator control panel (Read-only)FirstSyncstring `json:"firstSync,omitempty"`// Hardware: Mobile Device Hardware (Read-only)Hardwarestring `json:"hardware,omitempty"`// HardwareId: The IMEI/MEID unique identifier for Android hardware. It is not// applicable to Google Sync devices. When adding an Android mobile device,// this is an optional property. When updating one of these devices, this is a// read-only property.HardwareIdstring `json:"hardwareId,omitempty"`// Imei: The device's IMEI number.Imeistring `json:"imei,omitempty"`// KernelVersion: The device's kernel version.KernelVersionstring `json:"kernelVersion,omitempty"`// Kind: The type of the API resource. For Mobiledevices resources, the value// is `admin#directory#mobiledevice`.Kindstring `json:"kind,omitempty"`// LastSync: Date and time the device was last synchronized with the policy// settings in the G Suite administrator control panel (Read-only)LastSyncstring `json:"lastSync,omitempty"`// ManagedAccountIsOnOwnerProfile: Boolean indicating if this account is on// owner/primary profile or not.ManagedAccountIsOnOwnerProfilebool `json:"managedAccountIsOnOwnerProfile,omitempty"`// Manufacturer: Mobile Device manufacturer (Read-only)Manufacturerstring `json:"manufacturer,omitempty"`// Meid: The device's MEID number.Meidstring `json:"meid,omitempty"`// Model: The mobile device's model name, for example Nexus S. This property// can be updated// (https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html).// For more information, see the Developer's Guide// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).Modelstring `json:"model,omitempty"`// Name: The list of the owner's user names. If your application needs the// current list of device owner names, use the get// (https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html)// method. For more information about retrieving mobile device user// information, see the Developer's Guide// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).Name []string `json:"name,omitempty"`// NetworkOperator: Mobile Device mobile or network operator (if available)// (Read-only)NetworkOperatorstring `json:"networkOperator,omitempty"`// Os: The mobile device's operating system, for example IOS 4.3 or Android// 2.3.5. This property can be updated// (https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html).// For more information, see the Developer's Guide// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).Osstring `json:"os,omitempty"`// OtherAccountsInfo: The list of accounts added on device (Read-only)OtherAccountsInfo []string `json:"otherAccountsInfo,omitempty"`// Privilege: DMAgentPermission (Read-only)Privilegestring `json:"privilege,omitempty"`// ReleaseVersion: Mobile Device release version version (Read-only)ReleaseVersionstring `json:"releaseVersion,omitempty"`// ResourceId: The unique ID the API service uses to identify the mobile// device.ResourceIdstring `json:"resourceId,omitempty"`// SecurityPatchLevel: Mobile Device Security patch level (Read-only)SecurityPatchLevelint64 `json:"securityPatchLevel,omitempty,string"`// SerialNumber: The device's serial number.SerialNumberstring `json:"serialNumber,omitempty"`// Status: The device's status.Statusstring `json:"status,omitempty"`// SupportsWorkProfile: Work profile supported on device (Read-only)SupportsWorkProfilebool `json:"supportsWorkProfile,omitempty"`// Type: The type of mobile device.Typestring `json:"type,omitempty"`// UnknownSourcesStatus: Unknown sources enabled or disabled on device// (Read-only)UnknownSourcesStatusbool `json:"unknownSourcesStatus,omitempty"`// UserAgent: Gives information about the device such as `os` version. This// property can be updated// (https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html).// For more information, see the Developer's Guide// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).UserAgentstring `json:"userAgent,omitempty"`// WifiMacAddress: The device's MAC address on Wi-Fi networks.WifiMacAddressstring `json:"wifiMacAddress,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AdbStatus") 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. "AdbStatus") 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:"-"`}

MobileDevice: Google Workspace Mobile Management includes Android, GoogleSync (https://support.google.com/a/answer/135937), and iOS devices. For moreinformation about common group mobile device API tasks, see the Developer'sGuide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).

func (MobileDevice)MarshalJSON

func (sMobileDevice) MarshalJSON() ([]byte,error)

typeMobileDeviceAction

type MobileDeviceAction struct {// Action: The action to be performed on the device.Actionstring `json:"action,omitempty"`// ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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 (MobileDeviceAction)MarshalJSON

func (sMobileDeviceAction) MarshalJSON() ([]byte,error)

typeMobileDeviceApplications

type MobileDeviceApplications struct {// DisplayName: The application's display name. An example is `Browser`.DisplayNamestring `json:"displayName,omitempty"`// PackageName: The application's package name. An example is// `com.android.browser`.PackageNamestring `json:"packageName,omitempty"`// Permission: The list of permissions of this application. These can be either// a standard Android permission or one defined by the application, and are// found in an application's Android manifest// (https://developer.android.com/guide/topics/manifest/uses-permission-element.html).// Examples of a Calendar application's permissions are `READ_CALENDAR`, or// `MANAGE_ACCOUNTS`.Permission []string `json:"permission,omitempty"`// VersionCode: The application's version code. An example is `13`.VersionCodeint64 `json:"versionCode,omitempty"`// VersionName: The application's version name. An example is `3.2-140714`.VersionNamestring `json:"versionName,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 (MobileDeviceApplications)MarshalJSON

func (sMobileDeviceApplications) MarshalJSON() ([]byte,error)

typeMobileDevices

type MobileDevices struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// Mobiledevices: A list of Mobile Device objects.Mobiledevices []*MobileDevice `json:"mobiledevices,omitempty"`// NextPageToken: Token used to access next page of this result.NextPageTokenstring `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. "Etag") 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. "Etag") 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 (MobileDevices)MarshalJSON

func (sMobileDevices) MarshalJSON() ([]byte,error)

typeMobiledevicesActionCall

type MobiledevicesActionCall struct {// contains filtered or unexported fields}

func (*MobiledevicesActionCall)Context

Context sets the context to be used in this call's Do method.

func (*MobiledevicesActionCall)Do

Do executes the "directory.mobiledevices.action" call.

func (*MobiledevicesActionCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MobiledevicesActionCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMobiledevicesDeleteCall

type MobiledevicesDeleteCall struct {// contains filtered or unexported fields}

func (*MobiledevicesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MobiledevicesDeleteCall)Do

Do executes the "directory.mobiledevices.delete" call.

func (*MobiledevicesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MobiledevicesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMobiledevicesGetCall

type MobiledevicesGetCall struct {// contains filtered or unexported fields}

func (*MobiledevicesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*MobiledevicesGetCall)Do

Do executes the "directory.mobiledevices.get" call.Any non-2xx status code is an error. Response headers are in either*MobileDevice.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MobiledevicesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MobiledevicesGetCall)Header

func (c *MobiledevicesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MobiledevicesGetCall)IfNoneMatch

func (c *MobiledevicesGetCall) IfNoneMatch(entityTagstring) *MobiledevicesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MobiledevicesGetCall)Projection

func (c *MobiledevicesGetCall) Projection(projectionstring) *MobiledevicesGetCall

Projection sets the optional parameter "projection": Restrict informationreturned to a set of selected fields.

Possible values:

"BASIC" - Includes only the basic metadata fields (e.g., deviceId, model,

status, type, and status)

"FULL" - Includes all metadata fields

typeMobiledevicesListCall

type MobiledevicesListCall struct {// contains filtered or unexported fields}

func (*MobiledevicesListCall)Context

Context sets the context to be used in this call's Do method.

func (*MobiledevicesListCall)Do

Do executes the "directory.mobiledevices.list" call.Any non-2xx status code is an error. Response headers are in either*MobileDevices.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MobiledevicesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MobiledevicesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MobiledevicesListCall)IfNoneMatch

func (c *MobiledevicesListCall) IfNoneMatch(entityTagstring) *MobiledevicesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MobiledevicesListCall)MaxResults

func (c *MobiledevicesListCall) MaxResults(maxResultsint64) *MobiledevicesListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return. Max allowed value is 100.

func (*MobiledevicesListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Device property to use forsorting results.

Possible values:

"deviceId" - The serial number for a Google Sync mobile device. For

Android devices, this is a software generated unique identifier.

"email" - The device owner's email address."lastSync" - Last policy settings sync date time of the device."model" - The mobile device's model."name" - The device owner's user name."os" - The device's operating system."status" - The device status."type" - Type of the device.

func (*MobiledevicesListCall)PageToken

func (c *MobiledevicesListCall) PageToken(pageTokenstring) *MobiledevicesListCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage in the list

func (*MobiledevicesListCall)Pages

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.

func (*MobiledevicesListCall)Projection

func (c *MobiledevicesListCall) Projection(projectionstring) *MobiledevicesListCall

Projection sets the optional parameter "projection": Restrict informationreturned to a set of selected fields.

Possible values:

"BASIC" - Includes only the basic metadata fields (e.g., deviceId, model,

status, type, and status)

"FULL" - Includes all metadata fields

func (*MobiledevicesListCall)Query

Query sets the optional parameter "query": Search string in the format givenathttps://developers.google.com/workspace/admin/directory/v1/search-operators

func (*MobiledevicesListCall)SortOrder

func (c *MobiledevicesListCall) SortOrder(sortOrderstring) *MobiledevicesListCall

SortOrder sets the optional parameter "sortOrder": Whether to return resultsin ascending or descending order. Must be used with the `orderBy` parameter.

Possible values:

"ASCENDING" - Ascending order."DESCENDING" - Descending order.

typeMobiledevicesService

type MobiledevicesService struct {// contains filtered or unexported fields}

funcNewMobiledevicesService

func NewMobiledevicesService(s *Service) *MobiledevicesService

func (*MobiledevicesService)Action

func (r *MobiledevicesService) Action(customerIdstring, resourceIdstring, mobiledeviceaction *MobileDeviceAction) *MobiledevicesActionCall

Action: Takes an action that affects a mobile device. For example, remotelywiping a device.

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • resourceId: The unique ID the API service uses to identify the mobiledevice.

func (*MobiledevicesService)Delete

func (r *MobiledevicesService) Delete(customerIdstring, resourceIdstring) *MobiledevicesDeleteCall

Delete: Removes a mobile device.

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • resourceId: The unique ID the API service uses to identify the mobiledevice.

func (*MobiledevicesService)Get

func (r *MobiledevicesService) Get(customerIdstring, resourceIdstring) *MobiledevicesGetCall

Get: Retrieves a mobile device's properties.

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • resourceId: The unique ID the API service uses to identify the mobiledevice.

func (*MobiledevicesService)List

List: Retrieves a paginated list of all user-owned mobile devices for anaccount. To retrieve a list that includes company-owned devices, use theCloud Identity Devices API(https://cloud.google.com/identity/docs/concepts/overview-devices) instead.This method times out after 60 minutes. For more information, seeTroubleshoot error codes(https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).

typeOrgUnit

type OrgUnit struct {// BlockInheritance: This field is deprecated and setting its value has no// effect.BlockInheritancebool `json:"blockInheritance,omitempty"`// Description: Description of the organizational unit.Descriptionstring `json:"description,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of the API resource. For Orgunits resources, the value is// `admin#directory#orgUnit`.Kindstring `json:"kind,omitempty"`// Name: The organizational unit's path name. For example, an organizational// unit's name within the /corp/support/sales_support parent path is// sales_support. Required.Namestring `json:"name,omitempty"`// OrgUnitId: The unique ID of the organizational unit.OrgUnitIdstring `json:"orgUnitId,omitempty"`// OrgUnitPath: The full path to the organizational unit. The `orgUnitPath` is// a derived property. When listed, it is derived from `parentOrgunitPath` and// organizational unit's `name`. For example, for an organizational unit named// 'apps' under parent organization '/engineering', the orgUnitPath is// '/engineering/apps'. In order to edit an `orgUnitPath`, either update the// name of the organization or the `parentOrgunitPath`. A user's organizational// unit determines which Google Workspace services the user has access to. If// the user is moved to a new organization, the user's access changes. For more// information about organization structures, see the administration help// center (https://support.google.com/a/answer/4352075). For more information// about moving a user to a different organization, see Update a user// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).OrgUnitPathstring `json:"orgUnitPath,omitempty"`// ParentOrgUnitId: The unique ID of the parent organizational unit. Required,// unless `parentOrgUnitPath` is set.ParentOrgUnitIdstring `json:"parentOrgUnitId,omitempty"`// ParentOrgUnitPath: The organizational unit's parent path. For example,// /corp/sales is the parent path for /corp/sales/sales_support organizational// unit. Required, unless `parentOrgUnitId` is set.ParentOrgUnitPathstring `json:"parentOrgUnitPath,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BlockInheritance") 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. "BlockInheritance") 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:"-"`}

OrgUnit: Managing your account's organizational units allows you toconfigure your users' access to services and custom settings. For moreinformation about common organizational unit tasks, see the Developer'sGuide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html).The customer's organizational unit hierarchy is limited to 35 levels ofdepth.

func (OrgUnit)MarshalJSON

func (sOrgUnit) MarshalJSON() ([]byte,error)

typeOrgUnits

type OrgUnits struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of the API resource. For Org Unit resources, the type is// `admin#directory#orgUnits`.Kindstring `json:"kind,omitempty"`// OrganizationUnits: A list of organizational unit objects.OrganizationUnits []*OrgUnit `json:"organizationUnits,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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 (OrgUnits)MarshalJSON

func (sOrgUnits) MarshalJSON() ([]byte,error)

typeOrgunitsDeleteCall

type OrgunitsDeleteCall struct {// contains filtered or unexported fields}

func (*OrgunitsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*OrgunitsDeleteCall)Do

Do executes the "directory.orgunits.delete" call.

func (*OrgunitsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrgunitsDeleteCall)Header

func (c *OrgunitsDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOrgunitsGetCall

type OrgunitsGetCall struct {// contains filtered or unexported fields}

func (*OrgunitsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*OrgunitsGetCall)Do

Do executes the "directory.orgunits.get" call.Any non-2xx status code is an error. Response headers are in either*OrgUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrgunitsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrgunitsGetCall)Header

func (c *OrgunitsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OrgunitsGetCall)IfNoneMatch

func (c *OrgunitsGetCall) IfNoneMatch(entityTagstring) *OrgunitsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeOrgunitsInsertCall

type OrgunitsInsertCall struct {// contains filtered or unexported fields}

func (*OrgunitsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*OrgunitsInsertCall)Do

Do executes the "directory.orgunits.insert" call.Any non-2xx status code is an error. Response headers are in either*OrgUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrgunitsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrgunitsInsertCall)Header

func (c *OrgunitsInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOrgunitsListCall

type OrgunitsListCall struct {// contains filtered or unexported fields}

func (*OrgunitsListCall)Context

Context sets the context to be used in this call's Do method.

func (*OrgunitsListCall)Do

Do executes the "directory.orgunits.list" call.Any non-2xx status code is an error. Response headers are in either*OrgUnits.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrgunitsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrgunitsListCall)Header

func (c *OrgunitsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OrgunitsListCall)IfNoneMatch

func (c *OrgunitsListCall) IfNoneMatch(entityTagstring) *OrgunitsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*OrgunitsListCall)OrgUnitPath

func (c *OrgunitsListCall) OrgUnitPath(orgUnitPathstring) *OrgunitsListCall

OrgUnitPath sets the optional parameter "orgUnitPath": The full path to theorganizational unit or its unique ID. Returns the children of the specifiedorganizational unit.

func (*OrgunitsListCall)Type

Type sets the optional parameter "type": Whether to return allsub-organizations or just immediate children.

Possible values:

"all" - All sub-organizational units."children" - Immediate children only (default)."allIncludingParent" - All sub-organizational units and the specified

organizational unit (root if not specified).

typeOrgunitsPatchCall

type OrgunitsPatchCall struct {// contains filtered or unexported fields}

func (*OrgunitsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*OrgunitsPatchCall)Do

Do executes the "directory.orgunits.patch" call.Any non-2xx status code is an error. Response headers are in either*OrgUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrgunitsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrgunitsPatchCall)Header

func (c *OrgunitsPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOrgunitsService

type OrgunitsService struct {// contains filtered or unexported fields}

funcNewOrgunitsService

func NewOrgunitsService(s *Service) *OrgunitsService

func (*OrgunitsService)Delete

func (r *OrgunitsService) Delete(customerIdstring, orgUnitPathstring) *OrgunitsDeleteCall

Delete: Removes an organizational unit.

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • orgUnitPath: The full path of the organizational unit (minus the leading`/`) or its unique ID.

func (*OrgunitsService)Get

func (r *OrgunitsService) Get(customerIdstring, orgUnitPathstring) *OrgunitsGetCall

Get: Retrieves an organizational unit.

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • orgUnitPath: The full path of the organizational unit (minus the leading`/`) or its unique ID.

func (*OrgunitsService)Insert

func (r *OrgunitsService) Insert(customerIdstring, orgunit *OrgUnit) *OrgunitsInsertCall

Insert: Adds an organizational unit.

func (*OrgunitsService)List

func (r *OrgunitsService) List(customerIdstring) *OrgunitsListCall

List: Retrieves a list of all organizational units for an account.

func (*OrgunitsService)Patch

func (r *OrgunitsService) Patch(customerIdstring, orgUnitPathstring, orgunit *OrgUnit) *OrgunitsPatchCall

Patch: Updates an organizational unit. This method supports patch semantics(https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • orgUnitPath: The full path of the organizational unit (minus the leading`/`) or its unique ID.

func (*OrgunitsService)Update

func (r *OrgunitsService) Update(customerIdstring, orgUnitPathstring, orgunit *OrgUnit) *OrgunitsUpdateCall

Update: Updates an organizational unit.

  • customerId: The unique ID for the customer's Google Workspace account. Asan account administrator, you can also use the `my_customer` alias torepresent your account's `customerId`. The `customerId` is also returnedas part of the Users resource(https://developers.google.com/workspace/admin/directory/v1/reference/users).
  • orgUnitPath: The full path of the organizational unit (minus the leading`/`) or its unique ID.

typeOrgunitsUpdateCall

type OrgunitsUpdateCall struct {// contains filtered or unexported fields}

func (*OrgunitsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*OrgunitsUpdateCall)Do

Do executes the "directory.orgunits.update" call.Any non-2xx status code is an error. Response headers are in either*OrgUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrgunitsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrgunitsUpdateCall)Header

func (c *OrgunitsUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOsUpdateStatusadded inv0.92.0

type OsUpdateStatus struct {// RebootTime: Date and time of the last reboot.RebootTimestring `json:"rebootTime,omitempty"`// State: The update state of an OS update.//// Possible values://   "updateStateUnspecified" - The update state is unspecified.//   "updateStateNotStarted" - There is an update pending but it hasn't// started.//   "updateStateDownloadInProgress" - The pending update is being downloaded.//   "updateStateNeedReboot" - The device is ready to install the update, but// must reboot.Statestring `json:"state,omitempty"`// TargetKioskAppVersion: New required platform version from the pending// updated kiosk app.TargetKioskAppVersionstring `json:"targetKioskAppVersion,omitempty"`// TargetOsVersion: New platform version of the OS image being downloaded and// applied. It is only set when update status is// UPDATE_STATUS_DOWNLOAD_IN_PROGRESS or UPDATE_STATUS_NEED_REBOOT. Note this// could be a dummy "0.0.0.0" for UPDATE_STATUS_NEED_REBOOT for some edge// cases, e.g. update engine is restarted without a reboot.TargetOsVersionstring `json:"targetOsVersion,omitempty"`// UpdateCheckTime: Date and time of the last update check.UpdateCheckTimestring `json:"updateCheckTime,omitempty"`// UpdateTime: Date and time of the last successful OS update.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "RebootTime") 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. "RebootTime") 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:"-"`}

OsUpdateStatus: Contains information regarding the current OS update status.

func (OsUpdateStatus)MarshalJSONadded inv0.92.0

func (sOsUpdateStatus) MarshalJSON() ([]byte,error)

typePrintServeradded inv0.98.0

type PrintServer struct {// CreateTime: Output only. Time when the print server was created.CreateTimestring `json:"createTime,omitempty"`// Description: Editable. Description of the print server (as shown in the// Admin console).Descriptionstring `json:"description,omitempty"`// DisplayName: Editable. Display name of the print server (as shown in the// Admin console).DisplayNamestring `json:"displayName,omitempty"`// Id: Immutable. ID of the print server. Leave empty when creating.Idstring `json:"id,omitempty"`// Name: Identifier. Resource name of the print server. Leave empty when// creating. Format: `customers/{customer.id}/printServers/{print_server.id}`Namestring `json:"name,omitempty"`// OrgUnitId: ID of the organization unit (OU) that owns this print server.// This value can only be set when the print server is initially created. If// it's not populated, the print server is placed under the root OU. The// `org_unit_id` can be retrieved using the Directory API// (https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).OrgUnitIdstring `json:"orgUnitId,omitempty"`// Uri: Editable. Print server URI.Uristring `json:"uri,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`}

PrintServer: Configuration for a print server.

func (PrintServer)MarshalJSONadded inv0.98.0

func (sPrintServer) MarshalJSON() ([]byte,error)

typePrintServerFailureInfoadded inv0.98.0

type PrintServerFailureInfo struct {// ErrorCode: Canonical code for why the update failed to apply.//// Possible values://   "OK" - Not an error; returned on success. HTTP Mapping: 200 OK//   "CANCELLED" - The operation was cancelled, typically by the caller. HTTP// Mapping: 499 Client Closed Request//   "UNKNOWN" - Unknown error. For example, this error may be returned when a// `Status` value received from another address space belongs to an error space// that is not known in this address space. Also errors raised by APIs that do// not return enough error information may be converted to this error. HTTP// Mapping: 500 Internal Server Error//   "INVALID_ARGUMENT" - The client specified an invalid argument. Note that// this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates// arguments that are problematic regardless of the state of the system (e.g.,// a malformed file name). HTTP Mapping: 400 Bad Request//   "DEADLINE_EXCEEDED" - The deadline expired before the operation could// complete. For operations that change the state of the system, this error may// be returned even if the operation has completed successfully. For example, a// successful response from a server could have been delayed long enough for// the deadline to expire. HTTP Mapping: 504 Gateway Timeout//   "NOT_FOUND" - Some requested entity (e.g., file or directory) was not// found. Note to server developers: if a request is denied for an entire class// of users, such as gradual feature rollout or undocumented allowlist,// `NOT_FOUND` may be used. If a request is denied for some users within a// class of users, such as user-based access control, `PERMISSION_DENIED` must// be used. HTTP Mapping: 404 Not Found//   "ALREADY_EXISTS" - The entity that a client attempted to create (e.g.,// file or directory) already exists. HTTP Mapping: 409 Conflict//   "PERMISSION_DENIED" - The caller does not have permission to execute the// specified operation. `PERMISSION_DENIED` must not be used for rejections// caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for// those errors). `PERMISSION_DENIED` must not be used if the caller can not be// identified (use `UNAUTHENTICATED` instead for those errors). This error code// does not imply the request is valid or the requested entity exists or// satisfies other pre-conditions. HTTP Mapping: 403 Forbidden//   "UNAUTHENTICATED" - The request does not have valid authentication// credentials for the operation. HTTP Mapping: 401 Unauthorized//   "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a// per-user quota, or perhaps the entire file system is out of space. HTTP// Mapping: 429 Too Many Requests//   "FAILED_PRECONDITION" - The operation was rejected because the system is// not in a state required for the operation's execution. For example, the// directory to be deleted is non-empty, an rmdir operation is applied to a// non-directory, etc. Service implementors can use the following guidelines to// decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use// `UNAVAILABLE` if the client can retry just the failing call. (b) Use// `ABORTED` if the client should retry at a higher level. For example, when a// client-specified test-and-set fails, indicating the client should restart a// read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client// should not retry until the system state has been explicitly fixed. For// example, if an "rmdir" fails because the directory is non-empty,// `FAILED_PRECONDITION` should be returned since the client should not retry// unless the files are deleted from the directory. HTTP Mapping: 400 Bad// Request//   "ABORTED" - The operation was aborted, typically due to a concurrency// issue such as a sequencer check failure or transaction abort. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 409 Conflict//   "OUT_OF_RANGE" - The operation was attempted past the valid range. E.g.,// seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error// indicates a problem that may be fixed if the system state changes. For// example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to// read at an offset that is not in the range [0,2^32-1], but it will generate// `OUT_OF_RANGE` if asked to read from an offset past the current file size.// There is a fair bit of overlap between `FAILED_PRECONDITION` and// `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error)// when it applies so that callers who are iterating through a space can easily// look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping:// 400 Bad Request//   "UNIMPLEMENTED" - The operation is not implemented or is not// supported/enabled in this service. HTTP Mapping: 501 Not Implemented//   "INTERNAL" - Internal errors. This means that some invariants expected by// the underlying system have been broken. This error code is reserved for// serious errors. HTTP Mapping: 500 Internal Server Error//   "UNAVAILABLE" - The service is currently unavailable. This is most likely// a transient condition, which can be corrected by retrying with a backoff.// Note that it is not always safe to retry non-idempotent operations. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable//   "DATA_LOSS" - Unrecoverable data loss or corruption. HTTP Mapping: 500// Internal Server ErrorErrorCodestring `json:"errorCode,omitempty"`// ErrorMessage: Failure reason message.ErrorMessagestring `json:"errorMessage,omitempty"`// PrintServer: Failed print server.PrintServer *PrintServer `json:"printServer,omitempty"`// PrintServerId: ID of a failed print server.PrintServerIdstring `json:"printServerId,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorCode") 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. "ErrorCode") 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:"-"`}

PrintServerFailureInfo: Info about failures

func (PrintServerFailureInfo)MarshalJSONadded inv0.98.0

func (sPrintServerFailureInfo) MarshalJSON() ([]byte,error)

typePrinteradded inv0.42.0

type Printer struct {// AuxiliaryMessages: Output only. Auxiliary messages about issues with the// printer configuration if any.AuxiliaryMessages []*AuxiliaryMessage `json:"auxiliaryMessages,omitempty"`// CreateTime: Output only. Time when printer was created.CreateTimestring `json:"createTime,omitempty"`// Description: Editable. Description of printer.Descriptionstring `json:"description,omitempty"`// DisplayName: Editable. Name of printer.DisplayNamestring `json:"displayName,omitempty"`// Id: Id of the printer. (During printer creation leave empty)Idstring `json:"id,omitempty"`// MakeAndModel: Editable. Make and model of printer. e.g. Lexmark MS610de// Value must be in format as seen in ListPrinterModels response.MakeAndModelstring `json:"makeAndModel,omitempty"`// Name: Identifier. The resource name of the Printer object, in the format// customers/{customer-id}/printers/{printer-id} (During printer creation leave// empty)Namestring `json:"name,omitempty"`// OrgUnitId: Organization Unit that owns this printer (Only can be set during// Printer creation)OrgUnitIdstring `json:"orgUnitId,omitempty"`// Uri: Editable. Printer URI.Uristring `json:"uri,omitempty"`// UseDriverlessConfig: Editable. flag to use driverless configuration or not.// If it's set to be true, make_and_model can be ignoredUseDriverlessConfigbool `json:"useDriverlessConfig,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AuxiliaryMessages") 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. "AuxiliaryMessages") 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:"-"`}

Printer: Printer configuration.

func (Printer)MarshalJSONadded inv0.42.0

func (sPrinter) MarshalJSON() ([]byte,error)

typePrinterModeladded inv0.42.0

type PrinterModel struct {// DisplayName: Display name. eq. "Brother MFC-8840D"DisplayNamestring `json:"displayName,omitempty"`// MakeAndModel: Make and model as represented in "make_and_model" field in// Printer object. eq. "brother mfc-8840d"MakeAndModelstring `json:"makeAndModel,omitempty"`// Manufacturer: Manufacturer. eq. "Brother"Manufacturerstring `json:"manufacturer,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}

PrinterModel: Printer manufacturer and model

func (PrinterModel)MarshalJSONadded inv0.42.0

func (sPrinterModel) MarshalJSON() ([]byte,error)

typePrivilege

type Privilege struct {// ChildPrivileges: A list of child privileges. Privileges for a service form a// tree. Each privilege can have a list of child privileges; this list is empty// for a leaf privilege.ChildPrivileges []*Privilege `json:"childPrivileges,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// IsOuScopable: If the privilege can be restricted to an organization unit.IsOuScopablebool `json:"isOuScopable,omitempty"`// Kind: The type of the API resource. This is always// `admin#directory#privilege`.Kindstring `json:"kind,omitempty"`// PrivilegeName: The name of the privilege.PrivilegeNamestring `json:"privilegeName,omitempty"`// ServiceId: The obfuscated ID of the service this privilege is for. This// value is returned with `Privileges.list()`// (https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).ServiceIdstring `json:"serviceId,omitempty"`// ServiceName: The name of the service this privilege is for.ServiceNamestring `json:"serviceName,omitempty"`// ForceSendFields is a list of field names (e.g. "ChildPrivileges") 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. "ChildPrivileges") 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 (Privilege)MarshalJSON

func (sPrivilege) MarshalJSON() ([]byte,error)

typePrivileges

type Privileges struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: A list of Privilege resources.Items []*Privilege `json:"items,omitempty"`// Kind: The type of the API resource. This is always// `admin#directory#privileges`.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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 (Privileges)MarshalJSON

func (sPrivileges) MarshalJSON() ([]byte,error)

typePrivilegesListCall

type PrivilegesListCall struct {// contains filtered or unexported fields}

func (*PrivilegesListCall)Context

Context sets the context to be used in this call's Do method.

func (*PrivilegesListCall)Do

Do executes the "directory.privileges.list" call.Any non-2xx status code is an error. Response headers are in either*Privileges.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*PrivilegesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PrivilegesListCall)Header

func (c *PrivilegesListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*PrivilegesListCall)IfNoneMatch

func (c *PrivilegesListCall) IfNoneMatch(entityTagstring) *PrivilegesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typePrivilegesService

type PrivilegesService struct {// contains filtered or unexported fields}

funcNewPrivilegesService

func NewPrivilegesService(s *Service) *PrivilegesService

func (*PrivilegesService)List

List: Retrieves a paginated list of all privileges for a customer.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.

typeResourcesBuildingsDeleteCall

type ResourcesBuildingsDeleteCall struct {// contains filtered or unexported fields}

func (*ResourcesBuildingsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesBuildingsDeleteCall)Do

Do executes the "directory.resources.buildings.delete" call.

func (*ResourcesBuildingsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesBuildingsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesBuildingsGetCall

type ResourcesBuildingsGetCall struct {// contains filtered or unexported fields}

func (*ResourcesBuildingsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesBuildingsGetCall)Do

Do executes the "directory.resources.buildings.get" call.Any non-2xx status code is an error. Response headers are in either*Building.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesBuildingsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesBuildingsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ResourcesBuildingsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeResourcesBuildingsInsertCall

type ResourcesBuildingsInsertCall struct {// contains filtered or unexported fields}

func (*ResourcesBuildingsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesBuildingsInsertCall)CoordinatesSourceadded inv0.2.0

func (c *ResourcesBuildingsInsertCall) CoordinatesSource(coordinatesSourcestring) *ResourcesBuildingsInsertCall

CoordinatesSource sets the optional parameter "coordinatesSource": Sourcefrom which Building.coordinates are derived.

Possible values:

"CLIENT_SPECIFIED" - Building.coordinates are set to the coordinates

included in the request.

"RESOLVED_FROM_ADDRESS" - Building.coordinates are automatically populated

based on the postal address.

"SOURCE_UNSPECIFIED" (default) - Defaults to `RESOLVED_FROM_ADDRESS` if

postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` ifcoordinates are provided.

func (*ResourcesBuildingsInsertCall)Do

Do executes the "directory.resources.buildings.insert" call.Any non-2xx status code is an error. Response headers are in either*Building.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesBuildingsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesBuildingsInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesBuildingsListCall

type ResourcesBuildingsListCall struct {// contains filtered or unexported fields}

func (*ResourcesBuildingsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesBuildingsListCall)Do

Do executes the "directory.resources.buildings.list" call.Any non-2xx status code is an error. Response headers are in either*Buildings.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesBuildingsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesBuildingsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ResourcesBuildingsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ResourcesBuildingsListCall)MaxResults

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*ResourcesBuildingsListCall)PageToken

PageToken sets the optional parameter "pageToken": Token to specify the nextpage in the list.

func (*ResourcesBuildingsListCall)Pages

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.

typeResourcesBuildingsPatchCall

type ResourcesBuildingsPatchCall struct {// contains filtered or unexported fields}

func (*ResourcesBuildingsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesBuildingsPatchCall)CoordinatesSourceadded inv0.2.0

func (c *ResourcesBuildingsPatchCall) CoordinatesSource(coordinatesSourcestring) *ResourcesBuildingsPatchCall

CoordinatesSource sets the optional parameter "coordinatesSource": Sourcefrom which Building.coordinates are derived.

Possible values:

"CLIENT_SPECIFIED" - Building.coordinates are set to the coordinates

included in the request.

"RESOLVED_FROM_ADDRESS" - Building.coordinates are automatically populated

based on the postal address.

"SOURCE_UNSPECIFIED" (default) - Defaults to `RESOLVED_FROM_ADDRESS` if

postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` ifcoordinates are provided.

func (*ResourcesBuildingsPatchCall)Do

Do executes the "directory.resources.buildings.patch" call.Any non-2xx status code is an error. Response headers are in either*Building.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesBuildingsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesBuildingsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesBuildingsService

type ResourcesBuildingsService struct {// contains filtered or unexported fields}

funcNewResourcesBuildingsService

func NewResourcesBuildingsService(s *Service) *ResourcesBuildingsService

func (*ResourcesBuildingsService)Delete

Delete: Deletes a building.

  • buildingId: The id of the building to delete.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesBuildingsService)Get

Get: Retrieves a building.

  • buildingId: The unique ID of the building to retrieve.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesBuildingsService)Insert

Insert: Inserts a building.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesBuildingsService)List

List: Retrieves a list of buildings for an account.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesBuildingsService)Patch

func (r *ResourcesBuildingsService) Patch(customerstring, buildingIdstring, building *Building) *ResourcesBuildingsPatchCall

Patch: Patches a building.

  • buildingId: The id of the building to update.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesBuildingsService)Update

func (r *ResourcesBuildingsService) Update(customerstring, buildingIdstring, building *Building) *ResourcesBuildingsUpdateCall

Update: Updates a building.

  • buildingId: The id of the building to update.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

typeResourcesBuildingsUpdateCall

type ResourcesBuildingsUpdateCall struct {// contains filtered or unexported fields}

func (*ResourcesBuildingsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesBuildingsUpdateCall)CoordinatesSourceadded inv0.2.0

func (c *ResourcesBuildingsUpdateCall) CoordinatesSource(coordinatesSourcestring) *ResourcesBuildingsUpdateCall

CoordinatesSource sets the optional parameter "coordinatesSource": Sourcefrom which Building.coordinates are derived.

Possible values:

"CLIENT_SPECIFIED" - Building.coordinates are set to the coordinates

included in the request.

"RESOLVED_FROM_ADDRESS" - Building.coordinates are automatically populated

based on the postal address.

"SOURCE_UNSPECIFIED" (default) - Defaults to `RESOLVED_FROM_ADDRESS` if

postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` ifcoordinates are provided.

func (*ResourcesBuildingsUpdateCall)Do

Do executes the "directory.resources.buildings.update" call.Any non-2xx status code is an error. Response headers are in either*Building.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesBuildingsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesBuildingsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesCalendarsDeleteCall

type ResourcesCalendarsDeleteCall struct {// contains filtered or unexported fields}

func (*ResourcesCalendarsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesCalendarsDeleteCall)Do

Do executes the "directory.resources.calendars.delete" call.

func (*ResourcesCalendarsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesCalendarsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesCalendarsGetCall

type ResourcesCalendarsGetCall struct {// contains filtered or unexported fields}

func (*ResourcesCalendarsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesCalendarsGetCall)Do

Do executes the "directory.resources.calendars.get" call.Any non-2xx status code is an error. Response headers are in either*CalendarResource.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResourcesCalendarsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesCalendarsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ResourcesCalendarsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeResourcesCalendarsInsertCall

type ResourcesCalendarsInsertCall struct {// contains filtered or unexported fields}

func (*ResourcesCalendarsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesCalendarsInsertCall)Do

Do executes the "directory.resources.calendars.insert" call.Any non-2xx status code is an error. Response headers are in either*CalendarResource.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResourcesCalendarsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesCalendarsInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesCalendarsListCall

type ResourcesCalendarsListCall struct {// contains filtered or unexported fields}

func (*ResourcesCalendarsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesCalendarsListCall)Do

Do executes the "directory.resources.calendars.list" call.Any non-2xx status code is an error. Response headers are in either*CalendarResources.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResourcesCalendarsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesCalendarsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ResourcesCalendarsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ResourcesCalendarsListCall)MaxResults

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*ResourcesCalendarsListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Field(s) to sort results byin either ascending or descending order. Supported fields include`resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. Ifno order is specified, defaults to ascending. Should be of the form "field[asc|desc], field [asc|desc], ...". For example `buildingId, capacity desc`would return results sorted first by `buildingId` in ascending order then by`capacity` in descending order.

func (*ResourcesCalendarsListCall)PageToken

PageToken sets the optional parameter "pageToken": Token to specify the nextpage in the list.

func (*ResourcesCalendarsListCall)Pages

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.

func (*ResourcesCalendarsListCall)Query

Query sets the optional parameter "query": String query used to filterresults. Contains one or more search clauses, each with a field, operator,and value. A field can be any of supported fields and operators can be anyof supported operations. Operators include '=' for exact match, '!=' formismatch and ':' for prefix match or HAS match where applicable. For prefixmatch, the value should always be followed by a *. Logical operators NOT andAND are supported (in this order of precedence). Supported fields include`generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`,`featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. Forexample `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.

typeResourcesCalendarsPatchCall

type ResourcesCalendarsPatchCall struct {// contains filtered or unexported fields}

func (*ResourcesCalendarsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesCalendarsPatchCall)Do

Do executes the "directory.resources.calendars.patch" call.Any non-2xx status code is an error. Response headers are in either*CalendarResource.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResourcesCalendarsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesCalendarsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesCalendarsService

type ResourcesCalendarsService struct {// contains filtered or unexported fields}

funcNewResourcesCalendarsService

func NewResourcesCalendarsService(s *Service) *ResourcesCalendarsService

func (*ResourcesCalendarsService)Delete

func (r *ResourcesCalendarsService) Delete(customerstring, calendarResourceIdstring) *ResourcesCalendarsDeleteCall

Delete: Deletes a calendar resource.

  • calendarResourceId: The unique ID of the calendar resource to delete.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesCalendarsService)Get

func (r *ResourcesCalendarsService) Get(customerstring, calendarResourceIdstring) *ResourcesCalendarsGetCall

Get: Retrieves a calendar resource.

  • calendarResourceId: The unique ID of the calendar resource to retrieve.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesCalendarsService)Insert

Insert: Inserts a calendar resource.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesCalendarsService)List

List: Retrieves a list of calendar resources for an account.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesCalendarsService)Patch

func (r *ResourcesCalendarsService) Patch(customerstring, calendarResourceIdstring, calendarresource *CalendarResource) *ResourcesCalendarsPatchCall

Patch: Patches a calendar resource.

  • calendarResourceId: The unique ID of the calendar resource to update.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesCalendarsService)Update

func (r *ResourcesCalendarsService) Update(customerstring, calendarResourceIdstring, calendarresource *CalendarResource) *ResourcesCalendarsUpdateCall

Update: Updates a calendar resource. This method supports patch semantics,meaning you only need to include the fields you wish to update. Fields thatare not present in the request will be preserved.

  • calendarResourceId: The unique ID of the calendar resource to update.
  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

typeResourcesCalendarsUpdateCall

type ResourcesCalendarsUpdateCall struct {// contains filtered or unexported fields}

func (*ResourcesCalendarsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesCalendarsUpdateCall)Do

Do executes the "directory.resources.calendars.update" call.Any non-2xx status code is an error. Response headers are in either*CalendarResource.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResourcesCalendarsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesCalendarsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesFeaturesDeleteCall

type ResourcesFeaturesDeleteCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesDeleteCall)Do

Do executes the "directory.resources.features.delete" call.

func (*ResourcesFeaturesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesFeaturesGetCall

type ResourcesFeaturesGetCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesGetCall)Do

Do executes the "directory.resources.features.get" call.Any non-2xx status code is an error. Response headers are in either*Feature.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesFeaturesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ResourcesFeaturesGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeResourcesFeaturesInsertCall

type ResourcesFeaturesInsertCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesInsertCall)Do

Do executes the "directory.resources.features.insert" call.Any non-2xx status code is an error. Response headers are in either*Feature.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesFeaturesInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesFeaturesListCall

type ResourcesFeaturesListCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesListCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesListCall)Do

Do executes the "directory.resources.features.list" call.Any non-2xx status code is an error. Response headers are in either*Features.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesFeaturesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ResourcesFeaturesListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ResourcesFeaturesListCall)MaxResults

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*ResourcesFeaturesListCall)PageToken

PageToken sets the optional parameter "pageToken": Token to specify the nextpage in the list.

func (*ResourcesFeaturesListCall)Pages

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.

typeResourcesFeaturesPatchCall

type ResourcesFeaturesPatchCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesPatchCall)Do

Do executes the "directory.resources.features.patch" call.Any non-2xx status code is an error. Response headers are in either*Feature.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesFeaturesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesFeaturesRenameCall

type ResourcesFeaturesRenameCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesRenameCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesRenameCall)Do

Do executes the "directory.resources.features.rename" call.

func (*ResourcesFeaturesRenameCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesRenameCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesFeaturesService

type ResourcesFeaturesService struct {// contains filtered or unexported fields}

funcNewResourcesFeaturesService

func NewResourcesFeaturesService(s *Service) *ResourcesFeaturesService

func (*ResourcesFeaturesService)Delete

Delete: Deletes a feature.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.
  • featureKey: The unique ID of the feature to delete.

func (*ResourcesFeaturesService)Get

Get: Retrieves a feature.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.
  • featureKey: The unique ID of the feature to retrieve.

func (*ResourcesFeaturesService)Insert

Insert: Inserts a feature.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesFeaturesService)List

List: Retrieves a list of features for an account.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.

func (*ResourcesFeaturesService)Patch

func (r *ResourcesFeaturesService) Patch(customerstring, featureKeystring, feature *Feature) *ResourcesFeaturesPatchCall

Patch: Patches a feature.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.
  • featureKey: The unique ID of the feature to update.

func (*ResourcesFeaturesService)Rename

func (r *ResourcesFeaturesService) Rename(customerstring, oldNamestring, featurerename *FeatureRename) *ResourcesFeaturesRenameCall

Rename: Renames a feature.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.
  • oldName: The unique ID of the feature to rename.

func (*ResourcesFeaturesService)Update

func (r *ResourcesFeaturesService) Update(customerstring, featureKeystring, feature *Feature) *ResourcesFeaturesUpdateCall

Update: Updates a feature.

  • customer: The unique ID for the customer's Google Workspace account. As anaccount administrator, you can also use the `my_customer` alias torepresent your account's customer ID.
  • featureKey: The unique ID of the feature to update.

typeResourcesFeaturesUpdateCall

type ResourcesFeaturesUpdateCall struct {// contains filtered or unexported fields}

func (*ResourcesFeaturesUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*ResourcesFeaturesUpdateCall)Do

Do executes the "directory.resources.features.update" call.Any non-2xx status code is an error. Response headers are in either*Feature.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ResourcesFeaturesUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResourcesFeaturesUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeResourcesService

type ResourcesService struct {Buildings *ResourcesBuildingsServiceCalendars *ResourcesCalendarsServiceFeatures *ResourcesFeaturesService// contains filtered or unexported fields}

funcNewResourcesService

func NewResourcesService(s *Service) *ResourcesService

typeRole

type Role struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// IsSuperAdminRole: Returns `true` if the role is a super admin role.IsSuperAdminRolebool `json:"isSuperAdminRole,omitempty"`// IsSystemRole: Returns `true` if this is a pre-defined system role.IsSystemRolebool `json:"isSystemRole,omitempty"`// Kind: The type of the API resource. This is always `admin#directory#role`.Kindstring `json:"kind,omitempty"`// RoleDescription: A short description of the role.RoleDescriptionstring `json:"roleDescription,omitempty"`// RoleId: ID of the role.RoleIdint64 `json:"roleId,omitempty,string"`// RoleName: Name of the role.RoleNamestring `json:"roleName,omitempty"`// RolePrivileges: The set of privileges that are granted to this role.RolePrivileges []*RoleRolePrivileges `json:"rolePrivileges,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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 (Role)MarshalJSON

func (sRole) MarshalJSON() ([]byte,error)

typeRoleAssignment

type RoleAssignment struct {// AssignedTo: The unique ID of the entity this role is assigned to—either// the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a// service account as defined in Identity and Access Management (IAM)// (https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).AssignedTostring `json:"assignedTo,omitempty"`// AssigneeType: Output only. The type of the assignee (`USER` or `GROUP`).//// Possible values://   "user" - An individual user within the domain.//   "group" - A group within the domain.AssigneeTypestring `json:"assigneeType,omitempty"`// Condition: Optional. The condition associated with this role assignment.// Note: Feature is available to Enterprise Standard, Enterprise Plus, Google// Workspace for Education Plus and Cloud Identity Premium customers. A// `RoleAssignment` with the `condition` field set will only take effect when// the resource being accessed meets the condition. If `condition` is empty,// the role (`role_id`) is applied to the actor (`assigned_to`) at the scope// (`scope_type`) unconditionally. Currently, the following conditions are// supported: - To make the `RoleAssignment` only applicable to Security Groups// (https://cloud.google.com/identity/docs/groups#group_types):// `api.getAttribute('cloudidentity.googleapis.com/groups.labels',// []).hasAny(['groups.security']) && resource.type ==// 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not// applicable to Security Groups// (https://cloud.google.com/identity/docs/groups#group_types):// `!api.getAttribute('cloudidentity.googleapis.com/groups.labels',// []).hasAny(['groups.security']) && resource.type ==// 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have// to be verbatim and they only work with the following pre-built administrator// roles (https://support.google.com/a/answer/2405986): - Groups Editor -// Groups Reader The condition follows Cloud IAM condition syntax// (https://cloud.google.com/iam/docs/conditions-overview). - To make the// `RoleAssignment` not applicable to Locked Groups// (https://cloud.google.com/identity/docs/groups#group_types):// `!api.getAttribute('cloudidentity.googleapis.com/groups.labels',// []).hasAny(['groups.locked']) && resource.type ==// 'cloudidentity.googleapis.com/Group'` This condition can also be used in// conjunction with a Security-related condition.Conditionstring `json:"condition,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of the API resource. This is always// `admin#directory#roleAssignment`.Kindstring `json:"kind,omitempty"`// OrgUnitId: If the role is restricted to an organization unit, this contains// the ID for the organization unit the exercise of this role is restricted to.OrgUnitIdstring `json:"orgUnitId,omitempty"`// RoleAssignmentId: ID of this roleAssignment.RoleAssignmentIdint64 `json:"roleAssignmentId,omitempty,string"`// RoleId: The ID of the role that is assigned.RoleIdint64 `json:"roleId,omitempty,string"`// ScopeType: The scope in which this role is assigned.ScopeTypestring `json:"scopeType,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AssignedTo") 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. "AssignedTo") 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:"-"`}

RoleAssignment: Defines an assignment of a role.

func (RoleAssignment)MarshalJSON

func (sRoleAssignment) MarshalJSON() ([]byte,error)

typeRoleAssignments

type RoleAssignments struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: A list of RoleAssignment resources.Items []*RoleAssignment `json:"items,omitempty"`// Kind: The type of the API resource. This is always// `admin#directory#roleAssignments`.Kindstring `json:"kind,omitempty"`NextPageTokenstring `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. "Etag") 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. "Etag") 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 (RoleAssignments)MarshalJSON

func (sRoleAssignments) MarshalJSON() ([]byte,error)

typeRoleAssignmentsDeleteCall

type RoleAssignmentsDeleteCall struct {// contains filtered or unexported fields}

func (*RoleAssignmentsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*RoleAssignmentsDeleteCall)Do

Do executes the "directory.roleAssignments.delete" call.

func (*RoleAssignmentsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RoleAssignmentsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeRoleAssignmentsGetCall

type RoleAssignmentsGetCall struct {// contains filtered or unexported fields}

func (*RoleAssignmentsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*RoleAssignmentsGetCall)Do

Do executes the "directory.roleAssignments.get" call.Any non-2xx status code is an error. Response headers are in either*RoleAssignment.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RoleAssignmentsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RoleAssignmentsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*RoleAssignmentsGetCall)IfNoneMatch

func (c *RoleAssignmentsGetCall) IfNoneMatch(entityTagstring) *RoleAssignmentsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeRoleAssignmentsInsertCall

type RoleAssignmentsInsertCall struct {// contains filtered or unexported fields}

func (*RoleAssignmentsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*RoleAssignmentsInsertCall)Do

Do executes the "directory.roleAssignments.insert" call.Any non-2xx status code is an error. Response headers are in either*RoleAssignment.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RoleAssignmentsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RoleAssignmentsInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeRoleAssignmentsListCall

type RoleAssignmentsListCall struct {// contains filtered or unexported fields}

func (*RoleAssignmentsListCall)Context

Context sets the context to be used in this call's Do method.

func (*RoleAssignmentsListCall)Do

Do executes the "directory.roleAssignments.list" call.Any non-2xx status code is an error. Response headers are in either*RoleAssignments.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*RoleAssignmentsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RoleAssignmentsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*RoleAssignmentsListCall)IfNoneMatch

func (c *RoleAssignmentsListCall) IfNoneMatch(entityTagstring) *RoleAssignmentsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*RoleAssignmentsListCall)IncludeIndirectRoleAssignmentsadded inv0.115.0

func (c *RoleAssignmentsListCall) IncludeIndirectRoleAssignments(includeIndirectRoleAssignmentsbool) *RoleAssignmentsListCall

IncludeIndirectRoleAssignments sets the optional parameter"includeIndirectRoleAssignments": When set to `true`, fetches indirect roleassignments (i.e. role assignment via a group) as well as direct ones.Defaults to `false`. You must specify `user_key` or the indirect roleassignments will not be included.

func (*RoleAssignmentsListCall)MaxResults

func (c *RoleAssignmentsListCall) MaxResults(maxResultsint64) *RoleAssignmentsListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*RoleAssignmentsListCall)PageToken

PageToken sets the optional parameter "pageToken": Token to specify the nextpage in the list.

func (*RoleAssignmentsListCall)Pages

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.

func (*RoleAssignmentsListCall)RoleId

RoleId sets the optional parameter "roleId": Immutable ID of a role. Ifincluded in the request, returns only role assignments containing this roleID.

func (*RoleAssignmentsListCall)UserKey

UserKey sets the optional parameter "userKey": The primary email address,alias email address, or unique user or group ID. If included in the request,returns role assignments only for this user or group.

typeRoleAssignmentsService

type RoleAssignmentsService struct {// contains filtered or unexported fields}

funcNewRoleAssignmentsService

func NewRoleAssignmentsService(s *Service) *RoleAssignmentsService

func (*RoleAssignmentsService)Delete

func (r *RoleAssignmentsService) Delete(customerstring, roleAssignmentIdstring) *RoleAssignmentsDeleteCall

Delete: Deletes a role assignment.

- customer: Immutable ID of the Google Workspace account.- roleAssignmentId: Immutable ID of the role assignment.

func (*RoleAssignmentsService)Get

func (r *RoleAssignmentsService) Get(customerstring, roleAssignmentIdstring) *RoleAssignmentsGetCall

Get: Retrieves a role assignment.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.
  • roleAssignmentId: Immutable ID of the role assignment.

func (*RoleAssignmentsService)Insert

func (r *RoleAssignmentsService) Insert(customerstring, roleassignment *RoleAssignment) *RoleAssignmentsInsertCall

Insert: Creates a role assignment.

- customer: Immutable ID of the Google Workspace account.

func (*RoleAssignmentsService)List

List: Retrieves a paginated list of all roleAssignments.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.

typeRoleRolePrivileges

type RoleRolePrivileges struct {// PrivilegeName: The name of the privilege.PrivilegeNamestring `json:"privilegeName,omitempty"`// ServiceId: The obfuscated ID of the service this privilege is for. This// value is returned with `Privileges.list()`// (https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).ServiceIdstring `json:"serviceId,omitempty"`// ForceSendFields is a list of field names (e.g. "PrivilegeName") 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. "PrivilegeName") 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 (RoleRolePrivileges)MarshalJSON

func (sRoleRolePrivileges) MarshalJSON() ([]byte,error)

typeRoles

type Roles struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: A list of Role resources.Items []*Role `json:"items,omitempty"`// Kind: The type of the API resource. This is always `admin#directory#roles`.Kindstring `json:"kind,omitempty"`NextPageTokenstring `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. "Etag") 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. "Etag") 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 (Roles)MarshalJSON

func (sRoles) MarshalJSON() ([]byte,error)

typeRolesDeleteCall

type RolesDeleteCall struct {// contains filtered or unexported fields}

func (*RolesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*RolesDeleteCall)Do

Do executes the "directory.roles.delete" call.

func (*RolesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RolesDeleteCall)Header

func (c *RolesDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeRolesGetCall

type RolesGetCall struct {// contains filtered or unexported fields}

func (*RolesGetCall)Context

func (c *RolesGetCall) Context(ctxcontext.Context) *RolesGetCall

Context sets the context to be used in this call's Do method.

func (*RolesGetCall)Do

func (c *RolesGetCall) Do(opts ...googleapi.CallOption) (*Role,error)

Do executes the "directory.roles.get" call.Any non-2xx status code is an error. Response headers are in either*Role.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RolesGetCall)Fields

func (c *RolesGetCall) Fields(s ...googleapi.Field) *RolesGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RolesGetCall)Header

func (c *RolesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*RolesGetCall)IfNoneMatch

func (c *RolesGetCall) IfNoneMatch(entityTagstring) *RolesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeRolesInsertCall

type RolesInsertCall struct {// contains filtered or unexported fields}

func (*RolesInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*RolesInsertCall)Do

func (c *RolesInsertCall) Do(opts ...googleapi.CallOption) (*Role,error)

Do executes the "directory.roles.insert" call.Any non-2xx status code is an error. Response headers are in either*Role.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RolesInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RolesInsertCall)Header

func (c *RolesInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeRolesListCall

type RolesListCall struct {// contains filtered or unexported fields}

func (*RolesListCall)Context

Context sets the context to be used in this call's Do method.

func (*RolesListCall)Do

func (c *RolesListCall) Do(opts ...googleapi.CallOption) (*Roles,error)

Do executes the "directory.roles.list" call.Any non-2xx status code is an error. Response headers are in either*Roles.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RolesListCall)Fields

func (c *RolesListCall) Fields(s ...googleapi.Field) *RolesListCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RolesListCall)Header

func (c *RolesListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*RolesListCall)IfNoneMatch

func (c *RolesListCall) IfNoneMatch(entityTagstring) *RolesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*RolesListCall)MaxResults

func (c *RolesListCall) MaxResults(maxResultsint64) *RolesListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*RolesListCall)PageToken

func (c *RolesListCall) PageToken(pageTokenstring) *RolesListCall

PageToken sets the optional parameter "pageToken": Token to specify the nextpage in the list.

func (*RolesListCall)Pages

func (c *RolesListCall) Pages(ctxcontext.Context, f func(*Roles)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.

typeRolesPatchCall

type RolesPatchCall struct {// contains filtered or unexported fields}

func (*RolesPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*RolesPatchCall)Do

func (c *RolesPatchCall) Do(opts ...googleapi.CallOption) (*Role,error)

Do executes the "directory.roles.patch" call.Any non-2xx status code is an error. Response headers are in either*Role.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RolesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RolesPatchCall)Header

func (c *RolesPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeRolesService

type RolesService struct {// contains filtered or unexported fields}

funcNewRolesService

func NewRolesService(s *Service) *RolesService

func (*RolesService)Delete

func (r *RolesService) Delete(customerstring, roleIdstring) *RolesDeleteCall

Delete: Deletes a role.

- customer: Immutable ID of the Google Workspace account.- roleId: Immutable ID of the role.

func (*RolesService)Get

func (r *RolesService) Get(customerstring, roleIdstring) *RolesGetCall

Get: Retrieves a role.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.
  • roleId: Immutable ID of the role.

func (*RolesService)Insert

func (r *RolesService) Insert(customerstring, role *Role) *RolesInsertCall

Insert: Creates a role.

- customer: Immutable ID of the Google Workspace account.

func (*RolesService)List

func (r *RolesService) List(customerstring) *RolesListCall

List: Retrieves a paginated list of all the roles in a domain.

  • customer: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.

func (*RolesService)Patch

func (r *RolesService) Patch(customerstring, roleIdstring, role *Role) *RolesPatchCall

Patch: Patches a role.

- customer: Immutable ID of the Google Workspace account.- roleId: Immutable ID of the role.

func (*RolesService)Update

func (r *RolesService) Update(customerstring, roleIdstring, role *Role) *RolesUpdateCall

Update: Updates a role.

- customer: Immutable ID of the Google Workspace account.- roleId: Immutable ID of the role.

typeRolesUpdateCall

type RolesUpdateCall struct {// contains filtered or unexported fields}

func (*RolesUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*RolesUpdateCall)Do

func (c *RolesUpdateCall) Do(opts ...googleapi.CallOption) (*Role,error)

Do executes the "directory.roles.update" call.Any non-2xx status code is an error. Response headers are in either*Role.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*RolesUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RolesUpdateCall)Header

func (c *RolesUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSchema

type Schema struct {// DisplayName: Display name for the schema.DisplayNamestring `json:"displayName,omitempty"`// Etag: The ETag of the resource.Etagstring `json:"etag,omitempty"`// Fields: A list of fields in the schema.Fields []*SchemaFieldSpec `json:"fields,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// SchemaId: The unique identifier of the schema (Read-only)SchemaIdstring `json:"schemaId,omitempty"`// SchemaName: The schema's name. Each `schema_name` must be unique within a// customer. Reusing a name results in a `409: Entity already exists` error.SchemaNamestring `json:"schemaName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}

Schema: The type of API resource. For Schema resources, this is always`admin#directory#schema`.

func (Schema)MarshalJSON

func (sSchema) MarshalJSON() ([]byte,error)

typeSchemaFieldSpec

type SchemaFieldSpec struct {// DisplayName: Display Name of the field.DisplayNamestring `json:"displayName,omitempty"`// Etag: The ETag of the field.Etagstring `json:"etag,omitempty"`// FieldId: The unique identifier of the field (Read-only)FieldIdstring `json:"fieldId,omitempty"`// FieldName: The name of the field.FieldNamestring `json:"fieldName,omitempty"`// FieldType: The type of the field.FieldTypestring `json:"fieldType,omitempty"`// Indexed: Boolean specifying whether the field is indexed or not. Default:// `true`.//// Default: trueIndexed *bool `json:"indexed,omitempty"`// Kind: The kind of resource this is. For schema fields this is always// `admin#directory#schema#fieldspec`.Kindstring `json:"kind,omitempty"`// MultiValued: A boolean specifying whether this is a multi-valued field or// not. Default: `false`.MultiValuedbool `json:"multiValued,omitempty"`// NumericIndexingSpec: Indexing spec for a numeric field. By default, only// exact match queries will be supported for numeric fields. Setting the// `numericIndexingSpec` allows range queries to be supported.NumericIndexingSpec *SchemaFieldSpecNumericIndexingSpec `json:"numericIndexingSpec,omitempty"`// ReadAccessType: Specifies who can view values of this field. See Retrieve// users as a non-administrator// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin)// for more information. Note: It may take up to 24 hours for changes to this// field to be reflected.ReadAccessTypestring `json:"readAccessType,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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:"-"`}

SchemaFieldSpec: You can use schemas to add custom fields to user profiles.You can use these fields to store information such as the projects yourusers work on, their physical locations, their hire dates, or whatever elsefits your business needs. For more information, see Custom User Fields(https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).

func (SchemaFieldSpec)MarshalJSON

func (sSchemaFieldSpec) MarshalJSON() ([]byte,error)

typeSchemaFieldSpecNumericIndexingSpec

type SchemaFieldSpecNumericIndexingSpec struct {// MaxValue: Maximum value of this field. This is meant to be indicative rather// than enforced. Values outside this range will still be indexed, but search// may not be as performant.MaxValuefloat64 `json:"maxValue,omitempty"`// MinValue: Minimum value of this field. This is meant to be indicative rather// than enforced. Values outside this range will still be indexed, but search// may not be as performant.MinValuefloat64 `json:"minValue,omitempty"`// ForceSendFields is a list of field names (e.g. "MaxValue") 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. "MaxValue") 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:"-"`}

SchemaFieldSpecNumericIndexingSpec: Indexing spec for a numeric field. Bydefault, only exact match queries will be supported for numeric fields.Setting the `numericIndexingSpec` allows range queries to be supported.

func (SchemaFieldSpecNumericIndexingSpec)MarshalJSON

func (*SchemaFieldSpecNumericIndexingSpec)UnmarshalJSON

func (s *SchemaFieldSpecNumericIndexingSpec) UnmarshalJSON(data []byte)error

typeSchemas

type Schemas struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// Schemas: A list of UserSchema objects.Schemas []*Schema `json:"schemas,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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:"-"`}

Schemas: JSON response template for List Schema operation in Directory API.

func (Schemas)MarshalJSON

func (sSchemas) MarshalJSON() ([]byte,error)

typeSchemasDeleteCall

type SchemasDeleteCall struct {// contains filtered or unexported fields}

func (*SchemasDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*SchemasDeleteCall)Do

Do executes the "directory.schemas.delete" call.

func (*SchemasDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SchemasDeleteCall)Header

func (c *SchemasDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSchemasGetCall

type SchemasGetCall struct {// contains filtered or unexported fields}

func (*SchemasGetCall)Context

Context sets the context to be used in this call's Do method.

func (*SchemasGetCall)Do

Do executes the "directory.schemas.get" call.Any non-2xx status code is an error. Response headers are in either*Schema.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SchemasGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SchemasGetCall)Header

func (c *SchemasGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SchemasGetCall)IfNoneMatch

func (c *SchemasGetCall) IfNoneMatch(entityTagstring) *SchemasGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSchemasInsertCall

type SchemasInsertCall struct {// contains filtered or unexported fields}

func (*SchemasInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*SchemasInsertCall)Do

Do executes the "directory.schemas.insert" call.Any non-2xx status code is an error. Response headers are in either*Schema.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SchemasInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SchemasInsertCall)Header

func (c *SchemasInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSchemasListCall

type SchemasListCall struct {// contains filtered or unexported fields}

func (*SchemasListCall)Context

Context sets the context to be used in this call's Do method.

func (*SchemasListCall)Do

Do executes the "directory.schemas.list" call.Any non-2xx status code is an error. Response headers are in either*Schemas.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SchemasListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SchemasListCall)Header

func (c *SchemasListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*SchemasListCall)IfNoneMatch

func (c *SchemasListCall) IfNoneMatch(entityTagstring) *SchemasListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeSchemasPatchCall

type SchemasPatchCall struct {// contains filtered or unexported fields}

func (*SchemasPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*SchemasPatchCall)Do

Do executes the "directory.schemas.patch" call.Any non-2xx status code is an error. Response headers are in either*Schema.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SchemasPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SchemasPatchCall)Header

func (c *SchemasPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeSchemasService

type SchemasService struct {// contains filtered or unexported fields}

funcNewSchemasService

func NewSchemasService(s *Service) *SchemasService

func (*SchemasService)Delete

func (r *SchemasService) Delete(customerIdstring, schemaKeystring) *SchemasDeleteCall

Delete: Deletes a schema.

- customerId: Immutable ID of the Google Workspace account.- schemaKey: Name or immutable ID of the schema.

func (*SchemasService)Get

func (r *SchemasService) Get(customerIdstring, schemaKeystring) *SchemasGetCall

Get: Retrieves a schema.

  • customerId: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.
  • schemaKey: Name or immutable ID of the schema.

func (*SchemasService)Insert

func (r *SchemasService) Insert(customerIdstring, schema *Schema) *SchemasInsertCall

Insert: Creates a schema.

- customerId: Immutable ID of the Google Workspace account.

func (*SchemasService)List

func (r *SchemasService) List(customerIdstring) *SchemasListCall

List: Retrieves all schemas for a customer.

  • customerId: The unique ID for the customer's Google Workspace account. Incase of a multi-domain account, to fetch all groups for a customer, usethis field instead of `domain`. You can also use the `my_customer` aliasto represent your account's `customerId`. The `customerId` is alsoreturned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain`parameter.

func (*SchemasService)Patch

func (r *SchemasService) Patch(customerIdstring, schemaKeystring, schema *Schema) *SchemasPatchCall

Patch: Patches a schema.

- customerId: Immutable ID of the Google Workspace account.- schemaKey: Name or immutable ID of the schema.

func (*SchemasService)Update

func (r *SchemasService) Update(customerIdstring, schemaKeystring, schema *Schema) *SchemasUpdateCall

Update: Updates a schema.

- customerId: Immutable ID of the Google Workspace account.- schemaKey: Name or immutable ID of the schema.

typeSchemasUpdateCall

type SchemasUpdateCall struct {// contains filtered or unexported fields}

func (*SchemasUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*SchemasUpdateCall)Do

Do executes the "directory.schemas.update" call.Any non-2xx status code is an error. Response headers are in either*Schema.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*SchemasUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SchemasUpdateCall)Header

func (c *SchemasUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAsps *AspsServiceChannels *ChannelsServiceChromeosdevices *ChromeosdevicesServiceCustomer *CustomerServiceCustomers *CustomersServiceDomainAliases *DomainAliasesServiceDomains *DomainsServiceGroups *GroupsServiceMembers *MembersServiceMobiledevices *MobiledevicesServiceOrgunits *OrgunitsServicePrivileges *PrivilegesServiceResources *ResourcesServiceRoleAssignments *RoleAssignmentsServiceRoles *RolesServiceSchemas *SchemasServiceTokens *TokensServiceTwoStepVerification *TwoStepVerificationServiceUsers *UsersServiceVerificationCodes *VerificationCodesService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeStatusadded inv0.155.0

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `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:"-"`}

Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSONadded inv0.155.0

func (sStatus) MarshalJSON() ([]byte,error)

typeToken

type Token struct {// Anonymous: Whether the application is registered with Google. The value is// `true` if the application has an anonymous Client ID.Anonymousbool `json:"anonymous,omitempty"`// ClientId: The Client ID of the application the token is issued to.ClientIdstring `json:"clientId,omitempty"`// DisplayText: The displayable name of the application the token is issued to.DisplayTextstring `json:"displayText,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of the API resource. This is always `admin#directory#token`.Kindstring `json:"kind,omitempty"`// NativeApp: Whether the token is issued to an installed application. The// value is `true` if the application is installed to a desktop or mobile// device.NativeAppbool `json:"nativeApp,omitempty"`// Scopes: A list of authorization scopes the application is granted.Scopes []string `json:"scopes,omitempty"`// UserKey: The unique ID of the user that issued the token.UserKeystring `json:"userKey,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Anonymous") 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. "Anonymous") 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:"-"`}

Token: JSON template for token resource in Directory API.

func (Token)MarshalJSON

func (sToken) MarshalJSON() ([]byte,error)

typeTokens

type Tokens struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: A list of Token resources.Items []*Token `json:"items,omitempty"`// Kind: The type of the API resource. This is always// `admin#directory#tokenList`.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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:"-"`}

Tokens: JSON response template for List tokens operation in Directory API.

func (Tokens)MarshalJSON

func (sTokens) MarshalJSON() ([]byte,error)

typeTokensDeleteCall

type TokensDeleteCall struct {// contains filtered or unexported fields}

func (*TokensDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*TokensDeleteCall)Do

Do executes the "directory.tokens.delete" call.

func (*TokensDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TokensDeleteCall)Header

func (c *TokensDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeTokensGetCall

type TokensGetCall struct {// contains filtered or unexported fields}

func (*TokensGetCall)Context

Context sets the context to be used in this call's Do method.

func (*TokensGetCall)Do

func (c *TokensGetCall) Do(opts ...googleapi.CallOption) (*Token,error)

Do executes the "directory.tokens.get" call.Any non-2xx status code is an error. Response headers are in either*Token.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*TokensGetCall)Fields

func (c *TokensGetCall) Fields(s ...googleapi.Field) *TokensGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TokensGetCall)Header

func (c *TokensGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*TokensGetCall)IfNoneMatch

func (c *TokensGetCall) IfNoneMatch(entityTagstring) *TokensGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeTokensListCall

type TokensListCall struct {// contains filtered or unexported fields}

func (*TokensListCall)Context

Context sets the context to be used in this call's Do method.

func (*TokensListCall)Do

Do executes the "directory.tokens.list" call.Any non-2xx status code is an error. Response headers are in either*Tokens.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*TokensListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TokensListCall)Header

func (c *TokensListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*TokensListCall)IfNoneMatch

func (c *TokensListCall) IfNoneMatch(entityTagstring) *TokensListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeTokensService

type TokensService struct {// contains filtered or unexported fields}

funcNewTokensService

func NewTokensService(s *Service) *TokensService

func (*TokensService)Delete

func (r *TokensService) Delete(userKeystring, clientIdstring) *TokensDeleteCall

Delete: Deletes all access tokens issued by a user for an application.

  • clientId: The Client ID of the application the token is issued to.
  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*TokensService)Get

func (r *TokensService) Get(userKeystring, clientIdstring) *TokensGetCall

Get: Gets information about an access token issued by a user.

  • clientId: The Client ID of the application the token is issued to.
  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*TokensService)List

func (r *TokensService) List(userKeystring) *TokensListCall

List: Returns the set of tokens specified user has issued to 3rd partyapplications.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

typeTwoStepVerificationServiceadded inv0.32.0

type TwoStepVerificationService struct {// contains filtered or unexported fields}

funcNewTwoStepVerificationServiceadded inv0.32.0

func NewTwoStepVerificationService(s *Service) *TwoStepVerificationService

func (*TwoStepVerificationService)TurnOffadded inv0.32.0

TurnOff: Turns off 2-Step Verification for user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

typeTwoStepVerificationTurnOffCalladded inv0.32.0

type TwoStepVerificationTurnOffCall struct {// contains filtered or unexported fields}

func (*TwoStepVerificationTurnOffCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*TwoStepVerificationTurnOffCall)Doadded inv0.32.0

Do executes the "directory.twoStepVerification.turnOff" call.

func (*TwoStepVerificationTurnOffCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TwoStepVerificationTurnOffCall)Headeradded inv0.32.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUser

type User struct {// Addresses: The list of the user's addresses. The maximum allowed data size// for this field is 10KB.Addresses interface{} `json:"addresses,omitempty"`// AgreedToTerms: Output only. This property is `true` if the user has// completed an initial login and accepted the Terms of Service agreement.AgreedToTermsbool `json:"agreedToTerms,omitempty"`// Aliases: Output only. The list of the user's alias email addresses.Aliases []string `json:"aliases,omitempty"`// Archived: Indicates if user is archived.Archivedbool `json:"archived,omitempty"`// ChangePasswordAtNextLogin: Indicates if the user is forced to change their// password at next login. This setting doesn't apply when the user signs in// via a third-party identity provider// (https://support.google.com/a/answer/60224).ChangePasswordAtNextLoginbool `json:"changePasswordAtNextLogin,omitempty"`// CreationTime: User's G Suite account creation time. (Read-only)CreationTimestring `json:"creationTime,omitempty"`// CustomSchemas: Custom fields of the user. The key is a `schema_name` and its// values are `'field_name': 'field_value'`.CustomSchemas map[string]googleapi.RawMessage `json:"customSchemas,omitempty"`// CustomerId: Output only. The customer ID to retrieve all account users// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users).// You can use the alias `my_customer` to represent your account's// `customerId`. As a reseller administrator, you can use the resold customer// account's `customerId`. To get a `customerId`, use the account's primary// domain in the `domain` parameter of a users.list// (https://developers.google.com/workspace/admin/directory/v1/reference/users/list)// request.CustomerIdstring `json:"customerId,omitempty"`DeletionTimestring `json:"deletionTime,omitempty"`// Emails: The list of the user's email addresses. The maximum allowed data// size for this field is 10KB. This excludes// `publicKeyEncryptionCertificates`.Emails interface{} `json:"emails,omitempty"`// Etag: Output only. ETag of the resource.Etagstring `json:"etag,omitempty"`// ExternalIds: The list of external IDs for the user, such as an employee or// network ID. The maximum allowed data size for this field is 2KB.ExternalIds interface{} `json:"externalIds,omitempty"`// Gender: The user's gender. The maximum allowed data size for this field is// 1KB.Gender interface{} `json:"gender,omitempty"`// GuestAccountInfo: Immutable. Additional guest-related metadata fieldsGuestAccountInfo *GuestAccountInfo `json:"guestAccountInfo,omitempty"`// HashFunction: Stores the hash format of the `password` property. The// following `hashFunction` values are allowed: * `MD5` - Accepts simple// hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt`// - Compliant with the C crypt library// (https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash// prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`)// hash algorithms. If rounds are specified as part of the prefix, they must be// 10,000 or fewer.HashFunctionstring `json:"hashFunction,omitempty"`// Id: The unique ID for the user. A user `id` can be used as a user request// URI's `userKey`.Idstring `json:"id,omitempty"`// Ims: The list of the user's Instant Messenger (IM) accounts. A user account// can have multiple ims properties. But, only one of these ims properties can// be the primary IM contact. The maximum allowed data size for this field is// 2KB.Ims interface{} `json:"ims,omitempty"`// IncludeInGlobalAddressList: Indicates if the user's profile is visible in// the Google Workspace global address list when the contact sharing feature is// enabled for the domain. For more information about excluding user profiles,// see the administration help center// (https://support.google.com/a/answer/1285988).IncludeInGlobalAddressListbool `json:"includeInGlobalAddressList,omitempty"`// IpWhitelisted: If `true`, the user's IP address is subject to a deprecated// IP address `allowlist` (https://support.google.com/a/answer/60752)// configuration.IpWhitelistedbool `json:"ipWhitelisted,omitempty"`// IsAdmin: Output only. Indicates a user with super administrator privileges.// The `isAdmin` property can only be edited in the Make a user an// administrator// (https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin)// operation ( makeAdmin// (https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html)// method). If edited in the user insert// (https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html)// or update// (https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html)// methods, the edit is ignored by the API service.IsAdminbool `json:"isAdmin,omitempty"`// IsDelegatedAdmin: Output only. Indicates if the user is a delegated// administrator. Delegated administrators are supported by the API but cannot// create or undelete users, or make users administrators. These requests are// ignored by the API service. Roles and privileges for administrators are// assigned using the Admin console// (https://support.google.com/a/answer/33325).IsDelegatedAdminbool `json:"isDelegatedAdmin,omitempty"`// IsEnforcedIn2Sv: Output only. Is 2-step verification enforced (Read-only)IsEnforcedIn2Svbool `json:"isEnforcedIn2Sv,omitempty"`// IsEnrolledIn2Sv: Output only. Is enrolled in 2-step verification (Read-only)IsEnrolledIn2Svbool `json:"isEnrolledIn2Sv,omitempty"`// IsGuestUser: Immutable. Indicates if the inserted user is a guest.IsGuestUserbool `json:"isGuestUser,omitempty"`// IsMailboxSetup: Output only. Indicates if the user's Google mailbox is// created. This property is only applicable if the user has been assigned a// Gmail license.IsMailboxSetupbool `json:"isMailboxSetup,omitempty"`// Keywords: The list of the user's keywords. The maximum allowed data size for// this field is 1KB.Keywords interface{} `json:"keywords,omitempty"`// Kind: Output only. The type of the API resource. For Users resources, the// value is `admin#directory#user`.Kindstring `json:"kind,omitempty"`// Languages: The user's languages. The maximum allowed data size for this// field is 1KB.Languages interface{} `json:"languages,omitempty"`// LastLoginTime: User's last login time. (Read-only)LastLoginTimestring `json:"lastLoginTime,omitempty"`// Locations: The user's locations. The maximum allowed data size for this// field is 10KB.Locations interface{} `json:"locations,omitempty"`// Name: Holds the given and family names of the user, and the read-only// `fullName` value. The maximum number of characters in the `givenName` and in// the `familyName` values is 60. In addition, name values support// unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers// (0-9), dashes (-), forward slashes (/), and periods (.). For more// information about character usage rules, see the administration help center// (https://support.google.com/a/answer/9193374). Maximum allowed data size for// this field is 1KB.Name *UserName `json:"name,omitempty"`// NonEditableAliases: Output only. The list of the user's non-editable alias// email addresses. These are typically outside the account's primary domain or// sub-domain.NonEditableAliases []string `json:"nonEditableAliases,omitempty"`// Notes: Notes for the user.Notes interface{} `json:"notes,omitempty"`// OrgUnitPath: The full path of the parent organization associated with the// user. If the parent organization is the top-level, it is represented as a// forward slash (`/`).OrgUnitPathstring `json:"orgUnitPath,omitempty"`// Organizations: The list of organizations the user belongs to. The maximum// allowed data size for this field is 10KB.Organizations interface{} `json:"organizations,omitempty"`// Password: User's passwordPasswordstring `json:"password,omitempty"`// Phones: The list of the user's phone numbers. The maximum allowed data size// for this field is 1KB.Phones interface{} `json:"phones,omitempty"`// PosixAccounts: The list of POSIX// (https://www.opengroup.org/austin/papers/posix_faq.html) account information// for the user.PosixAccounts interface{} `json:"posixAccounts,omitempty"`// PrimaryEmail: The user's primary email address. This property is required in// a request to create a user account. The `primaryEmail` must be unique and// cannot be an alias of another user.PrimaryEmailstring `json:"primaryEmail,omitempty"`// RecoveryEmail: Recovery email of the user.RecoveryEmailstring `json:"recoveryEmail,omitempty"`// RecoveryPhone: Recovery phone of the user. The phone number must be in the// E.164 format, starting with the plus sign (+). Example: *+16506661212*.RecoveryPhonestring `json:"recoveryPhone,omitempty"`// Relations: The list of the user's relationships to other users. The maximum// allowed data size for this field is 2KB.Relations interface{} `json:"relations,omitempty"`// SshPublicKeys: A list of SSH public keys.SshPublicKeys interface{} `json:"sshPublicKeys,omitempty"`// Suspended: Indicates if user is suspended.Suspendedbool `json:"suspended,omitempty"`// SuspensionReason: Output only. Has the reason a user account is suspended// either by the administrator or by Google at the time of suspension. The// property is returned only if the `suspended` property is `true`.SuspensionReasonstring `json:"suspensionReason,omitempty"`// ThumbnailPhotoEtag: Output only. ETag of the user's photo (Read-only)ThumbnailPhotoEtagstring `json:"thumbnailPhotoEtag,omitempty"`// ThumbnailPhotoUrl: Output only. The URL of the user's profile photo. The URL// might be temporary or private.ThumbnailPhotoUrlstring `json:"thumbnailPhotoUrl,omitempty"`// Websites: The user's websites. The maximum allowed data size for this field// is 2KB.Websites interface{} `json:"websites,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Addresses") 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. "Addresses") 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:"-"`}

User: The Directory API allows you to create and manage your account'susers, user aliases, and user Google profile photos. For more informationabout common tasks, see the User Accounts Developer's Guide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html)and the User Aliases Developer's Guide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).

func (User)MarshalJSON

func (sUser) MarshalJSON() ([]byte,error)

typeUserAbout

type UserAbout struct {// ContentType: About entry can have a type which indicates the content type.// It can either be plain or html. By default, notes contents are assumed to// contain plain text.ContentTypestring `json:"contentType,omitempty"`// Value: Actual value of notes.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "ContentType") 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. "ContentType") 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:"-"`}

UserAbout: JSON template for About (notes) of a user in Directory API.

func (UserAbout)MarshalJSON

func (sUserAbout) MarshalJSON() ([]byte,error)

typeUserAddress

type UserAddress struct {// Country: Country.Countrystring `json:"country,omitempty"`// CountryCode: Country code.CountryCodestring `json:"countryCode,omitempty"`// CustomType: Custom type.CustomTypestring `json:"customType,omitempty"`// ExtendedAddress: Extended Address.ExtendedAddressstring `json:"extendedAddress,omitempty"`// Formatted: Formatted address.Formattedstring `json:"formatted,omitempty"`// Locality: Locality.Localitystring `json:"locality,omitempty"`// PoBox: Other parts of address.PoBoxstring `json:"poBox,omitempty"`// PostalCode: Postal code.PostalCodestring `json:"postalCode,omitempty"`// Primary: If this is user's primary address. Only one entry could be marked// as primary.Primarybool `json:"primary,omitempty"`// Region: Region.Regionstring `json:"region,omitempty"`// SourceIsStructured: User supplied address was structured. Structured// addresses are NOT supported at this time. You might be able to write// structured addresses but any values will eventually be clobbered.SourceIsStructuredbool `json:"sourceIsStructured,omitempty"`// StreetAddress: Street.StreetAddressstring `json:"streetAddress,omitempty"`// Type: Each entry can have a type which indicates standard values of that// entry. For example address could be of home work etc. In addition to the// standard type an entry can have a custom type and can take any value. Such// type should have the CUSTOM value as type and also have a customType value.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Country") 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. "Country") 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:"-"`}

UserAddress: JSON template for address.

func (UserAddress)MarshalJSON

func (sUserAddress) MarshalJSON() ([]byte,error)

typeUserAliasadded inv0.93.0

type UserAlias struct {// Alias: The alias email address.Aliasstring `json:"alias,omitempty"`// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Id: The unique ID for the user.Idstring `json:"id,omitempty"`// Kind: The type of the API resource. For Alias resources, the value is// `admin#directory#alias`.Kindstring `json:"kind,omitempty"`// PrimaryEmail: The user's primary email address.PrimaryEmailstring `json:"primaryEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "Alias") 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. "Alias") 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:"-"`}

UserAlias: The Directory API manages aliases, which are alternative emailaddresses.

func (UserAlias)MarshalJSONadded inv0.93.0

func (sUserAlias) MarshalJSON() ([]byte,error)

typeUserEmail

type UserEmail struct {// Address: Email id of the user.Addressstring `json:"address,omitempty"`// CustomType: Custom Type.CustomTypestring `json:"customType,omitempty"`// Primary: If this is user's primary email. Only one entry could be marked as// primary.Primarybool `json:"primary,omitempty"`// PublicKeyEncryptionCertificates: Public Key Encryption Certificates. Current// limit: 1 per email address, and 5 per user.PublicKeyEncryptionCertificates *UserEmailPublicKeyEncryptionCertificates `json:"public_key_encryption_certificates,omitempty"`// Type: Each entry can have a type which indicates standard types of that// entry. For example email could be of home, work etc. In addition to the// standard type, an entry can have a custom type and can take any value Such// types should have the CUSTOM value as type and also have a customType value.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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:"-"`}

UserEmail: JSON template for an email.

func (UserEmail)MarshalJSON

func (sUserEmail) MarshalJSON() ([]byte,error)

typeUserEmailPublicKeyEncryptionCertificatesadded inv0.151.0

type UserEmailPublicKeyEncryptionCertificates struct {// Certificate: X.509 encryption certificate in `PEM` format. Must only be an// end-entity (leaf) certificate.Certificatestring `json:"certificate,omitempty"`// IsDefault: Whether this is the default certificate for the given email// address.IsDefaultbool `json:"is_default,omitempty"`// State: Denotes the certificate's state in its lifecycle. Possible values are// `not_yet_validated`, `valid`, `invalid`, `expired`, and `revoked`.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "Certificate") 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. "Certificate") 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:"-"`}

UserEmailPublicKeyEncryptionCertificates: Public Key EncryptionCertificates. Current limit: 1 per email address, and 5 per user.

func (UserEmailPublicKeyEncryptionCertificates)MarshalJSONadded inv0.151.0

typeUserExternalId

type UserExternalId struct {// CustomType: Custom type.CustomTypestring `json:"customType,omitempty"`// Type: The type of the Id.Typestring `json:"type,omitempty"`// Value: The value of the id.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomType") 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. "CustomType") 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:"-"`}

UserExternalId: JSON template for an externalId entry.

func (UserExternalId)MarshalJSON

func (sUserExternalId) MarshalJSON() ([]byte,error)

typeUserGender

type UserGender struct {// AddressMeAs: AddressMeAs. A human-readable string containing the proper way// to refer to the profile owner by humans for example he/him/his or// they/them/their.AddressMeAsstring `json:"addressMeAs,omitempty"`// CustomGender: Custom gender.CustomGenderstring `json:"customGender,omitempty"`// Type: Gender.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressMeAs") 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. "AddressMeAs") 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 (UserGender)MarshalJSON

func (sUserGender) MarshalJSON() ([]byte,error)

typeUserIm

type UserIm struct {// CustomProtocol: Custom protocol.CustomProtocolstring `json:"customProtocol,omitempty"`// CustomType: Custom type.CustomTypestring `json:"customType,omitempty"`// Im: Instant messenger id.Imstring `json:"im,omitempty"`// Primary: If this is user's primary im. Only one entry could be marked as// primary.Primarybool `json:"primary,omitempty"`// Protocol: Protocol used in the instant messenger. It should be one of the// values from ImProtocolTypes map. Similar to type it can take a CUSTOM value// and specify the custom name in customProtocol field.Protocolstring `json:"protocol,omitempty"`// Type: Each entry can have a type which indicates standard types of that// entry. For example instant messengers could be of home work etc. In addition// to the standard type an entry can have a custom type and can take any value.// Such types should have the CUSTOM value as type and also have a customType// value.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomProtocol") 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. "CustomProtocol") 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:"-"`}

UserIm: JSON template for instant messenger of an user.

func (UserIm)MarshalJSON

func (sUserIm) MarshalJSON() ([]byte,error)

typeUserKeyword

type UserKeyword struct {// CustomType: Custom Type.CustomTypestring `json:"customType,omitempty"`// Type: Each entry can have a type which indicates standard type of that// entry. For example keyword could be of type occupation or outlook. In// addition to the standard type an entry can have a custom type and can give// it any name. Such types should have the CUSTOM value as type and also have a// customType value.Typestring `json:"type,omitempty"`// Value: Keyword.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomType") 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. "CustomType") 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:"-"`}

UserKeyword: JSON template for a keyword entry.

func (UserKeyword)MarshalJSON

func (sUserKeyword) MarshalJSON() ([]byte,error)

typeUserLanguage

type UserLanguage struct {// CustomLanguage: Other language. User can provide their own language name if// there is no corresponding ISO 639 language code. If this is set,// `languageCode` can't be set.CustomLanguagestring `json:"customLanguage,omitempty"`// LanguageCode: ISO 639 string representation of a language. See Language// Codes (/admin-sdk/directory/v1/languages) for the list of supported codes.// Valid language codes outside the supported set will be accepted by the API// but may lead to unexpected behavior. Illegal values cause `SchemaException`.// If this is set, `customLanguage` can't be set.LanguageCodestring `json:"languageCode,omitempty"`// Preference: Optional. If present, controls whether the specified// `languageCode` is the user's preferred language. If `customLanguage` is set,// this can't be set. Allowed values are `preferred` and `not_preferred`.Preferencestring `json:"preference,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomLanguage") 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. "CustomLanguage") 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:"-"`}

UserLanguage: JSON template for a language entry.

func (UserLanguage)MarshalJSON

func (sUserLanguage) MarshalJSON() ([]byte,error)

typeUserLocation

type UserLocation struct {// Area: Textual location. This is most useful for display purposes to// concisely describe the location. For example 'Mountain View, CA', 'Near// Seattle', 'US-NYC-9TH 9A209A.”Areastring `json:"area,omitempty"`// BuildingId: Building Identifier.BuildingIdstring `json:"buildingId,omitempty"`// CustomType: Custom Type.CustomTypestring `json:"customType,omitempty"`// DeskCode: Most specific textual code of individual desk location.DeskCodestring `json:"deskCode,omitempty"`// FloorName: Floor name/number.FloorNamestring `json:"floorName,omitempty"`// FloorSection: Floor section. More specific location within the floor. For// example if a floor is divided into sections 'A', 'B' and 'C' this field// would identify one of those values.FloorSectionstring `json:"floorSection,omitempty"`// Type: Each entry can have a type which indicates standard types of that// entry. For example location could be of types default and desk. In addition// to standard type an entry can have a custom type and can give it any name.// Such types should have 'custom' as type and also have a customType value.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Area") 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. "Area") 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:"-"`}

UserLocation: JSON template for a location entry.

func (UserLocation)MarshalJSON

func (sUserLocation) MarshalJSON() ([]byte,error)

typeUserMakeAdmin

type UserMakeAdmin struct {// Status: Indicates the administrator status of the user.Statusbool `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "Status") 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. "Status") 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 (UserMakeAdmin)MarshalJSON

func (sUserMakeAdmin) MarshalJSON() ([]byte,error)

typeUserName

type UserName struct {// DisplayName: The user's display name. Limit: 256 characters.DisplayNamestring `json:"displayName,omitempty"`// FamilyName: The user's last name. Required when creating a user account.FamilyNamestring `json:"familyName,omitempty"`// FullName: The user's full name formed by concatenating the first and last// name values.FullNamestring `json:"fullName,omitempty"`// GivenName: The user's first name. Required when creating a user account.GivenNamestring `json:"givenName,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 (UserName)MarshalJSON

func (sUserName) MarshalJSON() ([]byte,error)

typeUserOrganization

type UserOrganization struct {// CostCenter: The cost center of the users department.CostCenterstring `json:"costCenter,omitempty"`// CustomType: Custom type.CustomTypestring `json:"customType,omitempty"`// Department: Department within the organization.Departmentstring `json:"department,omitempty"`// Description: Description of the organization.Descriptionstring `json:"description,omitempty"`// Domain: The domain to which the organization belongs to.Domainstring `json:"domain,omitempty"`// FullTimeEquivalent: The full-time equivalent millipercent within the// organization (100000 = 100%).FullTimeEquivalentint64 `json:"fullTimeEquivalent,omitempty"`// Location: Location of the organization. This need not be fully qualified// address.Locationstring `json:"location,omitempty"`// Name: Name of the organizationNamestring `json:"name,omitempty"`// Primary: If it user's primary organization.Primarybool `json:"primary,omitempty"`// Symbol: Symbol of the organization.Symbolstring `json:"symbol,omitempty"`// Title: Title (designation) of the user in the organization.Titlestring `json:"title,omitempty"`// Type: Each entry can have a type which indicates standard types of that// entry. For example organization could be of school work etc. In addition to// the standard type an entry can have a custom type and can give it any name.// Such types should have the CUSTOM value as type and also have a CustomType// value.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "CostCenter") 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. "CostCenter") 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:"-"`}

UserOrganization: JSON template for an organization entry.

func (UserOrganization)MarshalJSON

func (sUserOrganization) MarshalJSON() ([]byte,error)

typeUserPhone

type UserPhone struct {// CustomType: Custom Type.CustomTypestring `json:"customType,omitempty"`// Primary: If this is user's primary phone or not.Primarybool `json:"primary,omitempty"`// Type: Each entry can have a type which indicates standard types of that// entry. For example phone could be of home_fax work mobile etc. In addition// to the standard type an entry can have a custom type and can give it any// name. Such types should have the CUSTOM value as type and also have a// customType value.Typestring `json:"type,omitempty"`// Value: Phone number.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomType") 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. "CustomType") 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:"-"`}

UserPhone: JSON template for a phone entry.

func (UserPhone)MarshalJSON

func (sUserPhone) MarshalJSON() ([]byte,error)

typeUserPhoto

type UserPhoto struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Height: Height of the photo in pixels.Heightint64 `json:"height,omitempty"`// Id: The ID the API uses to uniquely identify the user.Idstring `json:"id,omitempty"`// Kind: The type of the API resource. For Photo resources, this is// `admin#directory#user#photo`.Kindstring `json:"kind,omitempty"`// MimeType: The MIME type of the photo. Allowed values are `JPEG`, `PNG`,// `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.MimeTypestring `json:"mimeType,omitempty"`// PhotoData: The user photo's upload data in web-safe Base64// (https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes.// This means: * The slash (/) character is replaced with the underscore (_)// character. * The plus sign (+) character is replaced with the hyphen (-)// character. * The equals sign (=) character is replaced with the asterisk// (*). * For padding, the period (.) character is used instead of the RFC-4648// baseURL definition which uses the equals sign (=) for padding. This is done// to simplify URL-parsing. * Whatever the size of the photo being uploaded,// the API downsizes it to 96x96 pixels.PhotoDatastring `json:"photoData,omitempty"`// PrimaryEmail: The user's primary email address.PrimaryEmailstring `json:"primaryEmail,omitempty"`// Width: Width of the photo in pixels.Widthint64 `json:"width,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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 (UserPhoto)MarshalJSON

func (sUserPhoto) MarshalJSON() ([]byte,error)

typeUserPosixAccount

type UserPosixAccount struct {// AccountId: A POSIX account field identifier.AccountIdstring `json:"accountId,omitempty"`// Gecos: The GECOS (user information) for this account.Gecosstring `json:"gecos,omitempty"`// Gid: The default group ID.Giduint64 `json:"gid,omitempty,string"`// HomeDirectory: The path to the home directory for this account.HomeDirectorystring `json:"homeDirectory,omitempty"`// OperatingSystemType: The operating system type for this account.OperatingSystemTypestring `json:"operatingSystemType,omitempty"`// Primary: If this is user's primary account within the SystemId.Primarybool `json:"primary,omitempty"`// Shell: The path to the login shell for this account.Shellstring `json:"shell,omitempty"`// SystemId: System identifier for which account Username or Uid apply to.SystemIdstring `json:"systemId,omitempty"`// Uid: The POSIX compliant user ID.Uiduint64 `json:"uid,omitempty,string"`// Username: The username of the account.Usernamestring `json:"username,omitempty"`// ForceSendFields is a list of field names (e.g. "AccountId") 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. "AccountId") 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:"-"`}

UserPosixAccount: JSON template for a POSIX account entry.

func (UserPosixAccount)MarshalJSON

func (sUserPosixAccount) MarshalJSON() ([]byte,error)

typeUserRelation

type UserRelation struct {// CustomType: Custom Type.CustomTypestring `json:"customType,omitempty"`// Type: The relation of the user. Some of the possible values are mother// father sister brother manager assistant partner.Typestring `json:"type,omitempty"`// Value: The name of the relation.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomType") 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. "CustomType") 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:"-"`}

UserRelation: JSON template for a relation entry.

func (UserRelation)MarshalJSON

func (sUserRelation) MarshalJSON() ([]byte,error)

typeUserSshPublicKey

type UserSshPublicKey struct {// ExpirationTimeUsec: An expiration time in microseconds since epoch.ExpirationTimeUsecint64 `json:"expirationTimeUsec,omitempty,string"`// Fingerprint: A SHA-256 fingerprint of the SSH public key. (Read-only)Fingerprintstring `json:"fingerprint,omitempty"`// Key: An SSH public key.Keystring `json:"key,omitempty"`// ForceSendFields is a list of field names (e.g. "ExpirationTimeUsec") 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. "ExpirationTimeUsec") 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:"-"`}

UserSshPublicKey: JSON template for a POSIX account entry.

func (UserSshPublicKey)MarshalJSON

func (sUserSshPublicKey) MarshalJSON() ([]byte,error)

typeUserUndelete

type UserUndelete struct {// OrgUnitPath: OrgUnit of UserOrgUnitPathstring `json:"orgUnitPath,omitempty"`// ForceSendFields is a list of field names (e.g. "OrgUnitPath") 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. "OrgUnitPath") 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 (UserUndelete)MarshalJSON

func (sUserUndelete) MarshalJSON() ([]byte,error)

typeUserWebsite

type UserWebsite struct {// CustomType: Custom Type.CustomTypestring `json:"customType,omitempty"`// Primary: If this is user's primary website or not.Primarybool `json:"primary,omitempty"`// Type: Each entry can have a type which indicates standard types of that// entry. For example website could be of home work blog etc. In addition to// the standard type an entry can have a custom type and can give it any name.// Such types should have the CUSTOM value as type and also have a customType// value.Typestring `json:"type,omitempty"`// Value: Website.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomType") 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. "CustomType") 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:"-"`}

UserWebsite: JSON template for a website entry.

func (UserWebsite)MarshalJSON

func (sUserWebsite) MarshalJSON() ([]byte,error)

typeUsers

type Users struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: Kind of resource this is.Kindstring `json:"kind,omitempty"`// NextPageToken: Token used to access next page of this result. The page token// is only valid for three days.NextPageTokenstring `json:"nextPageToken,omitempty"`// TriggerEvent: Event that triggered this response (only used in case of Push// Response)TriggerEventstring `json:"trigger_event,omitempty"`// Users: A list of user objects.Users []*User `json:"users,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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 (Users)MarshalJSON

func (sUsers) MarshalJSON() ([]byte,error)

typeUsersAliasesDeleteCall

type UsersAliasesDeleteCall struct {// contains filtered or unexported fields}

func (*UsersAliasesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersAliasesDeleteCall)Do

Do executes the "directory.users.aliases.delete" call.

func (*UsersAliasesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersAliasesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersAliasesInsertCall

type UsersAliasesInsertCall struct {// contains filtered or unexported fields}

func (*UsersAliasesInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersAliasesInsertCall)Do

Do executes the "directory.users.aliases.insert" call.Any non-2xx status code is an error. Response headers are in either*Alias.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersAliasesInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersAliasesInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersAliasesListCall

type UsersAliasesListCall struct {// contains filtered or unexported fields}

func (*UsersAliasesListCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersAliasesListCall)Do

Do executes the "directory.users.aliases.list" call.Any non-2xx status code is an error. Response headers are in either*Aliases.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersAliasesListCall)Event

Event sets the optional parameter "event": Events to watch for.

Possible values:

"add" - Alias Created Event"delete" - Alias Deleted Event

func (*UsersAliasesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersAliasesListCall)Header

func (c *UsersAliasesListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UsersAliasesListCall)IfNoneMatch

func (c *UsersAliasesListCall) IfNoneMatch(entityTagstring) *UsersAliasesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeUsersAliasesService

type UsersAliasesService struct {// contains filtered or unexported fields}

funcNewUsersAliasesService

func NewUsersAliasesService(s *Service) *UsersAliasesService

func (*UsersAliasesService)Delete

Delete: Removes an alias.

  • alias: The alias to be removed.
  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersAliasesService)Insert

func (r *UsersAliasesService) Insert(userKeystring, alias *Alias) *UsersAliasesInsertCall

Insert: Adds an alias.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersAliasesService)List

List: Lists all aliases for a user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersAliasesService)Watch

func (r *UsersAliasesService) Watch(userKeystring, channel *Channel) *UsersAliasesWatchCall

Watch: Watches for changes in users list.

- userKey: Email or immutable ID of the user.

typeUsersAliasesWatchCall

type UsersAliasesWatchCall struct {// contains filtered or unexported fields}

func (*UsersAliasesWatchCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersAliasesWatchCall)Do

Do executes the "directory.users.aliases.watch" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersAliasesWatchCall)Event

Event sets the optional parameter "event": Events to watch for.

Possible values:

"add" - Alias Created Event"delete" - Alias Deleted Event

func (*UsersAliasesWatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersAliasesWatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersCreateGuestCalladded inv0.257.0

type UsersCreateGuestCall struct {// contains filtered or unexported fields}

func (*UsersCreateGuestCall)Contextadded inv0.257.0

Context sets the context to be used in this call's Do method.

func (*UsersCreateGuestCall)Doadded inv0.257.0

Do executes the "directory.users.createGuest" call.Any non-2xx status code is an error. Response headers are in either*User.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersCreateGuestCall)Fieldsadded inv0.257.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersCreateGuestCall)Headeradded inv0.257.0

func (c *UsersCreateGuestCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersDeleteCall

type UsersDeleteCall struct {// contains filtered or unexported fields}

func (*UsersDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersDeleteCall)Do

Do executes the "directory.users.delete" call.

func (*UsersDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersDeleteCall)Header

func (c *UsersDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersGetCall

type UsersGetCall struct {// contains filtered or unexported fields}

func (*UsersGetCall)Context

func (c *UsersGetCall) Context(ctxcontext.Context) *UsersGetCall

Context sets the context to be used in this call's Do method.

func (*UsersGetCall)CustomFieldMask

func (c *UsersGetCall) CustomFieldMask(customFieldMaskstring) *UsersGetCall

CustomFieldMask sets the optional parameter "customFieldMask": Acomma-separated list of schema names. All fields from these schemas arefetched. This should only be set when `projection=custom`.

func (*UsersGetCall)Do

func (c *UsersGetCall) Do(opts ...googleapi.CallOption) (*User,error)

Do executes the "directory.users.get" call.Any non-2xx status code is an error. Response headers are in either*User.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersGetCall)Fields

func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersGetCall)Header

func (c *UsersGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UsersGetCall)IfNoneMatch

func (c *UsersGetCall) IfNoneMatch(entityTagstring) *UsersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*UsersGetCall)Projection

func (c *UsersGetCall) Projection(projectionstring) *UsersGetCall

Projection sets the optional parameter "projection": What subset of fieldsto fetch for this user.

Possible values:

"basic" (default) - Do not include any custom fields for the user."custom" - Include custom fields from schemas requested in

`customFieldMask`.

"full" - Include all fields associated with this user.

func (*UsersGetCall)ViewType

func (c *UsersGetCall) ViewType(viewTypestring) *UsersGetCall

ViewType sets the optional parameter "viewType": Whether to fetch theadministrator-only or domain-wide public view of the user. For moreinformation, see Retrieve a user as a non-administrator(https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).

Possible values:

"admin_view" (default) - Results include both administrator-only and

domain-public fields for the user.

"domain_public" - Results only include fields for the user that are

publicly visible to other users in the domain.

typeUsersInsertCall

type UsersInsertCall struct {// contains filtered or unexported fields}

func (*UsersInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersInsertCall)Do

func (c *UsersInsertCall) Do(opts ...googleapi.CallOption) (*User,error)

Do executes the "directory.users.insert" call.Any non-2xx status code is an error. Response headers are in either*User.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersInsertCall)Header

func (c *UsersInsertCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UsersInsertCall)ResolveConflictAccountadded inv0.138.0

func (c *UsersInsertCall) ResolveConflictAccount(resolveConflictAccountbool) *UsersInsertCall

ResolveConflictAccount sets the optional parameter "resolveConflictAccount":If set to `true`, the option selected for handling unmanaged user accounts(https://support.google.com/a/answer/11112794) will apply. Default: `false`

typeUsersListCall

type UsersListCall struct {// contains filtered or unexported fields}

func (*UsersListCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersListCall)CustomFieldMask

func (c *UsersListCall) CustomFieldMask(customFieldMaskstring) *UsersListCall

CustomFieldMask sets the optional parameter "customFieldMask": Acomma-separated list of schema names. All fields from these schemas arefetched. This should only be set when `projection=custom`.

func (*UsersListCall)Customer

func (c *UsersListCall) Customer(customerstring) *UsersListCall

Customer sets the optional parameter "customer": The unique ID for thecustomer's Google Workspace account. In case of a multi-domain account, tofetch all users for a customer, use this field instead of `domain`. You canalso use the `my_customer` alias to represent your account's `customerId`.The `customerId` is also returned as part of the Users(https://developers.google.com/workspace/admin/directory/v1/reference/users)resource. You must provide either the `customer` or the `domain` parameter.

func (*UsersListCall)Do

func (c *UsersListCall) Do(opts ...googleapi.CallOption) (*Users,error)

Do executes the "directory.users.list" call.Any non-2xx status code is an error. Response headers are in either*Users.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersListCall)Domain

func (c *UsersListCall) Domain(domainstring) *UsersListCall

Domain sets the optional parameter "domain": The domain name. Use this fieldto get users from only one domain. To return all domains for a customeraccount, use the `customer` query parameter instead. Either the `customer`or the `domain` parameter must be provided.

func (*UsersListCall)Event

func (c *UsersListCall) Event(eventstring) *UsersListCall

Event sets the optional parameter "event": Event on which subscription isintended (if subscribing)

Possible values:

"add" - User Created Event"delete" - User Deleted Event"makeAdmin" - User Admin Status Change Event"undelete" - User Undeleted Event"update" - User Updated Event

func (*UsersListCall)Fields

func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersListCall)Header

func (c *UsersListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UsersListCall)IfNoneMatch

func (c *UsersListCall) IfNoneMatch(entityTagstring) *UsersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*UsersListCall)MaxResults

func (c *UsersListCall) MaxResults(maxResultsint64) *UsersListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*UsersListCall)OrderBy

func (c *UsersListCall) OrderBy(orderBystring) *UsersListCall

OrderBy sets the optional parameter "orderBy": Property to use for sortingresults.

Possible values:

"email" - Primary email of the user."familyName" - User's family name."givenName" - User's given name.

func (*UsersListCall)PageToken

func (c *UsersListCall) PageToken(pageTokenstring) *UsersListCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage in the list. The page token is only valid for three days.

func (*UsersListCall)Pages

func (c *UsersListCall) Pages(ctxcontext.Context, f func(*Users)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.

func (*UsersListCall)Projection

func (c *UsersListCall) Projection(projectionstring) *UsersListCall

Projection sets the optional parameter "projection": What subset of fieldsto fetch for this user.

Possible values:

"basic" (default) - Do not include any custom fields for the user."custom" - Include custom fields from schemas requested in

`customFieldMask`.

"full" - Include all fields associated with this user.

func (*UsersListCall)Query

func (c *UsersListCall) Query(querystring) *UsersListCall

Query sets the optional parameter "query": Query string for searching userfields. For more information on constructing user queries, see Search forUsers(https://developers.google.com/workspace/admin/directory/v1/guides/search-users).

func (*UsersListCall)ShowDeleted

func (c *UsersListCall) ShowDeleted(showDeletedstring) *UsersListCall

ShowDeleted sets the optional parameter "showDeleted": If set to `true`,retrieves the list of deleted users. (Default: `false`)

func (*UsersListCall)SortOrder

func (c *UsersListCall) SortOrder(sortOrderstring) *UsersListCall

SortOrder sets the optional parameter "sortOrder": Whether to return resultsin ascending or descending order, ignoring case.

Possible values:

"ASCENDING" - Ascending order."DESCENDING" - Descending order.

func (*UsersListCall)ViewType

func (c *UsersListCall) ViewType(viewTypestring) *UsersListCall

ViewType sets the optional parameter "viewType": Whether to fetch theadministrator-only or domain-wide public view of the user. For moreinformation, see Retrieve a user as a non-administrator(https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).

Possible values:

"admin_view" (default) - Results include both administrator-only and

domain-public fields for the user.

"domain_public" - Results only include fields for the user that are

publicly visible to other users in the domain.

typeUsersMakeAdminCall

type UsersMakeAdminCall struct {// contains filtered or unexported fields}

func (*UsersMakeAdminCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersMakeAdminCall)Do

Do executes the "directory.users.makeAdmin" call.

func (*UsersMakeAdminCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersMakeAdminCall)Header

func (c *UsersMakeAdminCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersPatchCall

type UsersPatchCall struct {// contains filtered or unexported fields}

func (*UsersPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersPatchCall)Do

func (c *UsersPatchCall) Do(opts ...googleapi.CallOption) (*User,error)

Do executes the "directory.users.patch" call.Any non-2xx status code is an error. Response headers are in either*User.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersPatchCall)Header

func (c *UsersPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersPhotosDeleteCall

type UsersPhotosDeleteCall struct {// contains filtered or unexported fields}

func (*UsersPhotosDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersPhotosDeleteCall)Do

Do executes the "directory.users.photos.delete" call.

func (*UsersPhotosDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersPhotosDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersPhotosGetCall

type UsersPhotosGetCall struct {// contains filtered or unexported fields}

func (*UsersPhotosGetCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersPhotosGetCall)Do

Do executes the "directory.users.photos.get" call.Any non-2xx status code is an error. Response headers are in either*UserPhoto.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersPhotosGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersPhotosGetCall)Header

func (c *UsersPhotosGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UsersPhotosGetCall)IfNoneMatch

func (c *UsersPhotosGetCall) IfNoneMatch(entityTagstring) *UsersPhotosGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeUsersPhotosPatchCall

type UsersPhotosPatchCall struct {// contains filtered or unexported fields}

func (*UsersPhotosPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersPhotosPatchCall)Do

Do executes the "directory.users.photos.patch" call.Any non-2xx status code is an error. Response headers are in either*UserPhoto.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersPhotosPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersPhotosPatchCall)Header

func (c *UsersPhotosPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersPhotosService

type UsersPhotosService struct {// contains filtered or unexported fields}

funcNewUsersPhotosService

func NewUsersPhotosService(s *Service) *UsersPhotosService

func (*UsersPhotosService)Delete

Delete: Removes the user's photo.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersPhotosService)Get

Get: Retrieves the user's photo.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersPhotosService)Patch

func (r *UsersPhotosService) Patch(userKeystring, userphoto *UserPhoto) *UsersPhotosPatchCall

Patch: Adds a photo for the user. This method supports patch semantics(https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersPhotosService)Update

func (r *UsersPhotosService) Update(userKeystring, userphoto *UserPhoto) *UsersPhotosUpdateCall

Update: Adds a photo for the user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

typeUsersPhotosUpdateCall

type UsersPhotosUpdateCall struct {// contains filtered or unexported fields}

func (*UsersPhotosUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersPhotosUpdateCall)Do

Do executes the "directory.users.photos.update" call.Any non-2xx status code is an error. Response headers are in either*UserPhoto.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersPhotosUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersPhotosUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersService

type UsersService struct {Aliases *UsersAliasesServicePhotos *UsersPhotosService// contains filtered or unexported fields}

funcNewUsersService

func NewUsersService(s *Service) *UsersService

func (*UsersService)CreateGuestadded inv0.257.0

func (r *UsersService) CreateGuest(directoryuserscreateguestrequest *DirectoryUsersCreateGuestRequest) *UsersCreateGuestCall

CreateGuest: Create a guest user with access to a subset of Workspacecapabilities (https://support.google.com/a/answer/16558545?hl=en). Thisfeature is currently in Alpha. Please reach out to support if you areinterested in trying this feature.

func (*UsersService)Delete

func (r *UsersService) Delete(userKeystring) *UsersDeleteCall

Delete: Deletes a user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersService)Get

func (r *UsersService) Get(userKeystring) *UsersGetCall

Get: Retrieves a user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersService)Insert

func (r *UsersService) Insert(user *User) *UsersInsertCall

Insert: Creates a user. Mutate calls immediately following user creationmight sometimes fail as the user isn't fully created due to propagationdelay in our backends. Check the error details for the "User creation is notcomplete" message to see if this is the case. Retrying the calls after sometime can help in this case. If `resolveConflictAccount` is set to `true`, a`202` response code means that a conflicting unmanaged account exists andwas invited to join the organization. A `409` response code means that aconflicting account exists so the user wasn't created based on the handlingunmanaged user accounts (https://support.google.com/a/answer/11112794)option selected.

func (*UsersService)List

func (r *UsersService) List() *UsersListCall

List: Retrieves a paginated list of either deleted users or all users in adomain.

func (*UsersService)MakeAdmin

func (r *UsersService) MakeAdmin(userKeystring, usermakeadmin *UserMakeAdmin) *UsersMakeAdminCall

MakeAdmin: Makes a user a super administrator.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersService)Patch

func (r *UsersService) Patch(userKeystring, user *User) *UsersPatchCall

Patch: Updates a user using patch semantics. The update method should beused instead, because it also supports patch semantics and has betterperformance. If you're mapping an external identity to a Google identity,use the `update`(https://developers.google.com/workspace/admin/directory/v1/reference/users/update)method instead of the `patch` method. This method is unable to clear fieldsthat contain repeated objects (`addresses`, `phones`, etc). Use the updatemethod instead.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersService)SignOutadded inv0.32.0

func (r *UsersService) SignOut(userKeystring) *UsersSignOutCall

SignOut: Signs a user out of all web and device sessions and reset theirsign-in cookies. User will have to sign in by authenticating again.

  • userKey: Identifies the target user in the API request. The value can bethe user's primary email address, alias email address, or unique user ID.

func (*UsersService)Undelete

func (r *UsersService) Undelete(userKeystring, userundelete *UserUndelete) *UsersUndeleteCall

Undelete: Undeletes a deleted user.

- userKey: The immutable id of the user.

func (*UsersService)Update

func (r *UsersService) Update(userKeystring, user *User) *UsersUpdateCall

Update: Updates a user. This method supports patch semantics, meaning thatyou only need to include the fields you wish to update. Fields that are notpresent in the request will be preserved, and fields set to `null` will becleared. For repeating fields that contain arrays, individual items in thearray can't be patched piecemeal; they must be supplied in the request bodywith the desired values for all items. See the user accounts guide(https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user)for more information.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

func (*UsersService)Watch

func (r *UsersService) Watch(channel *Channel) *UsersWatchCall

Watch: Watches for changes in users list.

typeUsersSignOutCalladded inv0.32.0

type UsersSignOutCall struct {// contains filtered or unexported fields}

func (*UsersSignOutCall)Contextadded inv0.32.0

Context sets the context to be used in this call's Do method.

func (*UsersSignOutCall)Doadded inv0.32.0

Do executes the "directory.users.signOut" call.

func (*UsersSignOutCall)Fieldsadded inv0.32.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersSignOutCall)Headeradded inv0.32.0

func (c *UsersSignOutCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersUndeleteCall

type UsersUndeleteCall struct {// contains filtered or unexported fields}

func (*UsersUndeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersUndeleteCall)Do

Do executes the "directory.users.undelete" call.

func (*UsersUndeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersUndeleteCall)Header

func (c *UsersUndeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersUpdateCall

type UsersUpdateCall struct {// contains filtered or unexported fields}

func (*UsersUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersUpdateCall)Do

func (c *UsersUpdateCall) Do(opts ...googleapi.CallOption) (*User,error)

Do executes the "directory.users.update" call.Any non-2xx status code is an error. Response headers are in either*User.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersUpdateCall)Header

func (c *UsersUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUsersWatchCall

type UsersWatchCall struct {// contains filtered or unexported fields}

func (*UsersWatchCall)Context

Context sets the context to be used in this call's Do method.

func (*UsersWatchCall)CustomFieldMask

func (c *UsersWatchCall) CustomFieldMask(customFieldMaskstring) *UsersWatchCall

CustomFieldMask sets the optional parameter "customFieldMask":Comma-separated list of schema names. All fields from these schemas arefetched. This should only be set when projection=custom.

func (*UsersWatchCall)Customer

func (c *UsersWatchCall) Customer(customerstring) *UsersWatchCall

Customer sets the optional parameter "customer": Immutable ID of the GoogleWorkspace account. In case of multi-domain, to fetch all users for acustomer, fill this field instead of domain.

func (*UsersWatchCall)Do

Do executes the "directory.users.watch" call.Any non-2xx status code is an error. Response headers are in either*Channel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UsersWatchCall)Domain

func (c *UsersWatchCall) Domain(domainstring) *UsersWatchCall

Domain sets the optional parameter "domain": Name of the domain. Fill thisfield to get users from only this domain. To return all users in amulti-domain fill customer field instead."

func (*UsersWatchCall)Event

func (c *UsersWatchCall) Event(eventstring) *UsersWatchCall

Event sets the optional parameter "event": Events to watch for.

Possible values:

"add" - User Created Event"delete" - User Deleted Event"makeAdmin" - User Admin Status Change Event"undelete" - User Undeleted Event"update" - User Updated Event

func (*UsersWatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UsersWatchCall)Header

func (c *UsersWatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UsersWatchCall)MaxResults

func (c *UsersWatchCall) MaxResults(maxResultsint64) *UsersWatchCall

MaxResults sets the optional parameter "maxResults": Maximum number ofresults to return.

func (*UsersWatchCall)OrderBy

func (c *UsersWatchCall) OrderBy(orderBystring) *UsersWatchCall

OrderBy sets the optional parameter "orderBy": Column to use for sortingresults

Possible values:

"email" - Primary email of the user."familyName" - User's family name."givenName" - User's given name.

func (*UsersWatchCall)PageToken

func (c *UsersWatchCall) PageToken(pageTokenstring) *UsersWatchCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage in the list

func (*UsersWatchCall)Projection

func (c *UsersWatchCall) Projection(projectionstring) *UsersWatchCall

Projection sets the optional parameter "projection": What subset of fieldsto fetch for this user.

Possible values:

"basic" (default) - Do not include any custom fields for the user."custom" - Include custom fields from schemas mentioned in

customFieldMask.

"full" - Include all fields associated with this user.

func (*UsersWatchCall)Query

func (c *UsersWatchCall) Query(querystring) *UsersWatchCall

Query sets the optional parameter "query": Query string search. Contains oneor more search clauses, each with a field, operator, and value. For completedocumentation, go to Search for users(https://developers.google.com/workspace/admin/directory/v1/guides/search-users).

func (*UsersWatchCall)ShowDeleted

func (c *UsersWatchCall) ShowDeleted(showDeletedstring) *UsersWatchCall

ShowDeleted sets the optional parameter "showDeleted": If set to true,retrieves the list of deleted users. (Default: false)

func (*UsersWatchCall)SortOrder

func (c *UsersWatchCall) SortOrder(sortOrderstring) *UsersWatchCall

SortOrder sets the optional parameter "sortOrder": Whether to return resultsin ascending or descending order.

Possible values:

"ASCENDING" - Ascending order."DESCENDING" - Descending order.

func (*UsersWatchCall)ViewType

func (c *UsersWatchCall) ViewType(viewTypestring) *UsersWatchCall

ViewType sets the optional parameter "viewType": Whether to fetch theadministrator-only or domain-wide public view of the user. For moreinformation, see Retrieve a user as a non-administrator(https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).

Possible values:

"admin_view" (default) - Results include both administrator-only and

domain-public fields.

"domain_public" - Results only include fields for the user that are

publicly visible to other users in the domain.

typeVerificationCode

type VerificationCode struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Kind: The type of the resource. This is always// `admin#directory#verificationCode`.Kindstring `json:"kind,omitempty"`// UserId: The obfuscated unique ID of the user.UserIdstring `json:"userId,omitempty"`// VerificationCode: A current verification code for the user. Invalidated or// used verification codes are not returned as part of the result.VerificationCodestring `json:"verificationCode,omitempty"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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:"-"`}

VerificationCode: The Directory API allows you to view, generate, andinvalidate backup verification codes for a user.

func (VerificationCode)MarshalJSON

func (sVerificationCode) MarshalJSON() ([]byte,error)

typeVerificationCodes

type VerificationCodes struct {// Etag: ETag of the resource.Etagstring `json:"etag,omitempty"`// Items: A list of verification code resources.Items []*VerificationCode `json:"items,omitempty"`// Kind: The type of the resource. This is always// `admin#directory#verificationCodesList`.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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:"-"`}

VerificationCodes: JSON response template for list verification codesoperation in Directory API.

func (VerificationCodes)MarshalJSON

func (sVerificationCodes) MarshalJSON() ([]byte,error)

typeVerificationCodesGenerateCall

type VerificationCodesGenerateCall struct {// contains filtered or unexported fields}

func (*VerificationCodesGenerateCall)Context

Context sets the context to be used in this call's Do method.

func (*VerificationCodesGenerateCall)Do

Do executes the "directory.verificationCodes.generate" call.

func (*VerificationCodesGenerateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*VerificationCodesGenerateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeVerificationCodesInvalidateCall

type VerificationCodesInvalidateCall struct {// contains filtered or unexported fields}

func (*VerificationCodesInvalidateCall)Context

Context sets the context to be used in this call's Do method.

func (*VerificationCodesInvalidateCall)Do

Do executes the "directory.verificationCodes.invalidate" call.

func (*VerificationCodesInvalidateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*VerificationCodesInvalidateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeVerificationCodesListCall

type VerificationCodesListCall struct {// contains filtered or unexported fields}

func (*VerificationCodesListCall)Context

Context sets the context to be used in this call's Do method.

func (*VerificationCodesListCall)Do

Do executes the "directory.verificationCodes.list" call.Any non-2xx status code is an error. Response headers are in either*VerificationCodes.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*VerificationCodesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*VerificationCodesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*VerificationCodesListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeVerificationCodesService

type VerificationCodesService struct {// contains filtered or unexported fields}

funcNewVerificationCodesService

func NewVerificationCodesService(s *Service) *VerificationCodesService

func (*VerificationCodesService)Generate

Generate: Generates new backup verification codes for the user.

- userKey: Email or immutable ID of the user.

func (*VerificationCodesService)Invalidate

Invalidate: Invalidates the current backup verification codes for the user.

- userKey: Email or immutable ID of the user.

func (*VerificationCodesService)List

List: Returns the current set of valid backup verification codes for thespecified user.

  • userKey: Identifies the user in the API request. The value can be theuser's primary email address, alias email address, or unique user ID.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp