GoogleApi.ContentWarehouse.V1.

Model.AppsPeopleOzExternalMer
gedpeopleapiVisibleToGuests
Store metadata information like annotation-id and product source for
visible to guests contacts go/visible-to-guests.

Attributes

metadata (type:
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternal
MergedpeopleapiPersonFieldMetadata.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiVisibleTo
Guests{

metadata:

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFiel
dMetadata.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AppsPeopleOzExternalMer
gedpeopleapiWebContactsExtende
dData
Attributes

(type: boolean(), default: nil) - Used by

isIncomplete
Contacts client-side to indicate whether a person is not completed.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebContac
tsExtendedData{
isIncomplete: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AppsPeopleOzExternalMer
gedpeopleapiWebsite
Attributes

formattedType (type: String.t, default: nil) - The type

translated and formatted in the request locale. See go/people-api-
howto/localization for details on how to usage.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternal
MergedpeopleapiPersonFieldMetadata.t, default: nil) -
rel (type:
list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExt
ernalMergedpeopleapiWebsiteRelationshipInfo.t), default:
nil) - Currently in Oz: "Links": Links with no rel. "Other
profiles": Links with rel=ME. "Contributor to": Links with
rel=CONTRIBUTOR_TO or PAST_CONTRIBUTOR_TO.
type (type: String.t, default: nil) - The type of the website.
The type can be free form or one of these predefined values: home
work blog profile homePage ftp reservations
appInstallPage: website for a Currents application. * other
value (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebsite{
formattedType: String.t() | nil,
metadata:

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFiel
dMetadata.t()
| nil,

rel:
[

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebsiteRel

ationshipInfo.t()
]
| nil,
type: String.t() | nil,

value: String.t() | nil

}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AppsPeopleOzExternalMer
gedpeopleapiWebsiteRelationshipI
nfo
Attributes

type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebsiteRe
lationshipInfo{
type: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AppsPeopleOzExternalMer
gedpeopleapiYoutubeExtendedDat
a
Extension data for use in Youtube Product Profile.

Attributes

channelData (type:
list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExt
default: nil) -
ernalMergedpeopleapiChannelData.t),
Information about a channel created by the user. A user can create
multiple Youtube channels.
failure (type:
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternal
default: nil) -
MergedpeopleapiProductProfileFailure.t,
Failure type if there is an error when fetching product profile data.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiYoutubeEx
tendedData{
channelData:
[

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiChannelDat

a.t()
]
| nil,

failure:

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiProductPro
fileFailure.t()

| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiActionV2Suppo
rtedFeatures
The features supported by the ActionV2 protocol. Note that after we
move on to ConversationProto for all surfaces we can remove this
message.

Attributes

expressUrlInSettingsResponseSupported (type: boolean(),

default: nil) - This flag is used to work around a bug in AGSA 6.8
that got away. The bug prevents users from accessing their
shopping list if the URL of the shopping list is not a
keep.google.com URL. This will happen when switch the backend
that stores the shopping list from Keep to a backend maintained by
the Google Shopping Express team.
reconnectClientInputSupported (type: boolean(), default:
nil) - Whether client supports reconnect client input in action v2
payload. This capability is needed to determine if client supports
parsing client input payload from actionv2 proto for workflow
purposes. See go/personal-workflow. OWNER:nyzstar,vvvemuri.
simpleActionV2PuntSupported (type: boolean(), default: nil) -
Whether or not the surface supports a simple UnsupportedAction
instead of a ModalState punt card for rendering. For ActionV2 punt
cards, the ModalState extension on the ResourceSet is the canonical
way of building punt cards. However, while most all devices
support the ActionV2 protocol, not all devices handle the
ModalState rendering as part of the ActionV2. For these devices,
we want to build a modified ActionV2 for punt cards which omits
this ModalState. At present, this is only Android Wear and should
 not be used for other devices if they support ModalState or
Conversation protocol.
supportedActionType (type: list(String.t), default: nil) - A
list of all the action types supported by the client. These should be
the string representation of majel.ActionTypes within
"quality/majel/api/proto/action_v2.proto".
takeScreenshotSupported (type: boolean(), default: nil) -
Checks if screenshots can be taken on the client. This field is set on
the client from AGSA 7.2 onwards.
voiceDelightImmersiveUiSupported (type: boolean(), default:
nil) - If IMMERSIVE_ACTIONS UiType is supported by the
client.
voiceDelightStickersSupported (type: boolean(), default:
nil) - If Voice Delight Stickers are supported by the client. In
order to support Voice Delight stickers, the client should know how
to extract sticker_url from VoiceDelightSystemInteractionSegment.
voiceDelightSuggestionsSupported (type: boolean(), default:
nil) - If Voice Delight Suggestion Chips are supported by the
client. In order to support Voice Delight Suggestion Chips, the
client should know how to extract suggestions form
VoiceDelightSystemInteraction.ResourceSet.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiActionV2SupportedFeatures{

expressUrlInSettingsResponseSupported: boolean() | nil,

reconnectClientInputSupported: boolean() | nil,
simpleActionV2PuntSupported: boolean() | nil,
supportedActionType: [String.t()] | nil,

takeScreenshotSupported: boolean() | nil,

voiceDelightImmersiveUiSupported: boolean() | nil,
voiceDelightStickersSupported: boolean() | nil,
voiceDelightSuggestionsSupported: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAndroidIntent
Capabilities
Capabilities related to Android intent support. These capabilities can
apply to any device on the Android platform. Provides the list of
Android package names that support a given Android intent.

Attributes

androidIntentCapability (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiAnd
roidIntentCapabilitiesAndroidIntentCapability.t), default:
nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidIntentCapabilities{
androidIntentCapability:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidIntentCapabilitiesAndroidI
ntentCapability.t()

]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAndroidIntent
CapabilitiesAndroidIntentCapabili
ty
Attributes

intentActionName(type: String.t, default: nil) - The Action

name of the Android Intent in standard notation
(https://developer.android.com/reference/android/content/Intent#get
Action()).
packageNames (type: list(String.t), default: nil) - The
Android provider packages that support the intent, e.g.
"com.google.android.deskclock".

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidIntentCapabilitiesAndroid
IntentCapability{
intentActionName: String.t() | nil,
packageNames: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAppCapabilitie
s
Used to describe app capabilities of the device installed apps reported to
the server.

Attributes

allowlistedForMediaFulfillment (type: boolean(), default:

nil) - Indicates whether the provider is compatible for media
fulfillment on this surface. For example, Amazon Music isn't
compatible with the driving mode.
appIntegrationsSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppInteg
default: nil) - Currently unused. Will be
rationsSettings.t,
used in the future when integrating with incremental app
capabilities.
disabledSystemApp (type: boolean(), default: nil) - This
system app is disabled in settings.
provider (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The installed app of the provider.
sProvider.t,
routableToProviderCloud (type: boolean(), default: nil) -
This provider has integrated its cloud backend with Google, and
Google can route the user queries to the provider's cloud.
searchableOnDevice (type: boolean(), default: nil) - This
provider has an app that supports on-device search through the
provider's own inventory.
searchableOnServer (type: boolean(), default: nil) - This
provider has integrated its content with Google, and Google has
 enabled to serve its content as a server-side solution.
supports3pPodcastPlayback (type: boolean(), default: nil) -
Indicates whether the provider supports playback of 3P(externally
hosted) podcasts.
supportsScreenlessInitiation (type: boolean(), default: nil)
- This provider has an app that supports starting new media
playback when there is no screen (e.g. by integrating with the Bisto
SDK).
whitelistedForAnnotation (type: boolean(), default: nil) -
This provider is an app which should be used for query annotations.
This is useful for apps which may not be already indexed by Google
or are client specific.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppCapabilities{
allowlistedForMediaFulfillment: boolean() | nil,
appIntegrationsSettings:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppIntegrationsSettings.t()
| nil,
disabledSystemApp: boolean() | nil,

provider:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider.t() | nil,
routableToProviderCloud: boolean() | nil,

searchableOnDevice: boolean() | nil,

searchableOnServer: boolean() | nil,
supports3pPodcastPlayback: boolean() | nil,
supportsScreenlessInitiation: boolean() | nil,

whitelistedForAnnotation: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAppCapabilitie
sDelta
Used to describe the incremental change of app capabilities of the device
installed apps reported to the server.

Attributes

appIntegrationsSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppInteg
default: nil) - Currently unused. Will be
rationsSettings.t,
used in the future when integrating with incremental app
capabilities.
providerDelta (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sProviderDelta.t, default: nil) - The installed app of the
provider.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppCapabilitiesDelta{
appIntegrationsSettings:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppIntegrationsSettings.t()
| nil,

providerDelta:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProviderDelta.t()
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAppControlSup
port
Attributes

enabled (type: String.t, default: nil) -

sendMessageSuppressed (type: boolean(), default: nil) - If
true, disable send message AppControl/SD flow. This is needed to
suppress the feature for specific device. If we decide to turn down
this feature for all devices, then this field will become obsolete and
should be removed. See context in b/275727627.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppControlSupport{

enabled: String.t() | nil,

sendMessageSuppressed: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAppIntegration
sSettings
Contains the app privacy bits used for App Integrations implicit request.
(go/app-privacy-settings-for-implicit-requests)

Attributes

(type: String.t, default:

handleRequestsWithPredictedApps
nil) - Whether to enable Assistant to handle request with predicted
apps.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppIntegrationsSettings{
handleRequestsWithPredictedApps: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAssistantContin
uedPresenceSupport
Attributes

plateSupport(type: String.t, default: nil) - Indicates in what

cases assistant continued presence can be shown as a plate. This
field is white-listed as being PII-free. Please do not add PII here.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiAssistantContinuedPresenceSuppor
t{
plateSupport: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAudioInput
These capabilities represent the audio input features associated with the
device. This includes what kind of audio input the device can handle,
and what the privacy circumstances of that input are.

Attributes

environment (type: String.t, default: nil) -

quality (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioInput{

environment: String.t() | nil,

quality: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiAudioOutput
These capabilities represent the audio output features associated with the
device. This includes what kind of audio output the device can handle,
and what the privacy circumstances of that output are.

Attributes

alwaysOnSpeaker (type: String.t, default: nil) -

environment (type: String.t, default: nil) -
mediaTtsMixable (type: String.t, default: nil) -
quality (type: String.t, default: nil) -
volumeProperties (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiVolumePr
operties.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioOutput{

alwaysOnSpeaker: String.t() | nil,

environment: String.t() | nil,
mediaTtsMixable: String.t() | nil,

quality: String.t() | nil,

volumeProperties:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiVolumeProperties.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiBluetoothCapa
bilities
Bluetooth capabilities related to usage of a feature.

Attributes

isBluetoothConnectedProfileRequired(type: boolean(),
default: nil) - If this surface needs to bluetooth pair a phone
before using a feature.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiBluetoothCapabilities{

isBluetoothConnectedProfileRequired: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCallCapabilitie
s
CallCapabilities supported by a surface. See go/call-capabilities. Next
ID: 7

Attributes

callFormats (type: list(String.t), default: nil) - The

supported call formats on the surface.
callMediums (type: list(String.t), default: nil) - The
supported call mediums on the surface.
callOptions (type: list(String.t), default: nil) - The call
options this surface can provide. For example, SPEAKERPHONE
is available on Android OPA while iOPA doesn't support it yet.
fallbackToTetheredDeviceAppCapabilities (type: boolean(),
default: nil) - If true, APP_ID queries initiated by this device
should fall back to execution on the tethered device if it's available
and if the primary device cannot perform the action (e.g. due to the
app not being installed).
supportedRecipientTypes (type: list(String.t), default: nil)
- Should only be checked if nonempty.
supportsDuoEmailEndpoint (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCallCapabilities{

callFormats: [String.t()] | nil,

callMediums: [String.t()] | nil,

callOptions: [String.t()] | nil,
fallbackToTetheredDeviceAppCapabilities: boolean() | nil,
supportedRecipientTypes: [String.t()] | nil,

supportsDuoEmailEndpoint: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCameraCapabil
ities
These capabilities represent the camera features associated with the
device.

Attributes

faceMatchCapable(type: boolean(), default: nil) - Whether the

device supports Face Match.
hasCamera (type: boolean(), default: nil) - Whether the device
has a camera.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraCapabilities{

faceMatchCapable: boolean() | nil,
hasCamera: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCameraReceive
rCapabilities
These capabilities present the capability of the device running camera
receiver apps.

Attributes

hasLimitedCameraStreamCapability(type: boolean(), default:

nil) - Whether the device has limited camera stream capability. If
true, check supported_camera_receivers for detailed supported
cameras.
supportedCameraReceivers (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCor
default: nil) - The camera receiver cast
eTypesCastAppInfo.t),
apps the device supports. Only used if
has_limited_camera_stream_capability is true.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraReceiverCapabilities{
hasLimitedCameraStreamCapability: boolean() | nil,

supportedCameraReceivers:
[GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCastAppInfo.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCarAssistantCa
pabilities
Capabilities that are associated with Assistants on auto surfaces. This is
different from other capabilities such as CarSettingsCapabilities,
CloudCarCapabilities since they are specific to settings and 3P cloud
information. All the auto/car Assistant specific capabilities should live
here.

Attributes

(type: boolean(), default: nil)

shouldPuntMultiAssistantMode
- Indicates whether the current Assistant should provide a multi
Assistant specific punt when there are multiple Auto specific
Google Assistants (Android Auto Projected (AAP) and Android
Auto Embedded (AAE)) in the same GAS enabled car. This will be
used by both AAP and AAE. Design doc: go/doubledash++

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarAssistantCapabilities{
shouldPuntMultiAssistantMode: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCarSettingsCap
abilities
Capabilities that are associated with Assistant Settings on auto surfaces.

Attributes

playWarmerWelcome (type: boolean(), default: nil) - If true, it

indicates that the auto surface client should receive a warmer
welcome TTS for signed-out users. For signed-in user, we will rely
on server side metadata. go/aaae:preview-lang
supportsAddingCars (type: boolean(), default: nil) - If true, it
indicates that the client can be used to add cars after account linking
with the OEM.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarSettingsCapabilities{

playWarmerWelcome: boolean() | nil,

supportsAddingCars: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCastAssistantSe
ttingLinkingResult
Attributes

castLinkingStatus(type: String.t, default: nil) - Cast linking

status for ATV surfaces. This is derived from error messages
returned from Cast Orchestration Server and will be used for data
profiling only(go/katniss-settings-dashboard).
truncatedErrorMsg (type: String.t, default: nil) - The error
msg returned from COS, truncated in case it's too large.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastAssistantSettingLinkingResul

t{
castLinkingStatus: String.t() | nil,
truncatedErrorMsg: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCastCapabilitie
s
These capabilities represent capabilities that have to do with casting that
pertain to this device. Next ID: 9

Attributes

cameraReceiverCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraRe
default: nil) - Whether the device has
ceiverCapabilities.t,
limited camera stream capability and if yes, which receivers are
supported.
cameraStreamSupportedProtocols (type: list(String.t),
default: nil) - The supported protocols for camera streaming. The
value is used as string in go/smarthome-internal-api#camera-
stream, so using a string for this field instead of an enum. Supported
protocols: (align the definition in go/smarthome-camerastream-
trait) - "hls": HTTP Live Streaming - "dash": Dynamic Adaptive
Streaming over HTTP - "smooth_stream": Smooth Streaming -
"progressive_mp4": Progressive MP4 (will likely only be used for
Clips) - "webrtc": WebRTC (currently, only H.264 is supported) -
"nexustalk": Internal-only protocol used for Nest
canReceiveCast (type: boolean(), default: nil) - True if we can
cast things to this device.
deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - Optional for primarily cast devices
sDeviceId.t,
(e.g., Chirp, Chromecast). For devices that are NOT primarily cast
devices, but having a cast receiver as secondary functionality, this
 field SHOULD store the cast-device-id to be used to send remote
casting commands to the device. Example: Android TV, which
supports both Android-native actions as well as remote casting
using its built-in cast receiver. Android TV device id contains a
DUSI id, which is not a cast-device-id. When executing a cast
command on the Android TV, this field is used to route the cast
command (through CloudCastService) to the cast receiver on the
device.
dynamicGroupsSupported (type: boolean(), default: nil) -
Whether this device supports dynamic groups or not. It implies if a
Stream Control operation (transfer, expansion, and contraction)
could be applied on this device since Stream Control is
implemented as part of dynamic groups (ie, adding/removing
devices from playback)
groupType (type: String.t, default: nil) -
overlayApplicationsSupported (type: boolean(), default: nil)
- Whether UI overlay applications are supported on this device. It's
used by Chromecast only.
yetiGamingSupported (type: boolean(), default: nil) - Whether
the device supports playing games through Yeti. This is set by the
cast device when the device is updated: Chromecast updates ->
Chromecast registers its capabilities with CCS -> CCS passes the
capabilities to the AssistantSettingsService ->
AssistantSettingsService stores the device's capabilities. go/yeti-
gaming-supported-cast-capability

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastCapabilities{

cameraReceiverCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraReceiverCapabilities.t()

| nil,
cameraStreamSupportedProtocols: [String.t()] | nil,

canReceiveCast: boolean() | nil,

deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,
dynamicGroupsSupported: boolean() | nil,

groupType: String.t() | nil,

overlayApplicationsSupported: boolean() | nil,
yetiGamingSupported: boolean() | nil

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiClientOpPrope
rtiesDeviceModifySettingClientOp
Property
The properties of the client op device.MODIFY_SETTING. This proto
is stored in the SupportedClientOp proto.

Attributes

skipAndroidAndGsaVersionCheck (type: boolean(), default:

nil) - Additional specific setting capabilities. This boolean is used
to indicate whether we want to skip the Android and GSA version
check in CheckSettingSchemaAndMaybeGetUris() from
assistant/vertical/device/fulfillment/utils/setting_utils.h. Consider
setting this field to true if your device is neither Android or GSA
(especially when the UserAgent string of your device's TaskRequest
will not contain a valid/up-to-date Android/GSA version).
supportedSettings (type: list(String.t), default: nil) - Uses
DeviceSetting enum which corresponds to setting_id. This indicates
which specific settings are supported by client. An empty list
implies all settings are supported.
supportsDoNotDisturbWithDuration (type: boolean(), default:
nil) - Additional specific setting capabilities. This boolean is used
to indicate if do not disturb with duration is supported through
device.MODIFY_SETTING clientop on a client or not.
supportsMuteUnmute (type: boolean(), default: nil) -
Additional specific setting capabilities. This boolean is used to
indicate if new unmute logic is enabled on a client or not.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesDeviceModifySe
ttingClientOpProperty{
skipAndroidAndGsaVersionCheck: boolean() | nil,

supportedSettings: [String.t()] | nil,

supportsDoNotDisturbWithDuration: boolean() | nil,
supportsMuteUnmute: boolean() | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiClientOpPrope
rtiesProviderOpenClientOpPropert
y
The properties of the provider.OPEN ClientOp. This proto is stored in
the SupportedClientOp proto with the key provider.OPEN.

Attributes

(type: boolean(),
keepsConversationAliveAfterOpeningApp
default: nil) - Whether conversation is kept alive after opening the
app. See go/keep-opa-conversation-alive for details.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesProviderOpenCl
ientOpProperty{
keepsConversationAliveAfterOpeningApp: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiClockCapabiliti
es
Used to describe clock capabilities of the device (for example,
capabilities related to maximum number of supported alarms and timers
that can be created on the device). Fields may be populated by clients or
be backfilled by SAL (in case of Timon, for example).

Attributes

maxSupportedAlarms (type: integer(), default: nil) -

Maximum number of alarms that can be created on the client.
maxSupportedExtendedTimerDuration (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration
default: nil) - Maximum extended timer duration supported by
.t,
the client. The extended timer duration is the total start-to-finish
duration after an AddTimeToTimer operation. E.g. if a user sets a
timer for 30 minutes, and later adds 10 minutes, the extended
duration is 40 minutes.
maxSupportedTimerDuration (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration
default: nil) - Maximum duration of timers that can be created
.t,
on the client.
maxSupportedTimers (type: integer(), default: nil) -
Maximum number of timers that can be created on the client.
preferredStopwatchProvider (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The preferred provider to use for
sProvider.t,
stopwatch related functionality.
 (type: boolean(), default: nil) -
restrictAlarmsToNext24h
Whether the client restricts alarms to ring within the next 24 hours.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiClockCapabilities{

maxSupportedAlarms: integer() | nil,
maxSupportedExtendedTimerDuration:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration.t() | nil,
maxSupportedTimerDuration:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration.t() | nil,
maxSupportedTimers: integer() | nil,

preferredStopwatchProvider:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider.t() | nil,
 restrictAlarmsToNext24h: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCommunicatio
nUiCapabilities
UI capabilities for the surfaces rendering Comms features. See go/rohan-
comms-fluid-actions-customization.

Attributes

fluidActionsUiType (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCommunicationUiCapabilities{

fluidActionsUiType: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiContactLookup
Capabilities
Attributes

fallbackToTetheredDevice(type: boolean(), default: nil) - If

true, contact.LOOKUP should be routed to the tethered device (if
present) if the tethered device supports contact.LOOKUP and the
primary device does not.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiContactLookupCapabilities{
fallbackToTetheredDevice: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesAndr
oidAppInfo
The android app information of the provider. Like, Spotify. Next ID: 17

Attributes

accountType (type: String.t, default: nil) -

activityInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sAndroidAppInfoActivityInfo.t, default: nil) -
androidIntent (type: String.t, default: nil) - Intent associated
with the app. We include intents here as different versions of the
same app may support different intents. In those cases, the
package_name is not enough to identify the app and we should use
the combination of package_name and android_intent. This field
might contain sensitive data, if represents ClientOp with
encapsulated PII such as user query.
appUniqueId (type: String.t, default: nil) - Store the app
unique id endpoint. This will be passed over to app to fulfill the
action.
appVersion (type: integer(), default: nil) - The android app
version. Deprecated because
https://developer.android.com/reference/android/content/pm/Packag
eInfo.html#getLongVersionCode
dataMimetype (type: String.t, default: nil) - data_mimetype
and account_type are the what AGSA uses to filter which contacts
support this Android app in ContactProvider.
isBroadcastIntent (type: boolean(), default: nil) - If true,
client should broadcast the intent instead of open the intent.
isDefault (type: boolean(), default: nil) - App is the default
app for it's core functionality. For example, it will be true for
Android messages if it is the default app to send and receive SMS
on the phone.
localizedAppName (type: String.t, default: nil) - The localized
app name.
longVersionCode (type: String.t, default: nil) - The long
android app version.
mimetype (type: String.t, default: nil) - Store mimetype of this
endpoint. We will use this as the differentiator for Assistant to know
whether to use the RawContact for messaging, call or video call.
For example, send message mimetype for whatsapp:
"vnd.android.cursor.item/vnd.com.whatsapp.profile" voice call
mimetype for whatsapp:
"vnd.android.cursor.item/vnd.com.whatsapp.voip.call"
packageName (type: String.t, default: nil) - The android app
package of the provider, like "com.spotify.music".
providerType (type: String.t, default: nil) - The
OemProviderType is specific for OEM system Android apps. For
example, in Auto Embedded, the OEM will have a system
Radio/Media app. The system app’s capabilities/core functionalities
are captured here. For physical media sources, the OEM may decide
to implement one media app (thus, one package name) that handles
multiple physical media sources. For these cases, each physical
media source will be sent as different providers even though the
package name is the same.
shortcutId (type: String.t, default: nil) - Id of the app's
Android shortcut to be launched by Assistant. The client is expected
to use the Android LauncherApps API to execute this shortcut
which in turn will open the app. For example, Whatsapp may create
an Android shortcut for a frequently messaged contact with an id
"contact_123". This field will contain that id and the client can
execute it to open up the chat with that particular contact. If this
field is set, the package_name field must also be set since both will
be used by the LauncherApps API for execution. If this field is set,
 the intent related fields will be ignored and not used as a fallback.
Design: go/shortcut-id-in-provider-open-clientop This field should
only be set for devices with Android API level >= 25 (since that is
the version from which the LauncherApps startShortcut API is
available)
targetClass (type: String.t, default: nil) - The fully qualified
target class name of the provider, like
"com.example.myapp.GetOrderService".
versionName (type: String.t, default: nil) - The android app
version name, like "4.1.091.05.40d", "11.2.7.21.alpha". Android
Docs:
https://developer.android.com/reference/android/content/pm/Packag
eInfo#versionName

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfo{
accountType: String.t() | nil,
activityInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoActivityIn
fo.t()

| nil,

androidIntent: String.t() | nil,

appUniqueId: String.t() | nil,
appVersion: integer() | nil,
dataMimetype: String.t() | nil,

isBroadcastIntent: boolean() | nil,

isDefault: boolean() | nil,
localizedAppName: String.t() | nil,

longVersionCode: String.t() | nil,

mimetype: String.t() | nil,

packageName: String.t() | nil,
providerType: String.t() | nil,
shortcutId: String.t() | nil,

targetClass: String.t() | nil,

versionName: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesAndr
oidAppInfoActivityInfo
General information about activities in the app.

Attributes

activeLaunchableActivities (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCor
default: nil)
eTypesAndroidAppInfoActivityInfoActivity.t),
- Activities that are currently active and tagged as ACTION_MAIN
and CATEGORY_LAUNCHER. Includes the activity
corresponding to android_intent if it falls under
CATEGORY_LAUNCHER.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoActivityI
nfo{

activeLaunchableActivities:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoActivityIn
foActivity.t()
]
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesAndr
oidAppInfoActivityInfoActivity
Information about an individual activity.

Attributes

localizedActivityName(type: String.t, default: nil) - The

localized user visible activity name.
shortClassName (type: String.t, default: nil) - Short class
name for activity, following
https://developer.android.com/reference/android/content/Componen
tName#getShortClassName()

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoActivityI
nfoActivity{
localizedActivityName: String.t() | nil,
shortClassName: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesAndr
oidAppInfoDelta
The change of AndroidAppInfo, e.g. app installation or deletion for
incremental delta app info upload.

Attributes

androidAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sAndroidAppInfo.t, default: nil) - The android app information
of the provider. Like, Spotify.
lastUpdateTimestamp (type: DateTime.t, default: nil) - The
client-side timestamp in millis when the app is last updated,
installed or deleted.
updateType (type: String.t, default: nil) - App is installed or
deleted.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoDelta{
androidAppInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfo.t()
| nil,
lastUpdateTimestamp: DateTime.t() | nil,

updateType: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCale
ndarEvent
This proto contains the information of a calendar event, including title,
start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26

Attributes

attendees (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCor
eTypesCalendarEventAttendee.t), default: nil) - Attendees
invited to the event, usually includes also the organizer.
backgroundColor (type: integer(), default: nil) - The
background color of the event, in RGB format.
calendarId (type: String.t, default: nil) - Optional calendar
containing the event.
creator (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sCalendarEventAttendee.t, default: nil) - The person who
created this event.
description (type: String.t, default: nil) - Optional
description of the event (plain text).
end (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime
.t,default: nil) - The end time of the event. Start and end time
must either both be date or both be datetime. End is exclusive, ie.
the first day / first second when the event is over.
eventId (type: String.t, default: nil) - Optional event id
provided by assistant server. Needs to be unique, at least on a per-
user and calendar level, ideally globally unique. If none is given,
the server will assign an id.
flairName (type: String.t, default: nil) - The flair name,
calculated according to the event title (go/as-cal-flair). With the
flair name, background images can be got from gstatic (go/scs):
https://ssl.gstatic.com/tmly/f8944938hffheth4ew890ht4i8/flairs/
foregroundColor (type: integer(), default: nil) - The
foreground color of the event, in RGB format.
guestsCanInviteOthers (type: boolean(), default: nil) -
Whether the guests can invite other guests.
guestsCanModify (type: boolean(), default: nil) - Whether the
guests can modify the event.
guestsCanSeeGuests (type: boolean(), default: nil) - Whether
the guests of the event can be seen. If false, the user is reported as
the only attendee to the event, even though there may be more
attendees.
habitId (type: String.t, default: nil) - Optional id of the Habit
(Calendar Goal) this event is linked to
habitStatus (type: String.t, default: nil) - Optional status for
this habit event instance.
htmlLink (type: String.t, default: nil) - Absolute link to this
event in the Calendar web UI.
location (type: String.t, default: nil) - Optional location of
the event (plain text).
meetingContacts (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCor
eTypesCalendarEventMeetingContact.t), default: nil) -
organizer (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sCalendarEventAttendee.t, default: nil) - The organizer of this
event.
(type: boolean(), default: nil) -
otherAttendeesExcluded
Whether not all attendees are included in the attendee list. This is
set when the attendees list has been truncated (e.g., when the
number of attendees is beyond the maxAttendees limitation).
 participationResponse(type: String.t, default: nil) - The
user's response (the owner of this copy of the event) to this event.
recurringEventId (type: String.t, default: nil) - If this is an
instance of a recurring event, recurring_event_id identifies the
recurring series as a whole.
rooms (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCor
eTypesCalendarEventRoom.t), default: nil) - Meeting rooms
associated to this event.
start (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime
.t,default: nil) - The start time of the event. This event is an all-
day event if start has no time_of_day.
summary (type: String.t, default: nil) - The title of the event.
visibility (type: String.t, default: nil) - Optional visibility of
the event.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEvent{

attendees:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventAttendee.t(
)
]

| nil,
backgroundColor: integer() | nil,
calendarId: String.t() | nil,
creator:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventAttendee.t(
)
| nil,

description: String.t() | nil,

end: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime.t() | nil,
eventId: String.t() | nil,
flairName: String.t() | nil,

foregroundColor: integer() | nil,

guestsCanInviteOthers: boolean() | nil,

guestsCanModify: boolean() | nil,

guestsCanSeeGuests: boolean() | nil,

habitId: String.t() | nil,
habitStatus: String.t() | nil,
htmlLink: String.t() | nil,

location: String.t() | nil,

meetingContacts:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventMeetingCont
 act.t()

]
| nil,
organizer:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventAttendee.t(
)

| nil,
otherAttendeesExcluded: boolean() | nil,

participationResponse: String.t() | nil,

recurringEventId: String.t() | nil,
rooms:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventRoom.t()
]

| nil,
start: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime.t() | nil,
summary: String.t() | nil,
visibility: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCale
ndarEventAttendee
Next id: 8

Attributes

displayName (type: String.t, default: nil) - Display name,

present only if available.
email (type: String.t, default: nil) - Email address of the
attendee (calendar), for regular events. For +Events, this field is not
populated, instead "id" is used.
givenName (type: String.t, default: nil) - Given (first) name,
present only if available. This is used for generating meeting titles
as given name is preferred over display (full) name (ie: "Jeff :
Sundar" is better than "Jeff Dean : Sundar Pichai").
id (type: String.t, default: nil) - Profile ID of the principal, for
+Events. For regular events, this field is not populated, instead
"email" is used.
organizer (type: boolean(), default: nil) - Is this the organizer?
responseStatus (type: String.t, default: nil) - Attendees
response status.
self (type: boolean(), default: nil) - Is this the owner of this
copy of the event?

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventAttendee{
displayName: String.t() | nil,
email: String.t() | nil,
givenName: String.t() | nil,

id: String.t() | nil,

organizer: boolean() | nil,
responseStatus: String.t() | nil,
self: boolean() | nil

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCale
ndarEventMeetingContact
Next id: 10

Attributes

conferenceId (type: String.t, default: nil) - ID that

corresponds to in ConferenceData.conference_id in
calendar.common.ConferenceData proto. For Meet, this is the
identifier used to join a meeting via URL.
dialInNumberClasses (type: list(String.t), default: nil) -
phoneNumberUri (type: String.t, default: nil) - Default meeting
phone number, for example: "tel:+1-475-777-1840"
pinNumber (type: String.t, default: nil) - A PIN that the
participant will need to input after dialing in the conference.
provider (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sProvider.t,default: nil) - Provider info for the meeting.
regionCode (type: String.t, default: nil) - The region code for
the default meeting phone number
source (type: String.t, default: nil) -
universalPinNumber (type: String.t, default: nil) - The
universal meeting PIN number for phone numbers in all available
countries
url (type: String.t, default: nil) - URL that can be used to join
the meeting.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventMeetingCon
tact{

conferenceId: String.t() | nil,

dialInNumberClasses: [String.t()] | nil,
phoneNumberUri: String.t() | nil,

pinNumber: String.t() | nil,

provider:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider.t()
| nil,

regionCode: String.t() | nil,

source: String.t() | nil,
universalPinNumber: String.t() | nil,
 url: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCale
ndarEventRoom
A room that is available for a potential meeting or has been booked for a
scheduled meeting. Next id: 4

Attributes

email (type: String.t, default: nil) - Room email that identifies

the room and is used to book it.
locationDetails (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sCalendarEventRoomRoomLocationDetails.t, default: nil) -
Additional room details. Read-only, populated on request.
name (type: String.t, default: nil) - Room name (ex: "MTV-
PR55-5-A-Shadow 5K0 (13) GVC (No external guests)").

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventRoom{
email: String.t() | nil,
locationDetails:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventRoomRoomLoc
ationDetails.t()
| nil,

name: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCale
ndarEventRoomRoomLocationDet
ails
Room location details. Read-only, populated on request. Next id: 8

Attributes

building (type: String.t, default: nil) - Building where the

room is (ex: "PR55").
city (type: String.t, default: nil) - City where the room is (ex:
"MTV").
floor (type: String.t, default: nil) - Floor where the room is
(ex: "5").
latitude (type: float(), default: nil) - The latitude in degrees.
longitude (type: float(), default: nil) - The longitude in
degrees.
section (type: String.t, default: nil) - Section in the floor (ex:
"A").
simpleName (type: String.t, default: nil) - Room name (ex:
"Shadow 5K0").

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventRoomRoomLo
cationDetails{
building: String.t() | nil,

city: String.t() | nil,

floor: String.t() | nil,

latitude: float() | nil,

longitude: float() | nil,

section: String.t() | nil,
simpleName: String.t() | nil

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCale
ndarEventWrapper
This empty type allows us to publish sensitive calendar events to
go/attentional-entities, while maintaining BUILD visibility protection for
their contents. The BUILD-visibility-protected extension to this message
is defined at
http://google3/assistant/verticals/calendar/proto/multi_account_calendar
_event.proto

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventWrapper{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesCast
AppInfo
The cast app information of the provider.

Attributes

castAppId (type: String.t, default: nil) - The cast app id.

|cast_app_id| is the ID of the cast app used on the current device
and |content_app_id| is the ID of the app that provides the actual
content. For example, in a group playback, on a follower device, the
|cast_app_id| is the follower cast app ID and the |content_app_id| is
the leader cast app ID.
contentAppId (type: String.t, default: nil) - The id of the cast
app that provides the content in a group. The field will always be
filled. In the case of a group playback and the current device is a
follower, the |cast_app_id| has the ID of the follower app, and
|content_app_id| has ID of the actual content app. In all other cases,
|content_app_id| and |cast_app_id| will be the same.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCastAppInfo{
castAppId: String.t() | nil,

contentAppId: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesChro
meOsAppInfo
The ChromeOS app information of the provider. Next ID: 3

Attributes

localizedAppName (type: String.t, default: nil) - The localized

app name.
packageName(type: String.t, default: nil) - Unique package
name that identifies a ChromeOS app of the provider.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesChromeOsAppInfo{
localizedAppName: String.t() | nil,

packageName: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesClou
dProviderInfo
The third party provider information.

Attributes

agentStyle (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sCloudProviderInfoAgentStyle.t, default: nil) -
directoryUrl (type: String.t, default: nil) - URL to a
directory page about the third party agent in Assistant HQ. This is a
universal (https) URL that may be handled natively by clients to
show HQ or launch to the HQ directory web page.
logoUrl (type: String.t, default: nil) - The logo url for the
third party provider.
name (type: String.t, default: nil) - The user visible name of
the cloud provider, which may be used for example in the chat
header during a conversation with the third party.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCloudProviderInfo{

agentStyle:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCloudProviderInfoAgentSt
yle.t()

| nil,
directoryUrl: String.t() | nil,
logoUrl: String.t() | nil,

name: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesClou
dProviderInfoAgentStyle
The style customizations for the 3p agent.

Attributes

backgroundColor (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sColor.t,default: nil) - The background color of the agent. Used
if no background image is specified for the given display
orientation, or if the provided background image does not fit.
headerTheme (type: String.t, default: nil) -
landscapeBackgroundImageUrl (type: String.t, default: nil) -
URL for the background image of the agent on landscape display.
logoUrl (type: String.t, default: nil) - URL for the image
containing the 3p logo. This can include logomark and logotype, or
logotype only. If present, this can be used in place of the square
logo contained in the top level logo_url field in CloudProviderInfo.
See go/cards-logo-customization for details on applying this logo.
maskColor (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sColor.t,default: nil) - The color of the mask to apply to the
background. See go/aog-cards-background-mask for details on
applying this mask.
portraitBackgroundImageUrl (type: String.t, default: nil) -
URL for the background image of the agent on portrait display.
primaryColor (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
 default: nil) - The primary color of the agent. Used by
sColor.t,
the client to style the header and suggestion chips.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCloudProviderInfoAgentS
tyle{
backgroundColor:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesColor.t() | nil,

headerTheme: String.t() | nil,

landscapeBackgroundImageUrl: String.t() | nil,
logoUrl: String.t() | nil,

maskColor:
 GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesColor.t() | nil,
portraitBackgroundImageUrl: String.t() | nil,
primaryColor:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesColor.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesColo
r
Represents a color in the RGBA color space. This message mirrors
google.type.Color.

Attributes

alpha (type: number(), default: nil) - The fraction of this color

that should be applied to the pixel. That is, the final pixel color is
defined by the equation: pixel color = alpha (this color) + (1.0 -
alpha) (background color) This means that a value of 1.0
corresponds to a solid color, whereas a value of 0.0 corresponds to a
completely transparent color. If omitted, this color object is to be
rendered as a solid color (as if the alpha value had been explicitly
given with a value of 1.0).
blue (type: number(), default: nil) - The amount of blue in the
color as a value in the interval [0, 1].
green (type: number(), default: nil) - The amount of green in
the color as a value in the interval [0, 1].
red (type: number(), default: nil) - The amount of red in the
color as a value in the interval [0, 1].

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesColor{

alpha: number() | nil,
blue: number() | nil,

green: number() | nil,

red: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesDevi
ceConfig
The identification information for third party devices that integrates with
the assistant. All of these fields will be populated by the third party when
the query is sent from the third party device. Next Id: 5

Attributes

agentId (type: String.t, default: nil) - Pantheon Project ID that

uniquely identifies the consumer project ID. Required
deviceId (type: String.t, default: nil) - Unique identifier for
the device. Example: DBCDW098234. Required

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceConfig{
agentId: String.t() | nil,

deviceId: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesDevi
ceId
LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface.
Note there may be multiple device ids for the same physical device E.g.
Allo app and Assistant app on Nexus. Note: DeviceId usage is
complicated. Please do not depend on it for surface specific logic. Please
use google3/assistant/api/capabilities.proto instead. IMPORTANT: When
checking for equality between two DeviceIds, you should always use
an isSameDevice{As} function to check for equality, as deep equality
between DeviceId's is not guaranteed. C++:
http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=
421295740 Dart:
http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=4421261
45 * Java:
http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdH
elper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more
details. Next ID: 14

Attributes

agsaClientInstanceId (type: String.t, default: nil) - The

client_instance_id on devices with GSA. See 'client_instance_field'
in go/androidids.
alloDeviceId (type: String.t, default: nil) - Allo Id.
Corresponds to the GBotRequest.Sender.sender. NOTE(dychen):
This may change to standard android/ios physical device ids in
order to enable shared data (e.g. installed app on physical device
shared between Allo and Opa apps on Nexus).
canonicalDeviceId (type: String.t, default: nil) - A unique
device ID for Assistant devices as proposed by go/ocelot-team to
solve the device id fragmentation problem. The value of this id is
the HomeGraph id of the device. See go/ocelot-track-0-registry-
design. New surfaces should use the canonical_device_id instead of
using other ids, and the registration should utilize the
DeviceDataLayer (go/ddl-v0). Please contact the assistant-state-
management@ team for guidance. Note: We didn't reuse
|home_graph_device_id| because in Assistant code base
|home_graph_device_id| is common to associate it with 3P devices.
See go/project-yellowstone for more context.
castDeviceId (type: String.t, default: nil) - If set, indicates
that the device is a cast device, and contains the UUID of the cast
device. Corresponds to the device_id field of the CastDevice proto.
clientInstanceId (type: String.t, default: nil) - DUSI
(go/dusi) is used as the identifier here. This identifier is unique to
the user and device. This will help identify which device or
application the user's request originated from. This is not to be
confused with the client_instance_id that android devices provide.
This is currently used by surfaces that use the assistant-legacy-
nexus and assistant-legacy-clockwork pipelines. DUSI is created
and set in S3. This field is only filled for GAIA requests.
connectedDockId (type: String.t, default: nil) - A device ID
produced by a connected dock, which is registered in HomeGraph.
deviceConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The unique DeviceConfig to the
sDeviceConfig.t,
specific third party device. It is also used by Android Auto
Embedded first party device. See go/opa-ids.
deviceType (type: String.t, default: nil) - DEPRECATED.
assistant.api.core_types.governed.SurfaceIdentity.surface_type field
should be used instead. The device's surface type. This is the string
version of surface_type. The server should use the SurfaceType
value derived from this string. If the device_type isn't supported
within the SurfaceType enum, it will be set as UNKNOWN.
 Developers should use the enum in ServerParams instead of this
string. WARNING: Clients are not actually setting this field. This
field will be removed once references to it within the code base
have been removed.
homeGraphDeviceId (type: String.t, default: nil) - The unique
device ID for HomeGraph devices. This is the HomeGraph ID,
created when the device is registered into HomeGraph. It is
immutable for the same device unless it is completely deleted and
recreated. See go/home-graph for details.
libassistantDeviceId (type: String.t, default: nil) - The
unique ID for libassistant based devices. See go/libassistant-id for
details.
multiHotwordArbitrationDeviceId (type: String.t, default:
nil) - If set, indicates that the device is participating the multi-
hotword arbitration and the id is an UUID to distinguish it from
other devices. It should also be consistent between requests from a
single device within a session (or short duration).
opaIosDeviceId (type: String.t, default: nil) - The unique
device ID for the Assistant App on iOS. See go/opa-ios-design for
details.
quartzDeviceId (type: String.t, default: nil) - The unique ID
of a Quartz device. See go/quartz-design-doc for more details.
Quartz ID is a hash of (android_id + gaia).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId{

agsaClientInstanceId: String.t() | nil,

alloDeviceId: String.t() | nil,

canonicalDeviceId: String.t() | nil,
castDeviceId: String.t() | nil,
clientInstanceId: String.t() | nil,

connectedDockId: String.t() | nil,

deviceConfig:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceConfig.t()

| nil,
deviceType: String.t() | nil,
homeGraphDeviceId: String.t() | nil,
libassistantDeviceId: String.t() | nil,

multiHotwordArbitrationDeviceId: String.t() | nil,

opaIosDeviceId: String.t() | nil,
quartzDeviceId: String.t() | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesDevi
ceUserIdentity
The set of information that helps Assistant identify a device-user pair.
An example use of this proto is in broadcast reply, when after receiving a
broadcast, we store a device-user pair in an attentional entity in order to
later infer who initated the broadcast on which device.

Attributes

deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The identifier of the device.
sDeviceId.t,
gaiaId (type: String.t, default: nil) - The identifier of the user.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceUserIdentity{
deviceId:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t()
| nil,
gaiaId: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesHom
eAppInfo
The Home app information of the provider. Next ID: 3

Attributes

localizedAppName (type: String.t, default: nil) - The localized

app name.
packageName(type: String.t, default: nil) - Unique package
name that identifies a Home app of the provider.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesHomeAppInfo{
localizedAppName: String.t() | nil,
packageName: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesImag
e
An image represents the data about an image or a photo. NextId: 13

Attributes

accessibilityText(type: String.t, default: nil) - A text

description of the image to be used for accessibility, e.g. screen
readers.
appIconIdentifier (type: String.t, default: nil) - App
identifier. This field is specific to mobile surfaces and stands for
app package name for Android surface, and app bundle identifier
for iOS. In case identifier is specified but invalid, some default icon
will be used, e.g. PackageManager.getDefaultActivityIcon() for
Android. If you want to show image for AGSA versions which
don't support this field, you can specify source_url as backup.
badgeImage (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sImage.t, default: nil) - This is the image that is displayed as the
badge on the main image.
content (type: String.t, default: nil) - Content of the image in
bytes.
height (type: integer(), default: nil) -
imageSource (type: String.t, default: nil) - Indicate the data
source where the image is fetched.
jsonContent (type: String.t, default: nil) - Content of image
in form of JSON representation.
letterDrawableText (type: String.t, default: nil) - Text used
to generate a letter drawable (a letter icon with color). It will be the
 default icon if the source_url is empty or cannot be rendered.
providerUrl (type: String.t, default: nil) - Url of the image
provider, which is the website containing the image. For example,
https://www.agentx.com.
sourceUrl (type: String.t, default: nil) - The source url of the
image. For example, https://www.agentx.com/logo.png
sourceUrlType (type: String.t, default: nil) - Type of the
source url.
width (type: integer(), default: nil) - The width and height of
the image in pixels.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesImage{
accessibilityText: String.t() | nil,

appIconIdentifier: String.t() | nil,

badgeImage: t() | nil,
content: String.t() | nil,

height: integer() | nil,

imageSource: String.t() | nil,
jsonContent: String.t() | nil,
letterDrawableText: String.t() | nil,

providerUrl: String.t() | nil,

sourceUrl: String.t() | nil,
sourceUrlType: String.t() | nil,

width: integer() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesInter
nalProviderInfo
Info for targeting a feature provided directly by the Assistant surface
itself. i.e Could be pointing to AGSA audio player for
AUDIO_PLAYER on AGSA.

Attributes

type (type: String.t, default: nil) - Specifying which type of

internal provider.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesInternalProviderInfo{
type: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesIosA
ppInfo
The iOS app information of the provider. Next ID: 4

Attributes

(type: String.t, default: nil) - Bundle

bundleIdentifier
identifier that identifies an iOS app of the provider.
localizedAppName (type: String.t, default: nil) - The localized
app name.
openAppUrl (type: String.t, default: nil) - A URL to open the
provider's app.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesIosAppInfo{

bundleIdentifier: String.t() | nil,

localizedAppName: String.t() | nil,
openAppUrl: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesKai
OsAppInfo
The KaiOS app information of the provider. Next ID: 4

Attributes

localizedAppName (type: String.t, default: nil) - The localized

app name.
openAppUrl(type: String.t, default: nil) - A URL to open the
provider's app.
packageName (type: String.t, default: nil) - Unique package
name that identifies a KaiOS app of the provider.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesKaiOsAppInfo{
localizedAppName: String.t() | nil,
openAppUrl: String.t() | nil,

packageName: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesLoca
tionCoordinates
Geographic coordinate information for location.

Attributes

accuracyMeters (type: float(), default: nil) - The accuracy of

the coordinates in meters.
latDegrees (type: float(), default: nil) - Latitude degrees.
lngDegrees (type: float(), default: nil) - Longitude degrees.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesLocationCoordinates{
accuracyMeters: float() | nil,
latDegrees: float() | nil,
lngDegrees: float() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesMess
ageNotification
This proto captures the contents of a messaging app notification that is
typically part of a conversation thread. Next Id: 21

Attributes

appName (type: String.t, default: nil) - App name of the

message notification, e.g. Hangouts.
bundleId (type: String.t, default: nil) - The key used to group
this notification into a cluster.
dataUri (type: String.t, default: nil) - Uri for the attachment
(image, audio, video etc.).
groupName (type: String.t, default: nil) - Name of the group
associated with the message notification. This field is set iff this is a
group message.
groupingKey (type: String.t, default: nil) - The group key of a
proactive notification. Details in
assistant.api.client_op.NotificationArgs.grouping_key.
index (type: integer(), default: nil) - Index of the message
notification.
markAsReadActionAvailable (type: boolean(), default: nil) -
Boolean indicating if the mark_as_read action is available for this
message.
messageLength (type: integer(), default: nil) - Length of the
message/notification content in characters. Note: We can't send the
full content because of privacy restriction, preventing sending client
content to our backends. Concatenated message_length of all
notification_entries.
 messageRecipientType (type: String.t, default: nil) -
messageWordCount (type: integer(), default: nil) - Word count
of the message
mimeType (type: String.t, default: nil) - Mime type of the
data_uri. e.g. 'audio/wav', 'video/mp4', 'image/png'.
notificationEntries (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiCor
eTypesMessageNotificationNotificationEntry.t), default:
nil) -
notificationIconKey (type: String.t, default: nil) - On-
device cache key for notification icon.
notificationKey (type: String.t, default: nil) - String key of
the notification. It is the key from original StatusBarNotification
received from Android OS. It is used to identify the original
notification to send a reply.
opaqueToken (type: String.t, default: nil) - The opaque_token
of a proactive notification. Details in
assistant.api.client_op.NotificationArgs.opaque_token.
packageName (type: String.t, default: nil) - App pkg of the
message notification, e.g. "com.google.android.talk".
postTime (type: String.t, default: nil) - Timestamp of the last
notification's post time.
replyActionAvailable (type: boolean(), default: nil) -
Boolean indicating if the reply action is available for this message.
sender (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) -
sMessageNotificationPerson.t,
senderName (type: String.t, default: nil) - Sender's name of the
message notification, e.g. Elsa. Last sender name in case of a group
conversation.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotification{

appName: String.t() | nil,

bundleId: String.t() | nil,
dataUri: String.t() | nil,

groupName: String.t() | nil,

groupingKey: String.t() | nil,
index: integer() | nil,
markAsReadActionAvailable: boolean() | nil,

messageLength: integer() | nil,

messageRecipientType: String.t() | nil,
messageWordCount: integer() | nil,

mimeType: String.t() | nil,

notificationEntries:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationNotif
 icationEntry.t()
]
| nil,

notificationIconKey: String.t() | nil,

notificationKey: String.t() | nil,
opaqueToken: String.t() | nil,
packageName: String.t() | nil,

postTime: String.t() | nil,

replyActionAvailable: boolean() | nil,
sender:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationPerso
n.t()
| nil,

senderName: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesMess
ageNotificationNotificationEntry
Structure of each notification in the MessageNotification Bundle.
Attribute sender_name could be different in case of group messages.
Next Id: 9

Attributes

audioDuration (type: String.t, default: nil) - Duration of

audio message.
charCount (type: integer(), default: nil) - Count of characters
in the message body in the notification.
dataUri (type: String.t, default: nil) - Uri for the attachment
(image, audio, video etc.).
messageBody (type: String.t, default: nil) - Note that this is not
present in production traffic. Content of the message body in the
notification.
mimeType (type: String.t, default: nil) - Mime type of the
data_uri. e.g. 'audio/wav', 'video/mp4', 'image/png'.
postTime (type: DateTime.t, default: nil) - Timestamp of the
notification's post time.
sender (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sMessageNotificationPerson.t, default: nil) - Sender of the
message notification.
wordCount (type: integer(), default: nil) - Count of words in
the message body in the notification.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationNoti
ficationEntry{
audioDuration: String.t() | nil,
charCount: integer() | nil,

dataUri: String.t() | nil,

messageBody: String.t() | nil,
mimeType: String.t() | nil,

postTime: DateTime.t() | nil,

sender:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationPerso

n.t()
 | nil,

wordCount: integer() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesMess
ageNotificationPerson
Mirrors part of
https://developer.android.com/reference/android/app/Person Next Id: 4

Attributes

isImportant(type: boolean(), default: nil) -

key (type: String.t, default: nil) -
name (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationPers

on{
isImportant: boolean() | nil,
key: String.t() | nil,
name: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesProv
ider
Provider. Like, Spotify or iHeartRadio. Next ID: 13

Attributes

androidAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sAndroidAppInfo.t, default: nil) - The android app information
of the provider.
castAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sCastAppInfo.t, default: nil) - The cast app information of the
provider.
chromeosAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sChromeOsAppInfo.t, default: nil) - The ChromeOS app
information of the provider.
cloudProviderInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sCloudProviderInfo.t, default: nil) - The third party provider
information.
fallbackUrl (type: String.t, default: nil) - A URL to fallback
to if app can not be opened.
homeAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sHomeAppInfo.t, default: nil) -
iconImageUrl (type: String.t, default: nil) - Public URL
pointing to an icon image for the provider. e.g.
 https://lh3.googleusercontent.com/UrY7BAZ-
XfXGpfkeWg0zCCeo-
7ras4DCoRalC_WXXWTK9q5b0Iw7B0YQMsVxZaNB7DM
internalProviderInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The internal assistant
sInternalProviderInfo.t,
provider information.
iosAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sIosAppInfo.t, default: nil) - The iOS app information of the
provider.
kaiosAppInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sKaiOsAppInfo.t, default: nil) - The KaiOS app information of
the provider.
sipProviderInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sSipProviderInfo.t, default: nil) - The sip information of the
provider.
webProviderInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sWebProviderInfo.t, default: nil) - The web provider
information.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider{

androidAppInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfo.t()

| nil,
castAppInfo:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCastAppInfo.t()
| nil,

chromeosAppInfo:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesChromeOsAppInfo.t()
| nil,

cloudProviderInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCloudProviderInfo.t()
| nil,

fallbackUrl: String.t() | nil,

homeAppInfo:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesHomeAppInfo.t()

| nil,
iconImageUrl: String.t() | nil,

internalProviderInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesInternalProviderInfo.t()
| nil,
iosAppInfo:
 GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesIosAppInfo.t()
| nil,

kaiosAppInfo:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesKaiOsAppInfo.t()
| nil,
sipProviderInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSipProviderInfo.t()
| nil,
webProviderInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesWebProviderInfo.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesProv
iderDelta
ProviderDelta. The incremental change, e.g. installation or deletion for
Spotify or iHeartRadio. Currently it is for Android only. A few
considerations for edge cases: - If the app being deleted is not found
from Footprints, it is ignored. - For Footprint upload through Geller, the
gPRC response is available for client to retry in the next upload if the
upload fails. - For Assistant Request, there is no upload status similar to
the current AppCapabilities. Next ID: 4

Attributes

androidAppInfoDelta (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sAndroidAppInfoDelta.t, default: nil) - The android app
information of the provider.
fallbackUrl (type: String.t, default: nil) - A URL to fallback
to if app can not be opened.
iconImageUrl (type: String.t, default: nil) - Public URL
pointing to an icon image for the provider. e.g.
https://lh3.googleusercontent.com/UrY7BAZ-
XfXGpfkeWg0zCCeo-
7ras4DCoRalC_WXXWTK9q5b0Iw7B0YQMsVxZaNB7DM

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProviderDelta{

androidAppInfoDelta:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoDelta.t()
| nil,
fallbackUrl: String.t() | nil,

iconImageUrl: String.t() | nil

}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadata
Task metadata information describing the ringtone. Next id: 11

Attributes

category (type: String.t, default: nil) - The category related

with the ringtone. It's used to generate ringtone related with the
category if the entity_mid is not be populated. E.g. for instrument,
the ringtone may be piano sound.
characterAlarmMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sRingtoneTaskMetadataCharacterAlarmMetadata.t, default:
nil) -
characterTag (type: String.t, default: nil) -
entityMid (type: String.t, default: nil) - The freebase mid of
the entity related to the ringtone. It will be used to generate the
ringtone for the alarm or timer (with support for i18n). For instance,
for the "cat" mid, the related ringtone will be a cat sound in some
language, and for the "Beyonce" mid, the ringtone will be, e.g., a
playlist of Beyonce's best hits.
funtimeMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sRingtoneTaskMetadataFuntimeMetadata.t, default: nil) -
genMlAlarmMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sRingtoneTaskMetadataGenMlAlarmMetadata.t, default: nil) -
gentleWakeInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
 default: nil) -
sRingtoneTaskMetadataGentleWakeInfo.t,
Gentle wake information for this alarm.
onDeviceAlarmMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sRingtoneTaskMetadataOnDeviceAlarmMetadata.t, default: nil)
-
onDeviceAlarmSound (type: String.t, default: nil) - Will be
deprecated. Use OnDeviceAlarmMetadata.
routineAlarmMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sRingtoneTaskMetadataRoutineAlarmMetadata.t, default: nil)
-

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadata{
category: String.t() | nil,
characterAlarmMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataChar

acterAlarmMetadata.t()
| nil,

characterTag: String.t() | nil,

entityMid: String.t() | nil,

funtimeMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataFunt

imeMetadata.t()
| nil,
genMlAlarmMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataGenM
lAlarmMetadata.t()
| nil,

gentleWakeInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataGent
leWakeInfo.t()

| nil,

onDeviceAlarmMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataOnDe
viceAlarmMetadata.t()
| nil,
onDeviceAlarmSound: String.t() | nil,

routineAlarmMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataRout

ineAlarmMetadata.t()
 | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadataCharacterAlarm
Metadata
Attributes

agentIds (type: list(String.t), default: nil) - For character

alarm, the media resources are provided through AOG apps. During
alarm trigger phase, aog apps with the specified agent_ids are used
to get the media resources. Multiple "AoG agents" can satisfy a
character_tag. So the user will select the agents they want at alarm
creation time. The chosen agents will be recorded so that the
resources only from those agents will be used at trigger time. The
number of selected agent_ids will not exceed 3. See go/character-
alarm-aog.
characterTags (type: list(String.t), default: nil) - The
Character Alarm tag. Tags are needed to identify the theme of the
alarm. For example, if the tag is 'astronaut', astronaut based audio is
played during alarm ring. Note : We have made it repeated so that
the user can choose multiple character alarm themes at one go. At
present, the user is allowed to choose only one theme during alarm
creation.
iconUrls (type: list(String.t), default: nil) - Icons urls
corresponding to a character. Note : We have made it repeated so
that we can show different images when the alarm rings. At present,
we only support only one image.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataCha
racterAlarmMetadata{
agentIds: [String.t()] | nil,
characterTags: [String.t()] | nil,

iconUrls: [String.t()] | nil

}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadataFuntimeMetadat
a
Used to make timers and alarms more delightful. See go/funtime-
engdesign for more details.

Attributes

agentIds (type: list(String.t), default: nil) - For FunTime

alarms and timers, the media resources are provided through AOG
apps during their ringtone. Multiple AoG agents can satisfy a label.
So a random agent will be chosen from those that are supplied. See
go/funtime-engdesign.
animationBlob (type: String.t, default: nil) - These bytes may
represent the blob of the Rive animation that we pass to the Opal
App. We will deprecate this field if we figure out a solution to load
the animation from the web.
animationUrl (type: String.t, default: nil) - Url for Rive
animation that is brought up on ring. Rive is a lightweight
animation library that is compatible with Flutter on Opal. See
https://rive.app/.
timerHeroUrl (type: String.t, default: nil) - The url used to
load the image that is at the center of the timer during timer
countdown visuals.
ttsServiceRequestBytes (type: String.t, default: nil) - This
is used to call S3 to realize the TTS. Is in the form of bytes because
of a circular dependency issue in libassistant protos. It is a
serialized proto of type speech.s3.TtsServiceRequest.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataFun
timeMetadata{
agentIds: [String.t()] | nil,

animationBlob: String.t() | nil,

animationUrl: String.t() | nil,

timerHeroUrl: String.t() | nil,

ttsServiceRequestBytes: String.t() | nil

}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadataGenMlAlarmMe
tadata
Metadata for machine learning generated audio samples. This will be
similar to character alarms, Category will be set MEDIA but this
metadata field will be used to identify the ringtone type on surface.
(go/magenta-alarm-ringtones).

Attributes

isEnabled(type: boolean(), default: nil) -

ringtoneLabel (type: String.t, default: nil) - Label for the
generated ringtone.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataGen
MlAlarmMetadata{
isEnabled: boolean() | nil,
ringtoneLabel: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadataGentleWakeInfo
Gentle wake actions like slowly brightening the room/device screen
leading up to the alarm firing (go/cube-gentle-wake-up).

Attributes

effectDurationMs (type: String.t, default: nil) - Specifies

how long the effect lasts. Allowed for effect to last after the alarm
has started ringing. If unset or negative or 0, effect is assumed to
last until alarm trigger time.
isEnabled (type: boolean(), default: nil) - Indicates if gentle
wake action is to be performed before this alarm fires. This is
enabled only if the device supports sunrise alarm capability.
http://cs/symbol:assistant.api.SunriseFeaturesSupport
startTimedeltaMs (type: String.t, default: nil) - Specifies
how long before the alarm fire time, the wakeup effect will start.
ALWAYS POSITIVE.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataGen
tleWakeInfo{
effectDurationMs: String.t() | nil,
isEnabled: boolean() | nil,
startTimedeltaMs: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadataOnDeviceAlarm
Metadata
This describes the alarm sound resource enum and the alarm sound label
for the on device alarm sound. On-device ringtones are product specific,
hence Opal/UI layer will be responsible for populating this metadata at
creation/edit. The enum map will be used to convert to an internal
resource id used by libassistant for accessing the asset which are not
exposed to UI.

Attributes

onDeviceAlarmSound (type: String.t, default: nil) - Opal/UI

layer will set this bit based on the user selection.
onDeviceAlarmSoundLabel (type: String.t, default: nil) - A
string label to identify the alarm sound name. Opal/UI layer will set
this as per product definition. This will be used to display the name
of the selected ringtone.
ttsServiceRequestBytes (type: String.t, default: nil) - This
is used to call S3 to realize the TTS. Is in the form of bytes because
of a circular dependency issue in libassistant protos. It is a
serialized proto of type speech.s3.TtsServiceRequest. This request
will contain an ssml with the url to the ringtone files hosted on
gstatic.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataOnD

eviceAlarmMetadata{
onDeviceAlarmSound: String.t() | nil,
onDeviceAlarmSoundLabel: String.t() | nil,
ttsServiceRequestBytes: String.t() | nil

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesRing
toneTaskMetadataRoutineAlarmM
etadata
Attributes

routineId(type: String.t, default: nil) - The unique id for

each routine. When the alrm is dismissed, it will trigger the routine
of the routine alarm's creator if feasible.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataRou
tineAlarmMetadata{
routineId: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesSipP
roviderInfo
Session Initiation Protocol (SIP) information for providers that use SIP
to initiate multimedia communication sessions, like Google Voice and
Fi. https://en.wikipedia.org/wiki/Session_Initiation_Protocol

Attributes

providerId (type: String.t, default: nil) - The providers id

(MID) which is the primary identifier for a call provider within the
Assistant. A MID, or machine identifier, is a unique identifier
issued by Knowledge Graph for all entities contained in it's graph.
realm (type: String.t, default: nil) - Calling realm to be use for
each call. i.e. For anonymous, this would be set to
anonymous.chirp.google.com
useBirdsongTacl (type: boolean(), default: nil) - If true, client
should use the Birdsong TaCL API for this call. Uses the
VoiceCallManager API by default. For more details: go/birdsong-
migration-google-home

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSipProviderInfo{

providerId: String.t() | nil,

realm: String.t() | nil,

useBirdsongTacl: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesSurf
aceIdentity
The set of information that helps the server identify the surface. This
replaces the User-Agent string within the Assistant Server. Note: The
SurfaceIdentity proto should only be used to derive the capabilities of a
surface. It should not be accessed outside of the CapabilityBuilder or
CapabilityChecker. NEXT ID: 6

Attributes

deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sDeviceId.t, default: nil) - The identifier of the device.
legacySurfaceType (type: String.t, default: nil) -
DEPRECATED: The legacy device's surface type enum. NOTE:
Prefer using the ontological surface_type field above. If you need
to access the legacy surface type, please file a bug and add it in
your code to migrate to ontological surface type.
surfaceType (type: String.t, default: nil) - The device's
surface type. The types are defined at
google3/assistant/api/core_types/surfaces.gcl. For more details,
refer to go/ontologicalize-surface-type.
surfaceTypeString (type: String.t, default: nil) -
DEPRECATED. The legacy device's surface type string. NOTE:
Prefer using the ontological surface_type field. The device's
surface type. This is the string version of the
assistant.api.core_types.SurfaceType enum. The server should not
use this field, rather it should use the SurfaceType value derived
from this string.
 surfaceVersion (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The version of the
sSurfaceVersion.t,
surface/client. This is different from the Conversation protocol
version.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity{
deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t()

| nil,
legacySurfaceType: String.t() | nil,
surfaceType: String.t() | nil,
 surfaceTypeString: String.t() | nil,
surfaceVersion:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesSurf
aceType
Specifies the types of device surfaces. LINT.IfChange When adding new
surface types make sure that My Activity
(https://myactivity.google.com/product/assistant) will correctly render by
adding your enum to
http://cs/symbol:GetAssistSurfaceName%20f:%5C.cc$ If your type
doesn't fit in to any of the existing surfaces messages, add a new
message in
http://google3/personalization/footprints/boq/uservisible/events/intl/smh
_frontend_messages.h.

Attributes

type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceType{
type: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesSurf
aceVersion
The version of the surface/client. New surfaces are encouraged to only
use the “major” field to keep track of version number. The “minor” field
may be used for surfaces that rely on both the “major” and “minor”
fields to define their version.

Attributes

major (type: integer(), default: nil) -

minor (type: integer(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion{

major: integer() | nil,

minor: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesWeb
ProviderInfo
The web information of the provider. Next ID: 5

Attributes

homeStorage (type: String.t, default: nil) - Serialized storage

(context) persisted and retrieved for the app and home.
localizedAppName (type: String.t, default: nil) - The localized
app name.
openAppUrl (type: String.t, default: nil) - A URL to open the
provider's app.
thirdPartyCustomNluInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) -
sWebProviderInfoThirdPartyCustomNluInfo.t,
Info about 3P Custom NLU used in this web provider.
TODO(b/321644453) remove when QRewrite is able to call
SERoot.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesWebProviderInfo{
homeStorage: String.t() | nil,
localizedAppName: String.t() | nil,

openAppUrl: String.t() | nil,

thirdPartyCustomNluInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesWebProviderInfoThirdPart
yCustomNluInfo.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCoreTypesWeb
ProviderInfoThirdPartyCustomNl
uInfo
Attributes

locale(type: String.t, default: nil) - The locale of this agent

version, represented by BCP-47 language strings, such as "en", "en-
US", "fr", "fr-CA", "sr-Latn", "zh-Hans-CN", etc.
nluAgentId (type: String.t, default: nil) - Unique internal
identifier of 3P Custom NLU agent. UUID.
nluAgentVersion (type: String.t, default: nil) - Identifies the
3P Custom NLU agent version.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesWebProviderInfoThirdPar

tyCustomNluInfo{
locale: String.t() | nil,
nluAgentId: String.t() | nil,
nluAgentVersion: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiCrossDeviceEx
ecutionCapability
Attributes

(type: boolean(), default: nil) -

localConnectivityEnabled
Whether the device has torus/usonia capabililities enabled or not.
remoteCastMediaEnabled (type: boolean(), default: nil) -
Whether the device supports cast media originated from a remote
device to be executed through local execution and can upload
results asynchronously. Needs to be checked before sending remote
media initiation through local channel since it needs an async result
upload path.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiCrossDeviceExecutionCapability{
localConnectivityEnabled: boolean() | nil,
remoteCastMediaEnabled: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiDataValidateCa
pabilities
Attributes

fallbackToTetheredDevice(type: boolean(), default: nil) - If

true, data.VALIDATE should be routed to the tethered device (if
present) if the tethered device supports data.VALIDATE and the
primary device does not.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiDataValidateCapabilities{
fallbackToTetheredDevice: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiDate
A Gregorian calendar date.

Attributes

day (type: integer(), default: nil) - The day, in 1...31.

month (type: integer(), default: nil) - The month, in 1...12.
year (type: integer(), default: nil) - The year, e.g. 2016.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate{
day: integer() | nil,

month: integer() | nil,

year: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiDateTime
A date-time specification, combining a date and civil time (relative to a
given timezone).

Attributes

date (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t,
default: nil) - A Gregorian calendar date.
timeOfDay (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeOfDa
default: nil) - A civil time relative to a timezone.
y.t,
timeZone (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeZone
.t, default: nil) - A time zone in IANA format.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime{

date: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t() | nil,
timeOfDay:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeOfDay.t() | nil,
timeZone: GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeZone.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiDateTimeRang
e
A representation of a range of time with start and end datetime specified.

Attributes

endDate (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime
.t,default: nil) - End date of the range.
startDate (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime
.t, default: nil) - Start date of the range.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTimeRange{

endDate: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime.t() | nil,

startDate: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiDeviceCapabilit
ies
This message describes roughly what a surface is capable of doing and
metadata around those capabilities. These capabilities are determined
based on: - device hardware - software - status (e.g. volume level,
battery percentage) These capabilities refer to the surface and not the
physical device. The list of supported surfaces can be found in the
assistant.api.core_types.SurfaceType enum. A surface's capabilities can
differ from the device's. An example would be ANDROID_ALLO
running on Pixel. Allo does not support AudioInput while the Pixel does.
In this case, audio_input will be set to false for Assistant Allo requests
while it might be set to true for OPA_NEXUS requests. Next ID: 37

Attributes

movement (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMovement
default: nil) - These capabilities are scoped to
Capabilities.t,
abilities of the device to move around.
surfaceIdentity (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - The set of information that
sSurfaceIdentity.t,
helps the server identify the surface.
screen (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCa
default: nil) - These capabilities are scoped to the
pabilities.t,
ability to see and interact with the Assistant through a screen. If the
device has no screen it should send an empty ScreenCapabilities.
Sending no ScreenCapabilities will cause this to be overridden with
the surface default.
callCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCallCapa
default: nil) - The call capabilities of this device.
bilities.t,
go/call-capabilities
systemNotificationRestrictions (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNo
default: nil) - Restrictions related to
tificationRestrictions.t,
system-level notifications. This field is superficially similar to
ProactiveNotificationOutput, but unlike that field which tracks a
per-user preference on the OPA side, this field captures system level
notifications restrictions. This field is not stored and is merged to
capabilities from conversation params. It exists mostly for logging
purposes of android channel state and global app-level notification
opt out.
sodaCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSodaCapa
default: nil) - Capabilities related to SODA (Speech
bilities.t,
On-Device API).
hasVoiceTelephony (type: boolean(), default: nil) - Indicates
that the device has connection to cellular network that allows it to
make voice calls. This is distinct from device just being capable of
voice telephony, because the device can be capable yet miss the
suitable SIM card (for example, it could miss SIM card altogether,
or have data-only SIM card).
lensPerceptionCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
default: nil) - Capabilities related to
eptionCapabilities.t,
Lens Perception, i.e. image understanding. See go/lens-perception-
sdk.
cast (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastCapa
default: nil) - These capabilities are scoped to the
bilities.t,
cast abilities of this device.
deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sDeviceId.t, default: nil) - This is the same device id that is
specified in the conversation protocol and should be unique to each
device/user/model combination. For example, if a request is coming
from a watch through AGSA the watch and AGSA should have
different device_ids. Note: this field should only be used to
determine which device the capabilities belong to and not to access
the id of the device. Instead DeviceProperties should be used and
accessed through ParamsAccessor.
thirdPartyCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPar
default: nil) - Capabilities related to third
tyCapabilities.t,
party integration.
androidIntentCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidI
default: nil) - Capabilites related to
ntentCapabilities.t,
Android intent support.
camera (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraCa
default: nil) - These capabilities are scoped to the
pabilities.t,
camera abilities of this device.
deviceUxMode (type: String.t, default: nil) - Capabilities
related to Android tablet UX experience.
assistantCapability (type: String.t, default: nil) -
Capabilities if surface supports Google Assistant.
bluetoothCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiBluetoot
default: nil) - Bluetooth capabilities related to
hCapabilities.t,
usage of a feature.
location (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLocation
default: nil) - These capabilities are scoped to
Capabilities.t,
the location abilities of this device.
notificationOutputRestrictions (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotifica
default: nil) - Settings, that reflect
tionOutputRestrictions.t,
whether a specific notification type is allowed for current device,
e.g. if the user opted out from notification category or category
group. This settings are server-side stored and evaluated unlike
SystemNotificationRestrictions field.
loggingOnlyData (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLoggingO
nlyData.t, default: nil) - Data which is produced for logging and
debugging. Servers MUST NOT use this for any other purposes,
such as branching on it.
notificationCapabilities (type: String.t, default: nil) -
DEPRECATED: Use SystemNotificationRestrictions instead.
Specifies whether the surface is able to display notifications. This
field is superficially similar to ProactiveNotificationOutput, but
unlike that field which tracks a per-user preference on the OPA side,
this field captures whether the surface is capable of displaying
notifications.
messageCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageC
default: nil) -
apabilities.t,
audioInput (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioInp
default: nil) - These capabilities are scoped to the ability to
ut.t,
gather audio. It includes information like the type of audio that can
be gathered (e.g. public, private).
contactLookupCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiContactL
ookupCapabilities.t, default: nil) -
outputRestrictions (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOutputRe
default: nil) - These are user configured
strictions.t,
restrictions indicating what the device is allowed to output from the
privacy point of view.
software (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSoftware
default: nil) - These capabilities are scoped to
Capabilities.t,
the software available on the device as well as the set of supported
Assistant features.
communicationUiCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCommunic
default: nil) -
ationUiCapabilities.t,
carUxRestrictions (type: list(String.t), default: nil) - UX
restrictions for Auto.
audioOutput (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioOut
put.t,default: nil) - These capabilities are scoped to the ability
to play audio. It includes information like the type of audio that can
be played (e.g. public, private).
popOnLockscreenCapability (type: String.t, default: nil) -
Capability to support Pop on lockscreen.
dataValidateCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDataVali
dateCapabilities.t,default: nil) -
surfaceTypeString (type: String.t, default: nil) -
DEPRECATED. surface_identity field below already contains this
information. The device's surface type. This is the string version of
the assistant.api.core_types.SurfaceType enum. The server should
not use this field, rather it should use the SurfaceType value derived
from this string.
jwnCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiJwnCapab
default: nil) - Indicates if the client supports
ilities.t,
Javascript Whatsnext (go/jwn). Also contains the Jwn libraries
present on the client along with their versions.
safetyRestrictions (type: String.t, default: nil) - Indicates if
the client has safety related restriction.
supportedLocale (type: list(String.t), default: nil) - Locales
supported by assistant settings for speaking and display. This is
 independent from device language that is defined in device setting.
New locales are added based on rollout, whitelist and app version
releases because older versions does not have model support.
Currently supported locale list differs by surface type.
speechCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSpeechCa
default: nil) - DEPRECATED Capabilities related
pabilities.t,
to speech detection on devices.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiDeviceCapabilities{

androidIntentCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidIntentCapabilities.t()
| nil,
 assistantCapability: String.t() | nil,
audioInput:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioInput.t() | nil,
audioOutput:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioOutput.t() | nil,
bluetoothCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiBluetoothCapabilities.t()
| nil,

callCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCallCapabilities.t() | nil,
camera:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraCapabilities.t() | nil,

carUxRestrictions: [String.t()] | nil,

cast:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastCapabilities.t() | nil,

communicationUiCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCommunicationUiCapabilities.t()

| nil,
contactLookupCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiContactLookupCapabilities.t()
| nil,

dataValidateCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiDataValidateCapabilities.t()
| nil,

deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,
deviceUxMode: String.t() | nil,
hasVoiceTelephony: boolean() | nil,
jwnCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiJwnCapabilities.t() | nil,
lensPerceptionCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilities.t()
| nil,
location:
 GoogleApi.ContentWarehouse.V1.Model.AssistantApiLocationCapabilities.t()

| nil,
loggingOnlyData:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLoggingOnlyData.t() | nil,
messageCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageCapabilities.t()
| nil,
movement:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMovementCapabilities.t()

| nil,
notificationCapabilities: String.t() | nil,
notificationOutputRestrictions:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictions.t(
)
| nil,

outputRestrictions:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiOutputRestrictions.t() | nil,
popOnLockscreenCapability: String.t() | nil,
safetyRestrictions: String.t() | nil,
screen:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilities.t() | nil,
sodaCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSodaCapabilities.t() | nil,
software:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSoftwareCapabilities.t()

| nil,
speechCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSpeechCapabilities.t() | nil,
supportedLocale: [String.t()] | nil,

surfaceIdentity:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity.t()
| nil,
surfaceTypeString: String.t() | nil,

systemNotificationRestrictions:
 GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictions.t(
)

| nil,
thirdPartyCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyCapabilities.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiDuration
A Duration represents a signed, fixed-length span of time represented as
a count of seconds and fractions of seconds at nanosecond resolution. It
is independent of any calendar and concepts like "day" or "month". It is
related to Timestamp in that the difference between two Timestamp
values is a Duration and it can be added or subtracted from a Timestamp.
Range is approximately +-10,000 years.

Attributes

nanos (type: integer(), default: nil) - Signed fractions of a

second at nanosecond resolution of the span of time. Durations less
than one second are represented with a 0 seconds field and a
positive or negative nanos field. For durations of one second or
more, a non-zero value for the nanos field must be of the same sign
as the seconds field. Must be from -999,999,999 to +999,999,999
inclusive.
seconds (type: String.t, default: nil) - Signed seconds of the
span of time. Must be from -315,576,000,000 to +315,576,000,000
inclusive.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration{

nanos: integer() | nil,

seconds: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiFeatureSpecific
ActionSupport
Attributes

(type: boolean(), default: nil) -

clarificationDataSupported
Whether client supports clarification suggestion chip to be
displayed see |assistant.suggestions.ClarificationData|

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiFeatureSpecificActionSupport{
clarificationDataSupported: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiFitnessFeature
Support
Attributes

supportedActivities(type: list(String.t), default: nil) - A

list of fitness activity types supported by this client.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiFitnessFeatureSupport{
supportedActivities: [String.t()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiFluidActionsSu
pport
Attributes

(type: String.t, default: nil) - Specifies the

stateSyncMethod
params proto that Fluid Actions uses to sync state with server.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiFluidActionsSupport{
stateSyncMethod: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiGacsCapabilitie
s
Capabilities of Google assistant conversation service(GACS) devices.
These capabilites including supported GACS actions and response size
limitations.

Attributes

deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - DeviceId of the accessory device (eg.
sDeviceId.t,
watch) Commonly the go/dusi (eg. client_instance_id) is provided.
responseConfig (type:
GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantAcces
soryV1ResponseConfig.t, default: nil) - Configuration sent by
device.
(type: String.t, default: nil) - DEPRECATED:
ttsEncoding
Format of TTS audio requested by the device.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiGacsCapabilities{

deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,

responseConfig:

GoogleApi.ContentWarehouse.V1.Model.GoogleAssistantAccessoryV1ResponseConfig.t()
| nil,

ttsEncoding: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiGcmCapabilitie
s
Capabilities related to GCM.

Attributes

gcmRegistrationId (type: String.t, default: nil) - GCM

registration id for the device. Used to pass messages to the device.
supportsAssistantGcm (type: boolean(), default: nil) -
Assistant supports GCM on the device. ClientOps can be sent to it
over GCM and will be executed.
supportsClientInputOverGcm (type: boolean(), default: nil) -
If it is set to true, then it indicates to server that device is capable of
receiving a GCM payload with serialized client input. The client
input will be sent back to Assistant Server over conversation
protocol.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiGcmCapabilities{

gcmRegistrationId: String.t() | nil,
supportsAssistantGcm: boolean() | nil,
supportsClientInputOverGcm: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiGestureCapabil
ities
The gesture capabilities related to Selina. Next ID: 4

Attributes

gestureSensing (type: boolean(), default: nil) - Whether

Gesture is supported. When false, override the value for tap and
omniswipe.
omniswipeGestureCapable (type: boolean(), default: nil) -
Whether omniswipe is supported
tapGestureCapable (type: boolean(), default: nil) - Whether
tap is supported

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiGestureCapabilities{

gestureSensing: boolean() | nil,

omniswipeGestureCapable: boolean() | nil,
tapGestureCapable: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiGuestAccessOu
tput
Access settings for guests.

Attributes

guestAccessOnYoutube (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiGuestAccessOutput{
guestAccessOnYoutube: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiImmersiveCanv
asSupport
Attributes

confirmationMessageSupported (type: boolean(), default: nil)

- Whether the client supports confirmation messages in Immersive
Canvas actions.
pauseSignalSupported (type: boolean(), default: nil) -
Whether the client support canvas pause signal. If true, the
Assistant Server will send a signal when canvas transitioning to
pause mode.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiImmersiveCanvasSupport{
confirmationMessageSupported: boolean() | nil,
pauseSignalSupported: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiJwnCapabilitie
s
These capabilities are used to determine the jwn libraries and their
versions that are present on the client.

Attributes

librariesVersionMap(type: map(), default: nil) - The name

and version of the jwn libraries currently stored on the client. These
are the same that the server communicated when the library was
first sent down.
supportedCompressionMode (type: list(String.t), default:
nil) - Compression algorithms supported on the client. Server can
choose one of these to compress WhatsNext Javascript programs
and libraries.
supportsJwn (type: boolean(), default: nil) - Whether the client
supports running jwn code.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiJwnCapabilities{

librariesVersionMap: map() | nil,

supportedCompressionMode: [String.t()] | nil,

supportsJwn: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
Capabilities
Capabilities related to Lens Perception, i.e. image understanding. See
go/loa-lens-device-capabilities. Next ID: 6

Attributes

hasLensPerception (type: boolean(), default: nil) - Whether

the device supports Lens Perception.
isLensDirectIntentAvailable (type: boolean(), default: nil) -
Indicates whether Lens supports Lens Direct Intent
(go/lensdirectintent).
isLensLiveViewfinderAvailable (type: boolean(), default:
nil) - Indicates whether Lens supports Live view-finder
experience.
isLensPostCaptureAvailable (type: boolean(), default: nil) -
Indicates whether Lens supports Post-capture experience with an
image payload.
lensCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
default: nil) -
eptionCapabilitiesLensCapabilities.t,
Contains the capabilities that Lens can support.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilities{

hasLensPerception: boolean() | nil,

isLensDirectIntentAvailable: boolean() | nil,
isLensLiveViewfinderAvailable: boolean() | nil,

isLensPostCaptureAvailable: boolean() | nil,

lensCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap

abilities.t()
| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilities
The set of capabilities that Lens can support. This is the Assistant proto
representation of Lens capabilities defined at
j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.pr
oto Next ID: 7

Attributes

dining (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
default: nil) -
eptionCapabilitiesLensCapabilitiesDining.t,
The presence of this message means that Dining is supported.
education (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
eptionCapabilitiesLensCapabilitiesEducation.t, default:
nil) - The presence of this message means that Education is
supported.
outdoor (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
default: nil)
eptionCapabilitiesLensCapabilitiesOutdoor.t,
- The presence of this message means that Outdoor is supported.
shopping (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
default: nil)
eptionCapabilitiesLensCapabilitiesShopping.t,
- The presence of this message means that Shopping is supported.
text (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
eptionCapabilitiesLensCapabilitiesText.t, default: nil) -
 The presence of this message means that intenting directly into the
text filter is supported.
translate (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerc
eptionCapabilitiesLensCapabilitiesTranslate.t, default:
nil) - The presence of this message means that Translation is
supported.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa
pabilities{
 dining:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap
abilitiesDining.t()
| nil,

education:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap

abilitiesEducation.t()
| nil,
outdoor:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap
abilitiesOutdoor.t()
| nil,
shopping:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap
abilitiesShopping.t()

| nil,
text:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap

abilitiesText.t()
| nil,
translate:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCap
abilitiesTranslate.t()
| nil

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilitiesDining
Dining recognition capability. For example popular dishes on a given
restaurant menu image.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa

pabilitiesDining{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilitiesEduca
tion
Education recognition capability.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa

pabilitiesEducation{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilitiesOutdo
or
Outdoor place recognition capability. For example recognizing
storefronts.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa

pabilitiesOutdoor{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilitiesShopp
ing
Shopping recognition capability.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa
pabilitiesShopping{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilitiesText
Text recognition capability.

Attributes

(type: boolean(), default: nil) -

isTextToSpeechSupported
Indicates whether text-to-speech is supported.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa
pabilitiesText{
isTextToSpeechSupported: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLensPerception
CapabilitiesLensCapabilitiesTransl
ate
Translation capability.

Attributes

supportedLanguageTags (type: list(String.t), default: nil) -

The list of language IETF BCP 47 tags that are supported. See the
full details in the comment on the equivalent field in:
http://google3/java/com/google/android/apps/gsa/search/shared/serv
ice/proto/lens_service_event.proto;l=55;rcl=355512559

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCa
pabilitiesTranslate{

supportedLanguageTags: [String.t()] | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLiveTvChannel
Capabilities
Attributes

channelsByProvider (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiv
default: nil)
eTvChannelCapabilitiesChannelsByProvider.t),
- A list of channel providers each of which provides a list of its
channels.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilities{
channelsByProvider:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesChannels
ByProvider.t()
]

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLiveTvChannel
CapabilitiesChannelsByProvider
Attributes

channels (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiv
eTvChannelCapabilitiesLiveTvChannel.t), default: nil) - A
list of channels provided by this input. Keep the performance
impact in mind when the number/size of the channels is large.
When there are too many channels, consider stripping out some
data.
inputId (type: String.t, default: nil) - An identifier to identify
the input source. For example for TIF based channels, this will be
the TIF input ID to differentiate different tuner apps. See
https://source.android.com/devices/tv
providerType (type: String.t, default: nil) - Type of provider
who provides this channel input.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesChannel
sByProvider{

channels:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesLiveTvCh
annel.t()
]
| nil,

inputId: String.t() | nil,

providerType: String.t() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLiveTvChannel
CapabilitiesLiveTvChannel
Attributes

channelId (type: String.t, default: nil) - Unique channel

identifier.
channelName (type: list(String.t), default: nil) - A list of
channel names and synonyms.
channelNumber (type: String.t, default: nil) - Channel number
displayed to user. Optional.
deeplink (type: String.t, default: nil) - A deep link into the
Live player app that tunes to this channel.
mid (type: String.t, default: nil) - KG mid of the channel if it
exists in KG.
networkMid (type: String.t, default: nil) - Network KG mid of
the channel if it exists in KG

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesLiveTvC
hannel{
channelId: String.t() | nil,

channelName: [String.t()] | nil,

channelNumber: String.t() | nil,
deeplink: String.t() | nil,

mid: String.t() | nil,

networkMid: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLiveTvProvider
Attributes

providerInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sProvider.t,default: nil) - Contains detailed provider
information such as android app package name.
providerKey (type: String.t, default: nil) - A provider enum
string for OTT providers. The available key can be found in
go/ump-provider-enum For Tuner provider, the provider key would
be an ID the tuner app uploaded from TIF. See
https://source.android.com/devices/tv
providerType (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvProvider{

providerInfo:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider.t() | nil,

providerKey: String.t() | nil,

providerType: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLocationCapab
ilities
Attributes

gpsAvailable (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiLocationCapabilities{
gpsAvailable: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiLoggingOnlyDa
ta
Data which is produced for logging and debugging. Servers MUST NOT
use this for any other purposes, such as branching on it. Next ID: 16

Attributes

acpVersion (type: String.t, default: nil) - A user-readable

string describing the ACP version (go/acp-version) of the client app
used by the user to originate the conversation.
androidId (type: String.t, default: nil) - Random identifier
assigned to Android mobile devices. Older logs may have
previously stored other kinds of android IDs in this field, but all
current logs should use the GServices Id. See go/androidids.
appVersion (type: String.t, default: nil) - A user-readable
string describing the version of the client app used by the user to
originate the conversation.
assistantSettingsSource (type: String.t, default: nil) - An
enum specifying when was this ATV AssistantSettings entry
initially created.
boardName (type: String.t, default: nil) - The type of board
used by manufacturer for this device
boardRevision (type: String.t, default: nil) - The revision of
board used
castAssistantSettingLinkingResult (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastAssi
default: nil) - This field records
stantSettingLinkingResult.t,
the linking status between Assistant setting entry and Cast setting
 entry. Currently only ATV surface populates this field for profiling
purpose.
deviceModel (type: String.t, default: nil) - A user-readable
string describing the device's hardware platform.
embedderBuildInfo (type: String.t, default: nil) - Any
relevant info concerning the build options of the embedder (that is
the software which runs as the 'driver' of an Assistant library, such
as libassistant. the embedder is typically built by a third party)
initialAppVersion (type: String.t, default: nil) - A string
recording the app version that is initially used to created this
settings entry.
isPrimaryUser (type: boolean(), default: nil) - Boolean field to
indicate whether a certain user is the primary user of a device or
not. This is useful for distinguishing the user0 from other users
given user0 might have certain privileges (Eg: Hubmode on
Tangor)
mdnsDisplayName (type: String.t, default: nil) - default display
name of device over mdns. This is specified at the factory, not
specified by the user.
platformBuild (type: String.t, default: nil) - A user-readable
string describing the device's software platform.
virtualReleaseChannel (type: String.t, default: nil) - A
string describing device's release channel. For cast devices, the
string will look like "qa-beta-channel", "eng-no-update", etc.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiLoggingOnlyData{

acpVersion: String.t() | nil,
androidId: String.t() | nil,
appVersion: String.t() | nil,

assistantSettingsSource: String.t() | nil,

boardName: String.t() | nil,
boardRevision: String.t() | nil,

castAssistantSettingLinkingResult:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastAssistantSettingLinkingResult

.t()
| nil,
deviceModel: String.t() | nil,
embedderBuildInfo: String.t() | nil,

initialAppVersion: String.t() | nil,

isPrimaryUser: boolean() | nil,
mdnsDisplayName: String.t() | nil,
platformBuild: String.t() | nil,

virtualReleaseChannel: String.t() | nil

}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiMediaControlS
upport
Attributes

skipConfirmationsWhilePlaying (type: boolean(), default:

nil) - Whether to prevent confirmations (text, tts) for
media
control actions while media is playing so that the media session is
not interrupted.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiMediaControlSupport{
skipConfirmationsWhilePlaying: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiMessageCapabi
lities
Attributes

fallbackToTetheredDeviceAppCapabilities (type: boolean(),

default: nil) - If true, APP_ID queries initiated by this device
should fall back to execution on the tethered device if it's available
and if the primary device cannot perform the action (e.g. due to the
app not being installed).
preferTargetingPrimaryDevice (type: boolean(), default: nil)
- For chat_message.SEND targeting, when either the primary or
secondary (tethered) device is capable of handling the
chat_message.SEND action, prefer targeting it to the primary
device.
supportedRecipientTypes (type: list(String.t), default: nil)
- Should only be checked if nonempty.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageCapabilities{

fallbackToTetheredDeviceAppCapabilities: boolean() | nil,

preferTargetingPrimaryDevice: boolean() | nil,
supportedRecipientTypes: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiMessageSumm
arySupport
LINT.IfChange(messageSummarySupport)

Attributes

deviceSettingStatus(type: String.t, default: nil) - The

current setting status of message summary on current device.
lastVoiceOptInFlowTimestamp (type: DateTime.t, default: nil)
- Last time that voice opt-in flow has been triggered.
readNotificationSummarizationSupported (type: boolean(),
default: nil) - Whether the client supports message
summarization.
voiceOptInFlowCounter (type: integer(), default: nil) - The
voice consent flow counter on current device.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageSummarySupport{
deviceSettingStatus: String.t() | nil,

lastVoiceOptInFlowTimestamp: DateTime.t() | nil,

readNotificationSummarizationSupported: boolean() | nil,
voiceOptInFlowCounter: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiMovementCapa
bilities
Attributes

mobility(type: String.t, default: nil) - Indicates how much

the device moves around. E.g., TV has a low mobility level, while
Auto has a very high level.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiMovementCapabilities{
mobility: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiNotificationOut
putRestrictions
Attributes

optOutState (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotifica
tionOutputRestrictionsOptOutState.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictions{

optOutState:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOpt
OutState.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiNotificationOut
putRestrictionsOptOutState
Per category/category group notification opt out settings.

Attributes

categoryGroupState (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiNot
ificationOutputRestrictionsOptOutStateCategoryGroupState
default: nil) -
.t),
categoryState (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiNot
ificationOutputRestrictionsOptOutStateCategoryState.t),
default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOp
tOutState{

categoryGroupState:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOpt

OutStateCategoryGroupState.t()
]
| nil,

categoryState:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOpt

OutStateCategoryState.t()
]
| nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiNotificationOut
putRestrictionsOptOutStateCatego
ryGroupState
Attributes

categoryGroup (type: String.t, default: nil) -

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOp
tOutStateCategoryGroupState{
categoryGroup: String.t() | nil,

state: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiNotificationOut
putRestrictionsOptOutStateCatego
ryState
Attributes

category (type: String.t, default: nil) -

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOp
tOutStateCategoryState{

category: String.t() | nil,

state: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiOemCapabilitie
s
Encapsulates the action capabilities of the OEM device. This data is
merged from Device Model lookup, per-device registration, and per-
request context. This data is sent to NLU layer for query understanding.

Attributes

cloudCapability (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoCloudCapability.t, default: nil) - The OEM Cloud
execution capability of this device, containing routing details for
cloud fulfillment.
cloudDeviceCapabilities (type: map(), default: nil) - If
fulfillment is done via 3P cloud and 3P supports device capabilities,
this field will be set.
deviceModelId (type: String.t, default: nil) - Device Model Id
from DeviceModelPackage.
deviceModelRevisionId (type: String.t, default: nil) - Device
Model Revision Id from DeviceModelPackage.
deviceSpecificData (type: String.t, default: nil) - Opaque
supported action data related to a specific domain of devices, for
example for car. go/car-talk-registration-model
internalCapability (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Internal-only
formProtoInternalCapability.t,
config containing metadata about the Device Model, for example to
control the ranking behavior.
 thirdPartyActionConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPar
default: nil) - 3P Action Metadata, populated
tyActionConfig.t,
from the Device Model lookup and the client request parameters.
For example, an Assistant SDK request would have the billed
project id of the Assistant request added here in order to enable any
Device Actions developed using the same Google Cloud project.
This data is sent to Service Engine to mask triggering for Device
Actions.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiOemCapabilities{

cloudCapability:
 GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudCapability.

t()
| nil,
cloudDeviceCapabilities: map() | nil,
deviceModelId: String.t() | nil,

deviceModelRevisionId: String.t() | nil,

deviceSpecificData: String.t() | nil,
internalCapability:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInternalCapabili
ty.t()
| nil,

thirdPartyActionConfig:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyActionConfig.t()
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiOnDeviceAssist
antCapabilities
Definitions of on-device assistant capabilities.

Attributes

isLocalNetworkArbitrationSupported (type: boolean(),

default: nil) - Capabilities related to local network arbitration
(go/local-network-arbitration). Indicates if the device is capable of
being a host device in the LAN whiling doing local network
arbitration.
isOnDeviceArbitrationSupported (type: boolean(), default:
nil) - Capabilities related to on-device arbitration(go/arbitration-
on-device).
isOnDeviceAssistantSupported (type: boolean(), default: nil)
- Indicates if on-device assistant is enabled on this device. Example
usecases: NGA (go/nga) or Marble (go/marble).
isOnDeviceUnderstandingSupported (type: boolean(), default:
nil) - This may be used by NGA. E.g. if understanding happens on
device, we can have more aggressive logic when fulfilling some
features on the server side, like teleport.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceAssistantCapabilities{

isLocalNetworkArbitrationSupported: boolean() | nil,

isOnDeviceArbitrationSupported: boolean() | nil,
isOnDeviceAssistantSupported: boolean() | nil,
isOnDeviceUnderstandingSupported: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiOnDeviceSmart
HomeCapabilities
Definitions of on-device Smart Home capabilities. Next ID: 2

Attributes

(type: boolean(), default: nil)

isOnDeviceSmartHomeSupported
- Master bit for on-device Smart Home features.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceSmartHomeCapabilities{
isOnDeviceSmartHomeSupported: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiOnDeviceStora
geCapabilities
The on-device storage capabilities found on the device.

Attributes

(type: boolean(), default: nil) - Determines if an

isSupported
on-device storage is supported.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceStorageCapabilities{

isSupported: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiOutputRestricti
ons
These are user configurable permissions representing what the device is
allowed to output. Next ID: 11

Attributes

googlePhotoContent(type: String.t, default: nil) - The type

of Google Photo content which the device can output.
guestAccessOutput (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGuestAcc
essOutput.t,default: nil) - Access settings for guests.
personalData (type: String.t, default: nil) - The level of
personal data which the device can output. See go/personal-readout
for detail.
proactiveNotificationOutput (type: String.t, default: nil) -
This controls if the server can proactively send notification to users,
and it does not affect scenarios that users ask for information. The
notification may include TTS and lights. It could be only lights for
chirp.
proactiveOutput (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiProactiv
eOutput.t,default: nil) - Restrictions on displaying and
interacting with content on proactive surfaces (e.g. Dragonglass
home screen). Note: NEVER access this field of OutputRestrictions
directly, use the code in
assistant/assistant_server/settings/device/device_settings_util.h
instead.
 youtubeAutoplayRestriction(type: String.t, default: nil) -
Whether YouTube autoplay is allowed for queries from the user to
this device. See go/assistant-youtube-settings for details.
youtubeContent (type: String.t, default: nil) - The type of
YouTube content which the device can output.
youtubeTvContent (type: String.t, default: nil) - The type of
YouTube TV content which the device can output.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiOutputRestrictions{

googlePhotoContent: String.t() | nil,
guestAccessOutput:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGuestAccessOutput.t() | nil,

personalData: String.t() | nil,

 proactiveNotificationOutput: String.t() | nil,
proactiveOutput:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiProactiveOutput.t() | nil,
youtubeAutoplayRestriction: String.t() | nil,

youtubeContent: String.t() | nil,

youtubeTvContent: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiProactiveOutpu
t
Next ID: 7

Attributes

allowAllPersonalData (type: boolean(), default: nil) - Allows

displaying all personal data on proactive surfaces with no face
match capability.
androidTvAssistantSettingsSource (type: String.t, default:
nil) - For ANDROID_TV devices, the location that this setting
was last changed from. Note: this structure allows to extend to more
per-vertical bits in the future.
healthAndFitnessProactive (type: String.t, default: nil) -
Allows displaying Health and Fitness content on proactive surfaces.
This is a sub bit of the device-wide PR bit - the device-wide PR bit
must be enabled AND this vertical sub bit must be enabled for H&F
content to be shown. This bit will be available on all surfaces that
have the proactive-bit enabled. If the proactive-bit is not enabled,
then we do not show health and fitness content at all (or even allow
access to this setting).
photosProactive (type: String.t, default: nil) - Allows
displaying photos content on Dragonglass proactive surfaces. This
is a sub bit of the device-wide PR bit - the device-wide PR bit must
be enabled AND this vertical sub bit must be enabled for photos
content to be shown on Dragonglass surfaces. This bit will be
available on all Dragonglass surfaces that have the proactive-bit
enabled. If the proactive-bit is not enabled or it's not a Dragonglass
surface, then we do not show proactive photos content at all, nor
 allow access to this setting. See go/opa-photos-sg-settings for more
details.
userMatchProactive (type: String.t, default: nil) - Settings
for displaying personal data on proactive surfaces with face match
capability.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiProactiveOutput{

allowAllPersonalData: boolean() | nil,

androidTvAssistantSettingsSource: String.t() | nil,

healthAndFitnessProactive: String.t() | nil,
photosProactive: String.t() | nil,
userMatchProactive: String.t() | nil

}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiProtobuf
Also known as "Extensions Without Extensions" or "The Poor Man's
Any", this simple proto is used to transmit arbitrary protocol buffers over
the wire. Unlike extensions: - It does not require the proto type to be
compiled into the binary. (Useful so that the proto declaration can be
inside the conversation package) - It is compatible with all versions of
proto, including proto3 and the wack-tastic version used on
ChromecastOS. Server libraries for dealing with it live in
google3/assistant/protocol/protobuf_lib.h.

Attributes

protobufData (type: String.t, default: nil) - The serialized

protocol buffer.
protobufType (type: String.t, default: nil) - The type of the
protocol buffer to use. This must be a resolvable name
(Namespace.ProtoName) and refer to a proto which is either
compiled in to both client and server (e.g. a base proto type) or to
one which is part of the conversation package.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiProtobuf{

protobufData: String.t() | nil,

protobufType: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRecurrence
Date-based recurrences specify repeating events. Conceptually, a
recurrence is a (possibly unbounded) sequence of dates on which an
event falls, described by a list of constraints. A date is in a recurrence if
and only if it satisfies all of the constraints. Note that devices may
support some constraints, but not all.

Attributes

begin (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t,
default: nil) - The first day of the recurrence. If begin is not set,
then the reminder will start infinitely in the past.
blacklistedRanges (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiDat
eTimeRange.t), default: nil) - A list of blacklisted dates to skip
the alarm on.
dayOfMonth (type: list(integer()), default: nil) - Specifies
the date in a month. For example, if day_of_month is 15, then it
represent the 15th day of the specified month.
dayOfWeek (type: list(integer()), default: nil) - Specifies a
weekly or daily recurrence. Constraint: The date falls on one of
these days of the week, in 0...6 (Sunday...Saturday).
end (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t,
default: nil) - The last day of the recurrence.
every (type: integer(), default: nil) - Multiplier on the
frequency of the recurrence. Use this to specify patterns that recur
every X days, months, years, etc. Example: [remind me to call mom
every 2nd week]. Default is 1 (every day, every month, every year).
 monthOfYear (type: list(integer()), default: nil) - Specifies
the month in a year. Constrain: the month falls on one of these
months, in 1, 2, ... 12 (January...December).
numOccurrences (type: integer(), default: nil) - The number of
occurrences after which the recurrence should end.
weekOfMonth (type: list(integer()), default: nil) - Specifies
the index of week in a month. For example, the second Tuesday
every month, in this case, week_of_month should be 2.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiRecurrence{

begin: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t() | nil,

blacklistedRanges:
[GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTimeRange.t()] | nil,
 dayOfMonth: [integer()] | nil,
dayOfWeek: [integer()] | nil,

end: GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate.t() | nil,

every: integer() | nil,
monthOfYear: [integer()] | nil,

numOccurrences: integer() | nil,

weekOfMonth: [integer()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRobinCapabilit
ies
Used to describe the capabilities and params of Robin Client. Field will
be populated from Client or backfilled in SAL only for Robin client.

Attributes

enabledExtensions (type: list(String.t), default: nil) - List

of enabled Robin extensions.
robinStatus (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCap
default: nil) -
abilitiesRobinStatus.t,
supportedRobinOps (type: list(String.t), default: nil) - List
of supported RobinOps.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilities{

enabledExtensions: [String.t()] | nil,

robinStatus:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatus.t()
| nil,
supportedRobinOps: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRobinCapabilit
iesRobinStatus
Current Robin status of the client.

Attributes

available (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCap
abilitiesRobinStatusRobinStatusAvailable.t, default: nil) -
notAvailable (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCap
abilitiesRobinStatusRobinStatusNotAvailable.t, default:
nil) -
optedIn (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCap
abilitiesRobinStatusRobinStatusOptedIn.t, default: nil) -
optedOut (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCap
abilitiesRobinStatusRobinStatusOptedOut.t, default: nil) -

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatus{
available:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobin
StatusAvailable.t()
| nil,

notAvailable:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobin

StatusNotAvailable.t()
| nil,
optedIn:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobin
StatusOptedIn.t()
| nil,

optedOut:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobin

StatusOptedOut.t()
 | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRobinCapabilit
iesRobinStatusRobinStatusAvailabl
e
Robin is available and can be enabled by the user.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobi
nStatusAvailable{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRobinCapabilit
iesRobinStatusRobinStatusNotAvai
lable
Robin is not available and can not be enabled by the user.

Attributes

reasons (type: list(integer()), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobi
nStatusNotAvailable{
reasons: [integer()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRobinCapabilit
iesRobinStatusRobinStatusOptedI
n
Robin is available and the user opted in already.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobi
nStatusOptedIn{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiRobinCapabilit
iesRobinStatusRobinStatusOptedO
ut
Robin would be available, but the user explicitly opted out.

Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobi
nStatusOptedOut{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiScreenCapabili
ties
These capabilities represent the tactile features associated with the
device. This includes, for example, whether the device has a screen, how
big the screen is, and privacy of the screen. Next ID: 11

Attributes

(type: number(), default: nil) - The scale

fontScaleFactor
factor used to convert Scalable Pixel (SP) units to Density-
independent Pixel (DP) units (DP = SP * scale factor). Fonts are
measured in units of SP, and on some platforms such as Android the
SP to DP scale factor can be affected by the font size a user selects
in accessibility settings.
inputType (type: list(String.t), default: nil) - The types of
input that this screen supports. Note that this can be empty in which
case the screen's input type is unknown.
mask (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCa
pabilitiesMask.t, default: nil) - Mask defined for this device, if
any.
protoLayoutTargetedSchema (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCa
default: nil) - The targeted
pabilitiesProtoLayoutVersion.t,
schema version for ProtoLayout requests.
resolution (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCa
default: nil) - If this field is absent,
pabilitiesResolution.t,
the resolution of the screen is unknown.
 screenOff (type: boolean(), default: nil) - If screen is turned
off.
screenStateDetection(type: String.t, default: nil) - The
ability of the client to correctly report screen state.
supportedRenderingFormat (type: String.t, default: nil) - The
primary supported rendering format for display on the device's
screen. This may be used to determine what format of card to be
returned when rendering cards.
supportedScreenStates (type: list(String.t), default: nil) -
The screen states that the client supports. The current screen state is
specified in DeviceProperties.screen.
visionHelpEnabled (type: boolean(), default: nil) - Whether
the device enabled vision help features in accessibility settings. The
settings is config in Assistant App and on-device settings, and
stored in footprints. When enabled, font, color and TTS will be
adjusted.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilities{

fontScaleFactor: number() | nil,
inputType: [String.t()] | nil,

mask:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesMask.t()
| nil,

protoLayoutTargetedSchema:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesProtoLayoutVers

ion.t()
| nil,
resolution:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesResolution.t()
| nil,
screenOff: boolean() | nil,
screenStateDetection: String.t() | nil,

supportedRenderingFormat: String.t() | nil,

supportedScreenStates: [String.t()] | nil,
visionHelpEnabled: boolean() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiScreenCapabili
tiesMask
A mask applied to the screen's pixel space to determine regions not
visible on the physical device.

Attributes

type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesMask{

type: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiScreenCapabili
tiesProtoLayoutVersion
Version info for ProtoLayout requests.

Attributes

major (type: integer(), default: nil) -

minor (type: integer(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesProtoLayoutVer
sion{
major: integer() | nil,
minor: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiScreenCapabili
tiesResolution
A Resolution proto indicates the size of the application window. All
fields are required.

Attributes

dpi (type: integer(), default: nil) - Dots (pixels) per inch of the
screen.
heightPx (type: integer(), default: nil) -
mSize (type: integer(), default: nil) - m_size is the smallest
square box size to display a capital letter M so that the user can still
easily understand it.
nengSize (type: integer(), default: nil) - neng_size is the
smallest square box size to display a letter 螚 (Neng, U+879A) so
that the user can easily understand it. (Neng is a visually dense
Chinese letter, and so may require a larger box than an M.)
widthPx (type: integer(), default: nil) - The dimensions of the
application window, in pixels.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesResolution{
dpi: integer() | nil,
heightPx: integer() | nil,
mSize: integer() | nil,
nengSize: integer() | nil,
widthPx: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSelinaCapabilit
es
The Soli capabilities on Elaine, including gestures and sleep sensing.
go/dingo-dc-software Next ID: 4

Attributes

gestureCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGestureC
apabilities.t, default: nil) - A list of gestures that selina
supports
selinaSupported(type: boolean(), default: nil) - Whether the
client supports selina.
sleepSensingSupported (type: boolean(), default: nil) -
Whether the client can monitor sleep. This allows us to show sleep
CUJ related information: go/TwilightDesign

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSelinaCapabilites{

gestureCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGestureCapabilities.t()
| nil,
selinaSupported: boolean() | nil,

sleepSensingSupported: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsAmbien
tSettings
Attributes

anyUserHasSetPersonalPhotos (type: boolean(), default: nil) -

Whether any user sets personal photos on this device. See
go/ambient-setting-in-assistant-design.
recentHighlightsEnabled (type: boolean(), default: nil) -
Whether or not the user's current selection for their ambient photo
frame includes the auto-generated "Recent Highlights" album. This
is used to determine which users to display the go/opa-photos-
memories-tile. See go/opa-photo-memories-imax-optin for more
discussion on why this bit was created.
showPersonalPhotoData (type: boolean(), default: nil) -
Whether to enable the personal photo data in the ambient settings:
https://screenshot.googleplex.com/Wd4OFkQfOyF See go/opa-
photos-ambient-location-date-dd#heading=h.5x4iaouuiett for
explanation.
showPersonalPhotos (type: boolean(), default: nil) - Whether
current user sets personal photos on this device. See go/ambient-
setting-in-assistant-design.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAmbientSettings{

anyUserHasSetPersonalPhotos: boolean() | nil,

recentHighlightsEnabled: boolean() | nil,
showPersonalPhotoData: boolean() | nil,
showPersonalPhotos: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsAppCa
pabilities
These capabilities are associated with Assistant Settings on devices.

Attributes

carSettingsCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarSetti
default: nil) - Capabilities that are
ngsCapabilities.t,
associated with Assistant Settings on auto surfaces.
reissueQueryAfterMusicSetup (type: boolean(), default: nil) -
Whether the client supports reissuing query after setting up in
Music Settings.
supportsPaymentsSettingsUpdate (type: boolean(), default:
nil) - Whether the client supports updating payments setting.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAppCapabilities{
carSettingsCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarSettingsCapabilities.t()

| nil,
reissueQueryAfterMusicSetup: boolean() | nil,
supportsPaymentsSettingsUpdate: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsAutoFr
amingSettings
Settings pertaining to auto framing. See go/auto-framing-presentation.

Attributes

isAutoFramingEnabled (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAutoFramingSettings{
isAutoFramingEnabled: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsCarrier
CallDeviceSettings
Carrier related call settings on the device.

Attributes

allowIncomingCalls (type: boolean(), default: nil) - Whether

this device is allowed to receive incoming PSTN calls.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCarrierCallDeviceSetting

s{
allowIncomingCalls: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsCommu
nicationsFilter
Specification of which communication features can be used.

Attributes

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCommunicationsFilter{
state: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDevice
DowntimeSettings
Specification of times when most features on a device are disabled for
certain users. During these periods, the device will respond to most
interactions with something like "sorry, I'm sleeping right now". Design:
go/home-ft-settings-storage PRD: go/home-family-tools-prd

Attributes

schedules (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSet
tingsLabeledDowntimeSchedule.t), default: nil) -
targets (type: list(String.t), default: nil) - The set of users
of this device that will have these downtime settings applied. Must
have at least one element.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceDowntimeSettings{

schedules:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLabeledDowntimeSchedule.t
()
]
| nil,

targets: [String.t()] | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDeviceF
eatureFilters
Defines a set of restrictions on particular device features for a certain set
of users. Design: go/home-ft-settings-storage PRD: go/home-family-
tools-prd

Attributes

enabled (type: boolean(), default: nil) - Enables/disables all the

filters at the same time. For new devices or non-Cast devices this is
always false.
featureFilters (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
FeatureFilters.t,default: nil) - The filters (feature restrictions)
to apply when enabled is true.
targets (type: list(String.t), default: nil) - The set of users
of this device that will have these settings applied. Must have at
least one element.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceFeatureFilters{
enabled: boolean() | nil,
featureFilters:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsFeatureFilters.t()

| nil,
targets: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDevice
LogsOptIn
Attributes

(type: boolean(), default: nil) - Indicates

optInEnabled
whether the crash logs can be uploaded and the device logs can be
enabled

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceLogsOptIn{

optInEnabled: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDeviceS
ettings
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.AssistantApiSet
tingsLinkedUser.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.AssistantApiSettings
default: nil) - The additional
InternalAncillaryDeviceId.t,
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.AssistantApiSettings
SpeechSettings.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.AssistantApiSettings
DeviceSupervisionSettings.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.AssistantApiSettings
HomeGraphData.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
default: nil) - The feature proto of the location of the device.
.t,
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.AssistantApiCoreType
 default: nil) - The identification of the default
sDeviceId.t,
device which user want to output audio. See go/default-media-
output-design for more info.
speechOutputSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
SpeechOutputSettings.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.AssistantApiSettings
MarketplaceDisclosure.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.AssistantApiCor
eTypesDeviceId.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.AssistantApiCoreType
default: nil) - The identification of the device.
sDeviceId.t,
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.AssistantApiCoreType
sLocationCoordinates.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.AssistantApiSettings
default: nil) - Specify whether polite mode is
PoliteMode.t,
enabled for this device. See go/pretty-please-dd.
hotwordThresholdAdjustmentFactor (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
HotwordThresholdAdjustmentFactor.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.AssistantApiSettings
default: nil) - Auto framing settings
AutoFramingSettings.t,
associated with a device. See go/auto-framing-presentation.
onDeviceAppSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
OnDeviceAppSettings.t, default: nil) - Device specific app
related settings.
kidsMode (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
KidsMode.t, default: nil) - Specifies if kids-mode is enabled for
the device. See go/aff-parentalsupervision-dd.
gcmSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
GcmSettings.t, default: nil) - Stores GCM info associated with a
device. See go/quartz-design-doc for more info.
tetheredInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) - Presence indicates a tethered
TetheredInfo.t,
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.AssistantApiSettings
default: nil) - Trusted device
ReauthTrustedDeviceSettings.t,
preferences Assistant reauth. go/assistant-reauth-verify-skip.
ambientSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
AmbientSettings.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.AssistantApiSettings
default: nil) - Indicates whether the device
HospitalityMode.t,
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.AssistantApiSettings
MasqueradeMode.t, default: nil) -
personalizationMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) - Metadata about how
PersonalizationMetadata.t,
personalization settings were configured.
defaultVideoDeviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sDeviceId.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.AssistantApiSettings
DeviceLogsOptIn.t, default: nil) - Specifies if device logs and
crashes can be captured during SendFeedback
surfaceType (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sSurfaceType.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_set
tings_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.AssistantApiSettings
NotificationProfile.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/p
ostaladdress.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/addressfo
rmatter/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_co
nfig.proto. go/cast-last-registration-time
crossSurfaceAvailability (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) -
DeviceSettingsCrossSurfaceAvailability.t,
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.AssistantApiSettings
default: nil) - Internal version of the
InternalVersion.t,
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.AssistantApiDeviceCa
default: nil) - Describes roughly what a device is
pabilities.t,
capable of doing and metadata around those capabilities. Note: this
includes device limitations as well as user configurable settings.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@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.AssistantApiSettingsDeviceSettingsCrossSurfac
eAvailability.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.AssistantApiSettingsHotwordThresholdAdjustmen
tFactor.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.AssistantApiSettingsReauthTrustedDeviceSettin

gs.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

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDeviceS
ettingsCrossSurfaceAvailability
Attributes

lastKnownClientLocale (type: String.t, default: nil) - Last

known locale of the client.
lastParamsWriteTimestamp (type: DateTime.t, default: nil) -
This is the timestamp when the AssistantRequestParams (in
ASSISTANT_SNAPSHOT corpus) were last written for this
device.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSettingsCrossSurfa
ceAvailability{
lastKnownClientLocale: String.t() | nil,

lastParamsWriteTimestamp: DateTime.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDeviceS
upervisionSettings
Attributes

downtimeSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) - Specification of times
DeviceDowntimeSettings.t,
that a device shouldn't respond to certain users. See go/home-ft-prd.
featureFilters (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) - Restrictions on features
DeviceFeatureFilters.t,
that certain users can access on a device. See go/home-ft-prd.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSupervisionSetting

s{
downtimeSettings:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceDowntimeSettings.t(

)
| nil,
featureFilters:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceFeatureFilters.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDownti
mePeriod
Specifies a period of up to 24 hours when downtime should be enabled,
starting at certain time on a certain day of the week, and ending at a later
time on either that day or the following day.

Attributes

enabled(type: boolean(), default: nil) - True if downtime

should be enabled during this period.
endTime (type:
GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeOfDay.
t, default: nil) - Time of day that this downtime period should
end. Required. If end_time > start_time, end_time is relative to
start_day. Otherwise, end_time is relative to the day after start_day.
For example, start_day: MONDAY, start_time: 9 p.m., end_time: 6
a.m. means that the downtime period starts at 9 p.m. on Monday
and ends at 6 a.m. on Tuesday.
startDay (type: String.t, default: nil) - The day of the week
when this downtime period starts. Required.
startTime (type:
GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeOfDay.
t,default: nil) - Time of day that this downtime period should
start. Required.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimePeriod{
enabled: boolean() | nil,

endTime: GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeOfDay.t() | nil,

startDay: String.t() | nil,
startTime: GoogleApi.ContentWarehouse.V1.Model.GoogleTypeTimeOfDay.t() | nil

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDownti
meSchedule
Specification of when downtime is enabled on different days of the
week. Contains up to 7 DowntimePeriod messages, up to one per day of
the week.

Attributes

enabled(type: boolean(), default: nil) - True if this downtime

schedule should be enabled.
periods (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSet
default: nil) - Downtime entries for
tingsDowntimePeriod.t),
the days of the week, in no particular order. There can be at most
one period defined for each day of the week. Days of the week with
no explicit period defined are treated as disabled, so the device is
available all day (modulo an end time that may spill over from the
previous day).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimeSchedule{
enabled: boolean() | nil,

periods:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimePeriod.t()

]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsDuoCal
lDeviceSettings
Duo related call settings on the device. Next ID: 5

Attributes

allowKnockKnock (type: boolean(), default: nil) - True if Duo

Knock Kncok feature is enabled on the device.
shouldBeLinked (type: boolean(), default: nil) - Boolean
indicating if user has explicitly marked this device to be linked or
not. This bit is used in case where unexpected errors occur and we
have to check for account/device status and mark the device linked
after verification.
state (type: String.t, default: nil) - The call state of the device
(i.e. whether a Duo call account has been setup on the device).
talkbackEnabled (type: boolean(), default: nil) - Client device
settings: settings which are populated by client to give to duocore.
TalkBack is an accessibility service that helps blind and vision-
impaired users interact with their devices. Indicates whether
talkback is enabled for the device. Note: this is per device settings
currently filled by client for all users.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDuoCallDeviceSettings{
allowKnockKnock: boolean() | nil,

shouldBeLinked: boolean() | nil,

state: String.t() | nil,

talkbackEnabled: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsFeature
Filters
Specification of which assistant features are allowed for a particular
device or user account.

Attributes

communicationsFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
CommunicationsFilter.t, default: nil) -
musicFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) -
MusicFilter.t,
newsFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
NewsFilter.t,default: nil) -
podcastFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
PodcastFilter.t,default: nil) -
searchFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) -
SearchFilter.t,
thirdPartyAppsFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
ThirdPartyAppsFilter.t, default: nil) -
videoFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
VideoFilter.t, default: nil) -
 webviewFilter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
WebviewFilter.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsFeatureFilters{
communicationsFilter:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCommunicationsFilter.t()
| nil,

musicFilter:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMusicFilter.t()
| nil,
 newsFilter:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNewsFilter.t() | nil,
podcastFilter:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPodcastFilter.t()
| nil,

searchFilter:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSearchFilter.t()
| nil,
thirdPartyAppsFilter:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsThirdPartyAppsFilter.t()

| nil,

videoFilter:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsVideoFilter.t()
| nil,
webviewFilter:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsWebviewFilter.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsGcmSet
tings
Attributes

gcmId(type: String.t, default: nil) -

gcmPackage (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsGcmSettings{
gcmId: String.t() | nil,

gcmPackage: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHomeG
raphData
Next ID: 8

Attributes

agentId (type: String.t, default: nil) - Agent ID, aka project

ID. Used as the AgentDeviceId.agent_id of device when calling
Home Graph Service.
attributes (type: map(), default: nil) - See go/ha-dev-guide
and HomeGraphItem.attribute in
//assistant/verticals/homeautomation/proto/home_graph.proto
deviceId (type: String.t, default: nil) - Device ID, used as
AgentDeviceId.device_id of device when calling Home Graph
Service.
deviceType (type: String.t, default: nil) - HGS device type.
See java/com/google/home/graph/service/config/protoconf.pi for
the exhaustive list of type strings.
shouldWriteToHomeGraph (type: boolean(), default: nil) -
Whether device data should be written to Home Graph via Assistant
device_settings. Assistant SDK and Google Home write their
devices into Home Graph through AssistantSettingsService, while
Home Automation Partner devices (e.g. SmartThings, Philips Hue,
Nest, TP-Link, etc.) don't need to be written to Home Graph
through AssistantSettingsService. This field decides whether
AssistantSettingsService writes devices to Home Graph or not.
supportedTraits (type: list(String.t), default: nil) -
Supported traits of the device. See
 java/com/google/home/graph/service/config/protoconf.pi for the
exhaustive list of trait-strings.
supportsDirectResponse (type: boolean(), default: nil) -
Whether the device supports direct response. See
HomeGraphItem.supports_direct_response in
//assistant/verticals/homeautomation/proto/home_graph.proto

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHomeGraphData{
agentId: String.t() | nil,
attributes: map() | nil,

deviceId: String.t() | nil,

deviceType: String.t() | nil,
 shouldWriteToHomeGraph: boolean() | nil,

supportedTraits: [String.t()] | nil,

supportsDirectResponse: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHospita
lityCardSettings
Attributes

cardConfig (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSet
tingsHospitalityCardSettingsCardConfig.t), default: nil) -
Config for Hospitality UI modules.
showMediaTapGestureTutorial (type: boolean(), default: nil) -
Toggle media tap gesture tutorial card.
showPhotoSwipeGestureTutorial (type: boolean(), default:
nil) - Toggle photo swipe gesture tutorial card.
youtubeCardConfig (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSet
tingsHospitalityCardSettingsYouTubeCardConfig.t), default:
nil) - Config for YouTube video cards.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettings{
cardConfig:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsCa

rdConfig.t()
]
| nil,
showMediaTapGestureTutorial: boolean() | nil,

showPhotoSwipeGestureTutorial: boolean() | nil,

youtubeCardConfig:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsYo
uTubeCardConfig.t()
]

| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHospita
lityCardSettingsCardConfig
Configuration for hospitality card.

Attributes

activeActionRequired (type: boolean(), default: nil) -

Whether the UI module requires user action. If true, the UI module
can peek on to the top of Ambient. See
SmartDisplayModuleState::ACTIVE_ACTION_REQUIRED.
dismissable (type: boolean(), default: nil) - Whether the UI
module is dismissable.
effectiveTime (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t,default: nil) - The time that the module is effective and
visible to the user. If not set, the module is effective immediately.
expiryTime (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t, default: nil) - The time that the module is expired and
invisible to the user. If not set, the module never expires.
imageUrl (type: String.t, default: nil) - The image URL for the
UI module.
moduleId (type: String.t, default: nil) - Module ID.
payloadQuery (type: String.t, default: nil) - Payload query to
the partner AoG action when user responds to UI Module, e.g. “Tell
the hotel how my stay is going”.
title (type: String.t, default: nil) - Title of the message to be
shown to user at the top of the UI Module.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsC

ardConfig{
activeActionRequired: boolean() | nil,
dismissable: boolean() | nil,
effectiveTime:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
expiryTime:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,

imageUrl: String.t() | nil,

moduleId: String.t() | nil,

payloadQuery: String.t() | nil,
 title: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHospita
lityCardSettingsYouTubeCardConf
ig
Configuration for YouTube video card (Stargazer tile).

Attributes

imageUrl (type: String.t, default: nil) - URL of image to go on

card. The URL must be a public link accessible from ZeroState.
playlistId (type: String.t, default: nil) - ID of YouTube
playlist to play on card tap. A playlist is used instead of a single
video id to avoid autoplaying related videos. The playlist and the
videos it contains must be public or unlisted to be accessible from
ZeroState.
text (type: String.t, default: nil) - Text on card (i.e., video
title).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsY
ouTubeCardConfig{
imageUrl: String.t() | nil,

playlistId: String.t() | nil,

text: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHospita
lityMode
Hospitality mode config for the current device. go/hospitality-mode-
design. Next ID: 17

Attributes

aogContextId(type: list(String.t), default: nil) - List of

AOG app context ids that are linked to this device. These apps will
have access to the structure information for the device.
aogInvocationPhrase (type: String.t, default: nil) -
Invocation phrase for hotel's AoG action. Used for ZS promotion
card and "talk to my hotel" rewrites. Setting this to an empty value
will mark it unset.
branding (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
HospitalityModeBranding.t, default: nil) -
cardSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) -
HospitalityCardSettings.t,
deviceClearRequest (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t, default: nil) - The time when we received a request to reset
the device.
dialogTtlOverrideMicros (type: String.t, default: nil) -
Should the dialog have a shorter ttl. See go/ipp-consumer-
prd#heading=h.ibu9b1ysdl4t and go/interpreter-device-
clear#bookmark=id.hw8ey1bzjadn for context.
enterpriseId(type: String.t, default: nil) - Identifier for the
enterprise which owns the device. Setting this to an empty value
will mark it unset.
hospitalityModeEnabled (type: boolean(), default: nil) -
Indicates whether this device is in the hospitality mode.
lastDeviceClear (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t,default: nil) - Last time the device was cleared and placed in
hospitality mode. Will be set when the switch is toggled on and
reset when a guest checks out. On the device this triggers removing
alarms, timers, etc.
lastModifiedTimestamp (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t,default: nil) - Indicates when hospitality settings were last
updated.
lastWelcomed (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t,default: nil) - Last time the welcome message was played for
the guest. If last_welcomed < welcome_request, the message should
be replayed and this time set.
manualResetRequired (type: boolean(), default: nil) - Indicates
whether or not the device must be reset manually (by voice or
touch), as opposed to being automatically reset. go/hospitality-
manual-reset
promotedLanguages (type: list(String.t), default: nil) - In
order promoted languages for interpreter devices. This represents
languages by BCP-47 language strings, such as "en", "en-US", "fr",
"fr-CA", "sr-Latn", "zh-Hans-CN", "zh-Hant-HK",etc.
type (type: String.t, default: nil) -
verbalResetSupported (type: boolean(), default: nil) -
Whether we allow users to initiate clearing the device verbally. We
generally allow this for private devices and not for public ones.
welcomeRequest (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
 default: nil) - The time when we received a request to
p.t,
welcome the user.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode{

aogContextId: [String.t()] | nil,

aogInvocationPhrase: String.t() | nil,
branding:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityModeBranding.t
()
| nil,

cardSettings:
 GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettings.t

()
| nil,
deviceClearRequest:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
dialogTtlOverrideMicros: String.t() | nil,
enterpriseId: String.t() | nil,

hospitalityModeEnabled: boolean() | nil,

lastDeviceClear:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
lastModifiedTimestamp:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,

lastWelcomed:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
manualResetRequired: boolean() | nil,

promotedLanguages: [String.t()] | nil,

type: String.t() | nil,
verbalResetSupported: boolean() | nil,
welcomeRequest:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHospita
lityModeBranding
TODO(b/169423976) Consider moving Branding out of user level
settings into enterprise level settings. Partner branding fields used to
customize the ui. Next ID: 7

Attributes

displayName (type: String.t, default: nil) - Brand display in

the UI
displayNameForLanguage (type: map(), default: nil) - Brand
display in the UI for languages that the enterprise has a localized
name that is different from its global branding name. For example,
Hilton is 'ヒルトン' in Japanese and '希爾頓' in Chinese. The keys
are hospitality supported display locales, e.g. en, ja-JP, etc, defined
in experiment parameter
Hospitality__hospitality_display_supported_locales.
largeLogoUrl (type: String.t, default: nil) -
smallLogoUrl (type: String.t, default: nil) -

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityModeBranding{
displayName: String.t() | nil,
displayNameForLanguage: map() | nil,

largeLogoUrl: String.t() | nil,

smallLogoUrl: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsHotwor
dThresholdAdjustmentFactor
HotwordThresholdAdjustmentFactor contains
threshold_adjustment_factor, and it's validity. value should only be
considered when is_valid = true.

Attributes

isValid (type: boolean(), default: nil) - Currently, is_valid is

set to false whenever the TAF is not an Autotune aware value. This
includes hotword sensitivity users, or devices not eligible for
autotune.
value (type: integer(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHotwordThresholdAdjustme
ntFactor{
isValid: boolean() | nil,
value: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsInterna
lAncillaryDeviceId
Represents supporting device ids.

Attributes

deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
default: nil) - Contains device ids known to
sDeviceId.t,
devices. eg. For ATV, it contains client_instance_id and cast_id.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalAncillaryDeviceI

d{
deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsInterna
lVersion
Represents a version of a specifit setting, e.g. DeviceSettings.

Attributes

generationTime (type: DateTime.t, default: nil) - Contains the

timestamp when this version was generated.
id (type: String.t, default: nil) - Integer value of the version, it
is a monotonically increasing number and starts at 0. On every
update it is incremented by 1.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalVersion{
generationTime: DateTime.t() | nil,
id: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsKidsMo
de
Kids mode config for the current device. go/aff-parentalsupervision-dd

Attributes

kidsModeEnabled (type: boolean(), default: nil) -

obfuscatedGaiaId (type: String.t, default: nil) - Identifier of
the account currently specified to be used with kids mode.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsKidsMode{

kidsModeEnabled: boolean() | nil,

obfuscatedGaiaId: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsLabeled
DowntimeSchedule
Attributes

displayName (type: String.t, default: nil) - User-provided

name for this schedule.
schedule (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
DowntimeSchedule.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLabeledDowntimeSchedule{
displayName: String.t() | nil,

schedule:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimeSchedule.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsLinked
User
Represents the profile of the user who has signed in onto this device.
Next id: 5

Attributes

castLinkingTime (type: DateTime.t, default: nil) - Time of

linking of the device with the user provided by Cast.
email (type: String.t, default: nil) - Primary email address of
the user.
gaiaId (type: String.t, default: nil) -
names (type:
list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExt
default: nil) - Supports features
ernalMergedpeopleapiName.t),
which depend on profile name, when no matching contact is found.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLinkedUser{

castLinkingTime: DateTime.t() | nil,

email: String.t() | nil,

gaiaId: String.t() | nil,
names:

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiName.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsMarket
placeDisclosure
Attributes

confirmed(type: boolean(), default: nil) - True if the user has

confirmed the marketplace disclosure.
timestampMs (type: String.t, default: nil) - The time user
confirmed the marketplace disclosure.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMarketplaceDisclosure{
confirmed: boolean() | nil,

timestampMs: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsMasque
radeMode
Guest mode for the current device. go/assistant-guest-mode-summary

Attributes

lastEnterGuestModeTimestamp (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t, default: nil) -
lastExitGuestModeTimestamp (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestam
p.t, default: nil) -
masqueradeModeEnabled (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMasqueradeMode{
lastEnterGuestModeTimestamp:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
lastExitGuestModeTimestamp:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp.t() | nil,
masqueradeModeEnabled: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsMusicF
ilter
Specification of which music features can be used.

Attributes

availableProviders (type: list(String.t), default: nil) -

Providers available at the time user updated settings.
providerFilterState (type: String.t, default: nil) -
Represents the state for the music provider filter.
state (type: String.t, default: nil) -
whitelistedProviders (type: list(String.t), default: nil) -
Contains the list of whitelisted music providers.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMusicFilter{

availableProviders: [String.t()] | nil,

providerFilterState: String.t() | nil,
state: String.t() | nil,
whitelistedProviders: [String.t()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsNewsFil
ter
Specification of which news features can be used.

Attributes

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNewsFilter{
state: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsNotifica
tionProfile
Attributes

alloNotificationProfile (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil)
NotificationProfileAlloNotificationProfile.t,
- Each device can have only one type of notification profile.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfile{
alloNotificationProfile:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfileAlloNo

tificationProfile.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsNotifica
tionProfileAlloNotificationProfile
Attributes

botSendToken (type:
GoogleApi.ContentWarehouse.V1.Model.ChatBotPlatformBotSe
ndToken.t, default: nil) - The send token of the conversation with
the user.
id (type:
GoogleApi.ContentWarehouse.V1.Model.ChatBotPlatformFireb
allId.t, default: nil) - The fireball id of this user.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfileAlloN
otificationProfile{
botSendToken:
GoogleApi.ContentWarehouse.V1.Model.ChatBotPlatformBotSendToken.t() | nil,

id: GoogleApi.ContentWarehouse.V1.Model.ChatBotPlatformFireballId.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsOnDevi
ceAppSettings
Attributes

carrierCallDeviceSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
CarrierCallDeviceSettings.t, default: nil) - On device carrier
call related settings.
duoCallDeviceSettings (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
DuoCallDeviceSettings.t, default: nil) - On device duo call
related settings.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsOnDeviceAppSettings{
carrierCallDeviceSettings:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCarrierCallDeviceSettings
.t()
| nil,
duoCallDeviceSettings:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDuoCallDeviceSettings.t()
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsPersona
lizationMetadata
Attributes

faceMatch (type: String.t, default: nil) -

personalResults (type: String.t, default: nil) -
voiceMatch (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPersonalizationMetadata{
faceMatch: String.t() | nil,

personalResults: String.t() | nil,

voiceMatch: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsPodcast
Filter
Specification of which podcast features can be used.

Attributes

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPodcastFilter{

state: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsPoliteM
ode
Polite mode config for the current device. go/polite-mode-dd

Attributes

politeModeEnabled (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPoliteMode{
politeModeEnabled: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsReauth
TrustedDeviceSettings
Settings related to Assistant reauth. go/assistant-reauth-verify-skip Next
id: 2

Attributes

trustSettingsForClient (type: %{optional(String.t) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil)
ReauthTrustedDeviceSettingsTrustSettings.t},
- Mapping from integrator client id to device's trust settings. Id
from
assistant/agent_platform/transactions/reauth/reauth_client.proto.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSetti

ngs{
trustSettingsForClient:
%{

optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSettin

gsTrustSettings.t()
}
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsReauth
TrustedDeviceSettingsTrustSettings
Next id: 6

Attributes

neverAskAgain (type: boolean(), default: nil) - If true, don't ask

user to trust this device again.
neverAskExpirationTimestamp (type: DateTime.t, default: nil)
- DEPRECATED: Use never_ask_again instead. Expiration
timestamp of "never ask again" status. If this field is set and is later
than current timestamp, we should NOT ask the user whether they'd
like to trust this device.
trustDeviceExpirationTimestamp (type: DateTime.t, default:
nil) - Expiration timestamp of "trusted" status. If this field is set
and is later than current timestamp, we can consider this device to
be trusted.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSetti
ngsTrustSettings{

neverAskAgain: boolean() | nil,

neverAskExpirationTimestamp: DateTime.t() | nil,
trustDeviceExpirationTimestamp: DateTime.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsSearch
Filter
Specification of which search features can be used.

Attributes

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSearchFilter{
state: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsSpeech
OutputSettings
Settings related to TTS output.

Attributes

speechOutput (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechOutputSettings{
speechOutput: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsSpeech
Settings
Settings related to speech detection. See go/hotword-settings-on-cloud
for more info. Next ID: 16

Attributes

continuedConversationEnabled (type: boolean(), default: nil)

- Indicates whether Continued Conversation is enabled for this
device.
deviceModelType (type: String.t, default: nil) - Stores the
device model type e.g Pixel.
dspAvailable (type: boolean(), default: nil) - Whether the
device has DSP chip to enable always on hotword detection.
hotwordInNavigationEnabled (type: String.t, default: nil) -
Whether hotword has been enabled by the user during navigation.
hotwordSetting (type: String.t, default: nil) - Stores hotword
setting status for the locales which don't support voice match.
lockscreenEnabled (type: boolean(), default: nil) - Whether
pin/pattern lockscreen has been enabled by the user.
opaEligibilityState (type: String.t, default: nil) - Stores if
Assistant is available for the user's device/locale, where Enabled
means it is available and disabled means it is not.
opaEligible (type: boolean(), default: nil) - Stores if Assistant
is available for the user's device/locale. Deprecated as bools do not
give accurate true/false ratios due to old clients reporting the default
value.
sdkVersion (type: integer(), default: nil) - Stores the Android
SDK version. This comes from
 android.os.Build.VERSION.SDK_INT.
speakerIdModelPresent (type: boolean(), default: nil) -
Whether speaker ID model is present for the user.
speakerIdRecognitionEnabled (type: boolean(), default: nil) -
Indicates whether the user has enabled speaker-id
(fromAnyScreen/alwaysOn) for this device. Deprecated - use
voice_match_setting instead
trustedVoiceEnabled (type: boolean(), default: nil) - Indicates
whether the user has enabled trusted voice for this device.
unlockWithHotwordAvailable (type: boolean(), default: nil) -
A bool indicating whether device supports unlocking device with
hotword.
userMigratedToDeclined (type: boolean(), default: nil) -
Stores if user was migrated from undecided to declined as apart of
Mariko project. Used for potential growth targeting.
voiceMatchSetting (type: String.t, default: nil) - Stores the
hotword/voice match setting status for the locales which support
voice match.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechSettings{
continuedConversationEnabled: boolean() | nil,
deviceModelType: String.t() | nil,
dspAvailable: boolean() | nil,
hotwordInNavigationEnabled: String.t() | nil,
hotwordSetting: String.t() | nil,
lockscreenEnabled: boolean() | nil,
opaEligibilityState: String.t() | nil,

opaEligible: boolean() | nil,

sdkVersion: integer() | nil,
speakerIdModelPresent: boolean() | nil,

speakerIdRecognitionEnabled: boolean() | nil,

trustedVoiceEnabled: boolean() | nil,
unlockWithHotwordAvailable: boolean() | nil,
userMigratedToDeclined: boolean() | nil,

voiceMatchSetting: String.t() | nil

}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsTethere
dInfo
Attributes

primaryHostDeviceId (type: String.t, default: nil) - The host

this wearable is tethered to (e.g. phone). When host is AGSA then
this is agsa_client_instance_id. When host is IOPA then this is
opa_ios_device_id.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsTetheredInfo{
primaryHostDeviceId: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsThirdP
artyAppsFilter
Specification of which third party apps can be used.

Attributes

state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsThirdPartyAppsFilter{
state: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsVideoFi
lter
Specification of which video features can be used.

Attributes

autoplayToggleState (type: String.t, default: nil) - State that

indicates whether autoplay is enabled for youtube videos.
availableProviders (type: list(String.t), default: nil) -
Providers available at the time user updated settings.
providerFilterState (type: String.t, default: nil) -
Represents the state for the video provider filter.
state (type: String.t, default: nil) -
whitelistedProviders (type: list(String.t), default: nil) -
Contains the list of whitelisted video providers.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsVideoFilter{

autoplayToggleState: String.t() | nil,

availableProviders: [String.t()] | nil,
providerFilterState: String.t() | nil,

state: String.t() | nil,

whitelistedProviders: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSettingsWebvie
wFilter
Specification of which webview features can be used.

Attributes

jasperWebviewConsent (type: boolean(), default: nil) -

Indicates if user has consented Jasper warning message.
state (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsWebviewFilter{
jasperWebviewConsent: boolean() | nil,

state: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSignInMethod
The method of sign in which the client supports.

Attributes

method (type: String.t, default: nil) -

signInRequired (type: boolean(), default: nil) - Make Google
sign-in mandatory for using Google Assistant on the device.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSignInMethod{
method: String.t() | nil,
signInRequired: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSodaCapabilitie
s
Capabilities related to SODA (Speech On-Device API). Next ID: 5

Attributes

supportsHotwordSensitivity(type: boolean(), default: nil) -

Whether the device supports different levels of hotword sensitivity.
go/hotword-sensitivity-prd
supportsSimpleStop (type: boolean(), default: nil) - Whether
Simple Stop (go/simple-stop) is enabled on the device. Simple stop
allows users to stop firing alarms and timers by just saying "stop"
without first saying the hotword.
supportsSpeakerId (type: boolean(), default: nil) - Whether
the device supports speaker-id (speaker identification based on
hotword and/or spoken query - go/speaker-id). Note: there are
existing devices that support speaker-id but does not have this
capability set. Not having this field populated doesn't necessarily
mean the device doesn't support speaker-id.
supportsWarmWords (type: boolean(), default: nil) - Whether
the device supports WarmWords (go/warm-words-framework).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSodaCapabilities{

supportsHotwordSensitivity: boolean() | nil,

supportsSimpleStop: boolean() | nil,

supportsSpeakerId: boolean() | nil,

supportsWarmWords: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSoftwareCapab
ilities
These capabilities represent what software features the client supports.
This should be determined based on the client's various software
versions (OS, GSA version, etc). Next ID: 28

Attributes

appCapabilities (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiApp
Capabilities.t),default: nil) - IMPORTANT: Only one of
AppCapabilities and AppCapabilitiesDelta should be in the
SoftwareCapabilities. In the edge case if the client sends up both
AppCapabilities and AppCapabilitiesDelta, AppCapabilitiesDelta is
ignored. Complete list of app capabilities.
appCapabilitiesDelta (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiApp
CapabilitiesDelta.t), default: nil) - Incremental update for
app capabilities.
appIntegrationsSettings (type: %{optional(String.t) =>
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppInteg
default: nil) - App integrations settings for
rationsSettings.t},
each packge name.
carAssistantCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarAssis
default: nil) - Capabilities related to
tantCapabilities.t,
Assistant on Auto surfaces.
clockCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiClockCap
 default: nil) - Capabilities related to clock
abilities.t,
functionality, like alarms, timers, etc.
conversationVersion (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupporte
default: nil) - A top-level version of
dConversationVersion.t,
Conversation protocol where the versions are explicitly defined at
go/conversation-versions.
crossDeviceExecutionCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCrossDev
iceExecutionCapability.t, default: nil) - For torus x-device
execution support
gacsCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGacsCapa
default: nil) -
bilities.t,
gcmCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGcmCapab
ilities.t, default: nil) -
liveTvChannelCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvCh
annelCapabilities.t, default: nil) - Capabilities related to live
TV channels.
oemCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOemCapab
default: nil) - List of actions OEM supports. This
ilities.t,
includes built-in actions and custom actions.
onDeviceAssistantCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDevice
AssistantCapabilities.t, default: nil) - on-device Assistant
capabilities
onDeviceSmartHomeCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDevice
default: nil) - Capability bits for on-
SmartHomeCapabilities.t,
device Smart Home. go/framework-for-local-semex
onDeviceStorageCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDevice
default: nil) - Reflects the storage
StorageCapabilities.t,
capabilities on the device.
operatingSystem (type: String.t, default: nil) - The operating
system of the device.
orderedLiveTvProviders (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiv
eTvProvider.t), default: nil) - An ordered list containing the
live tv providers available in the client. The order of the providers
reflects the ranking in the client and will be respected by server as
well.
robinCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCap
default: nil) - Capabilities of Robin client.
abilities.t,
selinaCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSelinaCa
default: nil) - The Soli capabilities on Elaine.
pabilites.t,
go/dingo-dc-software
settingsAppCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettings
default: nil) -
AppCapabilities.t,
supportedClientOp (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSup
portedClientOp.t),default: nil) -
supportedFeatures (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupporte
default: nil) -
dFeatures.t,
supportedMsgVersion (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupporte
default: nil) -
dProtocolVersion.t,
supportedProviderTypes (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupporte
dProviderTypes.t, default: nil) -
 surfaceProperties (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfaceP
roperties.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSoftwareCapabilities{
appCapabilities:

[GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppCapabilities.t()] | nil,
appCapabilitiesDelta:
[GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppCapabilitiesDelta.t()]

| nil,
appIntegrationsSettings:
%{
 optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppIntegrationsSettings.t()
}
| nil,

carAssistantCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarAssistantCapabilities.t()
| nil,
clockCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiClockCapabilities.t() | nil,
conversationVersion:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedConversationVersion.t()

| nil,
crossDeviceExecutionCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiCrossDeviceExecutionCapability.t(
)
| nil,

gacsCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGacsCapabilities.t() | nil,
gcmCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGcmCapabilities.t() | nil,
liveTvChannelCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilities.t()
| nil,
oemCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiOemCapabilities.t() | nil,
onDeviceAssistantCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceAssistantCapabilities.t()
| nil,
onDeviceSmartHomeCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceSmartHomeCapabilities.t()
| nil,
 onDeviceStorageCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceStorageCapabilities.t()
| nil,
operatingSystem: String.t() | nil,

orderedLiveTvProviders:
[GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvProvider.t()] | nil,

robinCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilities.t() | nil,
selinaCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSelinaCapabilites.t() | nil,
settingsAppCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAppCapabilities.t()
| nil,
supportedClientOp:
[GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedClientOp.t()]

| nil,
supportedFeatures:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedFeatures.t() | nil,
supportedMsgVersion:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProtocolVersion.t()
| nil,
supportedProviderTypes:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProviderTypes.t()

| nil,
surfaceProperties:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfaceProperties.t() | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSpeechCapabili
ties
DEPRECATED These capabilities are associated with speech detection
on devices.

Attributes

dspAvailable(type: boolean(), default: nil) - A bool

indicating whether device supports dsp based hotword detection.
unlockWithHotwordAvailable (type: boolean(), default: nil) -
A bool indicating whether device supports unlocking device with
hotword.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSpeechCapabilities{

dspAvailable: boolean() | nil,

unlockWithHotwordAvailable: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSuggestionsSup
port
Next ID: 18

Attributes

clickImpersonationSupported (type: boolean(), default: nil) -

Whether client supports user impersonation on suggestion chip
click. go/suggestion-click-impersonation
debugDataSupported (type: boolean(), default: nil) - Whether
client supports suggestions debug data to be displayed.
drlHistoryChipSupported (type: boolean(), default: nil) -
Whether DRL history chip is supported. Related bug:
http://b/241837879, http://b/171854732 Design doc:
http://go/panthera-history-chip-dd DRL history chip was originally
rolled out to Panthera in
http://google3/googledata/experiments/mobile/agsa/studies/agsa_ng
a/opa_panthera_one_input_ui_launch.gcl?l=55&rcl=384682900.
We plan to roll it out to NGA and TNG. drl_history_chip_supported
bit specifies whether the client support (and should have) DRL
history chip.
escapeHatchSupported (type: String.t, default: nil) - Whether
client supports escape hatches aka post execution suggestions
go/nga-escape-hatch-prd
executedTextSupported (type: boolean(), default: nil) -
Whether the client can rewrite suggestion query text into executed
text, if the latter is present. If this feature is disabled, the rewrite
happens in Assistant Server.
executionContextSupported (type: boolean(), default: nil) -
Whether the client supports passing back execution_context
from |assistant.api.client_op.SuggestionProcessingParams| when the
suggestion is clicked or spoken.
featureSpecificActionSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFeatureS
pecificActionSupport.t,default: nil) - Whether the client
supports features in |SuggestionFeatureSpecificAction|.
featureSpecificAppActionsNotificationSupported (type:
boolean(), default: nil) - Whether the client supports handling
App Actions' notification when the suggestion is clicked. This will
allow the server to populate the app_actions_notification_data
extension field from |SuggestionFeatureSpecificAction| proto
message.
multiStepTrySayingSupported (type: boolean(), default: nil) -
Whether the multi-step try saying suggestion feature is supported.
dd: go/tng-multi-step-simplified
ruleIdInExecutionContextSupported (type: boolean(), default:
nil) - Whether the rule_id field in the execution_context is
supported. This is a temporary workaround to be able to identify
clicks on Person entity suggestions on Sabrina and is expected to be
eventually deprecated. TODO(b/185517153) : Deprecate (but do
not delete) once click tracking is correctly sent up from the Katniss
client.
showExecutedTextSupported (type: boolean(), default: nil) -
Whether the client can show executed_text after the click on the
suggestion chip. Must be set to false on TNG. TNG disregards
|SuggestionProcessingParams.show_executed_text| field and
always treats it as if |show_executed_text=true|.

(type: boolean(), default: nil) -

showTranslationSupported
Whether the client can show chip as (text | translation). go/lang-
partner-doc
 supportedDisplayTargets (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSug
default: nil) - A
gestionsSupportDisplayTargetSupport.t),
list of suggestions display targets supported by this client. If unset
only DEFAULT SuggestionDisplayTarget is supported.
widgetDataSupported (type: boolean(), default: nil) - Whether
client supports widget suggestion chip to be displayed.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupport{

clickImpersonationSupported: boolean() | nil,
debugDataSupported: boolean() | nil,

drlHistoryChipSupported: boolean() | nil,

 escapeHatchSupported: String.t() | nil,
executedTextSupported: boolean() | nil,
executionContextSupported: boolean() | nil,

featureSpecificActionSupport:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiFeatureSpecificActionSupport.t()

| nil,
featureSpecificAppActionsNotificationSupported: boolean() | nil,
multiStepTrySayingSupported: boolean() | nil,
ruleIdInExecutionContextSupported: boolean() | nil,
showExecutedTextSupported: boolean() | nil,
showTranslationSupported: boolean() | nil,
supportedDisplayTargets:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupportDisplayTargetSu
pport.t()

]
| nil,
widgetDataSupported: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSuggestionsSup
portDisplayTargetSupport
Attributes

executedTextSupported (type: boolean(), default: nil) -

Whether the client can rewrite suggestion query text into executed
text, if the latter is present for the display target.
headerTextSupported (type: boolean(), default: nil) - Whether
PresentationParams.header_text is supported for the display target.
repressImpressionSupported (type: boolean(), default: nil) -
Whether Suggestion.repress_impression is supported. If not
repressed suggestions are not returned.
target (type: String.t, default: nil) - Display target that is
supported.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupportDisplayTargetS
upport{
executedTextSupported: boolean() | nil,
headerTextSupported: boolean() | nil,

repressImpressionSupported: boolean() | nil,

target: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSunriseFeature
sSupport
Attributes

(type: boolean(), default: nil) -

sunriseSimulationSupported
If true, the device can slowly brighten the screen and simulate
sunrise experience. Alarms with sunrise field enabled can be set on
this device.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSunriseFeaturesSupport{

sunriseSimulationSupported: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedClien
tOp
These are the set of ClientOps that are supported by the device.

Attributes

clientOpName (type: String.t, default: nil) - This should be the

same as the name of the SemanticClientOp that is supported.
clientOpProperties (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiProtobuf
default: nil) - The properties associated with the ClientOp.
.t,
This proto should be associated with the client_op_name.
supportedExecution (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupporte
dClientOpSupportedExecution.t, default: nil) -
version (type: integer(), default: nil) - A version of 0 is the
equivalent to not having support for that client_op type. Note that a
client_op is also unsupported if it is not included at all in the list of
supported client_ops.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedClientOp{

clientOpName: String.t() | nil,

clientOpProperties:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiProtobuf.t() | nil,
supportedExecution:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedClientOpSupportedExecuti

on.t()
| nil,

version: integer() | nil

}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedClien
tOpSupportedExecution
Additional properties that client can support for executing the client op.
They are surface-specific execution properties and are unrelated to the
execution model.

Attributes

(type: boolean(), default: nil) -

supportsPartialFulfillment
ClientOp execution supports special rendering behavior while the
user is in the middle of expressing their query. This behavior
includes: 1) New partial output always over-writes prior partial
output. 2) Canceling the interaction removes partial fulfilment from
any user visible interaction history. If this is true, whether to apply
the special rendering behavior will be determined by
PartialFulfillmentRenderingParams. More details can be found at
go/ma-natcon-pf-api.
supportsSynchronousExecution (type: boolean(), default: nil)
- Client can support synchronous execution of the client op. For
tts.OUTPUT client op it means that client would honor
|synchronous_playback_args| argument. Please see more at
go/synchronous-sounds-design.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedClientOpSupportedExecut
ion{

supportsPartialFulfillment: boolean() | nil,

supportsSynchronousExecution: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedConv
ersationVersion
The overall Conversation Protocol version. As we make fundamental
changes to Conversation protocol that are non-backwards compatible,
we will increment the protocol version. By default, all clients will
support version 0. All versions are documented at go/conversation-
versions.

Attributes

supportsConversationProtocol(type: boolean(), default: nil)

- Whether conversation protocol is supported explicitly. If true,
SingleDeviceCapabilityChecker::SupportsConversationProtocol
will always return true.
version (type: integer(), default: nil) - The supported version
number.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedConversationVersion{
supportsConversationProtocol: boolean() | nil,
version: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedFeat
ures
These are the set of features that are supported by the device. It's a part
of the SoftwareCapabilities of the device. Next ID: 69

Attributes

(type: boolean(),
readNotificationSummarizationSupported
default: nil) - Whether the client supports message
summarization. Deprecated, use message_summary_support
instead.
fitnessFeatureSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFitnessF
default: nil) - Information about what support
eatureSupport.t,
this device has for fitness.
masqueradeModeSupported (type: boolean(), default: nil) -
Whether the device supports masquerade mode (go/masquerade).
appControlSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppContr
olSupport.t,default: nil) - The client information for app
control support. More details in: go/acaia.
gearheadNotificationSourceSupported (type: boolean(),
default: nil) - Whether the client supports the Gearhead message
notification source, in which case notification-related operations
can access it.
parentalControlsSupported (type: boolean(), default: nil) -
Whether or not the client supports enabling parental controls. When
a device to supports parental controls, it has the software necessary
to store the relevant information required for parental controls to
work. This information includes a boolean "enabled bit" as well as
the obfuscated gaia ID of the kid account selected for use with
parental controls. Devices supportings kids mode send this
information to S3 via S3ClientInfo in every request. See go/aff-
kidsproduct for details.
mediaControlSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMediaCon
default: nil) - Information about how client
trolSupport.t,
handles media controls (play, pause, skip ...)
sunriseFeaturesSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSunriseF
eaturesSupport.t,default: nil) - Whether the client supports the
sunrise screen brightening feature before the alarm fires. This is
used to indicate whether sunrise alarms can be set on the device.
http://cs/symbol:assistant.api.core_types.governed.RingtoneTaskMe
tadata.GentleWakeInfo
shLockScreenSupported (type: boolean(), default: nil) -
Whether the client supports SmartHome lock screen logic (i.e. on
Tangor).
fluidActionsSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFluidAct
ionsSupport.t,default: nil) - Fluid Actions features supported
by the client. If this field is not set in the incoming request, it could
mean that the client does not support Fluid Actions. Alternatively, it
could mean that the client supports Fluid Actions, but syncs state
with server using the old protocol, namely
ConversationStateParams. When b/140733618 is resolved, Surface
Adaptation Layer will add this field for old clients that support
Fluid Actions framework.
bypassMsgNotificationDismissal (type: boolean(), default:
nil) - Whether or not Assistant should enforce the dismissal of
communication notifications associated with messages.
justInTimeSupported (type: boolean(), default: nil) - Whether
the client supports confirmation flow when a permission is missing.
If set to true, the user will be prompted and on confirmation the
original flow will continue.
sleepSensingSupported (type: boolean(), default: nil) -
Whether the client can monitor sleep. This allows us to show sleep
CUJ related information: go/TwilightDesign Use for development
only, see the same field in
DeviceCapabilities.SoftwareCapabilities.SelinaCapabilities.
actionV2SupportedFeatures (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiActionV2
SupportedFeatures.t, default: nil) -
mediaSessionDetection (type: String.t, default: nil) - The
ability of the client to detect media sessions on the device.
gdiSupported (type: boolean(), default: nil) - Whether account
linking via Google Deep Integrations (GDI) is supported. go/opa-
gdi-design
zoomSupported (type: boolean(), default: nil) - Whether the
client supports joining a Zoom meeting.
persistentDisplaySupported (type: boolean(), default: nil) -
Whether the client supports persistent display. The new feature
allows Assistant devices with screen to display a continuously
updating permanent display, such as ambient weather, without the
need for a user to ask the Assistant. Design doc: go/assistant-
persistent-display.
alarmTimerManagerApiSupported (type: boolean(), default:
nil) - Whether the client supports AlarmTimerManager API
(go/alarm-timer-manager-api).
bypassDiDcCheckForComms (type: boolean(), default: nil) -
Whether communications flows for the client can bypass the DI/DC
check. The client will enforce some other equivalent permission as
necessary concerning access to device contacts and apps.
readMessagesTtsTaperingSupported (type: boolean(), default:
nil) - Whether the client supports tts tapering for the read
messages flow. If set to true the tapered tts variant would be used
during the read messages flow.
funtimeSupported (type: boolean(), default: nil) - Whether the
surface client op performer supports Funtime alarms and timers.
go/funtime-engdesign
webBrowserSupported (type: boolean(), default: nil) - Whether
the supports opening a URL in a web browser. For example, we
want to disable this for clients like Chirp.
mapsDialogsSupported (type: boolean(), default: nil) -
Whether the client supports Assistant dialogs within Maps. This
field will be set only when the Maps on the surface supports
Assistant dialogs embedded within Maps. go/gsa-gmm.
opaOnSearchSupported (type: boolean(), default: nil) - When
the entry source is search, whether the client supports rendering a
similar response as OPA one does. Entry source is defined at
http://cs/symbol:assistant.api.params.DeviceProperties.EntrySource
isPairedPhoneContactUploadNeededForComms (type: boolean(),
default: nil) - Whether paired-phone contact upload is needed for
communications queries to work (e.g. on AAE).
noInputResponseSupported (type: boolean(), default: nil) -
Whether the client can render no input response or just ignore it. No
input response is returned when client has a no speech input
interaction, eg. user tapped mic but didn't say anything.
smartspaceCrossDeviceTimerSupported (type: boolean(),
default: nil) - Whether the client supports smart space cross-
device timers. (go/ss-x-device-timer)
clientOpResultBatchingSupported (type: boolean(), default:
nil) - Whether the client can batch client op results before sending
them to the server.
usesSeparateFullViewer (type: boolean(), default: nil) - If
set, it indicates that the client can open a separate HTML
browser/webviewer (full viewer) to display certain visual results.
These visual results usually require more memory to render (e.g.
high resolution photos). Compared to the regular viewer that
display all other Assistant result, the full viewer does not have
memory limit. The field is copied from the device model. See
http://google3/assistant/devices_platform/proto/device_model_capa
bilities.proto?l=225&rcl=312576471 Also see go/webassistant-full-
card-viewer.
confirmationBeforeReadingMultipleMessagesSupported (type:
boolean(), default: nil) - Whether the client supports
confirmation flow before announcement of multiple messages. If
set to true the user will be prompted once and confirmation will be
taken before all the messages are announced.
messageSummarySupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageS
ummarySupport.t,default: nil) - The client information for
message summary. More details in: go/roadwayrecap-prd
acpSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAssistan
tContinuedPresenceSupport.t, default: nil) - In what way is
assistant continued presence supported. (go/opa-acp-prd)
viewReminderHubPageNotSupported (type: boolean(), default:
nil) - Whether the client supports viewing of reminder hub page or
not. Default is supported. Set to true to disable returning reminder
hub page url in reminder responses.
duoGroupCallingSupported (type: boolean(), default: nil) -
Whether the client supports Duo group calling.
client1mProvidersSupported (type: boolean(), default: nil) -
Whether the client supports 1m providers (go/1m-partner-
expansion).
hasPhysicalRadio (type: boolean(), default: nil) - Whether the
client has a physical radio installed.
liveCardsSupported (type: boolean(), default: nil) - Whether
the surface supports LiveCards. In cases where the user intent flow
cannot be completed within the Assistant, LiveCards are used to
take the user to an external app or website. These cards will be
pushed to the Google Home app via the PushMessage ClientOp.
signInMethod (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSignInMe
thod.t, default: nil) - Which kind of sign in the client supports.
lottieAnimationSupport (type: String.t, default: nil) -
Whether the client supports the Lottie animation library for the
broadcast feature.
serverGeneratedFeedbackChipsEnabled (type: boolean(),
default: nil) - Whether the Assistant Server should generate
feedback suggestion chips.
transactionFeaturesSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTransact
ionFeaturesSupport.t, default: nil) - Transactions features,
supported by the client. Transactions feature may includes how
Transactions team want to populate additional information from the
device to the server.
tapToReadOptimizationSupported (type: boolean(), default:
nil) - Whether the client supports faster optimization for
tap_to_read feature.
remoteCloudCastingEnabled (type: boolean(), default: nil) -
Whether the client has remote casting enabled. For ex: we want to
disable this for clients like Auto.
crossDeviceBroadcastSupported (type: boolean(), default:
nil) - Whether the client supports cross-device broadcast (i.e. on
Torus).
suggestionsSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggesti
onsSupport.t, default: nil) - Suggestion chips features,
supported by the client.
crossDeviceBroadcastVersion (type: String.t, default: nil) -
The version of cross device broadcast (ie; broadcast on torus) which
the client supports.
conversationalCareSupported (type: boolean(), default: nil) -
Whether the client can render conversational care responses.
go/conversational-care
assistantForKidsSupported (type: boolean(), default: nil) -
Whether Assistant for Kids (a.k.a. Designed for Family) features
are supported.
isPairedPhoneNeededForComms (type: boolean(), default: nil) -
Whether a Bluetooth-paired phone is a core component of
communications flows on the client.
csatVisualOverlaySupported (type: boolean(), default: nil) -
Whether the client supports csat visual overlay. (go/sd-od-csat)
transactionsVersion (type: String.t, default: nil) - The
version of transactions which the client supports.
duoClientApiFeatures (type: String.t, default: nil) - The
features set which duo client on the device supports. This should be
serialized from proto {@code
duo_client_api.DuoClientApiFeatures}.
aaeNotificationSourceSupported (type: boolean(), default:
nil) - Whether the client supports the alternative message
notification sources on AAE, in which case notification-related
operations can access it.
immersiveCanvasSupport (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiImmersiv
eCanvasSupport.t, default: nil) -
soliGestureDetectionSupported (type: boolean(), default:
nil) - Whether or not the client supports gesture detection via soli
chips. The reason to prepend the name with soli is to distinguish it
from computer vision based methods, e.g. Newman devices.
lensSupported (type: boolean(), default: nil) - Whether the
client has Google Lens (Assistant Eyes).
privacyAwareLockscreenSupported (type: boolean(), default:
nil) - Whether the client supports the privacy-aware lockscreen
protocol (go/assistant-lockscreen-spec).
assistantExploreSupported (type: boolean(), default: nil) -
Whether the client supports the assistant explore section. This field
will be active only when the Explore section is available to the user.
This means that the user is (a) signed-in, (b) a IOPA / AGSA user,
and (c) in a locale where explore is available.
meetSupported (type: boolean(), default: nil) - Whether the
client supports joining a Google Meet meeting.
 launchKeyboardSupported (type: String.t, default: nil) -
Which way of launching the keyboard the client supports.
immersiveCanvasConfirmationMessageSupported (type:
boolean(), default: nil) - Whether the client supports
confirmation messages in Immersive Canvas actions. Deprecated:
use the filed in immersive_canvas_support.
warmWelcomeTutorialSupported (type: boolean(), default: nil)
- Whether the client supports the programmatic warm welcome
tutorial. Design doc: go/opal-pww-design.
inDialogAccountLinkingSupported (type: boolean(), default:
nil) - Whether the client supports account linking in-dialog
(askForSignIn). This is used before this feature is moved to
conversation protocol. To support this, the client needs to: -
Integrate with Google Deep Integrations. - Have logic to send the
result of account linking back to AS.
thirdPartyGuiSupported (type: boolean(), default: nil) -
Whether the device supports the 3p GUI framework, which allows
third parties to enter the conversation with the user, showing their
logo next to their chat bubbles, etc. go/3p-phone

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedFeatures{

aaeNotificationSourceSupported: boolean() | nil,
acpSupport:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiAssistantContinuedPresenceSupport
.t()

| nil,

actionV2SupportedFeatures:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiActionV2SupportedFeatures.t()
| nil,

alarmTimerManagerApiSupported: boolean() | nil,

appControlSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppControlSupport.t() | nil,
assistantExploreSupported: boolean() | nil,

assistantForKidsSupported: boolean() | nil,

bypassDiDcCheckForComms: boolean() | nil,
bypassMsgNotificationDismissal: boolean() | nil,
client1mProvidersSupported: boolean() | nil,

clientOpResultBatchingSupported: boolean() | nil,

confirmationBeforeReadingMultipleMessagesSupported: boolean() | nil,
conversationalCareSupported: boolean() | nil,
crossDeviceBroadcastSupported: boolean() | nil,

crossDeviceBroadcastVersion: String.t() | nil,

csatVisualOverlaySupported: boolean() | nil,

duoClientApiFeatures: String.t() | nil,

duoGroupCallingSupported: boolean() | nil,

fitnessFeatureSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFitnessFeatureSupport.t()
 | nil,
fluidActionsSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFluidActionsSupport.t()

| nil,
funtimeSupported: boolean() | nil,

gdiSupported: boolean() | nil,

gearheadNotificationSourceSupported: boolean() | nil,

hasPhysicalRadio: boolean() | nil,
immersiveCanvasConfirmationMessageSupported: boolean() | nil,
immersiveCanvasSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiImmersiveCanvasSupport.t()
| nil,
inDialogAccountLinkingSupported: boolean() | nil,
isPairedPhoneContactUploadNeededForComms: boolean() | nil,

isPairedPhoneNeededForComms: boolean() | nil,

justInTimeSupported: boolean() | nil,
launchKeyboardSupported: String.t() | nil,

lensSupported: boolean() | nil,

liveCardsSupported: boolean() | nil,
lottieAnimationSupport: String.t() | nil,
mapsDialogsSupported: boolean() | nil,

masqueradeModeSupported: boolean() | nil,

mediaControlSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMediaControlSupport.t()

| nil,
mediaSessionDetection: String.t() | nil,
meetSupported: boolean() | nil,
messageSummarySupport:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageSummarySupport.t()
| nil,
noInputResponseSupported: boolean() | nil,
opaOnSearchSupported: boolean() | nil,

parentalControlsSupported: boolean() | nil,

persistentDisplaySupported: boolean() | nil,
privacyAwareLockscreenSupported: boolean() | nil,

readMessagesTtsTaperingSupported: boolean() | nil,

 readNotificationSummarizationSupported: boolean() | nil,
remoteCloudCastingEnabled: boolean() | nil,
serverGeneratedFeedbackChipsEnabled: boolean() | nil,

shLockScreenSupported: boolean() | nil,

signInMethod:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSignInMethod.t() | nil,
sleepSensingSupported: boolean() | nil,

smartspaceCrossDeviceTimerSupported: boolean() | nil,

soliGestureDetectionSupported: boolean() | nil,
suggestionsSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupport.t() | nil,

sunriseFeaturesSupport:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSunriseFeaturesSupport.t()
| nil,

tapToReadOptimizationSupported: boolean() | nil,

thirdPartyGuiSupported: boolean() | nil,

transactionFeaturesSupport:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiTransactionFeaturesSupport.t()
| nil,
transactionsVersion: String.t() | nil,

usesSeparateFullViewer: boolean() | nil,

viewReminderHubPageNotSupported: boolean() | nil,
warmWelcomeTutorialSupported: boolean() | nil,
webBrowserSupported: boolean() | nil,

zoomSupported: boolean() | nil

}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedProt
ocolVersion
Contains versions of protocol buffer messages. This is the equivalence of
a proto3 map, keyed by a protocol buffer message’s name, and the value
is the version of this message. e.g. {"assistant.api.core_types.Timer": 2,
"assistant.api.core_types.Alarm": 1} See go/assistant-protocol-
versioning for more details.

Attributes

messageVersion (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSup
portedProtocolVersionMessageVersionPair.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProtocolVersion{
messageVersion:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProtocolVersionMessageVe
rsionPair.t()

]
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedProt
ocolVersionMessageVersionPair
Attributes

messageName (type: String.t, default: nil) - The full path of a

message which should start from the package name. e.g.
"assistant.api.core_types.Timer".
version (type: integer(), default: nil) - The supported version
number.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProtocolVersionMessageV
ersionPair{

messageName: String.t() | nil,

version: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSupportedProvi
derTypes
Types of providers that are supported by the client. For example,
ChromeOS support both web app and Android app (for eligible devices).

Attributes

supportedTypes (type: list(String.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProviderTypes{
supportedTypes: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSurfacePropert
ies
Properties of the surface that are not hardware related or feature specific.

Attributes

executionCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfaceP
default: nil) -
ropertiesExecutionCapabilities.t,
prefersGlanceableUi (type: boolean(), default: nil) - Indicates
if the surface prefers glanceable UI when rendering Assistant
response. (see go/mobile-dr-hbird-glanceable-comms-cuj for more
context).
responseDisplayFormat (type: String.t, default: nil) - If this
field is unset, the response format is unknown
supportsMultiResponse (type: boolean(), default: nil) - If
true, the client supports receiving multiple responses. See
go/multiple-response-in-media-use-cases for more details.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfaceProperties{

executionCapabilities:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfacePropertiesExecutionCapabil

ities.t()
| nil,
prefersGlanceableUi: boolean() | nil,

responseDisplayFormat: String.t() | nil,

supportsMultiResponse: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSurfacePropert
iesExecutionCapabilities
Describes the capabilities that are related to the execution of client ops
on the device.

Attributes

supportsClientOpPreloading (type: boolean(), default: nil) -

Completes the preloading ie., sets up the stage for the execution of
client ops on the device while the previous conv delta is being
executed. Refer to go/preload-convdelta for more information.
supportsNonFinalizedResponses (type: boolean(), default:
nil) - A value of true indicates that the client supports streaming
of non-finalized responses by use of
ClientExecutionParams.response_stream_id. and
ClientExecutionParams.to_be_finalized.
supportsNonMaterializedInteractions (type: boolean(),
default: nil) - If true, the client supports receiving non-
materialized interactions (go/as-streaming-protocol-nm).

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfacePropertiesExecutionCapabi
lities{
supportsClientOpPreloading: boolean() | nil,
supportsNonFinalizedResponses: boolean() | nil,

supportsNonMaterializedInteractions: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSystemNotificat
ionRestrictions
Restrictions related to system-level notifications.

Attributes

categoryState (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSys
temNotificationRestrictionsNotificationCategoryState.t),
default: nil) -
channelState (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSys
temNotificationRestrictionsNotificationChannelState.t),
default: nil) -
(type: String.t, default: nil) -
notificationCapabilities
Specifies whether the surface is able to display notifications.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictions{

categoryState:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictionsNot

ificationCategoryState.t()
]

| nil,
channelState:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictionsNot
ificationChannelState.t()
]
| nil,

notificationCapabilities: String.t() | nil

}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSystemNotificat
ionRestrictionsNotificationCategor
yState
Notification channels state for the new server driven channels.

Attributes

categoryId (type: integer(), default: nil) - Notification

channel type.
disabled (type: boolean(), default: nil) - Weather the
notifications on this channel are disabled.
disabledReason (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictionsNo
tificationCategoryState{

categoryId: integer() | nil,

disabled: boolean() | nil,
disabledReason: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiSystemNotificat
ionRestrictionsNotificationChannel
State
Notification channels state.

Attributes

channelType (type: String.t, default: nil) - Notification

channel type.
enabled (type: boolean(), default: nil) - Whether the
notifications on this channel are enabled.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictionsNo
tificationChannelState{
channelType: String.t() | nil,
enabled: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiThirdPartyActi
onConfig
3P Action Metadata. Next ID: 3

Attributes

deviceActionCapability (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoDeviceActionCapability.t,
DeviceActionCapability from DeviceModelPackage.
projectConfigs (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiThi
rdPartyActionConfigProjectConfig.t), default: nil) - List of
Action project capabilities.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyActionConfig{
deviceActionCapability:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceActionCapa
bility.t()
| nil,

projectConfigs:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyActionConfigProjectConf

ig.t()
]
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiThirdPartyActi
onConfigProjectConfig
Metadata for ActionPackage. Device Actions are disabled by default
unless explicitly enabled for the device here, see go/3p-device-actions-
v2-design.

Attributes

(type: String.t, default: nil) - Google cloud project

projectId
id for which the Action Package or Device Model is registered.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyActionConfigProjectCon
fig{
projectId: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiThirdPartyCap
abilities
Attributes

(type: String.t, default: nil) -

dataSharingRestrictions
Restrictions for the device to share any data with third party apps.
See details in go/atv-dsc.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyCapabilities{
dataSharingRestrictions: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiTimeOfDay
A civil time relative to a timezone.

Attributes

hour (type: integer(), default: nil) - The hour, in 0...23.

minute (type: integer(), default: nil) - The minute, in 0...59.
nanosecond (type: integer(), default: nil) - The fraction of
seconds in nanoseconds, in 0..999999999.
second (type: integer(), default: nil) - The second, in 0...59.
Leap seconds are not supported.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeOfDay{

hour: integer() | nil,
minute: integer() | nil,
nanosecond: integer() | nil,
second: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiTimeZone
A time zone. Conceptually, a time zone is a set of rules associated with a
location that describes a UTC offset and how it changes over time (e.g.
Daylight Saving Time). The offset is used to compute the local date and
time.

Attributes

(type: String.t, default: nil) - Time zone in IANA

ianaId
format, e.g. America/Los_Angeles for USA Pacific Time.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeZone{

ianaId: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiTimestamp
An absolute point in time independent of timezone or calendar, based on
the proto3 Timestamp (//google/protobuf/timestamp.proto). NOTE:
THIS IS NO LONGER RECOMMENDED TO BE USED. It was
originally defined separately from google.protobuf.Timestamp due to
incompatibility with proto2 syntax. The incompatibility issues have
since been resolved and so the Google-wide standard representation of
google.protobuf.Timestamp should be preferred. In fact,
google.protobuf.* protos in general are now recommended to be used in
new APIs.

Attributes

nanos(type: integer(), default: nil) - Non-negative fractions of

a second at nanosecond resolution.
seconds (type: String.t, default: nil) - Seconds of UTC time
since the Unix epoch.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp{

nanos: integer() | nil,

seconds: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiTransactionFea
turesSupport
Attributes

voicePinSuppressed(type: boolean(), default: nil) - If true,

setting this boolean means the device should not support voice PIN.
For example, although the phone supports both voice and PIN pad,
but we don't want users using voice.
https://docs.google.com/document/d/1M8iJQX3GuxGZGeidS8Gl4
KJt3LuBWAIlolPlW10DkxU/edit#heading=h.8ovvdd3i2thv

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantApiTransactionFeaturesSupport{

voicePinSuppressed: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantApiVolumeProperti
es
Attributes

defaultVolumePercentage (type: integer(), default: nil) - The

volume percentages for spelled out values.
highVolumePercentage (type: integer(), default: nil) -
levelStepSize (type: float(), default: nil) - The number of
levels to move for a step.
lowVolumePercentage (type: integer(), default: nil) -
maximumVolumeLevel (type: integer(), default: nil) - The max
number of volume levels the client supports.
mediumVolumePercentage (type: integer(), default: nil) -
veryHighVolumePercentage (type: integer(), default: nil) -
veryLowVolumePercentage (type: integer(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiVolumeProperties{

defaultVolumePercentage: integer() | nil,
highVolumePercentage: integer() | nil,
levelStepSize: float() | nil,
lowVolumePercentage: integer() | nil,
maximumVolumeLevel: integer() | nil,
mediumVolumePercentage: integer() | nil,

veryHighVolumePercentage: integer() | nil,

veryLowVolumePercentage: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDeviceTargetingDe
viceTargetingError
The information associated with an error while selecting the target
device. Next ID: 2

Attributes

type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDeviceTargetingDeviceTargetingError
{
type: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoAlarmCapability
Capability with regard to support of alarms by the client.

Attributes

maxSupportedAlarms (type: integer(), default: nil) -

Maximum number of alarms that can be created on the client. Zero
or unset indicates no maximum limit.
restrictAlarmsToNextDay (type: boolean(), default: nil) -
Whether the client restricts alarms to ring within the next 24 hours.
supportsGenericMutations (type: boolean(), default: nil) -
Whether the client supports mutation of any alarm attribute such as
time_pattern, recurrence_pattern, etc through the MUTATE action.
If this is false, MUTATE may only be used to disable or dismiss an
alarm. This field is true by default for backwards-compatibility;
clients which don't support mutation outside of
Disable/DismissAlarm should explicitly set this to false.
supportsStopAction (type: boolean(), default: nil) - Whether
the client supports the STOP alarm action. If this is false, stop
actions will be represented by the MUTATE action, and the device
may need to check alarm state to determine if there's a firing alarm
that needs to be dismissed.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoAlarmCapability
{
maxSupportedAlarms: integer() | nil,

restrictAlarmsToNextDay: boolean() | nil,

supportsGenericMutations: boolean() | nil,
supportsStopAction: boolean() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoArgSpec
Attributes

intValueSpec (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoIntValueSpec.t, default: nil) -
optionValueSpec (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoOptionValueSpec.t, default: nil) -
type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoArgSpec{
intValueSpec:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntValueSpec.t()
| nil,
optionValueSpec:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoOptionValueSpec.
t()
| nil,

type: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoCallCallCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCallCallCapabil
ity{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoClientReconnectCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoClientReconnect
Capability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoCloudCapability
States the cloud capabilities of the device, i.e. the endpoint(s) to use for
cloud execution of Actions or Registration.

Attributes

cloudEndpoints (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantDevice
default: nil) - The list of
sPlatformProtoCloudEndpoint.t),
CloudEndpoints supported by this Device Model. Note that each
should have a unique |name|. If any cloud endpoints are provided
here, then the first one in the list will be used by default for all
Cloud Execution. An Intent may override the default by providing
an |execution_config|.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudCapability
{
cloudEndpoints:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudEndpoint.t(
)
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoCloudEndpoint
A cloud endpoints associates with this device, it can be used for query
parsing, or cloud execution.

Attributes

name (type: String.t, default: nil) - The name for this cloud
endpoint. It's unique per Locale. This is not an API resource name.
Ex: sample-nlu-endpoint
scopes (type: list(String.t), default: nil) - The list of scopes
to be provided in the OAuth2 token. They must be a subset of the
scopes registered in the Account Linking flow, or the request will
fail. If the client itself provides the token, then this field is ignored.
url (type: String.t, default: nil) - The URL for this endpoint, it
must start with https.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudEndpoint{

name: String.t() | nil,

scopes: [String.t()] | nil,
url: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoCoreDismissAssistantCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCoreDismissAssi
stantCapability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoDeviceActionCapability
This capability represents device action needed capability. Next ID: 10

Attributes

assistantDeviceInRoomOptOut (type: boolean(), default: nil) -

Integrate your device with Google's Smart Home solution by
putting your device into Google's Home Graph, a database that
stores and provides contextual data about the home and its devices.
For example, Home Graph can store the concept of a living room
that contains multiple types of devices, when you say "turn on the
light" to a device, if you have light in the living room, that light will
be turned on.
builtInIntentMode (type: String.t, default: nil) - Specifies
behavior for built-in device actions for this device model. If not
specified, defaults to
ENABLE_CONFIGURED_INTENTS_ONLY.
customIntentMode (type: String.t, default: nil) - Specifies
which custom device actions should be enabled for this device
model. This will only affect the behavior of intents corresponding
to those from the Action Package of this project. If not specified,
defaults to ENABLE_ALL.
defaultExecutionConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Default
formProtoExecutionConfig.t,
instructions for routing of any Intent. The data here could be
overridden for specific Intents if provided directly in the 'intents'
field.
inlinedActionCapability (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Specifies
formProtoInlinedActionCapability.t,
capabilities for device actions that are inlined in the
google.assistant.embedded.v1.DeviceAction message.
intents (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantDevice
default: nil) - Intent configurations.
sPlatformProtoIntent.t),
Built-in and custom intents may be configured here. Note that built-
in intents will always behave with IntentMode of
ENABLE_CONFIGURED_INTENTS_ONLY. The IntentMode for
custom intents can be changed using the custom_intent_mode. To
configure an intent, list it here with its intent name, e.g.
"MY_CUSTOM_INTENT",
"google.assistant.car.model.capabilities.AC_TEMPERATURE".
providedData (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantDevice
sPlatformProtoProvidedData.t), default: nil) - Provided data
which augments the device action capabilities. Some built-in intents
may require additional configuration to be provided. One example
could be the list of channels available for the
action.intent.SelectChannel intent.
traits (type: list(String.t), default: nil) - List of built-in
traits such as "action.devices.traits.OnOff" See
java/com/google/home/graph/service/config/protoconf.pi As of
Nov. 2017, we also support custom traits for EAP users. We'll
eventually disable custom traits once custom actions are in place.
understandingConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Specifies the
formProtoUnderstandingConfig.t,
format how Google routes queries to 3P cloud. By default, this field
is unset, all partners should get shallow NLU. This is needed ONLY
for specific partners for strong business reasons.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceActionCap

ability{
assistantDeviceInRoomOptOut: boolean() | nil,
builtInIntentMode: String.t() | nil,
customIntentMode: String.t() | nil,

defaultExecutionConfig:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionConfig.
t()
| nil,
inlinedActionCapability:
 GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInlinedActionCap
ability.t()

| nil,
intents:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntent.t()
]
| nil,
providedData:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProvidedData.t()
]

| nil,
traits: [String.t()] | nil,
understandingConfig:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoUnderstandingCon
fig.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoDeviceModifySettingCapability
Attributes

clientOpProperty (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOp
PropertiesDeviceModifySettingClientOpProperty.t, default:
nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceModifySet
tingCapability{
clientOpProperty:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesDeviceModifySet
tingClientOpProperty.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoDeviceTakePhotoCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceTakePhoto
Capability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoExecutionConfig
Specifies the routing capabilities of the Intent. It will apply only when
the Intent is triggered. Next ID: 8

Attributes

cloudEndpointName (type: String.t, default: nil) - Instructions

for performing a cloud execution request for the Intent when the
execution_type is set to CLOUD. If non-empty, then the device
execution would be routed to the CloudEndpoint specified by this
name. The Account Linking exchange may be performed to fetch
the OAuth access token, and the access token will be included in
the HTTP header.
cloudIntentTranslationDisabled (type: boolean(), default:
nil) - If this field is set, then the Syndication cloud call will be
disabled for this intent. Note this only applies if any Syndication
cloud endpoint is associated with the Device Model, otherwise
setting this field does nothing. By default, all Intents that are
enabled and supported by the Syndication API will be routed
through the Syndication cloud endpoint if it's provided.
intentCommandFormat (type: String.t, default: nil) - Specifies
the intent command format for this Action. For example, in order to
launch an Android intent instead of receiving the device action
payload on the client, then this field can be set with
"intent:/#Intent;...;my_extra=
{$.params.channels[0].channelCode};end" The parameter "
{$.params.channels[0].channelCode}" is in JSON path format, and
will be replaced with the content from the original device action
 payload. Thus, with # JSON "execution": [ { "command":
"action.devices.commands.SelectChannel", "params": { "channels":
[{ "channelName": "exampleChannel", "channelCode": "1-1" }] } }
] as the original action result, then the final result would look like
"intent:/#Intent;...;my_extra=\"1-1\";end"
localDisabled (type: boolean(), default: nil) - If this field is
set, then local execution capability is disabled for all matching
intents.
localExecutionType (type: String.t, default: nil) - Specifies
how to execute this Action when it is invoked locally (from the
same device.)
remoteDisabled (type: boolean(), default: nil) - If this field is
set, then remote execution capability is disabled for all matching
intents.
remoteExecutionType (type: String.t, default: nil) - Specifies
how to execute this Action when it is invoked remotely (from a
different device.)

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionConfig
{
cloudEndpointName: String.t() | nil,
cloudIntentTranslationDisabled: boolean() | nil,
intentCommandFormat: String.t() | nil,
localDisabled: boolean() | nil,

localExecutionType: String.t() | nil,

remoteDisabled: boolean() | nil,
remoteExecutionType: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoExecutionWaitCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionWaitCa
pability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoGetHealthObservationCapabilit
y
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoGetHealthObserv
ationCapability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoInlinedActionCapability
Attributes

alarm (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Specifies
formProtoAlarmCapability.t,
capabilities for handling on-device alarms. The presence of this
field, even if empty, implies that the device supports alarms.
responseLimits (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoResponseLimits.t,default: nil) - Specifies the size
limits on responses. If message is not defined then no limits exist.
supportSdkExecute (type: boolean(), default: nil) - Whether
this device model package support sdk.EXECUTE client_op (a.k.a
action.devices.EXECUTE intent), which will be filled into
google.assistant.embedded.v1.DeviceAction.device_request_json. It
is default to true (and not public), since all 3P will depends on the
device_request_json. Only internal projects like Edoras will set this
to false.
supportedDeviceOps (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoSupportedDeviceOps.t,default: nil) - Specifies
capabilities for handling assistant.embedded.v1.DeviceOp.
supportsMultiResponse (type: boolean(), default: nil) -
Specifies whether server can send a series of responses for a single
query. Example: Routines where multiple actions to be executed
one after another.
 timer (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Specifies
formProtoTimerCapability.t,
capabilities for handling on-device timers. The presence of this
field, even if empty, implies that the device supports timers.
ttsOutput (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Specifies
formProtoTtsOutputCapability.t,
whether client supports receiving DeviceAction.tts_output.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInlinedActionCa
pability{
alarm:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoAlarmCapability.

t()
| nil,
responseLimits:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoResponseLimits.t
()
| nil,
supportSdkExecute: boolean() | nil,
supportedDeviceOps:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSupportedDeviceO

ps.t()
| nil,
supportsMultiResponse: boolean() | nil,

timer:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTimerCapability.
t()
| nil,
ttsOutput:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTtsOutputCapabil
ity.t()
| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoIntValueSpec
Attributes

maxValue (type: String.t, default: nil) -

minValue (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntValueSpec{
maxValue: String.t() | nil,

minValue: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoIntent
An intent configures the behavior of a device action for this device. Next
ID: 7

Attributes

argSpecs (type: %{optional(String.t) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoArgSpec.t},default: nil) - List of arguments
associated this intent. Each of which depends a template for the
expected argument.
executionConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoExecutionConfig.t, default: nil) - Instructions for the
routing of this Intent.
name (type: String.t, default: nil) - The name of the intent.
providedDataNames (type: list(String.t), default: nil) - List
of provided data names used by this intent. Note that some built-in
intents will not function properly without provided data, such as
action.intent.SwitchChannel or action.intent.AppSelector.
securityConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - Security
formProtoSecurityConfig.t,
configuration for this Intent.
triggerConditions (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantDevice
default: nil) - The
sPlatformProtoTriggerCondition.t),
conditions which must be met by the device before executing this
 Intent. More than one can be provided, in which case the conditions
operate with the "AND" operator, i.e. the first condition which is
failed will be used to restrict the execution of this Intent.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntent{
argSpecs:
%{
optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoArgSpec.t()
}
| nil,
 executionConfig:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionConfig.
t()
| nil,
name: String.t() | nil,
providedDataNames: [String.t()] | nil,
securityConfig:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSecurityConfig.t
()
| nil,
triggerConditions:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTriggerCondition

.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoInternalCapability
Capabilities that may only be set internally. Only internal callers (i.e.
Googlers or Google owned projects) will be able to set these, thanks to
go/assistant-device-model-package-ownership.

Attributes

allowedAssistantSdkAuthProjectIds (type: list(String.t),

default: nil) - When using the Assistant SDK (Embedded
Assistant API), the project id used to authenticate the gRPC request
is checked and must match against the project id of the Device
Model. We will additionally allow the project ids listed in the
device model here to be let through. See
https://docs.google.com/document/d/1InAczpQJs6LCH1l-
-2yy67JM9hsBJbiL57fusnL3A8A
appCapabilitiesFromDeviceInstallApps (type: boolean(),
default: nil) - Load the assistant.api.AppCapabilities from
DEVICE_INSTALLED_APP footprint corpus. See go/edoras-
geller.
cloudDeviceActionEndpoint (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoCloudEndpoint.t, default: nil) - Uses this endpoint for
device action fulfillment when there's no endpoint in
syndication_metadata. 1p surfaces/devices such as telephone can
enable this for its cloud action fulfillment without enabling the
whole syndication experience.
deviceActionsEligibleForHighConfidence (type: boolean(),
default: nil) - Signals that the model will have updated ranking
behavior as described in
https://docs.google.com/document/d/1SN_AgadRr_cdIrFe-
qgRbIX2J1sOE7lcRXAvM1GUPoU.
forceSignIn (type: boolean(), default: nil) - Make Google
sign-in mandatory for using Google Assistant on the device. (This
bit is initially added for Samsung TV.)
forceThirdPartyDeviceIdForDeviceLookup (type: boolean(),
default: nil) - When looking up device (for example for disclosure
consent check), then always use the third party device id for lookup
instead of any other device id which would normally have higher
precedence, such as cast_device_id.
forceTransactionsAuthentication (type: boolean(), default:
nil) - Adds "transactions.AUTHENTICATION" for car
automation probers. Since the probers run as Assistant SDK
requests, voice match always fails for car automation requests, so
we add this client op as a hack to allow probers to appear as
personal devices and bypass voice match. See b/137221645.
hasCustomSearchResultsRendering (type: boolean(), default:
nil) - Signals that this device can "render" raw search results even
with no screen (e.g., using a text reader). If this is true, fallback
search results can be returned as a custom device action in a
SearchResults message.
http://google3/assistant/embedded/proto_translation/utils/proto/sear
ch_results.proto
overrideProjectIdForDeviceLookup (type: String.t, default:
nil) - When looking up device (for example for disclosure consent
check), use this project id as part of the primary key for the device
lookup (i.e. instead of the device_config.agent_id.) The precedence
is as follows: 1) this field, if set for the device's device model 2)
device_config.agent_id 3) device_model.project_id
stadiaAssistantConfig (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoInternalCapabilityStadiaAssistantConfig.t,
default: nil) -
 (type: boolean(), default: nil) -
telephoneAttribution
Telephone server is able to send attribution to user feature phone.
See go/telephone-attribution.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInternalCapabil
ity{
allowedAssistantSdkAuthProjectIds: [String.t()] | nil,
appCapabilitiesFromDeviceInstallApps: boolean() | nil,
cloudDeviceActionEndpoint:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudEndpoint.t(
 )
| nil,
deviceActionsEligibleForHighConfidence: boolean() | nil,
forceSignIn: boolean() | nil,

forceThirdPartyDeviceIdForDeviceLookup: boolean() | nil,

forceTransactionsAuthentication: boolean() | nil,
hasCustomSearchResultsRendering: boolean() | nil,

overrideProjectIdForDeviceLookup: String.t() | nil,

stadiaAssistantConfig:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInternalCapabili

tyStadiaAssistantConfig.t()
| nil,
telephoneAttribution: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoInternalCapabilityStadiaAssista
ntConfig
The StadiaAssistantConfig. This field should only be set if the device
model is a Stadia.

Attributes

stadiaPlatform (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInternalCapabil
ityStadiaAssistantConfig{
stadiaPlatform: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaNextCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaNextCapabi
lity{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaPauseCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPauseCapab
ility{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaPlayMediaCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPlayMediaC
apability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaPreviousCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPreviousCa
pability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaResumeCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaResumeCapa

bility{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaShowControlsCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaShowContro
lsCapability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoMediaStopCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaStopCapabi
lity{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoOptionValueSpec
Attributes

values (type: list(String.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoOptionValueSpec
{
values: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoProvidedData
Provided data which augments the device action capabilities. Some built-
in intents may require additional configuration to be provided. One
example could be the list of channels available for the
action.intent.SelectChannel intent.

Attributes

name (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProvidedData{
name: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoProviderFulfillCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProviderFulfill
Capability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoProviderOpenCapability
Attributes

clientOpProperty (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOp
PropertiesProviderOpenClientOpProperty.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProviderOpenCap
ability{
clientOpProperty:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesProviderOpenCli
entOpProperty.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoResponseLimits
Specifies the size limits on responses receivable by the client.

Attributes

maxAssistResponseSizeBytes (type: integer(), default: nil) -

Max size in bytes of the total serialized AssistResponse receivable
by the client. If response exceeds this max, response may be
modified by the server.
maxDisplayLinesBytes (type: integer(), default: nil) -
Maximum size in bytes (not characters) of text the display can
handle (which may be different from how much the display can
show at a time due to scrolling).
maxSuggestionChipBytes (type: integer(), default: nil) -
Maximum size in bytes (not characters) for each suggestion chip.
maxSuggestionChips (type: integer(), default: nil) -
Maximum number of suggestion chips the device can handle to
display.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoResponseLimits{
maxAssistResponseSizeBytes: integer() | nil,
maxDisplayLinesBytes: integer() | nil,
maxSuggestionChipBytes: integer() | nil,
maxSuggestionChips: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoSecurityConfig
Encapsulates security configuration for a single intent of a device model.

Attributes

authMechanismForRemoteRequests(type: String.t, default:

nil) - Specifies auth mechanism to be used upon remote request
for device action.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSecurityConfig{
authMechanismForRemoteRequests: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoSendChatMessageCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSendChatMessage
Capability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoSupportedDeviceOps
This message will specify supports for fields in
|assistant.embedded.v1.DeviceOp|, for a device model package. See
go/easi-client-op2 for more info. Next ID: 19

Attributes

callCall (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) - |call_call|
formProtoCallCallCapability.t,
specifies the support for the call.CALL clientop, and the
corresponding call_call field in assistant.embedded.v1.DeviceOp.
clientReconnect (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoClientReconnectCapability.t,
|client_reconnect| indicates support for client.RECONNECT using
assistant.embedded.v1.DeviceOp. There is an alternative
API/capability for client.RECONNECT specified in
RoutineCapability.supports_reconnect. Client should choose
between this and RoutineCapability but not both.
coreDismissAssistant (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoCoreDismissAssistantCapability.t,
[core_dismiss_assistant] specifies the support for
core.DISMISS_ASSISTANT client_op and the corresponding
core_dismiss_assistant field in assistant.embedded.v1.DeviceOp.
deviceModifySetting (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
 default: nil) -
formProtoDeviceModifySettingCapability.t,
|device_modify_setting| specifies the support for
device.MODIFY_SETTING client_op, and the corresponding
device_modify_setting field in assistant.embedded.v1.DeviceOp.
deviceTakePhoto (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoDeviceTakePhotoCapability.t,
[device_take_photo] specifies the support for the
device.TAKE_PHOTO clientop, and the corresponding
device_take_photo field in assistant.embedded.v1.DeviceOp.
executionWait (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoExecutionWaitCapability.t,
|execution_wait| specifies the support for execution.WAIT
client_op, and the corresponding execution_wait field in
assistant.embedded.v1.DeviceOp.
getHealthObservation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoGetHealthObservationCapability.t,
|get_health_observation| specifies the support for
get_health_observation client_op, and the corresponding
get_health_observation field in assistant.embedded.v1.DeviceOp.
mediaNext (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaNextCapability.t, default: nil) -
mediaPause (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaPauseCapability.t, default: nil) -
mediaPlayMedia (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaPlayMediaCapability.t, default: nil) -
mediaPrevious (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaPreviousCapability.t, default: nil) -
mediaResume (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaResumeCapability.t, default: nil) -
mediaShowControls (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaShowControlsCapability.t, default: nil) -
mediaStop (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoMediaStopCapability.t, default: nil) -
providerFulfill (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoProviderFulfillCapability.t,
|provider_fulfill| specifies the support for provider.FULFILL
client_op, and the corresponding provider_fulfill field in
assistant.embedded.v1.DeviceOp.
providerOpen (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoProviderOpenCapability.t,
|provider_open| specifies the support for provider.OPEN client_op,
and the corresponding provider_open field in
assistant.embedded.v1.DeviceOp.
sendChatMessage (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoSendChatMessageCapability.t,
|send_chat_message| specifies the support for the
chat_message.SEND clientop, and the corresponding
send_chat_message field in assistant.embedded.v1.DeviceOp.
uiShowInterpreter (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
default: nil) -
formProtoUiShowInterpreterCapability.t,
|ui_show_interpreter| specifies the support for
ui.SHOW_INTERPRETER client_op, and the corresponding
ui_show_interpreter field in assistant.embedded.v1.DeviceOp.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSupportedDevice
Ops{
callCall:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCallCallCapabili
ty.t()
| nil,
clientReconnect:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoClientReconnectC
apability.t()
| nil,
 coreDismissAssistant:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCoreDismissAssis
tantCapability.t()
| nil,
deviceModifySetting:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceModifySett
ingCapability.t()
| nil,
deviceTakePhoto:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceTakePhotoC

apability.t()
| nil,
executionWait:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionWaitCap
ability.t()
| nil,
getHealthObservation:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoGetHealthObserva
tionCapability.t()
| nil,
mediaNext:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaNextCapabil

ity.t()
| nil,
mediaPause:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPauseCapabi
lity.t()
| nil,
mediaPlayMedia:
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPlayMediaCa
pability.t()
| nil,
mediaPrevious:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPreviousCap

ability.t()
| nil,
mediaResume:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaResumeCapab
ility.t()
| nil,

mediaShowControls:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaShowControl
sCapability.t()
| nil,
mediaStop:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaStopCapabil
ity.t()
| nil,

providerFulfill:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProviderFulfillC
apability.t()

| nil,
providerOpen:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProviderOpenCapa
bility.t()
| nil,
sendChatMessage:
 GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSendChatMessageC

apability.t()
| nil,
uiShowInterpreter:

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoUiShowInterprete
rCapability.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoTimerCapability
Capability with regard to support of timers by the client.

Attributes

maxSupportedExtendedTimerDuration (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration
default: nil) - Maximum extended timer duration supported by
.t,
the client. The extended timer duration is the total start-to-finish
duration after an AddTimeToTimer operation. E.g. if a user sets a
timer for 30 minutes, and later adds 10 minutes, the extended
duration is 40 minutes. Zero or unset indicates no maximum limit.
maxSupportedTimerDuration (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration
.t,default: nil) - Maximum timer duration supported by the
client. Zero or unset indicates no maximum limit.
maxSupportedTimers (type: integer(), default: nil) -
Maximum number of timers that can be created on the client. Zero
or unset indicates no maximum limit.
supportsMutateAction (type: boolean(), default: nil) -
Whether the client supports the MUTATE timer action. If this is
false, mutate operations may be handled by sending a pair of
REMOVE and CREATE timer actions to replace the existing timer
instead of mutating it.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTimerCapability
{
maxSupportedExtendedTimerDuration:

GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration.t() | nil,
maxSupportedTimerDuration:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration.t() | nil,
maxSupportedTimers: integer() | nil,

supportsMutateAction: boolean() | nil

}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoTriggerCondition
A TriggerCondition is described as a set of states which must be met by
the device. It also includes instructions to the Assistant on what kind of
response to execute when the condition is not met.

Attributes

requiredStateValues (type: %{optional(String.t) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlat
formProtoArgSpec.t}, default: nil) - The map of state keys along
with their values which must be returned by the device, for example
to start the dishwasher you may require states: {"door":
"CLOSED", "detergent_status": "READY"}.
simpleTts (type: String.t, default: nil) - A simple TTS to play.
status (type: String.t, default: nil) - Refers to a defined
ConditionalResult keyed by its status. It could be a built-in or
custom ConditionalResult for this Intent. Note: the states provided
by the device MUST contain all of the states required by the
ConditionalResult.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTriggerConditio
n{
requiredStateValues:
%{

optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoArgSpec.t()
}
| nil,
simpleTts: String.t() | nil,
status: String.t() | nil

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoTtsOutputCapability
Capabilities with regard to support of outputting TTS.

Attributes

supportsStructuredTts(type: boolean(), default: nil) -

Specifies whether client supports out-of-band TTS synthesis. When
this is enabled, client could receive TTS request message in
SpeechOutputArgs.structured_tts which it can then use to
make request to S3 for synthesizing TTS audio.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTtsOutputCapabi

lity{
supportsStructuredTts: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoUiShowInterpreterCapability
Attributes

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
 %GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoUiShowInterpret
erCapability{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantDevicesPlatformPr
otoUnderstandingConfig
Specifies the NLU level that Google performs, which determines the
request format sent to the 3P cloud.

Attributes

nluLevel(type: String.t, default: nil) - Specifies the NLU

level for the intent.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoUnderstandingCo

nfig{
nluLevel: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsAllMediaStrea
mLog
Attributes

streams (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMe
diaStreamLog.t), default: nil) - All active media streams while
the user issues the query.
targetStream (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaSt
reamLog.t,default: nil) - The stream selected by stream transfer
logic to be transferred to another device. It will be empty for other
features. Target_stream is different from target_device since
target_stream could have multiple devices.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAllMediaStreamLog{

streams:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaStreamLog.t()] | nil,
targetStream:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaStreamLog.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsAmbiguousTa
rgetDeviceLog
This message logs details on ambiguous device targeting logic. 1. It first
takes a list of ambiguous devices 2. Then applies two filters: structure
filter and playability filter. 3. If more than one device remains, it tiggers
DeviceSelectionDialog to let the user pick one device.

Attributes

ambiguousDeviceIndex (type: list(integer()), default: nil) -

Device index of the initial ambiguous devices. The device index in
this message is consistent with the device index in DeviceInfoLog.
It would be used to track more detailed information of a device if
needed.
devicesAfterPromoters (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
viceInfoLog.t), default: nil) - DeviceInfo for devices after the
filters and promoters. - When device targeting is only configured
for single target, these are ambiguous devices that would have been
the output of Lumos. Downstream may perform extra check before
disambiguation dialog. For example, Media Initiation checks
playability for devices. The output here is before the check. - When
configured for multi-target, these are just the target devices. For
privacy consideration, we may only log device id field inside.
finalTargetDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
default: nil) - the final targeted device selected by
nfoLog.t,
playability filter or DeviceSelectionDialog
 (type: list(integer()),
playabilityFilteredDevicesIndex
default: nil) - Device index of the devices after playability filter
puntInfoLog (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAm
biguousTargetDeviceLogPuntInfoLog.t), default: nil) - When
there is no qualified devices after playability check, it would
populate punt_info below. If all devices are filtered out for the same
reason, there would only be one item. Otherwise, there will be
multiple items.
structureFilteredDeviceIndex (type: list(integer()),
default: nil) - Device index of the devices after structure filter

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLog{
ambiguousDeviceIndex: [integer()] | nil,
devicesAfterPromoters:

[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t()] | nil,
finalTargetDevice:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
playabilityFilteredDevicesIndex: [integer()] | nil,
puntInfoLog:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLogPuntInfo
Log.t()
]
| nil,
structureFilteredDeviceIndex: [integer()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsAmbiguousTa
rgetDeviceLogPuntInfoLog
PuntInfoLog is used to log why devices get filtered out during media
content playability check. It contains media excuse, provider mid and
also index of devices filtered by them.

Attributes

(type: list(integer()), default: nil) - Index of

deviceIndex
devices that have the same punt info during playability check, i.e.
same media_excuse and provider_mid.
mediaExcuse (type: integer(), default: nil) - Excuse for media
action triggering. See:
assistant/verticals/media/proto/media_excuse.proto.
providerMid (type: String.t, default: nil) - Provider id that the
excuse belongs to. This is the KG MID of the provider, e.g.,
"/m/09jcvs" for Youtube.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLogPuntInf
oLog{
deviceIndex: [integer()] | nil,

mediaExcuse: integer() | nil,

providerMid: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsAvailableDevi
ceAndCtfContextDiffLog
A list of per-device contexts and their respective diffs between
AvailableDevice and CTF.

Attributes

localNetworkIdDiff (type: String.t, default: nil) - The diff

between AvailableDevice and CTF for the local network ID of the
device.
locationFeatureDiff (type: String.t, default: nil) - The diff
between AvailableDevice and CTF for the feature proto of the
location of the device.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailableDeviceAndCtfContextDif

fLog{
localNetworkIdDiff: String.t() | nil,
locationFeatureDiff: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsAvailableDevi
cesLog
Contains the available devices in DeviceTargetingContext.

Attributes

availableDeviceInfoLog (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
viceInfoLog.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailableDevicesLog{

availableDeviceInfoLog:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nDeviceContactInfoLog
This is the log version of
apps.people.oz.external.mergedpeopleapi.DeviceContactInfo Next ID: 2

Attributes

rawContactInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCo
default: nil) - This
mmunicationRawDeviceContactInfoLog.t),
list provides account information from the raw contact which is the
source of this field.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationDeviceContactInfoL
og{
rawContactInfo:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationRawDeviceContactInf
oLog.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nFuzzyNgramMatchLog
This is the log version of fuzzy ngram match results that's used for
generating the best fuzzy match. Next ID: 3

Attributes

(type: number(), default: nil) -

relativeCost
type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationFuzzyNgramMatchLog
{
relativeCost: number() | nil,
type: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nGoogleAccountProvenance
From google3/quality/qrewrite/proto/account_provenance.proto;l=14 We
need to copy this as the above proto has Enum field which is not
compatible between proto2 and proto3. go/proto2-versus-proto3#enums

Attributes

email (type: String.t, default: nil) -

gaiaId (type: String.t, default: nil) -
isDasherAccount (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationGoogleAccountProve
nance{
email: String.t() | nil,
gaiaId: String.t() | nil,
isDasherAccount: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nPersonMetadataLog
This is the log version of
apps.people.oz.external.mergedpeopleapi.PersonMetadata Next ID: 2

Attributes

deviceContactInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCo
mmunicationDeviceContactInfoLog.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonMetadataLog{
deviceContactInfo:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationDeviceContactInfoLo
g.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nPersonalContactDataLog
Contact meta data. Next ID: 31

Attributes

accountProvenance (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommuni
cationGoogleAccountProvenance.t, default: nil) - Google
AccountProvenance of the contact.
commonNameAliasConfidence (type: number(), default: nil) -
Populated if matched_name_type is GIVEN_NAME_ALIAS or
FULL_NAME_ALIAS.
conceptId (type: String.t, default: nil) - Concept id for
relationships in English, e.g. "Mother" for all non-English locales.
It's only populated for source = RELATIONSHIP.
deviceContactAttributes (type: list(integer()), default:
nil) - Integer value corresponding to
DeviceContactExtraMetadata.Attribute enum.
http://google3/social/graph/wire/proto/merged_person.proto?
l=933&rcl=320308954
emailIdCount (type: integer(), default: nil) - # emails stored
for the contact.
fuzzyNgramMatch (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCo
default: nil) - Populate
mmunicationFuzzyNgramMatchLog.t),
only if ContactRecognitionAlternate.Source is
'FUZZY_CONTACT_MATCH'.
gaiaId (type: String.t, default: nil) - Contact owner's gaia id
from
cs/symbol::symbol:quality_qrewrite.PersonalContactData.shared_c
ontact_owner_gaia_id. Only populated for is_shared = true and non
sign-out mode and user is not the owner of the contact(shared
contact from other user). This field is not being logged in P2.
isContactFromSecondaryAccount (type: boolean(), default:
nil) - Boolean value indicating whether selected contact is from
different account than the logged in account.
isExactMatch (type: boolean(), default: nil) - If the contact is
matched exactly from the query name.
isShared (type: boolean(), default: nil) - If this is a shared
contact. This is true in 2 cases: - User is calling their own contacts
that have been marked as shared. - User is calling shared contacts
from some other user's contact list. This field is not being logged in
P2.
isTransliteratedMatch (type: boolean(), default: nil) -
Indicate the contact matches the transliterated query.
isVanityContact (type: boolean(), default: nil) - True if the
contact is a vanity contact(has email = user's email address).
isVisibleToGuestsRelationship (type: boolean(), default:
nil) - If the lookup was done using relationship which is visible to
guests. This value will only be set if lookup was done using
relationship. E.g. user has a guest relationship (doctor) -> (John)
And user says "call doctor", then this value will be true.
matchedNameType (type: String.t, default: nil) - The matched
name type of a contact candidate.
matchedRecognitionAlternateName (type: String.t, default:
nil) - Alternate recognition term which was used to match this
contact.
matchedStarlightLookupName (type: list(String.t), default:
nil) - Ngram matched by starlight lookup for fuzzy matching in
fulfillment. We need this to analyze how many contacts are returned
by starlight lookup that is not matched by fuzzy matching. For
example, "Komal Dear" is matched to "Komal Dr" by fuzzy match.
When doing starlight lookup, "Komal" and "Dr" will be looked up
separately. So "Dr xxx" will also be returned. We want to see how
often this happens.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommuni
cationPersonMetadataLog.t, default: nil) - PersonMetadata of
the selected contact.
nameMatchedContactIndex (type: list(integer()), default:
nil) - The indices of the contact in |candidate_contact| whose
name matches the |selected_contact_data|. |candidate_contact|:
http://google3/logs/proto/assistant/contact.proto?
l=111&rcl=306283376 |selected_contact_data|:
http://google3/logs/proto/assistant/contact.proto?
l=108&rcl=306283376
originalQueryName (type: String.t, default: nil) - The original
name in the query as transcribed by ASR.
phone (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCo
mmunicationPhoneLog.t), default: nil) - Information regarding
the phone endpoints of the selected contact. Currently it is only
logged for selected candidate.
phoneNumberCount (type: integer(), default: nil) - #
phone_numbers stored for the contact.
pkgReferenceType (type: String.t, default: nil) - Encodes if
pkg_person was resolved via a name or relationship reference.
recognitionAlternateScore (type: number(), default: nil) -
Populate only if ContactRecognitionAlternate.Source is not NONE.
recognitionAlternateSource (type: String.t, default: nil) -
Recognition alternative source type. If not none, then it indicates
the personal contact data is alternative and how the alternative is
fulfilled.
relationshipMemoryCount (type: integer(), default: nil) - The
number of resolved relationship names and contact pointers from
Assistant Memory.
 selectedPhone (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommuni
cationPhoneLog.t, default: nil) - Information regarding the
selected phone endpoint. Currently it is only logged for selected
candidate.
shortcutContactInfo (type:
GoogleApi.ContentWarehouse.V1.Model.MajelContactInformat
ionShortcutInformation.t, default: nil) - Shortcut information
of the contact.
source (type: String.t, default: nil) - The contact source of a
contact candidate.
systemContactGroupId (type: list(integer()), default: nil) -
Integer value corresponding to SystemContactGroup enum.
http://google3/social/graph/wire/proto/merged_person.proto?
l=3151&rcl=320308954
whatsappPhoneNumberCount (type: integer(), default: nil) -
DEPRECATED. Use phone instead. Used before 2020-01-13.
Number of phone numbers annotated with Whatsapp.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonalContactDat
aLog{

accountProvenance:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationGoogleAccountProven
ance.t()

| nil,
commonNameAliasConfidence: number() | nil,
conceptId: String.t() | nil,
deviceContactAttributes: [integer()] | nil,

emailIdCount: integer() | nil,

fuzzyNgramMatch:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationFuzzyNgramMatchLog.
t()

]
| nil,
gaiaId: String.t() | nil,
isContactFromSecondaryAccount: boolean() | nil,
isExactMatch: boolean() | nil,
isShared: boolean() | nil,
isTransliteratedMatch: boolean() | nil,
isVanityContact: boolean() | nil,
isVisibleToGuestsRelationship: boolean() | nil,
matchedNameType: String.t() | nil,
 matchedRecognitionAlternateName: String.t() | nil,
matchedStarlightLookupName: [String.t()] | nil,
metadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonMetadataLog.t
()
| nil,
nameMatchedContactIndex: [integer()] | nil,

originalQueryName: String.t() | nil,

phone:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPhoneLog.t()
]
| nil,
phoneNumberCount: integer() | nil,
pkgReferenceType: String.t() | nil,
recognitionAlternateScore: number() | nil,

recognitionAlternateSource: String.t() | nil,

relationshipMemoryCount: integer() | nil,
selectedPhone:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPhoneLog.t()
| nil,
shortcutContactInfo:

GoogleApi.ContentWarehouse.V1.Model.MajelContactInformationShortcutInformation.t(
)
| nil,
source: String.t() | nil,

systemContactGroupId: [integer()] | nil,

whatsappPhoneNumberCount: integer() | nil
}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nPhoneLog
This is the log version of
apps.people.oz.external.mergedpeopleapi.Phone proto. Next ID: 3

Attributes

rawDeviceContactInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCo
mmunicationRawDeviceContactInfoLog.t), default: nil) - This
list provides account information from the raw contact which is the
source of this field.
type (type: String.t, default: nil) - Label for phone number in
the Contacts app. It can have standard values provided by the app
e.g. MOBILE, HOME, WORK etc, but users are allowed to modify.
So essentially it becomes user content.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPhoneLog{
rawDeviceContactInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationRawDeviceContactInf
oLog.t()
]
| nil,
type: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsCommunicatio
nRawDeviceContactInfoLog
This is the log version of
apps.people.oz.external.mergedpeopleapi.RawDeviceContactInfo proto.
Next ID: 3

Attributes

(type: String.t, default: nil) - Account type of

accountType
raw contact, e.g. "com.google" or "com.linkedin.android".

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationRawDeviceContactIn
foLog{

accountType: String.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDefaultDevice
Log
Log device info of default speaker and tv

Attributes

defaultSpeaker (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
nfoLog.t, default: nil) -
defaultTv (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
nfoLog.t,default: nil) -
sourceDeviceId (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog{

defaultSpeaker:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
defaultTv:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
sourceDeviceId: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDefaultDevice
sLog
Attributes

localDefaultDevices (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefault
DeviceLog.t,default: nil) -
nearbyDefaultDevices (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
faultDeviceLog.t), default: nil) - Default settings of nearby
devices.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDevicesLog{

localDefaultDevices:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog.t() | nil,

nearbyDefaultDevices:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDeviceAnnotat
ionLog
Device annotation mention from query

Attributes

deviceIdLog (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSe
ttingsDeviceIdLog.t),default: nil) - The identification of the
device. The logging version of the full DeviceId.
rawTextFromQuery (type: String.t, default: nil) - The raw text
mentioning a device from the query, such as "any tv".
type (type: String.t, default: nil) - The annotation type
mentioned in the query.
userDefinedName (type: String.t, default: nil) - The matched
device name set by the user, such as "big screen tv".

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceAnnotationLog{
deviceIdLog:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSettingsDeviceIdLog.t()]
| nil,
rawTextFromQuery: String.t() | nil,
type: String.t() | nil,
userDefinedName: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDeviceInfoLog
The information related to the device. Next ID: 19

Attributes

(type: String.t, default: nil) - Device

arbitrationDeviceId
identifier string for the current device used in the arbitration
service.
availableDeviceAndCtfContextDiff (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailab
leDeviceAndCtfContextDiffLog.t, default: nil) - A list of diffs
for the device's context between AvailableDevice and CTF.
connectivity (type: String.t, default: nil) -
deviceId (type: String.t, default: nil) - The identification of
the device. DeviceId (go/as-device-id) has multiple fields. To
consloidate it to a single to make dremel easier, we use the string
obtained by calling go/get-device-id.
deviceIdLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSetting
sDeviceIdLog.t, default: nil) - The identification of the device.
The logging version of the full DeviceId.
deviceIndex (type: integer(), default: nil) - We index linked
devices and log these index to avoid logging device_id.
device_index should always be a positive number or -1. -1 means
this device is not in homegraph.
deviceModelId (type: String.t, default: nil) - This is the
device_model_id field in device_settings proto. It has the same
value for the same type of devices. e.g. Sonos.Sonos One.S13
distance (type: String.t, default: nil) -
LINT.ThenChange(//depot/google3/assistant/context/proto/device_a
 rbitration.proto:EstimatedRelativeDistance)
eliminatingLumosProcessor (type: String.t, default: nil) -
The lumos processor which eliminated this device, if applicable
homeStructureId (type: String.t, default: nil) - The home
structure id of the device.
isRemote (type: boolean(), default: nil) -
isTethered (type: boolean(), default: nil) - This flag indicates
this is a non-local device that is tethered to local/originating device.
Tethered device is a special case of is_remote and typically used in
wearable scenarios. This is always false for local device and when it
is true, it implies is_remote is also true.
mediaCapabilities (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaCa
default: nil) -
pabilities.t,
mediaDeviceType (type: String.t, default: nil) -
name (type: String.t, default: nil) - User defined device name
sessions (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
viceMediaSessionLog.t),default: nil) - This field should be
populated only when there is at least one session on this device.
surfaceType (type: String.t, default: nil) - This field should
be populated only when the device is an Assistant device.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog{

arbitrationDeviceId: String.t() | nil,
availableDeviceAndCtfContextDiff:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailableDeviceAndCtfContextDiff
Log.t()
| nil,

connectivity: String.t() | nil,

deviceId: String.t() | nil,
deviceIdLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSettingsDeviceIdLog.t()

| nil,
deviceIndex: integer() | nil,
deviceModelId: String.t() | nil,

distance: String.t() | nil,

eliminatingLumosProcessor: String.t() | nil,
homeStructureId: String.t() | nil,
isRemote: boolean() | nil,
isTethered: boolean() | nil,
mediaCapabilities:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaCapabilities.t() | nil,

mediaDeviceType: String.t() | nil,

name: String.t() | nil,
sessions:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceMediaSessionLog.t()]
| nil,
 surfaceType: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDeviceMediaS
essionLog
Log about the media session on a device.

Attributes

deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sDeviceId.t,default: nil) -
mediaSessionType (type: String.t, default: nil) -

mediaType (type: String.t, default: nil) - The type of the media

session. If provider does not report this field, we ## compute it by
mapping provider type to media type. Here is the mapping:
|ProviderType |MediaItemMetadata.Type| |------------------------------
-------- |MUSIC |TRACK | |VIDEO |VIDEO | |LIVE_TV
|TV_CHANNEL | |AUDIOBOOK |AUDIO_BOOK | |PODCAST
|PODCAST_EPISODE | ## |LIVE_STREAMING|VIDEO |

(type: String.t, default: nil) - The playback

playbackState
states of the session.
providerMid (type: String.t, default: nil) - The KG mid of the
media provider.
supportedTransportControl (type: list(String.t), default:
nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceMediaSessionLog{
deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t() | nil,

mediaSessionType: String.t() | nil,

mediaType: String.t() | nil,
playbackState: String.t() | nil,
providerMid: String.t() | nil,
supportedTransportControl: [String.t()] | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDeviceSelectio
nLog
Contains information logged in target device selection. See go/improve-
device-targeting-logging for details. Next Id: 23

Attributes

allDefaultDevices (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
default: nil) - Default settings of all nearby
faultDeviceLog.t),
devices Deprecated, use default_devices_log instead.
allMediaStreamLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAllMedi
aStreamLog.t, default: nil) - Logs all active media sessions.
availableDevicesLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailab
leDevicesLog.t,default: nil) - The list of available_devices
as they appear in DeviceTargetingContext. This is very useful for
debugging diffs between GB and CMP since they have different
methods of populating the available_devices field.
counterfactualDeviceSelectionLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceS
default: nil) - DeviceSelectionLog for
electionLog.t,
counterfactual logging.
defaultDevices (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefault
default: nil) - Include default tv and default speaker
DeviceLog.t,
Deprecated, use all_default_devices below.
defaultDevicesLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefault
DevicesLog.t, default: nil) -
devicesStr (type: list(String.t), default: nil) - Temporaray
field for debugging ANDROID_AUTO multi_target_devices punt.
This will be removed once we identify the root cause.
inputErrorLog (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsIn
putErrorLog.t),default: nil) -
localDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
nfoLog.t,default: nil) - Now we just log the media sessions on
local device Deprecated, use NearbyDevicesLog::LocalDevice
instead.
logDataSource (type: String.t, default: nil) - Indicates which
library populated the device_selection_log for this query.
mediaFocus (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFo
default: nil) - The Media Focus information. This
cusInfoLog.t,
field should be populated only when there is a Media Focus.
Deprecated, use media_focuses below instead.
mediaFocusesLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFo
default: nil) - Media focuses on all devices.
cusesLog.t,
nearbyDevicesLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsNearbyD
default: nil) - All nearby devices and local device.
evicesLog.t,
queryAnnotation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsQueryAn
default: nil) - This should log the query
notationLog.t,
annotation features found in the device, such as the device
annotation, the room annotation, and the structure annotation from
the query.
 selectionResult (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceS
electionResultLog.t, default: nil) - The result of device
selection.
testCodes (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
viceTargetingTestCode.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceSelectionLog{

allDefaultDevices:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog.t()]
 | nil,
allMediaStreamLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAllMediaStreamLog.t() | nil,
availableDevicesLog:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailableDevicesLog.t()
| nil,
counterfactualDeviceSelectionLog: t() | nil,
defaultDevices:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog.t() | nil,
defaultDevicesLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDevicesLog.t() | nil,
devicesStr: [String.t()] | nil,
inputErrorLog:

[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsInputErrorLog.t()] | nil,
localDevice:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
logDataSource: String.t() | nil,
mediaFocus:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusInfoLog.t() | nil,
mediaFocusesLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusesLog.t() | nil,
nearbyDevicesLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsNearbyDevicesLog.t() | nil,
queryAnnotation:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsQueryAnnotationLog.t()
| nil,
selectionResult:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceSelectionResultLog.t()
| nil,

testCodes:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceTargetingTestCode.t()
]
| nil
}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDeviceSelectio
nResultLog
Log the selection result. Next ID: 11

Attributes

ambiguousTargetDevices (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguo
usTargetDeviceLog.t, default: nil) - Deprecated, please use
qualified_devices.
deviceSelectionDecisionSummary (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaDe
viceSelectionDecisionSummary.t, default: nil) -
deviceTargetingErrorType (type: String.t, default: nil) -
finalLumosStage (type: String.t, default: nil) - The class
name for the final filter/promoter used by Lumos for device
targeting. This filter or promoter runs for all users, and contains no
data specific to the individual user.
lowConfidenceTargetDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLowConf
idenceTargetDeviceLog.t, default: nil) -
////////////////////////////////////////////////////////////////////////// Ambiguous
Results: the library failed to select the final target device(s) but it
narrows down to a set of devices which are all valid target device
candidates. The client needs to do further disambiguation, e.g.,
giving a dialog or having customized logic. The low confidence
target device means the library falied to select the target device but
it picked two devices for the client to do disambiguation.
 mediaFocusSelectionErrorType (type: String.t, default: nil) -
////////////////////////////////////////////////////////////////////////// This field log
the error while selecting target device in media_focus_selector.
processorInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLu
mosProcessorInfo.t),default: nil) - The log for each stage of
Lumos, showing the number of eliminated devices from each
processor.
qualifiedDevices (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguo
usTargetDeviceLog.t, default: nil) - We will apply several filters
and dialogs to select a target device if media_focus_selector fail to
select one. This field should log the devices left after each filter or
dialog. It also log the detailed info of the final target device.
singleTargetDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
nfoLog.t, default: nil) -
////////////////////////////////////////////////////////////////////////// Unambiguous
Results: the library successfully selected the final target device(s)
and no further disambiguation is needed. Deprecated, please use
target_device.
targetDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsTargetD
eviceLog.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceSelectionResultLog{
ambiguousTargetDevices:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLog.t()
| nil,
deviceSelectionDecisionSummary:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaDeviceSelectionDecisionSumm
ary.t()
| nil,

deviceTargetingErrorType: String.t() | nil,

finalLumosStage: String.t() | nil,
lowConfidenceTargetDevice:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLowConfidenceTargetDeviceLog.t()

| nil,
mediaFocusSelectionErrorType: String.t() | nil,
processorInfo:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLumosProcessorInfo.t()]
| nil,
qualifiedDevices:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLog.t()
 | nil,
singleTargetDevice:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
targetDevice:

GoogleApi.ContentWarehouse.V1.Model.AssistantLogsTargetDeviceLog.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsDeviceTargeti
ngTestCode
Test code is used to track special events happening in Device Targeting
Library. Next Id: 2

Attributes

type (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceTargetingTestCode{
type: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsInputErrorLo
g
Attributes

errorCode (type: integer(), default: nil) -

errorType (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsInputErrorLog{
errorCode: integer() | nil,
errorType: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsLowConfidenc
eTargetDeviceLog
Represents the case where there is a target device with low confidence so
that the library didn't directly target it. Instead, the library returns the low
confidence target device and the fallback device for the client to decide
to either trigger a dialog to disambiguate or select one of them based on
extra business logic. Next ID: 3

Attributes

fallbackDeviceLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
default: nil) - The fallback device.
nfoLog.t,
lowConfTargetDeviceLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
nfoLog.t, default: nil) - The selected low confidence focus
device.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLowConfidenceTargetDeviceLog{

fallbackDeviceLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
lowConfTargetDeviceLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsLumosProcess
orInfo
Attributes

devicesAfterRun(type: integer(), default: nil) - Number of

candidate devices after this stage is run.
devicesBeforeRun (type: integer(), default: nil) - Number of
candidate devices before this stage is run.
processorName (type: String.t, default: nil) - Name of the
processor for this stage.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLumosProcessorInfo{
devicesAfterRun: integer() | nil,

devicesBeforeRun: integer() | nil,

processorName: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsMediaCapabil
ities
Attributes

canReceiveRemoteAction (type: boolean(), default: nil) -

hasScreen (type: boolean(), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaCapabilities{
canReceiveRemoteAction: boolean() | nil,
hasScreen: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsMediaDeviceS
electionDecisionSummary
A summary of the reasons that we chose a certain target device.

Attributes

deviceSelectionPreferenceUsed (type: String.t, default: nil)

-
deviceSelectionReason (type: String.t, default: nil) -
miscSelectionSignal (type: list(String.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaDeviceSelectionDecisionSum
mary{
deviceSelectionPreferenceUsed: String.t() | nil,
deviceSelectionReason: String.t() | nil,
miscSelectionSignal: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsMediaFocusIn
foLog
The information related to Media Focus. TODO(b/138952173)
Deprecate MediaFocusState in
logs/proto/majel_gws/media_action_triggering_info.proto and
assistant/verticals/media/proto/target_device_info.proto

Attributes

currentFocusDurationSec(type: integer(), default: nil) -

How long the device is in focus so far
dialogTriggered (type: boolean(), default: nil) -
TODO(b/134944092) Log MediaFocusDialogTrigger Enum in
focus_status.
focusDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
nfoLog.t,default: nil) -
LINT.ThenChange(//depot/google3/logs/proto/majel_gws/media_ac
tion_triggering_info.proto) The focus device.
mediaFocusState (type: String.t, default: nil) - The media
focus state at the time of the request.
sourceDeviceId (type: String.t, default: nil) - The source
device of media focus.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusInfoLog{

currentFocusDurationSec: integer() | nil,

dialogTriggered: boolean() | nil,
focusDevice:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
mediaFocusState: String.t() | nil,
sourceDeviceId: String.t() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsMediaFocuses
Log
Following are the MDA compatible loggings for media focus, default
settings and nearby devices.

Attributes

dialogTriggered(type: boolean(), default: nil) -

localMediaFocus (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFo
cusInfoLog.t,default: nil) -
mediaFocuses (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMe
default: nil) - Deprecated, use
diaFocusInfoLog.t),
nearby_media_focuses instead.
nearbyMediaFocuses (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMe
diaFocusInfoLog.t), default: nil) - MediaFouces found on
nearby devices.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusesLog{

dialogTriggered: boolean() | nil,
localMediaFocus:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusInfoLog.t() | nil,
mediaFocuses:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusInfoLog.t()]

| nil,
nearbyMediaFocuses:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusInfoLog.t()]

| nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsMediaStream
Log
Media stream is composed of a media session and one or more devices
which are hosting (playing) the session. Usually, a session is only hosted
by one devcie. However, with cast group or stream transfer/expansion, a
session could be hosted by multiple devices, which are playing the same
session simultaneously.

Attributes

deviceIndex (type: list(integer()), default: nil) - The device

index in this message is consistent with the device index in
DeviceInfoLog. This field refers to the devices that hosting the
session.
session (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceM
ediaSessionLog.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaStreamLog{

deviceIndex: [integer()] | nil,
session:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceMediaSessionLog.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsNearbyDevice
sLog
Attributes

deviceArbitrationCreationTimestampMs (type: String.t,

default: nil) - The timestamp that DeviceArbitration is created in
milliseconds.
deviceTargetingInputCreationTimestampMs (type: String.t,
default: nil) - The timestamp that DeviceTargetingInput is built in
milliseconds.
eliminatedByFurtherDistance (type: integer(), default: nil) -
eliminatedByLocalClosest (type: integer(), default: nil) -
eliminatedByUnknownDifferentRoom (type: integer(), default:
nil) -
eliminatedByUnregisteredDevice (type: integer(), default:
nil) -
localDevice (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceI
default: nil) -
nfoLog.t,
nearbyDevices (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
default: nil) -
viceInfoLog.t),
numClosestDevices (type: integer(), default: nil) -
numEquallyCloseDevices (type: integer(), default: nil) -
numFurtherDevices (type: integer(), default: nil) -
numHearingDevices (type: integer(), default: nil) -
numUnknownDistanceDevices (type: integer(), default: nil) -
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsNearbyDevicesLog{

deviceArbitrationCreationTimestampMs: String.t() | nil,
deviceTargetingInputCreationTimestampMs: String.t() | nil,

eliminatedByFurtherDistance: integer() | nil,

eliminatedByLocalClosest: integer() | nil,
eliminatedByUnknownDifferentRoom: integer() | nil,
eliminatedByUnregisteredDevice: integer() | nil,
localDevice:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t() | nil,
nearbyDevices:

[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t()] | nil,

numClosestDevices: integer() | nil,

numEquallyCloseDevices: integer() | nil,
numFurtherDevices: integer() | nil,
 numHearingDevices: integer() | nil,
numUnknownDistanceDevices: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsProviderAnno
tationLog
Provider annotation annotated from the query. These fields contain the
detailed information for the provider. (e.g. for Youtube, package_names
contains "com.google.android.youtube", localized_names contains
"youtube", and lang contains "en" from "en-US" which depends on user's
setting.)

Attributes

lang (type: String.t, default: nil) -

localizedNames (type: list(String.t), default: nil) -
packageNames (type: list(String.t), default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsProviderAnnotationLog{
lang: String.t() | nil,
localizedNames: [String.t()] | nil,

packageNames: [String.t()] | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsQueryAnnotat
ionLog
Log about the query requirements

Attributes

deviceAnnotation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceA
default: nil) - Deprecated, please use
nnotationLog.t,
room_annotations.
deviceAnnotations (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
viceAnnotationLog.t),default: nil) - Log the device
annotations mentioned in the query.
providerAnnotation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsProvide
default: nil) - Log the provider annotations
rAnnotationLog.t,
annotated from the query.
roomAnnotation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsRoomAnn
default: nil) - TODO(b/171250187) Deprecates
otationLog.t,
the optional RoomAnnotationLog and DeviceAnnotationLog.
Deprecated, please use device_annotations.
roomAnnotations (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsRo
omAnnotationLog.t), default: nil) - Log the room annotations
mentioned in the query.
structureAnnotations (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSt
 default: nil) - Log the structure
ructureAnnotationLog.t),
annotations mentioned in the query.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsQueryAnnotationLog{
deviceAnnotation:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceAnnotationLog.t()
| nil,
deviceAnnotations:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceAnnotationLog.t()]
| nil,

providerAnnotation:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsProviderAnnotationLog.t()
 | nil,
roomAnnotation:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsRoomAnnotationLog.t() | nil,
roomAnnotations:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsRoomAnnotationLog.t()]

| nil,
structureAnnotations:
[
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsStructureAnnotationLog.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsReminderLog
Annotate a single reminder instance.

Attributes

createdSecondsAgo (type: String.t, default: nil) - The

reminder is created N seconds ago. This helps tracking how the user
issues follow-up actions after reminder is created. For example,
whether the user likes to issues another [show reminders] query
right after reminder is created?
retrievedRankingClass (type: integer(), default: nil) - If the
reminder is retrieved by a ranking class (see go/opa-reminders-
ranker), this will be populated with the class info. Refer to
assistant.productivity.ReminderRankingClass.RankingType. Since
that proto is in proto2 format, we can only wire by int type.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsReminderLog{

createdSecondsAgo: String.t() | nil,
retrievedRankingClass: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsRoomAnnotati
onLog
Room annotation mentioned in query.

Attributes

rawTextFromQuery (type: String.t, default: nil) - The raw text

mentioning a room from the query, such as "my living room".
roomCount (type: integer(), default: nil) - The number of
rooms annotated, if there are multiple structures. They are
guaranteed to have the same text_from_query and name due to
exact matching.
roomId (type: list(String.t), default: nil) - The identification
of the room.
type (type: String.t, default: nil) - The annotation type
mentioned in the query.
userDefinedName (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsRoomAnnotationLog{

rawTextFromQuery: String.t() | nil,

roomCount: integer() | nil,

roomId: [String.t()] | nil,
type: String.t() | nil,
userDefinedName: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsSettingsDevice
IdLog
The logging-version of DeviceId proto, which identifies a device. This
mirrors cs/google3/assistant/api/core_types/device_type.proto?
q=symbol:DeviceId Next ID: 9

Attributes

agsaClientInstanceId (type: String.t, default: nil) - The

client_instance_id on devices with GSA. See 'client_instance_field'
in go/androidids.
alloDeviceId (type: String.t, default: nil) - Allo Id.
Corresponds to the GBotRequest.Sender.sender. This ID type
should be deprecated by now, yet we've observed it serving prod
traffic in GB.
canonicalDeviceId (type: String.t, default: nil) - A unique
device ID for Assistant devices as proposed by go/ocelot-team.
castDeviceId (type: String.t, default: nil) - If set, indicates
that the device is a cast device, and contains the UUID of the cast
device. Corresponds to the device_id field of the CastDevice proto.
clientInstanceId (type: String.t, default: nil) - DUSI
(go/dusi) is used as the identifier here. This identifier is unique to
the user and device. This will help identify which device or
application the user's request originated from. This is not to be
confused with the client_instance_id that android devices provide.
This is currently used by surfaces that use the assistant-legacy-
nexus and assistant-legacy-clockwork pipelines. DUSI is created
and set in S3. This field is only filled for GAIA requests.
 deviceConfigId (type: String.t, default: nil) - The unique
DeviceConfig to the specific third party device. It is also used by
Android Auto Embedded first party device. See go/opa-ids.
homeGraphDeviceId (type: String.t, default: nil) - The unique
device ID for HomeGraph devices. This is the HomeGraph ID,
created when the device is registered into HomeGraph. It is
immutable for the same device unless it is completely deleted and
recreated. See go/home-graph for details. }
libassistantDeviceId (type: String.t, default: nil) - The
unique ID for libassistant based devices.
opaIosDeviceId (type: String.t, default: nil) - The unique
device ID for the Assistant App on iOS. See go/opa-ios-design for
details.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSettingsDeviceIdLog{
agsaClientInstanceId: String.t() | nil,
alloDeviceId: String.t() | nil,
canonicalDeviceId: String.t() | nil,
castDeviceId: String.t() | nil,
clientInstanceId: String.t() | nil,
deviceConfigId: String.t() | nil,

homeGraphDeviceId: String.t() | nil,

libassistantDeviceId: String.t() | nil,
opaIosDeviceId: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsStructureAnn
otationLog
Structure annotation mentioned in query.

Attributes

rawTextFromQuery (type: String.t, default: nil) - The raw text

mentioning a structure from the query, such as "my house".
structureId (type: list(String.t), default: nil) - The
identification of the structure.
type (type: String.t, default: nil) - The annotation type
mentioned in the query.
userDefinedName (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantLogsStructureAnnotationLog{
rawTextFromQuery: String.t() | nil,
structureId: [String.t()] | nil,

type: String.t() | nil,

userDefinedName: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantLogsTargetDeviceL
og
Represents the case where the library successfully selects the target
device. It could be one or multiple devices. Next ID: 4

Attributes

devices (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDe
viceInfoLog.t),default: nil) -
lowConfidenceReason (type: String.t, default: nil) -
resultConfidenceLevel (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantLogsTargetDeviceLog{

devices:
[GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t()] | nil,
lowConfidenceReason: String.t() | nil,
resultConfidenceLevel: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantPfrDeviceRdMetad
ata
Attributes

deviceName (type: String.t, default: nil) -

deviceTypes (type: list(String.t), default: nil) -
effectiveArgSpanLength (type: number(), default: nil) -
hasAmbiguousResolutions (type: boolean(), default: nil) -
True if there are more than one possible resolutions to the RD.
hasResolvedDeviceId (type: boolean(), default: nil) - True if
there's at least one device id that gets resolved. Note this is different
from is_grounded = true: it is possible that is_grounded = false
(num_grounded_args =0) but there is resolved device ids. E.g.:
"turn on the blue light" Power_on(device_object = [d1,
d2]:RD(category=DeviceObject(name='blue light')) where there are
"blue light 1" and "blue light 2" hence two resolved device ids. But
since the quantifier is single, GB can't resolve the ambiguity and
would set num_grounded_args = 0 to indicate such unresolved
ambiguity.
roomName (type: String.t, default: nil) -

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantPfrDeviceRdMetadata{

deviceName: String.t() | nil,

deviceTypes: [String.t()] | nil,
effectiveArgSpanLength: number() | nil,
hasAmbiguousResolutions: boolean() | nil,
hasResolvedDeviceId: boolean() | nil,
roomName: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantPfrSmartHomeInte
ntMetadata
Used by the Smarthome Business Rules twiddler to determine whether to
replace the top-scoring Smarthome intent with another.

Attributes

deviceRdMetadata (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantPfrDev
default: nil) - Each DeviceRdMetadata
iceRdMetadata.t),
represents one device RD (device slot) in the intent. Note that each
device RD could have multiple device groundings inside of it.
intentName (type: String.t, default: nil) -
isExactMatch (type: boolean(), default: nil) - When
num_constraints == num_constraints_satisfied, indicating all slot
matchings are exact match.
isGrounded (type: boolean(), default: nil) - When
num_grounded_args > 0, indicating there is at least one top-level
argument is grounded.

Summary
Types
t()
Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHomeIntentMetadata{

deviceRdMetadata:
[GoogleApi.ContentWarehouse.V1.Model.AssistantPfrDeviceRdMetadata.t()] | nil,
intentName: String.t() | nil,
isExactMatch: boolean() | nil,
isGrounded: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantPfrTiebreakingMet
adata
Features used by the PrefulfillmentRanker's scorer exclusively to break
ties.

Attributes

(type: String.t, default: nil) -

fingerprint
sortedNameString (type: String.t, default: nil) -

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreakingMetadata{
fingerprint: String.t() | nil,
sortedNameString: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantPrefulfillmentRank
erPrefulfillmentSignals
Signals to be used by the Prefulfillment Ranker. Derived from the
ParsingSignals and GroundingSignals carried by the FunctionCall.
LINT.IfChange Next ID: 74

Attributes

fulfillableDominantMedia (type: boolean(), default: nil) -

Whether this is a fulfillable, dominant Media intent.
generatedByLegacyAquaDomain (type: boolean(), default: nil) -
Whether or not the intent was generated by a legacy Aqua domain
that PFR should care about.
hasAnswerGroup (type: boolean(), default: nil) - Whether the
interpretation has a Search answer group object, signifying it came
from Search resolution.
subIntentType (type: String.t, default: nil) -
isIntentFromOrbit (type: boolean(), default: nil) - Whether
the intent is from ORBIT.
usesGroundingBox (type: boolean(), default: nil) - Whether the
interpretation should run through grounding box or not.
effectiveArgSpanLength (type: number(), default: nil) - The
total effective length of the spans for the arguments used to
construct the parse. May include vertical specific adjustments. Eg:
For the query [delete my 7 p.m. alarm called chicken] and intent
Delete_alarm(alarm_object=RD(category=AlarmObject(
label="chicken", trigger_time_datetime=<< 7 PM >>))), the
effective argument span is "7 p.m." + "chicken" (total length of 13).
phase (type: String.t, default: nil) - Query understanding
phase the intent was produced in.
isFullyGrounded (type: boolean(), default: nil) - Whether the
intent is fully grounded.
isSageInNageIntent (type: boolean(), default: nil) - Whether
the intent is produced by the Sage IntentGenerator invoked by the
NSP intent-generator (thus, Sage-in-NSP-invoking_Sage, or Sage-
in-Nage).
isSageDisabledIntent (type: boolean(), default: nil) -
Whether the intent is an intent marked disabled by the Sage IG.
deepMediaDominant (type: boolean(), default: nil) - Whether
the intent is dominant according to NSP deep-media.
isVideoIntent (type: boolean(), default: nil) - Whether the
intent is a media object video intent.
parsingScoreMse8BucketId (type: integer(), default: nil) - A
ID corresponding to which bucket a given parsing score belongs in.
predictedIntentConfidence (type: number(), default: nil) -
Intent confidence predicted by the AssistantVerticalClassifier
QRewrite servlet.
nspIntentParseScore (type: float(), default: nil) - Parse score
generated by NSP. If NSP intent has been pruned due to
dededuplication, It will have highest parse score for deduplicated
intent.
numConstraints (type: float(), default: nil) - Signals as
proposed in go/improved-grounding-signals. Sum of the number of
constraints used by the Grounding Box to ground each variable.
isPodcastIntent (type: boolean(), default: nil) - Whether the
intent is a podcast intent.
isDummyIntent (type: boolean(), default: nil) -
isScoreBasedIntent (type: boolean(), default: nil) - Whether
this intent is a score-based intent, relying on PFR for scoring and
pruning to the top intent.
platinumSource (type: boolean(), default: nil) - Whether the
intent comes from the Sage IntentGenerator's "platinum" source,
signifying high-confidence in quality.
nspRank (type: integer(), default: nil) - Rank of the intent as
reported by NSP.
dominant (type: boolean(), default: nil) - Indicates
interpretation dominance predicted by KScorer
isRadioIntent (type: boolean(), default: nil) - Whether the
intent is a PlayMedia radio intent.
searchDispatch (type: String.t, default: nil) - The
determination made by the SearchDispatchingConfig as to whether
and how this interpretation should be dispatched to Search.
isHighConfidencePodcastIntent (type: boolean(), default:
nil) - Used for PFR manual rule to prefer high confidence podcast
intent (e.g. topical, genre) over generic podcast intents.
calibratedParsingScore (type: float(), default: nil) - A
parsing score that is independently calibrated by each parser/IG.
intentNameAuisScoreExp (type: float(), default: nil) -
Assistant User Interaction Score which is aggregated using intent
name from exp laelaps.
inQueryMaxEffectiveArgSpanLength (type: number(), default:
nil) - This is a cross-intent feature which is calculated by iterating
all intent candidates. This feature should be populated in post-IG
stage (before GB).
pq2tVsAssistantIbstCosine (type: float(), default: nil) -
Cosine similarity between predicted query-to-term model and
assistant intent-type-based salient terms. This is intended to be only
used for ACE ranking and only populated for assistant traffic.
isTvmIntent (type: boolean(), default: nil) - Whether the intent
is a media object tvm intent.
numGroundedArgs (type: float(), default: nil) - Number of
grounded arguments the intent has, populated by the Grounding
Box.
numGroundableArgs (type: float(), default: nil) - Grounding
Signals. Number of groundable arguments the intent has, populated
by the Grounding Box.
intentType (type: String.t, default: nil) - intent_type
differentiates between intents that share the top level intent name.
For eg: for TV_FALLBACK_SEARCH_INTENT, the top level
intent name must be "Find_media" and the media_object argument
within it must be of type "Media_unspecified".
pq2tVsIbstCosine (type: float(), default: nil) - Cosine
similarity between predicted query-to-term model and intent-type-
based salient terms. This is intended to be used as a backoff to
pq2t_vs_qibst_cosine if it is missing.
isNspIntent (type: boolean(), default: nil) - Whether this
interpretation was genearted by NSP.
isSageIntent (type: boolean(), default: nil) - Whether this
intent was generated by Sage.
intentNameAuisScore (type: float(), default: nil) - QUS
intent-based ranking signals. Assistant User Interaction Score which
is aggregated using intent name.
kScore (type: number(), default: nil) - Used for PFR manaul
rule to prefer high kscore radio intent. The k-score comes from
twiddled_ranking_scores in query interpretations.
isAquaMediaIntent (type: boolean(), default: nil) - Whether
the intent aqua intent from media domain enabled in QBT
isValidSmarthomeIntent (type: boolean(), default: nil) -
Whether the intent is a Smarthome-domain intent with valid device
arguments.
tiebreakingMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreak
default: nil) -
ingMetadata.t,
smarthomeIntentMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHom
default: nil) - SmartHome intent metadata
eIntentMetadata.t,
used for the SmartHome business-rules twiddler.
numConstraintsSatisfied (type: float(), default: nil) - Sum
of the number of constraints satisfied for each variable. Depending
on the match score for a constraint, this number can be fractional
and is in the range [0, num_constraints]. Populated by the
Grounding Box.
 isMediaControlIntent (type: boolean(), default: nil) -
Whether the intent is a media control intent.
isPodcastGenericIntent (type: boolean(), default: nil) - Used
for PFR manual rule to prefer high confidence podcast intent (e.g.
topical, genre) over generic podcast intents.
maxHgrScoreAcrossBindingSets (type: float(), default: nil) -
The maximum score assigned by the Horizontal Grounding Ranker
(HGR) across all of the intent's binding sets.
intentName (type: String.t, default: nil) - intent_name is used
by PFR ensemble model. See go/pfr_ha_launch_doc
kscorerRank (type: integer(), default: nil) - The rank order of
the interpretation as determined by kscorer. The kscorer-determined
dominant interpretation, if any, gets a rank of 0. The remaining N
interpretations get a rank of 1 through N.
isPlayGenericMusic (type: boolean(), default: nil) - Whether
the intent is a PlayGenericMusic-type intent.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantPrefulfillmentRankerPrefulfillmentS
ignals{
calibratedParsingScore: float() | nil,
deepMediaDominant: boolean() | nil,

dominant: boolean() | nil,

effectiveArgSpanLength: number() | nil,
fulfillableDominantMedia: boolean() | nil,
generatedByLegacyAquaDomain: boolean() | nil,
hasAnswerGroup: boolean() | nil,
inQueryMaxEffectiveArgSpanLength: number() | nil,
intentName: String.t() | nil,
intentNameAuisScore: float() | nil,

intentNameAuisScoreExp: float() | nil,

intentType: String.t() | nil,
isAquaMediaIntent: boolean() | nil,
isDummyIntent: boolean() | nil,
isFullyGrounded: boolean() | nil,
isHighConfidencePodcastIntent: boolean() | nil,
isIntentFromOrbit: boolean() | nil,

isMediaControlIntent: boolean() | nil,

isNspIntent: boolean() | nil,
isPlayGenericMusic: boolean() | nil,
isPodcastGenericIntent: boolean() | nil,
isPodcastIntent: boolean() | nil,
isRadioIntent: boolean() | nil,
isSageDisabledIntent: boolean() | nil,

isSageInNageIntent: boolean() | nil,

isSageIntent: boolean() | nil,
isScoreBasedIntent: boolean() | nil,
isTvmIntent: boolean() | nil,
 isValidSmarthomeIntent: boolean() | nil,
isVideoIntent: boolean() | nil,
kScore: number() | nil,

kscorerRank: integer() | nil,

maxHgrScoreAcrossBindingSets: float() | nil,
nspIntentParseScore: float() | nil,
nspRank: integer() | nil,

numConstraints: float() | nil,

numConstraintsSatisfied: float() | nil,
numGroundableArgs: float() | nil,
numGroundedArgs: float() | nil,
parsingScoreMse8BucketId: integer() | nil,
phase: String.t() | nil,
platinumSource: boolean() | nil,

pq2tVsAssistantIbstCosine: float() | nil,

pq2tVsIbstCosine: float() | nil,
predictedIntentConfidence: number() | nil,
searchDispatch: String.t() | nil,
smarthomeIntentMetadata:
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHomeIntentMetadata.t()

| nil,
subIntentType: String.t() | nil,
tiebreakingMetadata:
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreakingMetadata.t()
| nil,
usesGroundingBox: boolean() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantProductivityListIte
m
A message to represent an item in a list. Just a basic string for now, but
extensible for the future.

Attributes

name (type: String.t, default: nil) - [REQUIRED] The name of

the list item.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantProductivityListItem{

name: String.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantRemindersAttachm
ent
Proto descrbing an attachment to an Assistant Reminder. If the
attachment has different behavior on different surfaces (e.g., deeplinks),
there will be multiple attachments attach to the Reminder. Each of them
will specify the surface type and the corresponding deeplink.

Attributes

id (type: String.t, default: nil) - REQUIRED. An unique

identifier for the attachment. We have a plan to index this field, so
it's marked as REQUIRED. Chat with opa-reminders-eng@ if you
have a use case without an attachment ID.
link (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersAt
tachmentLink.t,default: nil) -
surfaceType (type: list(String.t), default: nil) -
REQUIRED. Surface types this attachment should be shown.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersAttachment{

id: String.t() | nil,

link:
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersAttachmentLink.t()
| nil,
surfaceType: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantRemindersAttachm
entLink
Attributes

linkUrl (type: String.t, default: nil) - REQUIRED. The link

to surface to frontends (e.g., Hubpage, notifications.) This could
also be a surface-specific deeplink (be sure to set surface_type
accordingly.)
notificationText (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersNl
gTemplateKey.t,default: nil) - REQUIRED. The text for the
notification link button. Note: We cannot take
nlp_generation.TemplateData yet due to cyclic dependency. The
plan is to cut dependency from TemplateData to
quality.actions.Reminder. DEPRECATED. No longer used as part
of the notification flow.

Summary
Types
t()

Functions
decode(value, options)
Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersAttachmentLink{
linkUrl: String.t() | nil,
notificationText:
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersNlgTemplateKey.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantRemindersMemory
Payload
Since this is stored in BE, any update on this proto needs LGTM by
ARIS storage owner

Attributes

hasReferencedEntityAtCreation (type: boolean(), default:

nil) - Whether the reminder created has a referenced_entity
attached to it or not(go/hub-memory-payload). Since we plan to set
this in Assistant reminder creation path flow, in case later the
referenced_entity is removed from the reminder, then this bit might
still remain true. Also in case referenced_entity is later added to
reminder(for example when referenced_entity is attached by
Server), then also this bit might remain false. This bit will be used
to guess if the user has a memory-enabled AGSA, thus we'll surface
the "open memory" button on hubpage. This check is not perfect, as
the user might have other phones with older AGSA, so this is just a
best guess. This field won't be stored in Memory backend, and will
not be populated back when retrieving reminders.
recordId (type: String.t, default: nil) - Id of record that is
associated with Reminder. This will be set for all Assistant
reminders created after the first launch of the Reminder Memory
integration, see go/reminders-memory for more details. Also, this
might apply to all other types of reminders.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersMemoryPayload{

hasReferencedEntityAtCreation: boolean() | nil,

recordId: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.AssistantRemindersNlgTem
plateKey
Equivalent to nlp_generation.TemplateKey. We cannot use
nlp_generation.TemplateKey message directly becasue that proto is
defined in a relatively large proto and has other dependencies, which will
increase the size unnecessary and might hit many limitations (e.g., 5MiB
limitation for Spanner type environment.).

Attributes

messageSet(type: String.t, default: nil) - REQUIRED.

templateName (type: String.t, default: nil) - REQUIRED.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersNlgTemplateKey{
messageSet: String.t() | nil,
templateName: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantTeleportTeleportNi
cknameSignals
Attributes

hasLocationInterpretation (type: boolean(), default: nil) -

Whether the nickname could also refer to a location. For example,
"walmart", "starbucks".
installInfo (type: String.t, default: nil) - Indicates whether
the user has the app installed.
isGeneric (type: boolean(), default: nil) - True when the name
is generic, i.e when it could refer to multiple packages from
different developrs. For example, "mail" is considered a generic
name (since it can refer to "gmail", "yahoo mail" etc.) but
"facebook" although could refer to both "facebook" and "facebook
lite" is not considered generic (both packages are from the same
third party).
nicknameTier (type: String.t, default: nil) - The tier of the
nickname.
source (type: String.t, default: nil) -

Summary
Types
t()