AssistantApiSettingsDeviceSettings

Next ID: 73

Attributes

• voiceEnrollmentStatus (type: String.t, default: nil) - Indicates whether the user's voice has been successfully enrolled on this device.
• paymentsEnabled (type: boolean(), default: nil) - DEPRECATED: Use DeviceCapabilities.OutputRestrictions.personal_data instead. Whether the user has enabled payments for this device.
• linkedUsers (type: list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLinkedUser.t), default: nil) - Please do NOT use this field without prior approval from PWG. Users who have signed in onto this device, go/linked-users-in-pkg.
• ancillaryDeviceId (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalAncillaryDeviceId.t, default: nil) - The additional device ids. Currently used only for ATV. go/project-yellowstone Note: This field is for internal (Within settings) use only.
• speakerIdEnabled (type: boolean(), default: nil) - Indicates whether the user has enabled speaker-id for this device. See go/google-assistant-multi-user for more info on this project.
• faceEnrollmentStatus (type: String.t, default: nil) - Indicates whether the user's face has been successfully enrolled on this device. See go/face-match-server-design for more info.
• speechSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechSettings.t, default: nil) - Speech/hotword detection related settings.
• colocationStatus (type: String.t, default: nil) - Status of colocation. go/co-location-work-v2 Note: this is a cache at the Assistant level. The source of truth is inside CastAuthenticationServer, which is only used for Home devices.
• lastUsedCoarseTimestamp (type: DateTime.t, default: nil) - Coarsened hourly timestamp of when the device was last used.
• supervisionSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSupervisionSettings.t, default: nil) - Restrictions on how and when certain users can use a device. See go/home-ft-prd.
• postalCode (type: String.t, default: nil) -
• humanFriendlyName (type: String.t, default: nil) - The human-friendly name of the cast device, e.g., my living room tv. This field is set by the user and already localized.
• homeGraphData (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHomeGraphData.t, default: nil) - Holds the data that should be written to HomeGraph. Note: this field is not persisted in Assistant Settings storage. It is simply used for transporting data when client calls UpdateSettings.
• blueSteelEnabled (type: boolean(), default: nil) - Indicates whether the user has enabled Blue Steel. See go/blue-steel for more info on this project.
• locationFeature (type: GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureProto.t, default: nil) - The feature proto of the location of the device. Note: client does not need to populate this. It will be auto-populated based on "address" field on server side. Currently, only "bound" and "type" are persisted, since the entire FeatureProto is too big.
• defaultAudioDeviceId (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t, default: nil) - The identification of the default device which user want to output audio. See go/default-media-output-design for more info.
• speechOutputSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechOutputSettings.t, default: nil) - Settings related to TTS output.
• oauthClientId (type: String.t, default: nil) - OAuth client id for the device. This field is available for Assistant SDK devices. It is written when the device is registered to the user (AssistantSettingsUiService.LinkAssistantDeviceUi). When user revokes grant on the Assistant device, Assistant Devices Platform Service will receive Pubsub notification with OAuth client id for the revoked device, and we will compare that with this stored id to identity device to remove.
• marketplaceDisclosure (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMarketplaceDisclosure.t, default: nil) - See go/marketplace-disclosure for more info.
• locale (type: String.t, default: nil) - The locale for the device: language + region, i.e., en-US, ja-JP.
• linkedDeviceId (type: list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t), default: nil) - Stores pairing between different devices. See go/quartz-design-doc for more info.
• deviceModelId (type: String.t, default: nil) - The model ID of the device. This should be globally unique across manufactures/OEMs. Examples: "nest_cam_iq_2017", "comcast_voice_box_2017".
• verboseTtsForChromecastEnabled (type: boolean(), default: nil) - Indicates whether to play verbose tts for Elementary on chirp. See: go/opa-cast-a11y-impl-design fore more info on this project. Note: this should probably be in SpeechOutputSetting below.
• shortenedAddress (type: String.t, default: nil) - A human-readable shortened address. This is usually the street address. Note: client does not need to populate this. It will be auto-populated based on "address" field on server side. Developers can use this field to avoid reading out the full address everytime.
• deviceBrand (type: String.t, default: nil) - The brand of the device, populated from DeviceOemParams. Examples: "google", "samsung".
• creationTimestampMs (type: String.t, default: nil) - The timestamp that the device is linked with the user in milliseconds.
• deviceId (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t, default: nil) - The identification of the device.
• faceEnrollmentErrors (type: list(String.t), default: nil) - List of errors that happened during the face enrollment process if it failed. See go/face-match-enrollment-error for more info.
• faceMatchEnabled (type: boolean(), default: nil) - Indicates whether the user has enabled Face Match for this device. See go/face-match-server-design for more info on this project.
• locationCoordinates (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesLocationCoordinates.t, default: nil) - Coordinate information of the device location.
• allowIncomingCalls (type: boolean(), default: nil) - Whether this device is allowed to receive incoming calls.
• isCloudSyncDevice (type: boolean(), default: nil) - Indicates whether the device is also managed through HA cloud sync. go/ha-dev-guide
• politeMode (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPoliteMode.t, default: nil) - Specify whether polite mode is enabled for this device. See go/pretty-please-dd.
• hotwordThresholdAdjustmentFactor (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHotwordThresholdAdjustmentFactor.t, default: nil) - HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it's validity. TAF is a measure of adjustment applied to the hotword threshold as a result of go/autotune. Currently, this is updated from query_settings_frame, but if we move to updating it from the client, this could also contain TAFs as a result of Hotword Sensitivity, in addition to Autotune.
• autoFramingSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAutoFramingSettings.t, default: nil) - Auto framing settings associated with a device. See go/auto-framing-presentation.
• onDeviceAppSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsOnDeviceAppSettings.t, default: nil) - Device specific app related settings.
• kidsMode (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsKidsMode.t, default: nil) - Specifies if kids-mode is enabled for the device. See go/aff-parentalsupervision-dd.
• gcmSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsGcmSettings.t, default: nil) - Stores GCM info associated with a device. See go/quartz-design-doc for more info.
• tetheredInfo (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsTetheredInfo.t, default: nil) - Presence indicates a tethered wearable. go/wearable-device-ids.
• hotwordSensitivity (type: String.t, default: nil) - The level of hotword sensitivity. go/hotword-sensitivity-prd
• reauthTrustedDeviceSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSettings.t, default: nil) - Trusted device preferences Assistant reauth. go/assistant-reauth-verify-skip.
• ambientSettings (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAmbientSettings.t, default: nil) - Ambient settings contains the configuration of Photo Frame on DG device. This field relies on IMAX service to do the update, sync happenes after user updates IMAX device settings or a device registers in CloudCastDevice. So it's more like a cached version instead of definitive source-of-truth. More details at go/ambient-setting-in-assistant-design.
• hospitalityModeStatus (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode.t, default: nil) - Indicates whether the device is currently in Hospitality mode. go/hospitality-mode-design. This is moved to a per user setting in assistant settings. ref. go/hospitality-settings-v2
• masqueradeMode (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMasqueradeMode.t, default: nil) -
• personalizationMetadata (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPersonalizationMetadata.t, default: nil) - Metadata about how personalization settings were configured.
• defaultVideoDeviceId (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t, default: nil) - The identification of the default device which user want to output video. Note that, we don't fallback to this for audio playback when default_audio_device_id is not set. See go/default-media-output-design for more info.
• optInStatus (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceLogsOptIn.t, default: nil) - Specifies if device logs and crashes can be captured during SendFeedback
• surfaceType (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceType.t, default: nil) - The type of assistant surface. Only use this field when device type is ASSISTANT.
• truncatedLocalNetworkId (type: String.t, default: nil) - Local network ID of the device (truncated to obfuscate devices and households globally). This is a temporary signal to determine proximity of Assistant devices in a house (HGS place).
• vmLastUsedCoarseTimestamp (type: DateTime.t, default: nil) - Coarsened hourly timestamp of when the user was last verified by VoiceMatch on this device. This is used for enforcing VoiceMatch model TTL. go/voicematch-pdd-ttl
• ackStatus (type: String.t, default: nil) - LINT.ThenChange(//depot/google3/assistant/ui/assistant_device_settings_ui.proto)
• deviceModelRevision (type: integer(), default: nil) - The Device Platform Service lookup revision. (go/device-model-revision) For 1p devices, and most 3p devices with no custom feature, this should be always 0, which means no lookup needed. For 3p devices with custom assistant feature, this is provided directly by OEM as incremental (e.g. 1, 2, 3, ...)
• notificationProfile (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfile.t, default: nil) - Information about how to send the user a notification. This won't be populated for fb-conv users (allo group chat users).
• voiceInputEnabled (type: boolean(), default: nil) - A boolean indicates whether voice input (mic-button, hotword, etc) is enabled.
• city (type: String.t, default: nil) - city and postal_code are sent to third party AoG Apps as location when permission is granted for precise or coarse location. https://developers.google.com/actions/reference/rest/Shared.Types/Permission city and postal_code have the same description as in Proto Postal Address: https://cs.corp.google.com/piper///depot/google3/location/country/postaladdress.proto city corresponds to locality_name, postal_code corresponds to postal_code_number. These two fields are set in assistant_settings_service by AddressConverter. https://cs.corp.google.com/piper///depot/google3/location/addressformatter/public/addressconverter.h See go/aog-i18n-address-parse for more information
• dusi (type: String.t, default: nil) - Only valid for ATV. Stores the android DUSI for the corresponding user. More details: go/auto-logout-on-unlink.
• timeZone (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeZone.t, default: nil) - Device time zone. It's mainly used for a one-time notification for new users when they just bought and activated their devices. They may not have used Search or Assistant before, so their timezone info may not available elsewhere when we want to send a notification. This should be used as a fallback only when other timezone sources such as assistant_settings:user_attribute#inferred_user_timezone are not available. Also, when both |time_zone| and |location| are set, the |location| should be preferred to derive the most up to date timezone. This info directly comes from the device through early device setting recording mechanism. See more details at go/early-device-setting-recording.
• lastCastRegistrationTimestamp (type: DateTime.t, default: nil) - Device's latest registration timestamp provided by Cast side. This field is not necessarily up to date. The update frequency is defined in last_registration_update_frequency_in_days field of AssistantConfig in java/com/google/chrome/dongle/common/proto/home_assistant_config.proto. go/cast-last-registration-time
• crossSurfaceAvailability (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability.t, default: nil) - Availability of this device for Assistant Cross-surface handoffs. (go/assistant-cross-surface)
• type (type: String.t, default: nil) - The type of the device. Note: this should only be used for grouping devices for UI presentation purpose. Use |capabilities| to decide what the device can do.
• aliasName (type: list(String.t), default: nil) - The alias names of the device, e.g. my living room tv, tv, living room and etc., which user will usually use to refer to the device in addition to human_friendly_name. It can help speech biasing and query understanding. This field is set by the user and already localized.
• homeGraphId (type: String.t, default: nil) - The home graph ID that can be used to lookup the corresponding entry in HomeGraph. go/home-graph. Note: when this field is empty, it doesn't necessarily mean that the device is not in home graph. It just means that Assistant doesn't know about the mapping.
• address (type: String.t, default: nil) - A human-readable address string for the location; generally a one-line address such as "34 Masonic Ave, San Francisco CA 94117, United States". Set this field to empty string for deletion, in which case the rest of the location related fields below will be cleared as well.
• internalVersion (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalVersion.t, default: nil) - Internal version of the DeviceSettings for measurement of the DeviceSettings mutation race conditions. See go/consistent-assistant-settings-update.
• isDeviceActivationCacheEnabled (type: boolean(), default: nil) - When true, the user has explicitly allowed audio and visual data collection on this device
• capabilities (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDeviceCapabilities.t, default: nil) - Describes roughly what a device is capable of doing and metadata around those capabilities. Note: this includes device limitations as well as user configurable settings.

Summary

Types

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSettings{
  ackStatus: String.t() | nil,
  address: String.t() | nil,
  aliasName: [String.t()] | nil,
  allowIncomingCalls: boolean() | nil,
  ambientSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAmbientSettings.t()
    | nil,
  ancillaryDeviceId:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalAncillaryDeviceId.t()
    | nil,
  autoFramingSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAutoFramingSettings.t()
    | nil,
  blueSteelEnabled: boolean() | nil,
  capabilities:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiDeviceCapabilities.t() | nil,
  city: String.t() | nil,
  colocationStatus: String.t() | nil,
  creationTimestampMs: String.t() | nil,
  crossSurfaceAvailability:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability.t()
    | nil,
  defaultAudioDeviceId:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,
  defaultVideoDeviceId:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,
  deviceBrand: String.t() | nil,
  deviceId:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,
  deviceModelId: String.t() | nil,
  deviceModelRevision: integer() | nil,
  dusi: String.t() | nil,
  faceEnrollmentErrors: [String.t()] | nil,
  faceEnrollmentStatus: String.t() | nil,
  faceMatchEnabled: boolean() | nil,
  gcmSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsGcmSettings.t()
    | nil,
  homeGraphData:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHomeGraphData.t()
    | nil,
  homeGraphId: String.t() | nil,
  hospitalityModeStatus:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode.t()
    | nil,
  hotwordSensitivity: String.t() | nil,
  hotwordThresholdAdjustmentFactor:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHotwordThresholdAdjustmentFactor.t()
    | nil,
  humanFriendlyName: String.t() | nil,
  internalVersion:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalVersion.t()
    | nil,
  isCloudSyncDevice: boolean() | nil,
  isDeviceActivationCacheEnabled: boolean() | nil,
  kidsMode:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsKidsMode.t() | nil,
  lastCastRegistrationTimestamp: DateTime.t() | nil,
  lastUsedCoarseTimestamp: DateTime.t() | nil,
  linkedDeviceId:
    [GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t()]
    | nil,
  linkedUsers:
    [GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLinkedUser.t()]
    | nil,
  locale: String.t() | nil,
  locationCoordinates:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesLocationCoordinates.t()
    | nil,
  locationFeature:
    GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureProto.t() | nil,
  marketplaceDisclosure:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMarketplaceDisclosure.t()
    | nil,
  masqueradeMode:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMasqueradeMode.t()
    | nil,
  notificationProfile:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfile.t()
    | nil,
  oauthClientId: String.t() | nil,
  onDeviceAppSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsOnDeviceAppSettings.t()
    | nil,
  optInStatus:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceLogsOptIn.t()
    | nil,
  paymentsEnabled: boolean() | nil,
  personalizationMetadata:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPersonalizationMetadata.t()
    | nil,
  politeMode:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPoliteMode.t() | nil,
  postalCode: String.t() | nil,
  reauthTrustedDeviceSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSettings.t()
    | nil,
  shortenedAddress: String.t() | nil,
  speakerIdEnabled: boolean() | nil,
  speechOutputSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechOutputSettings.t()
    | nil,
  speechSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechSettings.t()
    | nil,
  supervisionSettings:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSupervisionSettings.t()
    | nil,
  surfaceType:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceType.t()
    | nil,
  tetheredInfo:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsTetheredInfo.t()
    | nil,
  timeZone: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeZone.t() | nil,
  truncatedLocalNetworkId: String.t() | nil,
  type: String.t() | nil,
  verboseTtsForChromecastEnabled: boolean() | nil,
  vmLastUsedCoarseTimestamp: DateTime.t() | nil,
  voiceEnrollmentStatus: String.t() | nil,
  voiceInputEnabled: boolean() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()