Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AssistantTeleportTeleportNicknameSignals{
hasLocationInterpretation: boolean() | nil,
installInfo: String.t() | nil,
isGeneric: boolean() | nil,
nicknameTier: String.t() | nil,
source: 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.AssistantVerticalsCommonC
ontactMatchSignal
Neural contact match signals.

Attributes

(type: number(), default: nil) - Neural contact

matchScore
match similarity score.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsCommonContactMatchSignal{
matchScore: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoActionProjectConfig
Metadata for Actions-on-Google configuration.

Attributes

(type: String.t, default: nil) - Actions-on-Google

contextId
action context ID. See go/sdm-hospitality-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.AssistantVerticalsHomeautomationProtoActionP
rojectConfig{
contextId: 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.AssistantVerticalsHomeauto
mationProtoAgentDeviceId
An agent + device pair that uniquely identifies a device.

Attributes

agentId (type: String.t, default: nil) - The agent's ID.

Generally it is the agent's Google pantheon project id.
deviceId (type: String.t, default: nil) - Device ID defined by
the agent.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAgentDe

viceId{
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.AssistantVerticalsHomeauto
mationProtoAgentInformation
AgentInformation represents the details needed to support both 1P and
3P partnerships for Home Automation. Next ID: 7

Attributes

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

deviceSource (type: String.t, default: nil) -
executionPath (type: String.t, default: nil) -
id (type: String.t, default: nil) - Unique Agent ID which maps
to a specific Agent. Not using Agent Name here as it may change
over time.
key (type: String.t, default: nil) - Agent's foreign key that
uniquely identifies a user's 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.AssistantVerticalsHomeautomationProtoAgentIn
formation{
authType: String.t() | nil,
deviceSource: String.t() | nil,
executionPath: String.t() | nil,
id: String.t() | nil,

key: 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.AssistantVerticalsHomeauto
mationProtoAttribute
Protos representing device or structure attributes. See go/hgs-attributes-
protos. Only protos approved and formalized by assistant/HG team
should be added here.

Attributes

structureBasedRoutine (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoCommonStructureBasedRoutine.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.AssistantVerticalsHomeautomationProtoAttribu
te{
structureBasedRoutine:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonSt
ructureBasedRoutine.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoAttributes
LINT.IfChange(proto_attributes)

Attributes

attributeProtos (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantVertic
alsHomeautomationProtoAttribute.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.AssistantVerticalsHomeautomationProtoAttribu
tes{

attributeProtos:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAttribut
e.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoCommonEventTrigger
LINT.IfChange(proto_event_trigger) Next id: 5

Attributes

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

eventTriggerPayload (type: map(), default: nil) - Detailed
settings for the event trigger; unset if not applicable.
eventTriggerType (type: String.t, default: nil) - Different
event type may have different settings. For example: SCHEDULED
will have event_trigger_payload of
cs/symbol:assistant.verticals.voice_shortcut.proto.Schedule
LOCATION will have event_trigger_payload of
cs/symbol:assistant.verticals.voice_shortcut.proto.LocationTriggerE
vent
triggerSource (type: integer(), default: nil) - Unique
identifier for the EventTrigger, e.g. SCHEDULED_ROUTINES.
See the enum values of
cs/symbol:WorkflowTriggerInput.TriggerSource

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonE
ventTrigger{
enabled: boolean() | nil,
eventTriggerPayload: map() | nil,
eventTriggerType: String.t() | nil,
triggerSource: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoCommonStructureBas
edRoutine
Routines team stores the core Structure Based Routine data as the
payload. We will add specific metadata on a per-need basis.
LINT.IfChange(proto_structure_based_routine) Next id: 12 These two
forms of payload are equivalent data in different formats and both will
be stored in Home Graph. 1. The internal format will fan out to the
DynamicEntity Footprints for read in Settings flow and Execution. 2.
The UI format will be stripped out upon replication to DynamicEntity
Footprints due to its redundancy and the Footprints data size limit, i.e.
DE Footprints will only contain the internal format.

Attributes

enabled (type: boolean(), default: nil) - Whether this Routine

is enabled or not. If false, then this Routine can't be triggered by
Voice.
googlePreconfigWorkflowId (type: String.t, default: nil) -
The unique identifier for a class of workflows. For example:
"sbr_001" => Away "sbr_002" => Home * "category_template" =>
CUSTOM
language (type: String.t, default: nil) -
payload (type: map(), default: nil) - Internal format payload
primarily for Routines team use.
securityLevel (type: String.t, default: nil) - The security
level of the Structure Based Routine as determined by the most
security-sensitive task.
 shared (type: boolean(), default: nil) -
storagePayload (type: map(), default: nil) -
structureId (type: String.t, default: nil) -
triggers (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantVertic
alsHomeautomationProtoCommonStructureBasedRoutineTrigger
default: nil) - Voice or event triggers.
.t),
type (type: String.t, default: nil) -
uiPayload (type: map(), default: nil) - UI format payload
primarily for external team use.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonS
tructureBasedRoutine{
enabled: boolean() | nil,
googlePreconfigWorkflowId: String.t() | nil,
language: String.t() | nil,
payload: map() | nil,
securityLevel: String.t() | nil,

shared: boolean() | nil,

storagePayload: map() | nil,
structureId: String.t() | nil,
triggers:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonSt
ructureBasedRoutineTrigger.t()

]
| nil,
type: String.t() | nil,
uiPayload: map() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoCommonStructureBas
edRoutineTrigger
Next id: 3

Attributes

eventTrigger (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoCommonEventTrigger.t, default: nil) -
voiceTrigger (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoCommonVoiceTrigger.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.AssistantVerticalsHomeautomationProtoCommonS
tructureBasedRoutineTrigger{
eventTrigger:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonEv
entTrigger.t()
| nil,

voiceTrigger:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonVo
iceTrigger.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoCommonVoiceTrigger
LINT.IfChange(proto_voice_trigger) Next id: 2

Attributes

query (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.AssistantVerticalsHomeautomationProtoCommonV
oiceTrigger{
query: 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.AssistantVerticalsHomeauto
mationProtoConciergeFeatures
The Concierge features a structure is eligible for. See {@link
home.graph.common.ConciergeFeatures}.

Attributes

conciergeProductFeatures (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.AssistantVerticalsHomeautomationProtoConcier

geFeatures{
conciergeProductFeatures: [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.AssistantVerticalsHomeauto
mationProtoDeviceTargetingOutpu
tQueryInfo
Next ID: 5

Attributes

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

span for device mention.
annotatedSpanRoom (type: String.t, default: nil) - The query
span for room mention.
annotatedSpanStructure (type: String.t, default: nil) - The
query span for structure mention.
processedMentionedSpan (type: String.t, default: nil) - This
field is from query_info.processed_mentioned_span in DTO.

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoDeviceT
argetingOutputQueryInfo{
annotatedSpanDevice: String.t() | nil,

annotatedSpanRoom: String.t() | nil,

annotatedSpanStructure: String.t() | nil,
processedMentionedSpan: 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.AssistantVerticalsHomeauto
mationProtoHomeAutomationDevi
ce
Next ID: 9

Attributes

deviceSelectionLog (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceS
electionLog.t,default: nil) - the next 3 fields are for Lumos
output (DTO) that needs to be propagated to the Fulfilment through
the HomeAutomationDevice proto.
dtoError (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantDeviceTarge
tingDeviceTargetingError.t, default: nil) -
dtoQueryInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoDeviceTargetingOutputQueryInfo.t, default:
nil) - This field is from query_info in DTO.
homeautomationMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoHomeAutomation_MetaData.t, default: nil) -
Device meta data.
list (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantVertic
default:
alsHomeautomationProtoHomeAutomationDeviceItem.t),
nil) - list of HomeAutomationDeviceItem. After migration
 completes, we will mark the above 4 field as deprecated and only
use this field.
matchedItemKey (type: String.t, default: nil) - Corresponding
to casse matched_item CustomTypeItem key.
matchedItemRawvalue (type: String.t, default: nil) -
Corresponding to casse Argument raw_value.
matchedItemValue (type: list(String.t), default: nil) -
Corresponding to casse matched_item CustomTypeItem value.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAut
omationDevice{
 deviceSelectionLog:
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceSelectionLog.t()
| nil,
dtoError:

GoogleApi.ContentWarehouse.V1.Model.AssistantDeviceTargetingDeviceTargetingError.

t()
| nil,
dtoQueryInfo:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoDeviceTa
rgetingOutputQueryInfo.t()
| nil,

homeautomationMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAuto
mation_MetaData.t()

| nil,
list:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAuto
mationDeviceItem.t()
]
| nil,
matchedItemKey: String.t() | nil,
matchedItemRawvalue: String.t() | nil,
matchedItemValue: [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.AssistantVerticalsHomeauto
mationProtoHomeAutomationDevi
ceItem
Attributes

homeautomationMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoHomeAutomation_MetaData.t, default: nil) -
Device meta data.
matchedItemKey (type: String.t, default: nil) - Corresponding
to casse matched_item CustomTypeItem key.
matchedItemRawvalue (type: String.t, default: nil) -
Corresponding to casse Argument raw_value.
matchedItemValue (type: list(String.t), default: nil) -
Corresponding to casse matched_item CustomTypeItem value.

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAut
omationDeviceItem{

homeautomationMetadata:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAuto
mation_MetaData.t()
| nil,
matchedItemKey: String.t() | nil,
matchedItemRawvalue: String.t() | nil,
matchedItemValue: [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.AssistantVerticalsHomeauto
mationProtoHomeAutomation_Met
aData
Next ID: 45

Attributes

supportedStructureFeatures (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoSupportedStructureFeatures.t, default:
nil) - The features that are available for a structure. Will only be
populated if the item_type == STRUCTURE.
traitRoutingHints (type:
list(GoogleApi.ContentWarehouse.V1.Model.HomeGraphCommon
default: nil) - For SHED devices, some
TraitRoutingHints.t),
traits can only be executed on 3P cloud, e.g.
"action.devices.traits.MediaInitiation",
"action.devices.traits.Channel" go/shed-per-trait-routing
parentNode (type: list(String.t), default: nil) -
LINT.IfChange(home_graph_single_parent) At the moment, we just
have a single string. In future this will expand with additional
metadata from client or cloud execution data store. In today's 'tree'
HomeGraph each object has a single parent. In the future this may
have a mesh for complex cases -- zones, doors, etc -- so we make
this a repeated element today.
LINT.ThenChange(//depot/google3/assistant/assistant_server/settin
gs/user_defined_actions/footprints/footprint_accessor.cc:home_gra
ph_single_parent)
actionProjectConfigs (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantVertic
alsHomeautomationProtoActionProjectConfig.t), default: nil)
- Custom actions that this item supports.
zoneNameSaftDocument (type:
GoogleApi.ContentWarehouse.V1.Model.NlpSaftDocument.t,
default: nil) - SAFT Document with linguistic annotations for the
zone name, if applicable.
operationalNodeId (type: String.t, default: nil) - Operational
CHIP Node ID that combines the fabric ID and node id in format of
. (Hex format without 0x prefix, for example,
0F001234FA67AA39.1234ABCD1111DDDD).
saftDocument (type:
GoogleApi.ContentWarehouse.V1.Model.NlpSaftDocument.t,
default: nil) - SAFT Document with linguistic annotations for the
primary device name.
opaqueCustomData (type: String.t, default: nil) - Store custom
data for agent calls here. This will likely be short-lived -- we will
replace this with calls to HGS. (Note: This may end up not
temporary if we only need it for a couple partners -- more efficient
to have it on a few users than require HGS reads for all users.
lanscanOptedIn (type: boolean(), default: nil) - Whether local
home platform should discover new devices via LAN for the
structure.
plural (type: list(String.t), default: nil) - We use this to
determine if the synonyms matched in the aqua interpretation is
plural. Then we will return disambiguate dialog or execute
commands with all the targets.
deviceModelId (type: String.t, default: nil) - See note in
home_graph.proto; loaded into DE now to avoid having to double-
read assistant settings records as per go/smarthome-removing-
assistant-settings
notificationSupportedByAgent (type: boolean(), default: nil)
- Indicates whether the device is capable of sending notifications.
This field will be set by the agent (partner) on an incoming SYNC.
If a device is not capable of generating notifications, the partner
should set this flag to false. If a partner is not capable of calling
ReportStateAndNotification to send notifications to Google, the
partner should set this flag to false. If there is a user setting in the
partner app to enable notifications and it is turned off, the partner
should set this flag to false.
parentType (type: list(String.t), default: nil) - The type of
the parent. Currently only set for devices, to distinguish between
structure and room parents. Items currently have only one parent,
and entries after the first parent_type are ignored.
gcmExecutionAddress (type: String.t, default: nil) - GCM
address for cloud execution across google cloud messaging rather
than 3p cloud.
smartDeviceManagementData (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoSmartDeviceManagementData.t, default: nil)
- Data needed for SDM (fleet management). See go/enterprise-id-
in-assistant.
voiceMatchRequired (type: String.t, default: nil) - Set to
which level of voice match is needed. Enum based on string input
from the partner in json sync. Values accepted: "none" (but in this
case partners won't set it), "owner" [requires matching one of the
creator gaia IDs], or "member" [any recognized voice 'enrolled' on
the device]. This may expand; only "owner" is in use for first
partner, Tile.
personalizedNicknames (type: list(String.t), default: nil) -
User-given nicknames for an entity (e.g. "My house"). These
nicknames are unique to the gaia user. Nickname in DeviceInfo is
per-entity level nickname, while personalized_nicknames is per-
user per-entity.
primaryName (type: String.t, default: nil) - Which of the
values was the original, user-provided name -- or our
disambiguated, cleaned-up version of it. This is what we use in TTS
when we need to identify an object that wasn't just spoken uniquely
by the user -- in disambiguation dialogue, or in response to a
collective interrogative (e.g. "what lights are on in the kitchen?")
attributes (type: map(), default: nil) - Attributes data as
provided from SYNC. This gets used in mutation and execution and
in some potential cases, in biasing.
hashValue (type: String.t, default: nil) - The hash value from
go/de-consistency-check
willReportState (type: boolean(), default: nil) - This device
will report state; we can query realtime state from local HGS rather
than slow QUERY intent to the 3p cloud.
matterUniqueId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoMatterUniqueId.t, default: nil) - Matter
Unique ID. Contains VID/PID information
userDefinedDeviceType (type: String.t, default: nil) - The
priority order of speech targeting: 1. user_defined_device_type 2.
derived_device_type 3. device_type
supportsDirectResponse (type: boolean(), default: nil) - This
device supports direct response -- if the device itself is issuing the
query (which means it's also an assistant surface) we can return its
payload directly rather than via cloud.
targetDeviceSignalStrengths (type: map(), default: nil) -
Only present for an AoGH device. HGS Device ID of a target
device and the signal strength (RSSI in dB, higher is better)
between that target device and the AoGH device. If this map is
empty, there are no target devices reachable by this AoGH device.
roleInformation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoRoleInformation.t, default: nil) - User's
role information for this device. This will be used in Home
Automation server to decide if user has authority to fulfill its
request.
traitToAttributeProtos (type: %{optional(String.t) =>
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoAttributes.t}, default: nil) - Map of trait to
a proto representing the attribute. This is different from the
attributes field above which is represented as a struct. The attributes
here are represented as protos and will require specific support per
trait.
traitRoutingTable (type: %{optional(String.t) =>
GoogleApi.ContentWarehouse.V1.Model.HomeGraphCommonRouti
ngTable.t}, default: nil) - Map from traits to routing table.
Metadata includes preferred execution path per trait and, when
Matter is preferred, which endpoint should be used for the trait.
assistantDeviceId (type: String.t, default: nil) - Device ID
that matches the ID passed from the device to discourse_context
when a user issues a query to an Assistant-enabled device that is
registered with Cast (via CCS (see go/castservers)), or some other
service.
derivedType (type: list(String.t), default: nil) - Any types
that are not the given item type, but derived later. For example, if an
item has type action.devices.types.OUTLET but is named "floor
lamp" we can derive that it also has type
action.devices.types.LIGHT. Also considered along with |type|
when triggering type-based actions.
modelName (type: String.t, default: nil) - Model name from
HomeGraph, populated from model_manifest.model_name. See
b/200087451.
notificationEnabledByUser (type: boolean(), default: nil) -
Indicates whether notifications have been enabled by a user and will
be announced for this device. This is set by the user within the
Google app settings, and Google will announce the device
notification only if both notification_supported_by_agent and
notification_enabled_by_user are true.
otherDeviceIds (type:
list(GoogleApi.ContentWarehouse.V1.Model.AssistantVertic
default: nil) -
alsHomeautomationProtoAgentDeviceId.t),
Other agent id + foreign id pairs associated with the device. This
can be used to represent a group of devices (e.g. Sonos' bonded
zone) as a single device, or a device that comes in through different
sync flows (e.g. Newman with a Nest camera).
smartHomeFeatures (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoSmartHomeFeatures.t,default: nil) -
SmartHome feature flags that may be enabled per-item.
supportedTraitsByAgent (type: %{optional(String.t) =>
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoHomeAutomation_MetaDataSupportedTraits.
t}, default: nil) - Map from agent ID to supported traits. Some
devices (e.g. Newman) have multiple agents, with each agent being
associated with a specific set of traits. This could alternatively have
been formatted as map as {trait, agent} pairs instead of the {agent,
list of trait} pairs, but we retain this format to be consistent with
HomeGraph's representation. In practice, a trait should only be
paired with a single agent (i.e. we should not have two agents with
the same trait in their value list). This field is optional and should
only be provided if the item has multiple agents.
type (type: String.t, default: nil) - The item type, such as
"action.devices.types.VACUUM" - to be used in triggering type-
based actions, e.g. "start vacuuming": go/smarthome-type-based-
actions.
tdssUpdateTimestamp (type: DateTime.t, default: nil) - The
timestamp at which the TDSS map was last updated. This
information is used to help determine which hub would be preferred
if multiple hubs report the same reach-ability for a device.
creatorGaiaId (type: String.t, default: nil) - See
Device.creator_gaia_ids in //home/graph/proto/service/types.proto.
If empty, the GAIA ID from the request EUC is assumed to be the
creator. We only need at most one creator_gaia_id.
reportStateStatus (type: String.t, default: nil) - Whether
device report state is out of sync with Query response.
routableViaGcm (type: boolean(), default: nil) - Only present
for a target device. Indicates this target device is reachable by a
local (AoGH) path via an AoGH device.
 groupIds(type: list(String.t), default: nil) - List of parent
group IDs, if the device is added to one or multiple device groups
(see go/home-groups). Will be consumed by Smart Home APIs and
(in the future) Assistant CTF to populate the group member list of
device groups.
physicalLocation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoPhysicalLocation.t, default: nil) - Stores
the location for the STRUCTURE type.
otherDeviceSources (type: list(String.t), default: nil) -
Additional device sources. This can be the result of the device being
merged with other devices with a different source.
agentInformation (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoAgentInformation.t, default: nil) - Agent
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.AssistantVerticalsHomeautomationProtoHomeAut
omation_MetaData{
actionProjectConfigs:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoActionPr
ojectConfig.t()

]
| nil,
agentInformation:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAgentInf

ormation.t()
| nil,
assistantDeviceId: String.t() | nil,
attributes: map() | nil,
creatorGaiaId: String.t() | nil,
derivedType: [String.t()] | nil,
deviceModelId: String.t() | nil,

gcmExecutionAddress: String.t() | nil,

groupIds: [String.t()] | nil,
hashValue: String.t() | nil,
lanscanOptedIn: boolean() | nil,
matterUniqueId:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoMatterUn
iqueId.t()
| nil,
modelName: String.t() | nil,
notificationEnabledByUser: boolean() | nil,
 notificationSupportedByAgent: boolean() | nil,
opaqueCustomData: String.t() | nil,
operationalNodeId: String.t() | nil,
otherDeviceIds:
[

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAgentDev
iceId.t()
]
| nil,
otherDeviceSources: [String.t()] | nil,
parentNode: [String.t()] | nil,
parentType: [String.t()] | nil,

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

physicalLocation:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoPhysical
Location.t()
| nil,
plural: [String.t()] | nil,

primaryName: String.t() | nil,

reportStateStatus: String.t() | nil,
roleInformation:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoRoleInfo
rmation.t()
| nil,

routableViaGcm: boolean() | nil,

saftDocument: GoogleApi.ContentWarehouse.V1.Model.NlpSaftDocument.t() | nil,
smartDeviceManagementData:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoSmartDev
iceManagementData.t()
| nil,
smartHomeFeatures:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoSmartHom
eFeatures.t()
| nil,
supportedStructureFeatures:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoSupporte
dStructureFeatures.t()
| nil,
supportedTraitsByAgent:
%{
optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAuto
mation_MetaDataSupportedTraits.t()
}
| nil,
supportsDirectResponse: boolean() | nil,
targetDeviceSignalStrengths: map() | nil,

tdssUpdateTimestamp: DateTime.t() | nil,

traitRoutingHints:
[GoogleApi.ContentWarehouse.V1.Model.HomeGraphCommonTraitRoutingHints.t()]
| nil,
traitRoutingTable:
%{
optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.HomeGraphCommonRoutingTable.t()
}
| nil,
traitToAttributeProtos:
%{
optional(String.t()) =>

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAttribut

es.t()
}
| nil,
 type: String.t() | nil,
userDefinedDeviceType: String.t() | nil,
voiceMatchRequired: String.t() | nil,
willReportState: boolean() | nil,
zoneNameSaftDocument:
GoogleApi.ContentWarehouse.V1.Model.NlpSaftDocument.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoHomeAutomation_Met
aDataSupportedTraits
Attributes

traits (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.AssistantVerticalsHomeautomationProtoHomeAut
omation_MetaDataSupportedTraits{
traits: [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.AssistantVerticalsHomeauto
mationProtoMatterUniqueId
Matter unique Id. These values are provided by the device.

Attributes

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

uniqueId (type: String.t, default: nil) -
vendorId (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.AssistantVerticalsHomeautomationProtoMatterU
niqueId{
productId: integer() | nil,
uniqueId: String.t() | nil,
vendorId: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoPhysicalLocation
Attributes

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

geoLocation (type:
GoogleApi.ContentWarehouse.V1.Model.GoogleTypeLatLng.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.AssistantVerticalsHomeautomationProtoPhysica
lLocation{

address: String.t() | nil,

geoLocation: GoogleApi.ContentWarehouse.V1.Model.GoogleTypeLatLng.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoRoleInformation
Represents the user’s role such as assistant only or manager for a device.
Design doc:
https://docs.google.com/document/d/1c1hnauEbBfDkywO3GZkI8ejHP7
65l2tLspmPgckEe2Y/

Attributes

iamCheckRequired (type: boolean(), default: nil) - When true,

role_type will be ignored, Nest IAM RPC will called to check
authority.
roleType (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.AssistantVerticalsHomeautomationProtoRoleInf
ormation{

iamCheckRequired: boolean() | nil,

roleType: 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.AssistantVerticalsHomeauto
mationProtoSmartDeviceManagem
entData
Attributes

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

enterpriseId
that owns the structure. E.g. Disney, Dream Hotel, etc. This is used
for log/analytics purpose. For privacy reasons, we log at enterprise
level instead of structure 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.AssistantVerticalsHomeautomationProtoSmartDe
viceManagementData{
enterpriseId: 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.AssistantVerticalsHomeauto
mationProtoSmartHomeFeatures
SmartHome feature flags that may be enabled per-item. LINT.IfChange

Attributes

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

Flag indicating whether the background Circadian Lighting effect is
enabled for a particular light (go/circadian-lighting-e2e).
energySavingsEnabled (type: boolean(), default: nil) - Flag
indicating whether automatic Energy Savings are enabled for this
item.
gentleWakeupEnabled (type: boolean(), default: nil) - Flag
indicating whether Gentle Wake Up is enabled for this item
(go/sleep-wake-design).
homeAwayOverMatterEnabled (type: boolean(), default: nil) -
Flag indicating whether the user has enabled / disabled sending
Home/Away status updates to the device through the Google
custom IntelligenceEvents Matter cluster. (go/google-clusters-
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.AssistantVerticalsHomeautomationProtoSmartHo
meFeatures{
circadianLightingEnabled: boolean() | nil,
energySavingsEnabled: boolean() | nil,

gentleWakeupEnabled: boolean() | nil,

homeAwayOverMatterEnabled: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AssistantVerticalsHomeauto
mationProtoSupportedStructureFe
atures
The features a structure supports.

Attributes

conciergeFeatures (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHo
meautomationProtoConciergeFeatures.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.AssistantVerticalsHomeautomationProtoSupport
edStructureFeatures{
conciergeFeatures:

GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoConcierg
eFeatures.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AttentionalEntitiesMention
Properties
Represents the properties of a mention. Next ID: 13

Attributes

deviceId (type:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreType
sDeviceId.t, default: nil) - The unique device on which the
mention occurred. For example, if the user has two Google Home
devices, this indicates which of the two was used.
eventId (type:
GoogleApi.ContentWarehouse.V1.Model.EventIdMessage.t,
default: nil) - ID of the event that resulted in this entity mention.
For user and system turn AEs, this is taken from the
ConversationSnapshotId of the snapshot containing this mention.
For client AEs, this is empty. This can be used to join back this
particular mention to the specific "turn" in which this mention took
place.
factoidScore (type: number(), default: nil) - If this mention
corresponds to a WebAnswer, then this defines the score associated
with that answer.
listEntryInfo (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesM
default: nil) - If present,
entionPropertiesListEntryInfo.t,
this entity was mentioned as part of a larger list.
recency (type: String.t, default: nil) - Estimates the recency of
the mention. This is internally computed at runtime on a turn-by-
turn basis.
 role (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesS
emanticRoleId.t, default: nil) - The semantic role that the entity
was used in.
salience (type: String.t, default: nil) - How salient this
mention is. This field will only be set if the mention is derived from
a SearchAnswerValue. See go/webresultsdata-as-aes for more
details.
source (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesM
entionPropertiesSource.t,default: nil) - Contains metadata
about the source of the mention.
spatialProperties (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesS
default: nil) - If present, properties of
patialProperties.t,
visual mentions (e.g., how they are displayed to the user, visibility,
etc.).
surfaceForm (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesS
urfaceForm.t, default: nil) - Details about how this mention was
presented.
timestamp (type: DateTime.t, default: nil) - Unix timestamp
noting (approximately) when this mention occurred. We do not
guarantee that the time will correspond precisely to when the user
uttered/heard a response. If mentions within a single turn have
different timestamps, they should accurately reflect the order in
which the mentions occurred. If that order is unknown, they should
all have the same timestamp.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionProperties{
deviceId:
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId.t()
| nil,

eventId: GoogleApi.ContentWarehouse.V1.Model.EventIdMessage.t() | nil,

factoidScore: number() | nil,

listEntryInfo:

GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesListEntry
Info.t()

| nil,
recency: String.t() | nil,
role:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesSemanticRoleId.t()
| nil,
salience: String.t() | nil,
source:

GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSource.t(
 )
| nil,
spatialProperties:

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

surfaceForm:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesSurfaceForm.t()
| nil,
timestamp: 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.AttentionalEntitiesMention
PropertiesListEntryInfo
Contains information about how an entity was presented as part of a list.

Attributes

index (type: String.t, default: nil) - The index of the entity

presented to the user. NOTE: Indexing starts from 0.
lexicalGroundingsId (type: String.t, default: nil) - A string
which uniquely identifies the list item this entity represents in the
list. For example, consider the "OrderPizza" intent with the "size"
slot: U: I want to order a pizza A: Sure. What size do you want:
large, medium, or small? U: Gigantic The lexical_groundings_id
can be "large" to identify the large item in the list. This
lexical_groundings_id together with the semantic role fields (i.e.,
role.intent_id & role.role_id) can be used to match the
nlp_semantic_parsing::LexicalGroundings::ValueTermType to
utilize lexical grounding for i18n of static list selection items. Note
that this field only needs to be populated when developers expect to
provide lexical groundings for the list item this entity represents.
Effectively, this field will be populated when this entity is published
by ListPresentationFrame and the
::quality::dialog_manager::IntentStageSignals::FieldCandidate.lexic
al_groundings_id field is populated. See go/lpf-i18nv2 &
go/taskstate-ae-sync 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.AttentionalEntitiesMentionPropertiesListEntr
yInfo{
index: String.t() | nil,
lexicalGroundingsId: 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.AttentionalEntitiesMention
PropertiesSource
The agent or system from which the mention was derived. Each mention
corresponds to a single source.

Attributes

client (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesM
entionPropertiesSourceClient.t, default: nil) -
system (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesM
entionPropertiesSourceSystem.t, default: nil) -
user (type:
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesM
entionPropertiesSourceUser.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.AttentionalEntitiesMentionPropertiesSource{
client:

GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSourceCli

ent.t()
| nil,
system:

GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSourceSys
tem.t()
| nil,

user:

GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSourceUse
r.t()
| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AttentionalEntitiesMention
PropertiesSourceClient
The client provided this entity. Currently, this exclusively corresponds to
an entity that was circulated by the client. See go/on-device-aes for more
details.

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.AttentionalEntitiesMentionPropertiesSourceCl
ient{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AttentionalEntitiesMention
PropertiesSourceSystem
The Assistant mentioned this entity. This corresponds to entities
annotated during fulfillment. More specifically, these entities are
typically provided by developers either via a Monastery frame or an
InteractionBuilder.

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.AttentionalEntitiesMentionPropertiesSourceSy
stem{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AttentionalEntitiesMention
PropertiesSourceUser
The user mentioned this entity. It was extracted from a previous winning
intent (IntentQuery or IntentUpdate). Such entities are computed at
runtime from the interpretation history without any developer
intervention.

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.AttentionalEntitiesMentionPropertiesSourceUs
er{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.AttentionalEntitiesSemantic
RoleId
Uniquely identifies a semantic role. When this role corresponds to a slot
in a registered user intent (see go/assistant-intent-catalog), then the
SemanticRoleId maps precisely onto that slot in the intent catalog.
However, not all semantic roles corresponds to such user intent slots.

Attributes

intentId (type: String.t, default: nil) - Semantic roles will be

defined locally, within the context of a single task/feature. The
|intent_id| is a unique identifier for such a local cluster. In most
cases, this should be exactly the same as the name of the intent used
for TaskState (see go/assistant-intent-catalog). In cases where the
intent isn't well-defined, this can be an arbitrary, feature-defined
identifier.
roleId (type: String.t, default: nil) - Identifier for a semantic
role, unique within the namespace of |intent_id|. When this role
corresponds to a slot in the intent, the |role_id| should be equal to
the name of that argument. For example, consider an entry in the
intent catalog: core_intent { id { id: "BookARide" } slot { name:
"provider" type { string_type { } } } slot { name: "num_riders" type
{ number_type { } } } } Then, the |role_id| would be "provider" or
"num_riders" when referring to one of these slots. NOTE: when
responding to the user, the Assistant may actually make use of other
roles such as "ETA" or "driver" that are not part of the intent
declaration. These should still be assigned consistent semantic
roles. For example, a dialog with the Shopping feature: User:
Where can I buy XYZ? Google: [Best Buy in Sunnyvale] has
 [XYZ] in stock. User: Great! Give me directions. In this case, both
"Best Buy" and "XYZ" would be pushed to attentional entities. Best
Buy, in this case, may not be an argument in the
ShoppingItemStockInquiry intent, but should still have a consistent
|role_id| such as "possessing_business".

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

roleId: 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.AttentionalEntitiesSpatialPr
operties
Properties of visual mentions (e.g., how they are displayed to the user,
visibility, etc.).

Attributes

visibility (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.AttentionalEntitiesSpatialProperties{
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.AttentionalEntitiesSurfaceF
orm
How the entity was presented in this mention at a surface level. For
example, "President Barack Obama" or "Barack Obama" or "he" might
all be reasonable surface forms for the MID /m/02mjmr.

Attributes

text (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.AttentionalEntitiesSurfaceForm{

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.BiasingPerDocData
This data is expected to appear in approximately 2 out of every 1,000
documents with an average of 2 fields per document. Rough order of
size is in the hundreds of kilobytes per Mustang shard.

Attributes

biasingfield (type:
list(GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocDa
taBiasingField.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.BiasingPerDocData{

biasingfield:
[GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocDataBiasingField.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BiasingPerDocData2
A replacement for BiasingPerDocData that is more efficient wrt size in
the index.

Attributes

biasingField (type:
list(GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocDa
ta2BiasingField.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.BiasingPerDocData2{

biasingField:
[GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocData2BiasingField.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BiasingPerDocData2Biasing
Field
Attributes

compressedName (type: integer(), default: nil) - A fingerprint

of the actual name of the field.
value (type: float(), default: nil) - The value, under various
representations to get maximum compression. Exactly one of them
is guaranteed to be filled. value as a double.
valueFloat (type: integer(), default: nil) - a floating value,
represented as an integer by converting using floating_value *
1000. Useable for all floating values that need 3 digits of precision,
and are small enough.
valueInt (type: integer(), default: nil) - value as an int32.
When the value is encode-able as an integer.

Summary
Types
t()

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

Types

t()

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

compressedName: integer() | nil,
value: float() | nil,
valueFloat: integer() | nil,
valueInt: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BiasingPerDocDataBiasingF
ield
Metadata fields on which we can bias (sort) search results independently
from the normal ranking using a ScoreAdjuster

Attributes

Name (type: String.t, default: nil) - Fingerprint of the attribute

name (no need to keep long field names)
Value (type: float(), default: nil) - Biasing value translated
into a double for uniform comparison

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

Name: String.t() | nil,

Value: float() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BlobstoreBlobRef
A BlobRef is used to refer to a blob in BlobStore. Clients may only
manipulate blobs through BlobRefs. BlobRefs should not be sent in the
clear outside of Google (for example, encoded in URLs, stored in a
client cookie, or referred to in Javascript); for efficiency, the IDs expose
internal details of the blobstore (such as machine IPs or cluster names).
If clients need to store BlobRefs outside of Google, they must encrypt
the BlobRef securely or use an alternative insecure identifier with an id-
>BlobRef mapping inside our network.

Attributes

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

Options (type: String.t, default: nil) -
RefID (type: String.t, default: nil) -
ShardBin (type: integer(), default: nil) -
Size (type: String.t, default: nil) - Size of the complete blob,
in bytes.
SourceV2BlobID (type: String.t, default: nil) - The ID of the
V2 blob this blob has
V2ReadBlobToken (type: String.t, default: nil) - Deprecated.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

BlobID: String.t() | nil,
Options: String.t() | nil,
RefID: String.t() | nil,
ShardBin: integer() | nil,
Size: String.t() | nil,

SourceV2BlobID: String.t() | nil,

V2ReadBlobToken: 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.BlogPerDocData
Additional data for Blog/Posts

Attributes

blogurlFp(type: String.t, default: nil) - used for blogurl

crowding.
clientSpamminess (type: integer(), default: nil) - This score
captures how spammy the client is that the micropost was created
with. The higher the score the worse.
convTree (type:
GoogleApi.ContentWarehouse.V1.Model.BlogsearchConversati
onTree.t,default: nil) - For the threaded conversation view. Only
populated in docs with provider type
SYNTHETIC_CONVERSATION_DOC.
copycatScore (type: integer(), default: nil) -
docQualityScore (type: integer(), default: nil) -
isSyntacticReshare (type: boolean(), default: nil) - A
syntactic reshare is a document that is created from an original and
shared with friends and we detect this resharing property by
syntactically parsing the doc. . For example, a retweet is an example
of a syntactic_reshare because we can detect that it's a reshare by
grepping for "RT @".
microblogQualityExptData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
default: nil) - Experimental data for quality experiments.
et.t,
This will NOT be populated in prod, but we will use this for
experiments.
numMentions (type: integer(), default: nil) - For
replies/reshares. num_mentions = number of times the pattern @foo
 appears in the document.
outlinks (type:
list(GoogleApi.ContentWarehouse.V1.Model.BlogPerDocDataO
default: nil) -
utlinks.t),
postContentFingerprint (type: integer(), default: nil) - The
fingerprint for the body text of the microblog post. It is copied from
MicroBlogPost.post_content_fingerprint.
qualityScore (type: integer(), default: nil) -
spamScore (type: integer(), default: nil) - Blog scoring signals.
universalWhitelisted (type: boolean(), default: nil) -
userQualityScore (type: integer(), default: nil) - User and
doc quality scores for updates (aka microposts).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.BlogPerDocData{
blogurlFp: String.t() | nil,
clientSpamminess: integer() | nil,
convTree:
GoogleApi.ContentWarehouse.V1.Model.BlogsearchConversationTree.t() | nil,
copycatScore: integer() | nil,

docQualityScore: integer() | nil,

isSyntacticReshare: boolean() | nil,
microblogQualityExptData:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
numMentions: integer() | nil,
outlinks:
[GoogleApi.ContentWarehouse.V1.Model.BlogPerDocDataOutlinks.t()] | nil,

postContentFingerprint: integer() | nil,

qualityScore: integer() | nil,
spamScore: integer() | nil,

universalWhitelisted: boolean() | nil,

userQualityScore: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BlogPerDocDataOutlinks
Resolved url and site spamscore for outlinks in updates (aka microposts).

Attributes

aggregationFp (type: String.t, default: nil) - Representative id

for an equivalence class of URLs. E.g. http://youtube.com/watch?
v=12 and http://youtube.com/watch?v=12&feature=related have the
same aggregation id since they're effectively the same webpage
resolvedUrl (type: String.t, default: nil) -
siteSpamScore (type: integer(), default: nil) -
title (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.BlogPerDocDataOutlinks{

aggregationFp: String.t() | nil,
resolvedUrl: String.t() | nil,
siteSpamScore: integer() | 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.BlogsearchConversationNod
e
Attributes

authorName (type: String.t, default: nil) - The username of the

author of the microblog post represented by this node.
children (type: list(String.t), default: nil) - A list of docids
of child nodes.
date (type: String.t, default: nil) - The creation date of the
doc.
docid (type: String.t, default: nil) - Docid of the microblog
post represented by this node.
parent (type: String.t, default: nil) - The docid of the parent
node. The root of the tree will leave this empty.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

authorName: String.t() | nil,
children: [String.t()] | nil,
date: String.t() | nil,
docid: String.t() | nil,
parent: 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.BlogsearchConversationTre
e
Attributes

convId (type: String.t, default: nil) - The id of this

conversation.
nodes (type:
list(GoogleApi.ContentWarehouse.V1.Model.BlogsearchConve
default: nil) - The nodes in this conversation.
rsationNode.t),
No particular order is assumed.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

convId: String.t() | nil,
nodes:
[GoogleApi.ContentWarehouse.V1.Model.BlogsearchConversationNode.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BlueGingerClientVisiblePro
toBlueGingerSupportedServices
Information to indicate BG availability for businesses. This message is
filled from Topic Server and stored in the GSR in Superroot.

Attributes

modules (type:
list(GoogleApi.ContentWarehouse.V1.Model.BlueGingerClien
tVisibleProtoBlueGingerSupportedServicesBlueGingerModule
.t), default: nil) - List of supported modules for a business.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.BlueGingerClientVisibleProtoBlueGingerSuppor
tedServices{
modules:
[

GoogleApi.ContentWarehouse.V1.Model.BlueGingerClientVisibleProtoBlueGingerSupport

edServicesBlueGingerModule.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BlueGingerClientVisiblePro
toBlueGingerSupportedServicesBl
ueGingerModule
Attributes

name (type: String.t, default: nil) - Module name, e.g.

hairdresser_reservation. from
quality/views/extraction/kcube/bg/modules/modules.bzl.
services (type: list(String.t), default: nil) - Services of this
module that are supported by the business, e.g. haircuts.
useCase (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.BlueGingerClientVisibleProtoBlueGingerSuppor

tedServicesBlueGingerModule{
name: String.t() | nil,
services: [String.t()] | nil,
useCase: 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.BookCitationPerDocData
Per-doc data for the web page about the cited book Approximate size is
on average ~10bytes

Attributes

bookId (type: String.t, default: nil) - the book id for the main
citation
discretizedCitationScore (type: integer(), default: nil) - the
discretized citation score for the main book. we map the raw score
1.0-20.0 to 0 - 127
previewable (type: boolean(), default: nil) - Is there a preview
or excerpt of the book on this document?
secondBookId (type: String.t, default: nil) - book id for the
second citation if we can't separate the two top citations (they are
too close).
secondDiscretizedCitationScore (type: integer(), default:
nil) - the discretized score for the second citation

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

bookId: String.t() | nil,
discretizedCitationScore: integer() | nil,
previewable: boolean() | nil,
secondBookId: String.t() | nil,
secondDiscretizedCitationScore: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BusinessHours
We divide up a week into individual open intervals. If any are present
then they must be arranged in strictly increasing order, with non-empty
spaces between successive intervals, and all times between 0 and
604800, the number of seconds in a week.

Attributes

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

interval (type:
list(GoogleApi.ContentWarehouse.V1.Model.BusinessHoursIn
terval.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.BusinessHours{

dayopen: integer() | nil,
interval:
[GoogleApi.ContentWarehouse.V1.Model.BusinessHoursInterval.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.BusinessHoursInterval
Attributes

end (type: integer(), default: nil) - The interval ends at the

start of this second
start (type: integer(), default: nil) - Time in seconds since
Midnight-Monday-Morn

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

start: integer() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ChatBotPlatformBotSendTo
ken
Token to be exposed and stored by the bot

Attributes

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

expiryTimeMicros
epoch (micros) that this will expire
sendToken (type: String.t, default: nil) - Encrypted
InternalSendToken

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

expiryTimeMicros: String.t() | nil,

sendToken: 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.ChatBotPlatformFireballId
Attributes

id (type:
GoogleApi.ContentWarehouse.V1.Model.GoogleInternalCommun
default: nil) - When used as
icationsInstantmessagingV1Id.t,
a user ID, it's the phone number of the sender. When used as a
session ID: For group conversation, it is the group ID. For 1 to 1, it
is the receiver or sender phone number. For 1 to bot, it is the
receiver phone number or empty.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

id:

GoogleApi.ContentWarehouse.V1.Model.GoogleInternalCommunicationsInstantmessagingV
1Id.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornClassifierData
Next ID: 6

Attributes

classification (type:
list(GoogleApi.ContentWarehouse.V1.Model.ClassifierPornC
default: nil) -
lassifierDataClassification.t),
imageBasedDetectionDone (type: boolean(), default: nil) -
Records whether the image linker is run already. This is only used
for Alexandria but NOT for Segindexer.
timestamp (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.ClassifierPornClassifierData{

classification:
[

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

| nil,
imageBasedDetectionDone: boolean() | nil,

timestamp: 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.ClassifierPornClassifierData
Classification
Attributes

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

score (type: number(), 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.ClassifierPornClassifierDataClassification{
label: String.t() | nil,
score: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornDocumentDat
a
Next ID: 3

Attributes

classifierdata (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornClassi
fierData.t,default: nil) -
sitedata (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornSiteDa
ta.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.ClassifierPornDocumentData{

classifierdata:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornClassifierData.t() | nil,
sitedata: GoogleApi.ContentWarehouse.V1.Model.ClassifierPornSiteData.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornQueryClassifi
erOutput
Generic output for one vertical.

Attributes

csaiClassification(type: String.t, default: nil) - This field

is only filled for the CSAI vertical.
debug (type: String.t, default: nil) - Human-readable debug
information about the classification. This field is only set if
output_debug is set in the classification input.
isPositive (type: boolean(), default: nil) - The bit that shows
if this classifier outputs positive classification for the input query.
Set by thresholding with a recommended threshold.
score (type: number(), default: nil) - The score that the
classifier assigned to the input query. This is filled by all verticals.

Summary
Types
t()

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

Types

t()

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

debug: String.t() | nil,

isPositive: boolean() | nil,
score: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornQueryMultiL
abelClassifierOutput
Multi-label classification output. It contains the output for each vertical.
The output for some verticals can be empty, in case that vertical is not
supported by the classifier or if the set of verticals was restricted using
MultiLabelClassifierInput.verticals.

Attributes

csai (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.t, default: nil) -
fringe (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.t, default: nil) -
medical (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.t, default: nil) -
minor (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
default: nil) -
lassifierOutput.t,
offensive (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.t, default: nil) -
porn (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.t, default: nil) -
spoof (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
 lassifierOutput.t, default: nil) -
violence (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.t, default: nil) -
vulgar (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryC
lassifierOutput.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.ClassifierPornQueryMultiLabelClassifierOutpu
t{
 csai:

GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,
fringe:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,
medical:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()

| nil,
minor:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,
offensive:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,

porn:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,
spoof:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,
violence:

GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil,
vulgar:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornQueryClassifierOutput.t()
| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornQueryStats
QuerySats contains the information about the queries that users typed to
search for this image.

Attributes

queryTextPornScore (type: number(), default: nil) - A query

text porn score for the queries which have clicks to the image:
query_text_porn_score := sum(clicks(query) *
text_porn_score(query)) / sum(clicks(query))
totalClicks (type: number(), 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.ClassifierPornQueryStats{

queryTextPornScore: number() | nil,
totalClicks: number() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornReferrerCoun
ts
ReferrerCounts stores how many referrers an images has and how many
of them were classified as porn and as adult/softporn respectively. Note
that a referrer is usually a landing page, but as of March 2011 this also
includes referrers which an image can 'inherit' by propagating counts
from near duplicate images.

Attributes

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

porn (type: integer(), default: nil) - Number of referrers which
are classified as porn and as adult.
total (type: integer(), default: nil) - Total number of referrers.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

adult: integer() | nil,
porn: integer() | nil,
total: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornSiteData
Next ID: 53

Attributes

avgPedoPageScore (type: number(), default: nil) - The average

pedo page score for the site.
finalPedoSiteScore (type: number(), default: nil) -
numberOfPages (type: String.t, default: nil) - The number of
pages that were used to compute the scores and ratios.
numberOfPedoPages (type: String.t, default: nil) - The number
of pages with pedo restrict.
site (type: String.t, default: nil) - Sitechunk used to compute
the signals. The field is present only for data created after
December 2022.
sitePornRatio (type: number(), default: nil) - The ratio of
porn/softporn of the site this page belongs to.
siteSoftpornRatio (type: number(), default: nil) -
versionedscore (type:
list(GoogleApi.ContentWarehouse.V1.Model.ClassifierPornS
default: nil) -
iteDataVersionedScore.t),
violenceScore (type: number(), default: nil) - The cubic mean
aggregation of violence page scores in the site.
violenceStats (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornSiteVi
olenceStats.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.ClassifierPornSiteData{

avgPedoPageScore: number() | nil,
finalPedoSiteScore: number() | nil,
numberOfPages: String.t() | nil,
numberOfPedoPages: String.t() | nil,

site: String.t() | nil,

sitePornRatio: number() | nil,
siteSoftpornRatio: number() | nil,
versionedscore:
[

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

]
| nil,
 violenceScore: number() | nil,
violenceStats:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornSiteViolenceStats.t()
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornSiteDataVersi
onedScore
The site porn score of the site to which the page of interest belongs to.
Multiple versions are kept across large changes for some time. The
Version-4 score is the average Universal Page Probability of all the site's
pages, and will come with populated verticals4_score and site_rule (if
any rule fires) fields. When using this score it is recommended to
subscribe to the following mailing list: g/safesearch-announce.

Attributes

score (type: number(), default: nil) -

siteRule (type: list(String.t), default: nil) -
version (type: integer(), default: nil) -
verticals4Score (type: number(), default: nil) - Please talk to
safesearch@ before relying on any of these internal fields:

Summary
Types
t()

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

Types

t()

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

score: number() | nil,

siteRule: [String.t()] | nil,
version: integer() | nil,

verticals4Score: number() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ClassifierPornSiteViolenceSt
ats
Next ID: 6

Attributes

meanFinalViolenceScore (type: number(), default: nil) -

numberOfImages (type: String.t, default: nil) -
numberOfVideos (type: String.t, default: nil) -
videoViolenceScore (type: number(), 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.ClassifierPornSiteViolenceStats{
meanFinalViolenceScore: number() | nil,
numberOfImages: String.t() | nil,
numberOfVideos: String.t() | nil,
videoViolenceScore: number() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CloudAiPlatformTenantreso
urceCloudSqlInstanceConfig
The identity to configure a CloudSQL instance provisioned via SLM
Terraform.

Attributes

cloudSqlInstanceConnectionName (type: String.t, default:

nil) - Output only. The CloudSQL instance connection name.
cloudSqlInstanceName (type: String.t, default: nil) -
Input/Output [Optional]. The CloudSQL instance name within SLM
instance. If not set, a random UUIC will be generated as instance
name.
kmsKeyReference (type: String.t, default: nil) - Input
[Optional]. The KMS key name or the KMS grant name used for
CMEK encryption. Only set this field when provisioning new
CloudSQL instances. For existing CloudSQL instances, this field
will be ignored because CMEK re-encryption is not supported.
mdbRolesForCorpAccess (type: list(String.t), default: nil) -
Input [Optional]. MDB roles for corp access to CloudSQL instance.
slmInstanceName (type: String.t, default: nil) - Output only.
The SLM instance's full resource name.
slmInstanceTemplate (type: String.t, default: nil) - Input
[Required]. The SLM instance template to provision CloudSQL.
slmInstanceType (type: String.t, default: nil) - Input
[Required]. The SLM instance type to provision CloudSQL.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceCloudSqlInstanc
eConfig{
cloudSqlInstanceConnectionName: String.t() | nil,

cloudSqlInstanceName: String.t() | nil,

kmsKeyReference: String.t() | nil,
mdbRolesForCorpAccess: [String.t()] | nil,
slmInstanceName: String.t() | nil,
slmInstanceTemplate: String.t() | nil,
slmInstanceType: 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.CloudAiPlatformTenantreso
urceGcsBucketConfig
The identity to configure a GCS bucket.

Attributes

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

bucketName (type: String.t, default: nil) - Input/Output
[Optional]. The name of a GCS bucket with max length of 63 chars.
If not set, a random UUID will be generated as bucket name.
entityName (type: String.t, default: nil) - Input/Output
[Optional]. Only needed for per-entity tenant GCP resources.
During Deprovision API, the on-demand deletion will only cover
the tenant GCP resources with the specified entity name.
kmsKeyReference (type: String.t, default: nil) - Input/Output
[Optional]. The KMS key name or the KMS grant name used for
CMEK encryption. Only set this field when provisioning new GCS
bucket. For existing GCS bucket, this field will be ignored because
CMEK re-encryption is not supported.
ttlDays (type: integer(), default: nil) - Input/Output
[Optional]. Only needed when the content in bucket need to be
garbage collected within some amount of days.
viewers (type: list(String.t), default: nil) - Input/Output
[Required]. IAM roles (viewer/admin) put on the bucket.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceGcsBucketConfig
{
admins: [String.t()] | nil,
bucketName: String.t() | nil,
entityName: String.t() | nil,
kmsKeyReference: String.t() | nil,

ttlDays: integer() | nil,

viewers: [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.CloudAiPlatformTenantreso
urceIamPolicyBinding
The dynamic IAM bindings to be granted after tenant projects are
created.

Attributes

members (type: list(String.t), default: nil) - Input/Output

[Required]. The member service accounts with the roles above.
Note: placeholders are same as the resource above.
resource (type: String.t, default: nil) - Input/Output
[Required]. The resource name that will be accessed by members,
which also depends on resource_type. Note: placeholders are
supported in resource names. For example, ${tpn} will be used
when the tenant project number is not ready.
resourceType (type: String.t, default: nil) - Input/Output
[Required]. Specifies the type of resource that will be accessed by
members.
role (type: String.t, default: nil) - Input/Output [Required].
The role for members below.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceIamPolicyBindin
g{
members: [String.t()] | nil,
resource: String.t() | nil,

resourceType: String.t() | nil,

role: 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.CloudAiPlatformTenantreso
urceInfraSpannerConfig
The configuration for a spanner database provisioning. Next ID: 8

Attributes

createDatabaseOptions (type:
GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenan
tresourceInfraSpannerConfigCreateDatabaseOptions.t,
default: nil) - Input [Optional]. The options to create a spanner
database. Note: give the right options to ensure the right KMS key
access audit logging and AxT logging in expected logging category.
kmsKeyReference (type: String.t, default: nil) - Input
[Optional]. The KMS key name or the KMS grant name used for
CMEK encryption. Only set this field when provisioning new Infra
Spanner databases. For existing Infra Spanner databases, this field
will be ignored because CMEK re-encryption is not supported. For
example, projects//locations//keyRings//cryptoKeys/
sdlBundlePath (type: String.t, default: nil) - Input [Required].
The file path to the spanner SDL bundle.
spannerBorgServiceAccount (type: String.t, default: nil) -
Input [Optional]. The spanner borg service account for delegating
the kms key to. For example, spanner-infra-cmek-
[email protected], for the nonprod universe.
spannerLocalNamePrefix (type: String.t, default: nil) -
spannerNamespace (type: String.t, default: nil) -
spannerUniverse (type: String.t, default: nil) - Input
[Required]. Every database in Spanner can be identified by the
following path name: /span//:
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceInfraSpannerCon
fig{

createDatabaseOptions:

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceInfraSpannerConf

igCreateDatabaseOptions.t()
| nil,
kmsKeyReference: String.t() | nil,

sdlBundlePath: String.t() | nil,

spannerBorgServiceAccount: String.t() | nil,
spannerLocalNamePrefix: String.t() | nil,
spannerNamespace: String.t() | nil,
 spannerUniverse: 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.CloudAiPlatformTenantreso
urceInfraSpannerConfigCreateDat
abaseOptions
The options to create a spanner database. KMS key access audit logging
and AxT logging will be associated with the given resource name,
resource type and service name. Please ensure to give right options to
enable correct audit logging and AxT logging.

Attributes

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

cloud resource name for the CMEK encryption. For example,
projects//locations/
cmekCloudResourceType (type: String.t, default: nil) - The
cloud resource type for the CMEK encryption. For example,
contentwarehouse.googleapis.com/Location
cmekServiceName (type: String.t, default: nil) - The service
name for the CMEK encryption. For example,
contentwarehouse.googleapis.com

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceInfraSpannerCon
figCreateDatabaseOptions{
cmekCloudResourceName: String.t() | nil,

cmekCloudResourceType: String.t() | nil,

cmekServiceName: 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.CloudAiPlatformTenantreso
urceServiceAccountIdentity
The identity to configure a service account.

Attributes

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

only. The service account email that has been created.
tag (type: String.t, default: nil) - Input/Output [Optional]. The
tag that configures the service account, as defined in
google3/configs/production/cdpush/acl-zanzibar-cloud-
prod/activation_grants/activation_grants.gcl. Note: The default P4
service account has the empty tag.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceServiceAccountI
dentity{
serviceAccountEmail: String.t() | nil,
tag: 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.CloudAiPlatformTenantreso
urceTenantProjectConfig
The identity to configure a tenant project.

Attributes

billingConfig (type:
GoogleApi.ContentWarehouse.V1.Model.GoogleApiServicecons
umermanagementV1BillingConfig.t, default: nil) - Input/Output
[Required]. The billing account properties to create the tenant
project.
folder (type: String.t, default: nil) - Input/Output [Required].
The folder that holds tenant projects and folder-level permissions
will be automatically granted to all tenant projects under the folder.
Note: the valid folder format is folders/{folder_number}.
policyBindings (type:
list(GoogleApi.ContentWarehouse.V1.Model.GoogleApiServic
econsumermanagementV1PolicyBinding.t), default: nil) -
Input/Output [Required]. The policy bindings that are applied to the
tenant project during creation. At least one binding must have the
role roles/owner with either user or group type.
services (type: list(String.t), default: nil) - Input/Output
[Required]. The API services that are enabled on the tenant project
during creation.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantProjectCo

nfig{
billingConfig:

GoogleApi.ContentWarehouse.V1.Model.GoogleApiServiceconsumermanagementV1BillingCo
nfig.t()
| nil,
folder: String.t() | nil,

policyBindings:
[

GoogleApi.ContentWarehouse.V1.Model.GoogleApiServiceconsumermanagementV1PolicyBin
ding.t()
]
| nil,
 services: [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.CloudAiPlatformTenantreso
urceTenantProjectResource
The tenant project and tenant resources. Next ID: 10

Attributes

cloudSqlInstances (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
default: nil) - The
TenantresourceCloudSqlInstanceConfig.t),
CloudSQL instances that are provisioned under the tenant project.
gcsBuckets (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
default: nil) - The GCS
TenantresourceGcsBucketConfig.t),
buckets that are provisioned under the tenant project.
iamPolicyBindings (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
default: nil) - The
TenantresourceIamPolicyBinding.t),
dynamic IAM bindings that are granted under the tenant project.
Note: this should only add new bindings to the project if they don't
exist and the existing bindings won't be affected.
infraSpannerConfigs (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
TenantresourceInfraSpannerConfig.t), default: nil) - The
Infra Spanner databases that are provisioned under the tenant
project. Note: this is an experimental feature.
tag (type: String.t, default: nil) - Input/Output [Required].
The tag that uniquely identifies a tenant project within a tenancy
unit. Note: for the same tenant project tag, all tenant manager
operations should be idempotent.
 tenantProjectConfig (type:
GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenan
tresourceTenantProjectConfig.t,default: nil) - The
configurations of a tenant project.
tenantProjectId (type: String.t, default: nil) - Output only.
The tenant project ID that has been created.
tenantProjectNumber (type: String.t, default: nil) - Output
only. The tenant project number that has been created.
tenantServiceAccounts (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
default:
TenantresourceTenantServiceAccountIdentity.t),
nil) - The service account identities (or enabled API service's
P4SA) that are expclicitly created under the tenant project (before
JIT provisioning during enabled API services).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantProjectRe

source{
cloudSqlInstances:

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceCloudSqlInstance
Config.t()

]
| nil,
gcsBuckets:
[

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

| nil,
iamPolicyBindings:
[

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceIamPolicyBinding

.t()

]
| nil,
infraSpannerConfigs:
[

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceInfraSpannerConf
ig.t()
]

| nil,
 tag: String.t() | nil,
tenantProjectConfig:

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantProjectCon
fig.t()
| nil,
tenantProjectId: String.t() | nil,
tenantProjectNumber: String.t() | nil,
tenantServiceAccounts:
[

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantServiceAcc
ountIdentity.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CloudAiPlatformTenantreso
urceTenantResource
A collection of tenant resources.

Attributes

p4ServiceAccounts (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
default: nil) - A
TenantresourceServiceAccountIdentity.t),
list of P4 service accounts (go/p4sa) to provision or deprovision.
tenantProjectResources (type:
list(GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatform
default: nil) - A
TenantresourceTenantProjectResource.t),
list of tenant projects and tenant resources to provision or
deprovision.

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantResource{
p4ServiceAccounts:

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceServiceAccountId
entity.t()
]
| nil,
tenantProjectResources:

GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantProjectRes
ource.t()
]
| nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CloudAiPlatformTenantreso
urceTenantServiceAccountIdentity
The identity of service accounts that have been explicitly created under
tenant projects.

Attributes

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

only. The email address of the generated service account.
serviceName (type: String.t, default: nil) - Input/Output
[Required]. The service that the service account belongs to. (e.g.
cloudbuild.googleapis.com for GCB service accounts)

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CloudAiPlatformTenantresourceTenantServiceAc
countIdentity{
serviceAccountEmail: String.t() | nil,
serviceName: 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.CommerceDatastoreDeepTa
g
The basic message that contains a single decision output of
go/deeptagger.

Attributes

confidence(type: integer(), default: nil) - The confidence of

the tag, encoded to 14 bits (range [0, 16383]). Due to modeling
details, a large number of tags become trustworthy with confidence
greater than 0.001, so two bytes of precision are required.
tag (type: integer(), default: nil) - A Deep Tag enum in uint32
form.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

confidence: integer() | nil,

tag: integer() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CommerceDatastoreImageD
eepTags
Image-level deep tags: essentially equivalent to the proto above but
containing tags that are computed at the image level. These image
signals are maintained by the Visual Shopping team (visual-shopping@).
If you do use the signals, please add an entry in
go/ShoppingImageAttributeClients to be notified for model upgrade.
We recommend our clients against using the raw confidence value
directly. Instead, the clients should use the library,
cs/ads/shopping/visual/deeptags/public/single_tag.h and
cs/ads/shopping/visual/deeptags/public/single_scored_tag.h to specify an
operating point in terms of precision or recall. See the following code
example:
http://google3/shopping/visual/explore_looks/looks_offline_pipeline.cc?
l=268&rcl=304165166 model_outputs is a repeated field. Please
check version to get the model you desire to use, instead of indexing
the model_outputs directly e.g. model_outputs(0). We will remove the
old versions in the future and this will lead to incorrect model. Models:
As of Q2 2020, we have two models running within Shopping: model
one only has the overlay tag, which we are deprecating, and model two
has the tags specified in go/VisualShoppingImageAttributes.

Attributes

modelOutputs (type:
list(GoogleApi.ContentWarehouse.V1.Model.CommerceDatasto
default: nil) - The set of
reImageDeepTagsModelOutput.t),
outputs for a series of model versions. The size of this field should
 not extend beyond 4 at any time: two versions for slow-update track
dependencies, and two versions for fast-update track dependencies.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

modelOutputs:
[

GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreImageDeepTagsModelOutput.t()
]
| nil
}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CommerceDatastoreImageD
eepTagsModelOutput
Attributes

backgroundType (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
pTag.t,default: nil) -
collage (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
pTag.t,default: nil) -
cropping (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
default: nil) - We are looking to deploy a model for the
pTag.t,
Ads team to identify images with bad cropping. The model will be
for Ads only and we will not populate the cropping field in CDS.
modelType (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
pTag.t,default: nil) -
nfs (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
pTag.t,default: nil) - Tag corresponds to the shopping non-
family safe (nfs) image signal.
objectCount (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
pTag.t,default: nil) -
overlay (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
 pTag.t, default: nil) - Tag corresponding to unwanted text
overlay (watermarks, logos, promotional elements, artifacts, etc).
selfie (type:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDee
pTag.t,default: nil) -
textOverlay (type:
list(GoogleApi.ContentWarehouse.V1.Model.CommerceDatasto
reDeepTag.t), default: nil) - Tag corresponding to the text
overlay classifier (watermarks, logos, promotional elements,
artifacts, etc).
version (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.CommerceDatastoreImageDeepTagsModelOutput{
backgroundType:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
collage:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
cropping:

GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
modelType:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
nfs: GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
objectCount:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,

overlay:

GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
selfie:
GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.t() | nil,
textOverlay:
[GoogleApi.ContentWarehouse.V1.Model.CommerceDatastoreDeepTag.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.CompositeDoc
Protocol record used for collecting together all information about a
document. Please consult go/dj-explorer for two basic questions about
CompositeDoc: - Where should I look up certain information (e.g:
pagerank, language)? - What does each field in CompositeDoc mean and
who should I contact if I have questions? To add a new field into
CompositeDoc, or change existing field's size significantly, please file a
ticket at go/dj-new-field, fill in necessary information and get approved
by docjoin-access@ team. Next id: 194

Attributes

localizedvariations (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocLocalize
dVariations.t,default: nil) -
localizedAlternateName (type:
list(GoogleApi.ContentWarehouse.V1.Model.IndexingConvert
default: nil) - Localized
erLocalizedAlternateName.t),
alternate names are similar to alternate names, except that it is
associated with a language different from its canonical. This is the
subset of webmaster-provided localized alternate names being in
the dup cluster of this document. Used during serving for swapping
in the URL based on regional and language preferences of the user.
forwardingdup (type:
list(GoogleApi.ContentWarehouse.V1.Model.CompositeDocFor
wardingDup.t),default: nil) -
perDocData (type:
GoogleApi.ContentWarehouse.V1.Model.PerDocData.t, default:
nil) -
accessRequirements (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingPrivacyAcces
sAccessRequirements.t, default: nil) - Contains necessary
information to enforce row level Docjoin access control.
properties (type:
GoogleApi.ContentWarehouse.V1.Model.DocProperties.t,
default: nil) -
badSslCertificate (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingBadSSLCertif
default: nil) - This field is present iff the page has a bad
icate.t,
SSL certificate itself or in its redirect chain.
extradup (type:
list(GoogleApi.ContentWarehouse.V1.Model.CompositeDocExt
raDup.t),default: nil) -
subindexid (type: list(String.t), default: nil) -
ptoken (type:
GoogleApi.ContentWarehouse.V1.Model.PtokenPToken.t,
default: nil) - Contains information necessary to perform policy
decision on the usage of the data assosiated with this cdoc.
richcontentData (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterRic
hContentData.t,default: nil) - If present, indicates that some
content was inserted, deleted, or replaced in the document's content
(in CompositeDoc::doc::Content::Representation), and stores
information about what was inserted, deleted, or replaced.
scaledIndyRank (type: integer(), default: nil) - to copy to per-
doc
cseId (type:
list(GoogleApi.ContentWarehouse.V1.Model.QualityProseCSE
default: nil) -
UrlInfo.t),
indexingIntermediate (type: String.t, default: nil) -
Serialized indexing intermediate data.
docVideos (type:
list(GoogleApi.ContentWarehouse.V1.Model.ImageRepository
VideoProperties.t),default: nil) - Info about videos embedded
in the document.
indexinginfo (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocIndexing
Info.t,default: nil) -
localinfo (type:
GoogleApi.ContentWarehouse.V1.Model.LocalWWWInfo.t,
default: nil) -
storageRowTimestampMicros(type: String.t, default: nil) -
Row timestamp in CDoc storage.
partialUpdateInfo (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocPartialU
pdateInfo.t,default: nil) - Only present in partial cdocs.
additionalchecksums (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocAddition
alChecksums.t,default: nil) -
anchors (type:
GoogleApi.ContentWarehouse.V1.Model.Anchors.t, default:
nil) - Mark as non-personal since no personal fields will be
populated in anchors.link_additional_info and
anchors.additional_info. For more details of Search personal
data, see go/dma52-search-cdoc-fields.
registrationinfo (type:
GoogleApi.ContentWarehouse.V1.Model.RegistrationInfo.t,
default: nil) - Information about the most recent creation and
expiration of this domain. It's extracted from domainedge signal.
docAttachments (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
default: nil) - A generic container to hold document
et.t,
annotations and signals. For a full list of extensions live today, see
go/wde.
docinfoPassthroughAttachments (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
et.t, default: nil) - This message set is used for data pushed into
the index using the signals framework that is never to be used in
Mustang or TG Continuum scoring/snippeting code. Any protocol
buffer stored in this message set is automatically returned in a
docinfo response - it ends up in the "info" message set in the
WWWSnippetResponse, so it can be used in post-doc twiddlers and
for display in GWS with no code changes in Mustang or
Teragoogle.
docImages (type:
list(GoogleApi.ContentWarehouse.V1.Model.ImageData.t),
default: nil) - Info about "selected" images associated with the
document for which we (already) have ImageData. For each image
URL, some fixed number of documents are selected as web
referrers for the image URL, and within those selected documents,
we say the image is "selected". Within the remaining documents,
we say the image is "rejected". Note that this distinction is slightly
different from selected for indexing. Only images within
doc_images where is_indexed_by_imagesearch is true will be
selected for indexing. You can find the rejected images at
composite_doc.doc_attachments().get(). You can find images that
are selected, but for which we have no ImageData (yet) at
composite_doc.image_indexing_info().selected_not_indexed_imag
e_link()
includedcontent (type:
list(GoogleApi.ContentWarehouse.V1.Model.CompositeDocInc
ludedContent.t), default: nil) -
porninfo (type:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornDocume
ntData.t,default: nil) - Porn related data used for image and
web search porn classification as well as for diagnostics purposes.
urldate (type: String.t, default: nil) - Date in the url extracted
by quality/snippets/urldate/date-in-url.cc This is given as midnight
GMT on the date in question.
embeddedContentInfo (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingEmbeddedCont
entEmbeddedContentInfo.t, default: nil) - Data produced by the
embedded-content system. This is a thin message, containing only
embedded_links_info data for the embedder and JavaScript/CSS
embedded links (the embedded-content bigtable also contains
snapshots, compressed document trees and all embedded link
types). Provided using the index signal API.
richsnippet (type:
GoogleApi.ContentWarehouse.V1.Model.RichsnippetsPageMap.
t,default: nil) - rich snippet extracted from the content of a
document.
qualitysignals (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocQualityS
default: nil) -
ignals.t,
anchorStats (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingDocjoinerAnc
default: nil) - Mark as non-personal since it's
horStatistics.t,
an aggregation of anchors. For more details of Search personal data,
see go/dma52-search-cdoc-fields.
alternatename (type:
list(GoogleApi.ContentWarehouse.V1.Model.CompositeDocAlt
ernateName.t), default: nil) -
dataVersion (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingDocjoinerDat
default: nil) - Contains the tracking version of
aVersion.t,
various data fields in CompositeDoc.
syntacticDate (type:
GoogleApi.ContentWarehouse.V1.Model.QualityTimebasedSynt
acticDate.t,default: nil) -
url (type: String.t, default: nil) - WARNING!!! "url" field in
CompositeDoc is optional, and is usually missing: e.g., Docjoin
CompositeDoc's don't have CompositeDoc::url. has_url() checking
is often useful. So don't rely on CompositeDoc::url unless you're
sure otherwise. Usually you want to use CompositeDoc::doc::url
instead.
docjoinsOnSpannerCommitTimestampMicros (type: String.t,
default: nil) - The commit timestamp of a CDoc update to
 Docjoins on Spanner.
ContentChecksum96 (type: String.t, default: nil) - Visible
content checksum as computed by
repository::parsehandler::checksum::Checksum96bitsParseHandler.
The value is a Fprint96 in "key format" (i.e., by Fprint96::AsKey()).
liveexperimentinfo (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocLiveExpe
rimentInfo.t,default: nil) -
labelData (type:
GoogleApi.ContentWarehouse.V1.Model.QualityLabelsGoogleL
abelData.t, default: nil) - This field associates a document to
particular labels and assigns confidence values to them.
sitemap (type:
GoogleApi.ContentWarehouse.V1.Model.Sitemap.t, default:
nil) - Sitelinks: a collection of interesting links a user might be
interested in, given they are interested in this document.
WARNING: this is different from the crawler Sitemaps (see
SitemapsSignals in the attachments).
robotsinfolist (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocRobotsIn
default: nil) -
foList.t,
doc (type:
GoogleApi.ContentWarehouse.V1.Model.GDocumentBase.t,
default: nil) -
(type: integer(), default: nil) - URL
csePagerankCutoff
should only be selected for CSE Index if it's pagerank is higher than
cse_pagerank_cutoff.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

ContentChecksum96: String.t() | nil,
accessRequirements:

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

| nil,
additionalchecksums:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocAdditionalChecksums.t()
| nil,
alternatename:
[GoogleApi.ContentWarehouse.V1.Model.CompositeDocAlternateName.t()] | nil,
anchorStats:

GoogleApi.ContentWarehouse.V1.Model.IndexingDocjoinerAnchorStatistics.t()
| nil,
anchors: GoogleApi.ContentWarehouse.V1.Model.Anchors.t() | nil,
badSslCertificate:
GoogleApi.ContentWarehouse.V1.Model.IndexingBadSSLCertificate.t() | nil,
cseId: [GoogleApi.ContentWarehouse.V1.Model.QualityProseCSEUrlInfo.t()] | nil,
csePagerankCutoff: integer() | nil,

dataVersion:
 GoogleApi.ContentWarehouse.V1.Model.IndexingDocjoinerDataVersion.t() | nil,
doc: GoogleApi.ContentWarehouse.V1.Model.GDocumentBase.t() | nil,
docAttachments:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
docImages: [GoogleApi.ContentWarehouse.V1.Model.ImageData.t()] | nil,
docVideos:

[GoogleApi.ContentWarehouse.V1.Model.ImageRepositoryVideoProperties.t()]
| nil,
docinfoPassthroughAttachments:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
docjoinsOnSpannerCommitTimestampMicros: String.t() | nil,
embeddedContentInfo:

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

| nil,
extradup:
[GoogleApi.ContentWarehouse.V1.Model.CompositeDocExtraDup.t()] | nil,
forwardingdup:

[GoogleApi.ContentWarehouse.V1.Model.CompositeDocForwardingDup.t()] | nil,
includedcontent:
[GoogleApi.ContentWarehouse.V1.Model.CompositeDocIncludedContent.t()] | nil,
indexingIntermediate: String.t() | nil,
indexinginfo:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocIndexingInfo.t() | nil,
labelData:
GoogleApi.ContentWarehouse.V1.Model.QualityLabelsGoogleLabelData.t() | nil,
liveexperimentinfo:

GoogleApi.ContentWarehouse.V1.Model.CompositeDocLiveExperimentInfo.t() | nil,
localinfo: GoogleApi.ContentWarehouse.V1.Model.LocalWWWInfo.t() | nil,
localizedAlternateName:
[

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

]
| nil,
 localizedvariations:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocLocalizedVariations.t()
| nil,

partialUpdateInfo:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocPartialUpdateInfo.t() | nil,
perDocData: GoogleApi.ContentWarehouse.V1.Model.PerDocData.t() | nil,
porninfo:
GoogleApi.ContentWarehouse.V1.Model.ClassifierPornDocumentData.t() | nil,
properties: GoogleApi.ContentWarehouse.V1.Model.DocProperties.t() | nil,
ptoken: GoogleApi.ContentWarehouse.V1.Model.PtokenPToken.t() | nil,

qualitysignals:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocQualitySignals.t() | nil,
registrationinfo:
GoogleApi.ContentWarehouse.V1.Model.RegistrationInfo.t() | nil,
richcontentData:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterRichContentData.t()
| nil,

richsnippet:
GoogleApi.ContentWarehouse.V1.Model.RichsnippetsPageMap.t() | nil,
robotsinfolist:
GoogleApi.ContentWarehouse.V1.Model.CompositeDocRobotsInfoList.t() | nil,
scaledIndyRank: integer() | nil,
sitemap: GoogleApi.ContentWarehouse.V1.Model.Sitemap.t() | nil,
storageRowTimestampMicros: String.t() | nil,
subindexid: [String.t()] | nil,

syntacticDate:
GoogleApi.ContentWarehouse.V1.Model.QualityTimebasedSyntacticDate.t() | nil,
url: String.t() | nil,
urldate: 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.CompositeDocAdditionalCh
ecksums
Additional checksums of the document.

Attributes

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

as ContentChecksum96 but without transient boilerplate.
SimHash (type: String.t, default: nil) - Deprecated. Use
simhash_v2 and simhash_v2_significance instead.
SimHashIsTrusted (type: boolean(), default: nil) -
simhashV2 (type: String.t, default: nil) - Simhash-v2 is
generated by SimHashParseHandler, designed as a complete
replacement of simhash-v1 (a.k.a. the original simhash above) from
ApproxDupsParseHandler. Simhash-v2 uses a revised algorithm so
that it is expected to work better in most cases than simhash-v1.
They coexist in current transition period, then simhash-v1 will be
retired.
simhashV2Significance (type: float(), default: nil) -
Simhash-v2-significance is used to describe the confidence about
the corresponding simhash-v2 value. It is defined as the average
absolute difference from zero of all internal state components when
finalizing a simhash-v2 value in HashMultiSetDotCauchy. We used
to compare the significance against some pre-defined threshold
(default: 20) to get a boolean value "trusted_simhash_v2".
However, it is possible that this field is missing while "simhash_v2"
is present, in such case (1) Use "SimHashIsTrusted" instead if it is
present, AND/OR (2) Assume "simhash_v2" is trusted if its value is
non-zero.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

SimHash: String.t() | nil,

SimHashIsTrusted: boolean() | nil,
simhashV2: String.t() | nil,
simhashV2Significance: float() | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocAlternateNa
me
Alternate names are some urls that we would like to associate with
documents in addition to canonicals. Sometimes we may want to serve
these alternatenames instead of canonicals. Alternames in CompositeDoc
should come from WebMirror pipeline.

Attributes

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

UrlEncoding (type: integer(), default: nil) - See
webutil/urlencoding
ecnFp (type: String.t, default: nil) - Fp96 of webmirror
equivalence class as of last time this was exported.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

Url: String.t() | nil,
UrlEncoding: integer() | nil,
ecnFp: 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.CompositeDocExtraDup
The top non-forwarding dups of the canonical url.

Attributes

ecnFp (type: String.t, default: nil) - Fp96 of webmirror

equivalence class as of last time this was exported.
url (type: String.t, default: nil) - The url of the non-
forwarding dup.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

ecnFp: 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.CompositeDocForwardingD
up
The top forwarding dups of the canonical url. (note: it may actually
include some dups that are NOT used for forwarding data but for making
"info:" complete)

Attributes

ecn (type: String.t, default: nil) - The name of the url's

webmirror equivalence class.
ecnFp (type: String.t, default: nil) -
purposes (type: integer(), default: nil) - The purpose(s) of the
forwarding dup indicating if it is used for forwarding signal/anchors
generally, or only for forwarding some specific signal (e.g.
navboost), or for some other purposes (e.g., not for forwarding any
data but for making "info:" complete). See
indexing/dups/public/dups.h for more details.
rawPagerank (type: integer(), default: nil) - Raw pagerank of
the url.
repid (type: String.t, default: nil) - The webmirror repid of
the forwarding dup.
url (type: String.t, default: nil) - The url of the forwarding
dup.
urlencoding (type: integer(), default: nil) - The encoding of
the url (see webutil/urlencoding 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.CompositeDocForwardingDup{

ecn: String.t() | nil,

ecnFp: String.t() | nil,
purposes: integer() | nil,
rawPagerank: integer() | nil,
repid: String.t() | nil,
url: String.t() | nil,
urlencoding: integer() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocIncludedCont
ent
Attributes

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

how this content came to be included. Legal values are constructed
by bitwise-OR-ing values from the included_content::SourceType
enum. Default SourceTypeBitfield =
included_content::INCLUDED_FRAME
includedDoc (type:
GoogleApi.ContentWarehouse.V1.Model.GDocumentBase.t,
default: nil) -
linkUrl (type: String.t, default: nil) -
perDocData (type:
GoogleApi.ContentWarehouse.V1.Model.PerDocData.t, default:
nil) -
properties (type:
GoogleApi.ContentWarehouse.V1.Model.DocProperties.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.CompositeDocIncludedContent{

SourceTypeBitfield: String.t() | nil,
includedDoc: GoogleApi.ContentWarehouse.V1.Model.GDocumentBase.t() | nil,
linkUrl: String.t() | nil,
perDocData: GoogleApi.ContentWarehouse.V1.Model.PerDocData.t() | nil,
properties: GoogleApi.ContentWarehouse.V1.Model.DocProperties.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocIndexingInfo
Contains information mostly used within indexing (e.g. not used for
building the production serving shards). Most of this data is generated
only in Alexandria, however there are exceptions.

Attributes

cdocBuildInfo (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingDocjoinerCDo
cBuildInfo.t, default: nil) - To hold extra info for building a
final cdoc from raw cdoc and goldmine annotations.
contentProtected (type: boolean(), default: nil) - Whether
current page is under content protection, i.e. a page has been
crawled as an error page, but we preserve its last known good
content and keep its crawl_status as
converter.CrawlStatus::CONTENT.
convertToRobotedReason (type: integer(), default: nil) - If
set, indicates that the crawl status was converted to ROBOTED for
the reason specified by the enum value in
converter.RobotedReasons.ConvertToRobotedReasons. See
indexing/converter/proto/converter.proto for details. If unset, then
the document was not converted to roboted, and if the document
crawl status is ROBOTED, then the document is disallowed (at
least to Google) in robots.txt.
crawlStatus (type: integer(), default: nil) - One of the enum
values in converter.CrawlStatus.State (see
indexing/converter/proto/converter.proto for details). Default is
converter.CrawlStatus::CONTENT. The document is roboted if the
value is converter.CrawlStatus::ROBOTED.
demotionTags (type: list(String.t), default: nil) -
errorType (type: integer(), default: nil) - One of the enum
values in converter.ErrorPageType (see
indexing/converter/proto/error-page-detector-enum.proto for detail).
Default is converter::ERROR_PAGE_NONE.
freshdocsCorpora (type: list(String.t), default: nil) -
hostid (type: String.t, default: nil) - The host id of the
document. Used chiefly to determine whether the document is part
of a parked domain.
ieIdentifier (type: String.t, default: nil) - A short
descriptive string to help identify the IE application or setup where
this CDoc is generated. For example: websearch_m3 This field is
for debuggability purposes.
imageIndexingInfo (type:
GoogleApi.ContentWarehouse.V1.Model.ImageSearchImageInde
xingInfo.t,default: nil) - Indexing info about images (i.e. image
links missing image data, etc).
indexingTs (type: String.t, default: nil) - The timestamp (the
time since the Epoch, in microseconds) when the docjoin is
exported from indexing. The main purpose of this field is to identify
different versions of the same document.
noLongerCanonicalTimestamp (type: String.t, default: nil) - If
set, the timestamp in microseconds when the URL stopped being
canonical. This should never be set for exported canonical
documents. This field is used by dups during canonical flip, and by
webmain when doc selection switched between desktop and mobile.
Union respects this timestamp to prevent old doc being deleted until
the new doc is picked up
normalizedClickScore (type: number(), default: nil) - This
score is calculated by re-mapping the back onto the partition's score
distribution, such that the score represents the score of the
equivalently ranked organically-selected document.
primaryVertical (type: String.t, default: nil) - Vertical
membership of the document. - primary_vertical is the vertical
that initiated indexing of this document (or empty if the vertical was
websearch). - verticals is the full list of verticals that contained
this document (excluding websearch) at indexing time.
primary_vertical may or may not be an element of verticals
because of vertical membership skew between the ingestion time
and indexing time. See go/one-indexing-for-web for more
background.
rawNavboost (type: integer(), default: nil) - The raw navboost
count for the canonical url without aggregating the navboost from
dup urls. This field is used when building forwarding map.
rowTimestamp (type: String.t, default: nil) - The timestamp
(the time since the Epoch, in microseconds) to represent doc
version, which is used in the downstream processing after Raffia. If
it's not set, indexing_ts will be used as row_timestamp. The
timestamp is generally set by reprocessing to set slightly newer
indexing_ts such that the system can respect the reprocessed
version to overwrite old data in storage.
selectionTierRank (type: number(), default: nil) - Selection
tier rank is a language normalized score ranging from 0-1 over the
serving tier (Base, Zeppelins, Landfills) for this document.
tracingId (type: list(String.t), default: nil) - The tracing ids
is to label the version of url for url status tracking. This repeated
field will carry at most 10 tracing id. See more details in go/rich-
tracing-design There will be less than 2% base+uz cdocs carrying
this field. The major sources of tracing ids include: Indexing API
pushed urls Index Metrics sampling urls The tracing ids will be
written into cdocs by Webmain Ramifier. The consumer of the
tracing ids is Union serving notification collector see more at
go/serving-notification-from-union
urlChangerate (type:
GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrl
Changerate.t, default: nil) - Changerate information for this doc
(see crawler/changerate/changerate.proto for details).
urlHistory (type:
GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrl
default: nil) - Url change history for this doc (see
History.t,
crawler/changerate/changerate.proto for details). Note if a doc has
 more than 20 changes, we only keep the last 20 changes here to
avoid adding to much data in its docjoin.
urlPatternSignals (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingSignalAggreg
atorUrlPatternSignals.t, default: nil) - UrlPatternSignals for
this doc, used to compute document score in LTG (see
indexing/signal_aggregator/proto/signal-aggregator.proto for
details).
verticals (type: list(String.t), default: nil) -
videoIndexingInfo (type:
GoogleApi.ContentWarehouse.V1.Model.ImageRepositoryVideo
IndexingInfo.t, default: nil) - Indexing info about videos.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.CompositeDocIndexingInfo{
cdocBuildInfo:
GoogleApi.ContentWarehouse.V1.Model.IndexingDocjoinerCDocBuildInfo.t() | nil,
contentProtected: boolean() | nil,
convertToRobotedReason: integer() | nil,
crawlStatus: integer() | nil,
demotionTags: [String.t()] | nil,
errorType: integer() | nil,

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

hostid: String.t() | nil,
ieIdentifier: String.t() | nil,
imageIndexingInfo:
GoogleApi.ContentWarehouse.V1.Model.ImageSearchImageIndexingInfo.t() | nil,
indexingTs: String.t() | nil,
noLongerCanonicalTimestamp: String.t() | nil,

normalizedClickScore: number() | nil,

primaryVertical: String.t() | nil,

rawNavboost: integer() | nil,

rowTimestamp: String.t() | nil,
selectionTierRank: number() | nil,
tracingId: [String.t()] | nil,
urlChangerate:

GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrlChangerate.t() | nil,
urlHistory:
GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrlHistory.t() | nil,
urlPatternSignals:

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

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

videoIndexingInfo:
GoogleApi.ContentWarehouse.V1.Model.ImageRepositoryVideoIndexingInfo.t()
| nil
}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocLiveExperime
ntInfo
Contains information needed for end-to-end live experiments. For a cdoc
generated by production pipeline, it includes experiment IDs that have
selected current document. For a cdoc generated by experiment pipeline,
it includes current experiment ID.

Attributes

perLiveExperimentInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.CompositeDocLiv
default: nil) - List
eExperimentInfoPerLiveExperimentInfo.t),
of necessary information for each live experiments.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

perLiveExperimentInfo:
[

GoogleApi.ContentWarehouse.V1.Model.CompositeDocLiveExperimentInfoPerLiveExperime
ntInfo.t()
]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocLiveExperime
ntInfoPerLiveExperimentInfo
Contains information for a live experiment.

Attributes

experimentId (type: String.t, default: nil) - ID of a live

experiment.
partialCdoc (type:
GoogleApi.ContentWarehouse.V1.Model.CompositeDoc.t,
default: nil) - Partial CDoc for a live experiment.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CompositeDocLiveExperimentInfoPerLiveExperim
entInfo{
experimentId: String.t() | nil,

partialCdoc: GoogleApi.ContentWarehouse.V1.Model.CompositeDoc.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocLocalizedVari
ations
Attributes

dupsComputedAlternateNames (type:
list(GoogleApi.ContentWarehouse.V1.Model.IndexingDupsCom
default: nil) -
putedLocalizedAlternateNamesLocaleEntry.t),
A subset of computed variations, only the members which are dups
to the main url. Used during serving for swapping in the URL based
on regional and language preferences of the user.
webmasterAlternateNames (type:
list(GoogleApi.ContentWarehouse.V1.Model.IndexingConvert
default: nil) - All localized
erLocalizedAlternateName.t),
alternate names provided by the webmaster (canonical and dups,
indexed and not-indexed). Used on the ranking side for swapping
out results based on the webmaster preference.

Summary
Types
t()

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

Types

t()

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

GoogleApi.ContentWarehouse.V1.Model.IndexingDupsComputedLocalizedAlternateNamesLo
caleEntry.t()
]
| nil,
webmasterAlternateNames:

GoogleApi.ContentWarehouse.V1.Model.IndexingConverterLocalizedAlternateName.t()
]
| nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocPartialUpdate
Info
Contains information about the partial updates present in a partial
CompositeDoc.

Attributes

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

List of goldmine annotator updates present in the enclosing partial
cdoc.
imagesSignalNames (type: list(String.t), default: nil) - List
of images signal updates present in the enclosing partial cdoc.
Images signal name for a images signal is the unique name for the
signal according to SignalSpec.
lastFullIndexingInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.CompositeDocPar
tialUpdateInfoLastFullIndexingInfo.t),default: nil) -
Contains last full indexing information for partial updates.
shouldLookupDocjoinsTier (type: integer(), default: nil) -
Which tier we should do cdoc lookup to merge partial cdocs. This
uses the integer value of indexing.selection.CorpusId. NOT
intended for other usage.
shouldLookupDocjoinsVerticalCorpus (type: String.t, default:
nil) - Which vertical docjoin corpus we should do cdoc lookup to
merge partial cdocs. This uses the string value of table name in
google3/indexing/docjoins/spanner/schema/global_tables_data.sdl.
For example, Voce and ShortVideo. NOT intended for other usage.
signalNames (type: list(String.t), default: nil) - List of
signal updates present in the enclosing partial cdoc. Signal name for
 a signal is unique name for the signal according to SignalSpec.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

goldmineAnnotatorNames: [String.t()] | nil,
imagesSignalNames: [String.t()] | nil,
lastFullIndexingInfo:
[

GoogleApi.ContentWarehouse.V1.Model.CompositeDocPartialUpdateInfoLastFullIndexing
Info.t()
]
| nil,
shouldLookupDocjoinsTier: integer() | nil,
 shouldLookupDocjoinsVerticalCorpus: String.t() | nil,

signalNames: [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.CompositeDocPartialUpdate
InfoLastFullIndexingInfo
Last full indexing information for the partial CDoc.

Attributes

corpus (type: String.t, default: nil) - The corpus of last full

updates.
lastFullIndexingTsMicros (type: String.t, default: nil) -
Last full update indexing timestamp in microseconds.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CompositeDocPartialUpdateInfoLastFullIndexin

gInfo{
corpus: String.t() | nil,
lastFullIndexingTsMicros: 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.CompositeDocQualitySignal
s
Note: This is a misleading name as of 2022/10/14. The field is still set
and has meaningful data, but no longer holds quality signals. All the data
are freshness-related and they're not particularly sensitive.

Attributes

lastSignificantUpdate (type:
GoogleApi.ContentWarehouse.V1.Model.QualityTimebasedLast
default: nil) - Contains a date used for the
SignificantUpdate.t,
"Date Last Modified" toolbelt restrict mode. Note: this date is a
combined date and is different from the pure shingle-based signal
stored in contentage.last_significant_update field.
pagetype (type:
GoogleApi.ContentWarehouse.V1.Model.QualityTimebasedPage
Type.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.CompositeDocQualitySignals{

lastSignificantUpdate:
GoogleApi.ContentWarehouse.V1.Model.QualityTimebasedLastSignificantUpdate.t()
| nil,
pagetype:
GoogleApi.ContentWarehouse.V1.Model.QualityTimebasedPageType.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompositeDocRobotsInfoLi
st
List of robots info parsed for the user-agents other than the default used
to crawl this page.

Attributes

newsRobotsInfo (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterRob
otsInfo.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.CompositeDocRobotsInfoList{

newsRobotsInfo:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterRobotsInfo.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CompressedQualitySignals
A message containing per doc signals that are compressed and included
in Mustang and TeraGoogle. For TeraGoogle, this message is included in
perdocdata which means it can be used in preliminary scoring.
CAREFUL: For TeraGoogle, this data resides in very limited serving
memory (Flash storage) for a huge number of documents. Next id: 43

Attributes

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

UGC page quality signals. (Times 1000 and floored)
productReviewPPromotePage (type: integer(), default: nil) -
experimentalQstarDeltaSignal (type: number(), default: nil) -
This field is not propagated to shards. It is meant to be populated at
serving time using one of the versions present in the
experimental_nsr_team_wsj_data field above (using the
ExperimentalNsrTeamDataOverridesParams opti to populate it;
see http://source/search?
q=ExperimentalNsrTeamDataOverridesParams%20file:ascorer.prot
o). The purpose of this field is to be read by an experimental Q*
component, in order to quickly run LEs with new delta components.
See go/0DayLEs for details.
productReviewPDemoteSite (type: integer(), default: nil) -
Product review demotion/promotion confidences. (Times 1000 and
floored)
experimentalQstarSiteSignal (type: number(), default: nil) -
This field is not propagated to shards. It is meant to be populated at
serving time using one of the versions present in the
experimental_nsr_team_wsj_data field above (using the
ExperimentalNsrTeamDataOverridesParams opti to populate it;
see http://source/search?
q=ExperimentalNsrTeamDataOverridesParams%20file:ascorer.prot
o). The purpose of this field is to be read by an experimental Q*
component, in order to quickly run LEs with new site components.
See go/0DayLEs for details.
exactMatchDomainDemotion (type: integer(), default: nil) -
Page quality signals converted from fields in proto QualityBoost in
quality/q2/proto/quality-boost.proto. To save indexing space, we
convert the float values in [0, 1] to integers in range [0, 1023] (use
10 bits). exact_match_domain_demotion: converted from
QualityBoost.emd.boost.
nsrVersionedData (type:
list(GoogleApi.ContentWarehouse.V1.Model.NSRVersionedIte
m.t),default: nil) - Versioned NSR score to be used in
continuous evaluation of the upcoming NSR version and assess
quality impact on various slices. This field is deprecated - used the
equivalent field inside nsr_data_proto instead.
nsrConfidence (type: integer(), default: nil) - NSR
confidence score: converted from quality_nsr.NsrData. This field is
deprecated - use nsr_variance inside nsr_data_proto instead.
lowQuality (type: integer(), default: nil) - S2V low quality
score: converted from quality_nsr.NsrData, applied in Qstar. See
quality_nsr::util::ConvertNsrDataToLowQuality.
navDemotion (type: integer(), default: nil) - nav_demotion:
converted from QualityBoost.nav_demoted.boost.
pqData (type: integer(), default: nil) - Encoded page-level PQ
signals.
siteAuthority (type: integer(), default: nil) - site_authority:
converted from quality_nsr.SiteAuthority, applied in Qstar.
crapsNewUrlSignals (type: String.t, default: nil) - For
craps[url|pattern]_signals, please avoid accessing these fields
directly, even in minor ways like checking has_craps*. Instead,
please use methods from quality/navboost/craps/craps-lossy-
compression.h or talk to craps-team@.
babyPandaV2Demotion (type: integer(), default: nil) - New
BabyPanda demotion, applied on top of Panda. This is meant to
replace |baby_panda_demotion|.
authorityPromotion (type: integer(), default: nil) - authority
promotion: converted from QualityBoost.authority.boost
productReviewPUhqPage (type: integer(), default: nil) - The
possibility of a page being a high quality review page.
crapsAbsoluteHostSignals (type: integer(), default: nil) -
Impressions, unsquashed, host level, not to be used with
compressed ratios. Not to be used in Pattern Data.
productReviewPPromoteSite (type: integer(), default: nil) -
nsrOverrideBid (type: number(), default: nil) - NSR override
bid, used in Q* for emergency overrides. This field is deprecated -
used the equivalent field inside nsr_data_proto instead.
babyPandaDemotion (type: integer(), default: nil) -
baby_panda_demotion: converted from
QualityBoost.rendered.boost.
serpDemotion (type: integer(), default: nil) - serp demotion:
applied in Qstar.
anchorMismatchDemotion (type: integer(), default: nil) -
anchor_mismatch_demotion: converted from
QualityBoost.mismatched.boost.
crapsNewHostSignals (type: String.t, default: nil) -
experimentalQstarSignal (type: number(), default: nil) - This
field is not propagated to shards. It is meant to be populated at
serving time using one of the versions present in the
experimental_nsr_team_wsj_data field above (using the
ExperimentalNsrTeamDataOverridesParams opti to populate it;
see http://source/search?
q=ExperimentalNsrTeamDataOverridesParams%20file:ascorer.prot
o). The purpose of this field is to be read by an experimental Q*
component, in order to quickly run LEs with new components. See
go/0DayLEs for details.
pairwiseqScoringData (type:
GoogleApi.ContentWarehouse.V1.Model.PairwiseQScoringData
 default: nil) - Deprecated and unused field.
.t,
topicEmbeddingsVersionedData (type:
list(GoogleApi.ContentWarehouse.V1.Model.QualityAuthorit
yTopicEmbeddingsVersionedItem.t), default: nil) - Versioned
TopicEmbeddings data to be populated later into superroot / used
directly in scorers.
scamness (type: integer(), default: nil) - Scam model score.
Used as one of the web page quality qstar signals. Value range from
0 to 1023.
crapsUnscaledIpPriorBadFraction (type: integer(), default:
nil) -
pandaDemotion (type: integer(), default: nil) - This is the
encoding of Panda fields in the proto SiteQualityFeatures in
quality/q2/proto/site_quality_features.proto. The encoding/decoding
is performed using functions from quality_coati::coati_util.
unauthoritativeScore (type: integer(), default: nil) -
Unauthoritative score. Used as one of the web page quality qstar
signals.
experimentalNsrTeamWsjData (type:
list(GoogleApi.ContentWarehouse.V1.Model.QualityNsrExper
imentalNsrTeamWSJData.t), default: nil) - This field is not
propagated to shards, but it's populated at serving time by go/web-
signal-joins (see b/207344056). See go/0DayLEs for details. This is
only meant to be used during LEs, it should not be used for
launches.
experimentalNsrTeamData (type:
GoogleApi.ContentWarehouse.V1.Model.QualityNsrExperiment
alNsrTeamData.t, default: nil) - This field is not propagated to
shards, but it's populated at serving time by go/web-signal-joins
(see b/207344056). See go/0DayLEs for details. This is only meant
to be used during LEs, it should not be used for launches.
productReviewPReviewPage (type: integer(), default: nil) -
Fields product_review_p_review_page and
product_review_p_uhq_page are for promoting/demoting HQ/LQ
 review pages in NGS. See go/pr-boosts for details. The possibility
of a page being a review page.
pqDataProto (type:
GoogleApi.ContentWarehouse.V1.Model.QualityNsrPQData.t,
default: nil) - Stripped page-level signals, not present in the
encoded field 'pq_data'.
pairwiseqVersionedData (type:
list(GoogleApi.ContentWarehouse.V1.Model.PairwiseQVersio
nedItem.t),default: nil) - Versioned PairwiseQ score to be used
in continuous evaluation of the upcoming PairwiseQ versions and
assess quality impact on various slices.
crapsNewPatternSignals (type: String.t, default: nil) -
vlqNsr (type: integer(), default: nil) - NSR for low-quality
videos, converted from quality_nsr.NsrData.vlq_nsr. This field is
deprecated - used the equivalent field inside nsr_data_proto instead.
productReviewPDemotePage (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.CompressedQualitySignals{

anchorMismatchDemotion: integer() | nil,

authorityPromotion: integer() | nil,
babyPandaDemotion: integer() | nil,
babyPandaV2Demotion: integer() | nil,
crapsAbsoluteHostSignals: integer() | nil,
crapsNewHostSignals: String.t() | nil,
crapsNewPatternSignals: String.t() | nil,
crapsNewUrlSignals: String.t() | nil,

crapsUnscaledIpPriorBadFraction: integer() | nil,

exactMatchDomainDemotion: integer() | nil,
experimentalNsrTeamData:
GoogleApi.ContentWarehouse.V1.Model.QualityNsrExperimentalNsrTeamData.t()
| nil,
experimentalNsrTeamWsjData:
[

GoogleApi.ContentWarehouse.V1.Model.QualityNsrExperimentalNsrTeamWSJData.t()
]
| nil,
experimentalQstarDeltaSignal: number() | nil,
experimentalQstarSignal: number() | nil,
experimentalQstarSiteSignal: number() | nil,

lowQuality: integer() | nil,

navDemotion: integer() | nil,
nsrConfidence: integer() | nil,
nsrOverrideBid: number() | nil,
nsrVersionedData:
[GoogleApi.ContentWarehouse.V1.Model.NSRVersionedItem.t()] | nil,
pairwiseqScoringData:

GoogleApi.ContentWarehouse.V1.Model.PairwiseQScoringData.t() | nil,
pairwiseqVersionedData:
 [GoogleApi.ContentWarehouse.V1.Model.PairwiseQVersionedItem.t()] | nil,
pandaDemotion: integer() | nil,
pqData: integer() | nil,

pqDataProto: GoogleApi.ContentWarehouse.V1.Model.QualityNsrPQData.t() | nil,

productReviewPDemotePage: integer() | nil,
productReviewPDemoteSite: integer() | nil,
productReviewPPromotePage: integer() | nil,
productReviewPPromoteSite: integer() | nil,
productReviewPReviewPage: integer() | nil,
productReviewPUhqPage: integer() | nil,

scamness: integer() | nil,

serpDemotion: integer() | nil,
siteAuthority: integer() | nil,
topicEmbeddingsVersionedData:
[

GoogleApi.ContentWarehouse.V1.Model.QualityAuthorityTopicEmbeddingsVersionedItem.

t()
]
| nil,
ugcDiscussionEffortScore: integer() | nil,
unauthoritativeScore: integer() | nil,
vlqNsr: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.ConceptsConceptId
Attributes

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

id (type: String.t, default: nil) - uint64 bring lots of issues, and
string a better practice.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

conceptId: String.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.ContentAttributions
The following protobuf is used to store an attribution from one page to
(usually) one other page, giving credit for the content. This information
is used during ranking to promote the attributed page. This protobuf is
copied from a quality_contra::SelectedAttribution. See
//quality/contra/authorship/attribution and
https://qwiki.corp.google.com/display/Q/ContentTrackingContentAttribu
tion.

Attributes

freshdocsOutgoing (type:
list(GoogleApi.ContentWarehouse.V1.Model.ContentAttribut
default: nil) - Selected outgoing
ionsOutgoingAttribution.t),
attributions extracted on FreshDocs.
offlineOutgoing (type:
list(GoogleApi.ContentWarehouse.V1.Model.ContentAttribut
default: nil) - Selected outgoing
ionsOutgoingAttribution.t),
attributions extracted via offline MR jobs.
onlineOutgoing (type:
list(GoogleApi.ContentWarehouse.V1.Model.ContentAttribut
default: nil) - Selected outgoing
ionsOutgoingAttribution.t),
attributions extracted online on Alexandria.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

freshdocsOutgoing:
[

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

]
| nil,
offlineOutgoing:
[

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

| nil,
onlineOutgoing:
[

GoogleApi.ContentWarehouse.V1.Model.ContentAttributionsOutgoingAttribution.t()
]
| nil

}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ContentAttributionsOutgoin
gAttribution
This is a copy of quality_contra::SelectedAttribution::SelectedInfo. The
url is converted to docid and other fields are copied directly.

Attributes

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

docid (type: String.t, default: nil) -
properties (type: integer(), default: nil) -
usableForClustering (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.ContentAttributionsOutgoingAttribution{
bestEvidenceType: String.t() | nil,
docid: String.t() | nil,
properties: integer() | nil,

usableForClustering: boolean() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ContentAwareCropsIndexin
g
Attributes

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

representation for Mustang storage. See
image/search/utils/packed_crops.h for details on the packing
format.
mustangBytesVersion (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.ContentAwareCropsIndexing{

mustangBytes: String.t() | nil,
mustangBytesVersion: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CopleyLexicalMetadata
Contains lexical metadata for a given reference. For example, this proto
will be used to store locale-specific Lexical mids for contact
relationships (e.g. /g/11gv0vypg4 is the mid for mother in english and
/g/11gmy_gv87 is for mother in french) as an extension to
QRefAnnotation::other_metadata, when available.

Attributes

canonicalLexicalMid(type: String.t, default: nil) - Mid for

an entity that has lexical data (a LexiconEntry). See
https://g3doc.corp.google.com/nlp/generation/g3doc/lexical_data.m
d for for more information about lexical data. This is the canonical
mid for this entity (eg. it would be for "mother" in EN even if user
referred to "mom").

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

canonicalLexicalMid: 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.CopleyPersonalReference
Represents a reference made by a user that refers to some personal
entity.

Attributes

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

personalReferenceType
manner in which the entity was referenced (e.g. "my hotel", "the
airport").

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

personalReferenceType: 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.CopleyPersonalReferenceM
etadata
General message used to store metadata about references to personal
entities, even if those entities cannot be resolved.

Attributes

referenceScore (type: number(), default: nil) - The strength of

the personal reference. For example "my flight" may receive a high
reference_score, whereas "the airport" may receive a low score.
references (type:
list(GoogleApi.ContentWarehouse.V1.Model.CopleyPersonalR
eference.t),default: nil) - A list of all references made. Empty
if no personal references exist. Multiple references can be present
when multiple references were made in a single query, or the type
of reference was ambiguous.
subreferenceMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.CopleySubreferenceMe
default: nil) - Subreference metadata for all compound
tadata.t,
references on this span.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.CopleyPersonalReferenceMetadata{
referenceScore: number() | nil,

references:
[GoogleApi.ContentWarehouse.V1.Model.CopleyPersonalReference.t()] | nil,
subreferenceMetadata:
GoogleApi.ContentWarehouse.V1.Model.CopleySubreferenceMetadata.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CopleySourceTypeList
Attributes

sourceTypeMetadata (type:
list(GoogleApi.ContentWarehouse.V1.Model.CopleySourceTyp
eMetadata.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.CopleySourceTypeList{
sourceTypeMetadata:
[GoogleApi.ContentWarehouse.V1.Model.CopleySourceTypeMetadata.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CopleySourceTypeMetadata
Contains the source and type information related to a personal entity, for
example if it's an hotel or a restaurant (type) and if it comes from gmail,
calendar, etc. (source). Next ID: 13

Attributes

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

Annotation ID of a contact annotation, e.g. a relationship set via
Assistant. This ID is generated by People Write Server. It is used to
delete Contact Annotations via People API.
displayableName (type: String.t, default: nil) -
emailIdentifier (type: String.t, default: nil) - Only used if
personal_data_provenance == PERSONAL_SOURCE_GMAIL.
Used to create a link to the source email in the form:
mail.google.com/mail/u/0/?extsrc=sync&client=h&plid=
{email_identifier}
eventId (type:
GoogleApi.ContentWarehouse.V1.Model.EventIdMessage.t,
default: nil) - Populated for some footprints data sources;
uniquely identifies the footprint that generated the personal data
that this provenance is attached to.
localDiscoverySettingsMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.PersonalizationSetti
ngsApiProtoLocalDiscoveryLocalDiscoverySettingsMetadata.
t, default: nil) -
personalDataProvenance(type: String.t, default: nil) -
personalDataType (type: String.t, default: nil) -
provenanceCategory (type: list(String.t), default: nil) -
 sensitivity (type:
GoogleApi.ContentWarehouse.V1.Model.KnowledgeAnswersSens
default: nil) - Sensitivity applying to this
itivitySensitivity.t,
copley annotation.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

contactAnnotationId: String.t() | nil,

displayableName: String.t() | nil,

emailIdentifier: String.t() | nil,
eventId: GoogleApi.ContentWarehouse.V1.Model.EventIdMessage.t() | nil,
localDiscoverySettingsMetadata:

GoogleApi.ContentWarehouse.V1.Model.PersonalizationSettingsApiProtoLocalDiscovery
 LocalDiscoverySettingsMetadata.t()
| nil,
personalDataProvenance: String.t() | nil,
personalDataType: String.t() | nil,
provenanceCategory: [String.t()] | nil,

sensitivity:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CopleySubreferenceMetadat
a
Represents the most compound resolved entities and most nested
unresolved references for a span. Useful for punting.

Attributes

mostCompoundResolvedEntities (type:
list(GoogleApi.ContentWarehouse.V1.Model.CopleySubrefere
default: nil) - Resolved entities are sorted
nceResolution.t),
from highest resolution score to lowest.
mostNestedUnresolvedReference (type:
GoogleApi.ContentWarehouse.V1.Model.CopleySubreferenceRe
default: nil) - This is a merged representation of the
ference.t,
compound reference having the most_compound_resolved_entities
as an argument.

Summary
Types
t()

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

Types

t()

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

mostCompoundResolvedEntities:
[GoogleApi.ContentWarehouse.V1.Model.CopleySubreferenceResolution.t()] | nil,
mostNestedUnresolvedReference:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CopleySubreferenceReferen
ce
Represents a reference that may be part of a larger compound reference.
For example, "my brother's birthday" will have a subreference that may
have references for "my brother".

Attributes

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

Type of reference. There may be multiple for a single reference
(e.g. relationship and contact).
referenceScore (type: number(), default: nil) - Highest
reference score for any references merged in this span.
relationshipLexicalInfo (type:
GoogleApi.ContentWarehouse.V1.Model.CopleyLexicalMetadat
default: nil) - Only set for unresolved relationship references
a.t,
and can be used to get the canonical word for the relationship (e.g.
"mother") in TTS.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

personalReferenceTypes: [String.t()] | nil,
referenceScore: number() | nil,

relationshipLexicalInfo:
GoogleApi.ContentWarehouse.V1.Model.CopleyLexicalMetadata.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CopleySubreferenceResoluti
on
Represents a resolution that may be part of a larger compound reference.
For example, "my brother's birthday" will have a subreference that may
have resolutions for "my brother".

Attributes

mid (type: String.t, default: nil) - Can be used with PKG

Service for looking up metadata about this entity at
fulfillment/GenX time.
name (type: String.t, default: nil) - Name of the entity
represented by this resolution.
resolutionScore (type: number(), default: nil) - A resolution
score of 0 indicates that it did not resolve to a real entity.

Summary
Types
t()

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

Types

t()

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

mid: String.t() | nil,
name: String.t() | nil,

resolutionScore: number() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CorpusSelectionInfo
Attributes

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

corpusScore (type: number(), default: nil) - Corpus specific
score for an image
isSelectedForIndexing (type: boolean(), default: nil) -
Whether an image was selected for indexing.
referrerDocid (type: list(String.t), default: nil) - Set of
referrers indexed with the image.
referrerUrls (type: list(String.t), default: nil) - Set of
referrer urls indexed with the 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.CorpusSelectionInfo{

corpus: String.t() | nil,

corpusScore: number() | nil,
isSelectedForIndexing: boolean() | nil,
referrerDocid: [String.t()] | nil,
referrerUrls: [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.CountryClickDistribution
Attributes

confidence (type: float(), default: nil) - To store confidence in

the distribution in cases when total is not set.
item (type:
list(GoogleApi.ContentWarehouse.V1.Model.CountryClickDis
default: nil) -
tributionItem.t),
total (type: float(), default: nil) - To store total clicks on this
page/domain.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

confidence: float() | nil,

item:
[GoogleApi.ContentWarehouse.V1.Model.CountryClickDistributionItem.t()] | nil,
total: float() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CountryClickDistributionIte
m
Attributes

doubleValue (type: float(), default: nil) -

name (type: String.t, default: nil) -
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.CountryClickDistributionItem{
doubleValue: float() | nil,
name: String.t() | 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.CountryCountryAttachment
If you add new fields to this message, do not use any tag value less than
the "Next free tag" below. The lower tag values might be missing in this
file, but they were used in past for some field, so cannot be used again.
Next free tag: 44

Attributes

debug (type: String.t, default: nil) - A non critical field to store

debug info for a country attachment. Used in experiments and for
debugging.
salientCountrySet (type:
GoogleApi.ContentWarehouse.V1.Model.QualitySalientCountr
default: nil) -
iesSalientCountrySet.t,
provinceGeotokenList (type:
list(GoogleApi.ContentWarehouse.V1.Model.CountryProvince
Geotoken.t), default: nil) -
countryidFromUgc (type: boolean(), default: nil) - Is true if the
country attachment was computed through the UGC pipeline.
fromUrlPattern (type: boolean(), default: nil) -
weightAboveIdealForLocalness (type: float(), default: nil) -
If result is global, store weight above ideal, as a confidence signal.
Used in query localness, cleared in production CountryAttachment.
existNextLevel (type: boolean(), default: nil) -
global (type: boolean(), default: nil) -
urlPatternBasedCountry (type: integer(), default: nil) -
fromLanguageFallback (type: boolean(), default: nil) -
Booleans to keep track of where the country-id of the page came
from. These are used for debugging and/or unittests, and cleared in
production.
salientCountries (type:
list(GoogleApi.ContentWarehouse.V1.Model.CountrySalientC
ountry.t), default: nil) - [Experimental]: Top salient countries
for a doc. If a country can not be found on this field it can be
considered that this doc is not relevant to it.
fromRestricts (type: boolean(), default: nil) -
relatedCountries (type: list(String.t), default: nil) - two-
letter(lower-case) countrycode, e.g. us countries that is related to,
but not local to
relatedCountryCodes (type: list(integer()), default: nil) -
sitename (type: String.t, default: nil) - Domain name of keys
in filtering metro reducer class, used only by the intermediate
mapreduces to produce filtered data.
fromUgc (type: boolean(), default: nil) -
localCountryCodes (type: list(integer()), default: nil) -
Fields that actually store the country id in docjoins. The format of
this data is defined in
//i18n/identifiers/stableinternalregionconverter.cc. Converter
defined there can be used to convert it to RegionCode format.
clickDistribution (type:
GoogleApi.ContentWarehouse.V1.Model.CountryClickDistribu
tion.t,default: nil) - Store weighted click distribution for page
level country-id classification.
localCountries (type: list(String.t), default: nil) - two-
letter(lower-case) countrycode, e.g. us countries that is local to
geoLocations (type:
GoogleApi.ContentWarehouse.V1.Model.CountryGeoLocations.
t, default: nil) - New MetroID: Now called GeoLocations since
the locations could be sublocalities, cities or states. GeoLocations
are always more fine grained than country. TODO (jayeshv): Once
new MetroID/GeoLocations is launched everywhere, deleted old
MetroID related fields.
superGlobal (type: boolean(), default: nil) - Super global
pages get lesser demotion than global pages. A document can only
be either global or super_global but not both.
 (type: boolean(), default: nil) -
isValidForCountryRestrict
Set to true if the local_countries field can be used for country
restricts as well.
documentLocationSource (type: String.t, default: nil) -
Specifies the origin of geo_locations. Right now, it can either
come from deprecated Docloc system or the new Brainloc system
when Docloc doesn't have sufficient evidence.
fromSgDomains (type: boolean(), default: nil) -
fromWmx (type: boolean(), default: nil) -
userVisibleCountryFromLogs (type: String.t, default: nil) -
This is used to store the visible country id computed from logs data
fromTld (type: boolean(), default: nil) -
metroIdList (type:
list(GoogleApi.ContentWarehouse.V1.Model.CountryMetroNBF
eature.t), default: nil) - Metro locations: list of NavBoost
feature V2 associated with a doc, along with the enclosing province.
Metro locations with new tags.
restrictCountries (type: list(String.t), default: nil) - List
of two-letter(lower-case) countrycodes(e.g. us) valid for restricts.
Typically cloned out of local_countries if
is_valid_for_country_restrict is set to true.
debugSourceUrl (type: list(String.t), default: nil) - Set to
the signal source URLs when merging country signals in
Alexandria during sitemoves. Essentially if sites A and B move to
C, and we merge A and B's signal to C, in the countryattachment
signal C will have URL A and B as source_url. Only used for
debugging and it doesn't show up in docjoins.
wmxCountry (type: String.t, default: nil) - Country specified
for a web-site through webmaster console.
metroNavboost (type:
list(GoogleApi.ContentWarehouse.V1.Model.CountryMetroNBF
eature.t),default: nil) - Metro navboost: list of (NavBoost
feature V2, navboost float) pairs.
urlPatternBasedLanguage (type: integer(), default: nil) -
Language and country extracted using the URL pattern map.
 metroLocationId (type: list(String.t), default: nil) - Metro
level data. metro_location_id stores geotokens for metro restricts.
userVisibleLocalCountry (type: integer(), default: nil) -
This is the country id we show to users on the result page. This is
kept different from country demotion country id because we dont
want to expose our backoff and url based detection algorithm - also
we want to be ultra conservative in showing this.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

clickDistribution:
GoogleApi.ContentWarehouse.V1.Model.CountryClickDistribution.t() | nil,
countryidFromUgc: boolean() | nil,
debug: String.t() | nil,
 debugSourceUrl: [String.t()] | nil,
documentLocationSource: String.t() | nil,
existNextLevel: boolean() | nil,
fromLanguageFallback: boolean() | nil,
fromRestricts: boolean() | nil,

fromSgDomains: boolean() | nil,

fromTld: boolean() | nil,
fromUgc: boolean() | nil,
fromUrlPattern: boolean() | nil,
fromWmx: boolean() | nil,
geoLocations:
GoogleApi.ContentWarehouse.V1.Model.CountryGeoLocations.t() | nil,
global: boolean() | nil,

isValidForCountryRestrict: boolean() | nil,

localCountries: [String.t()] | nil,
localCountryCodes: [integer()] | nil,
metroIdList:
[GoogleApi.ContentWarehouse.V1.Model.CountryMetroNBFeature.t()] | nil,
metroLocationId: [String.t()] | nil,
metroNavboost:

[GoogleApi.ContentWarehouse.V1.Model.CountryMetroNBFeature.t()] | nil,
provinceGeotokenList:
[GoogleApi.ContentWarehouse.V1.Model.CountryProvinceGeotoken.t()] | nil,
relatedCountries: [String.t()] | nil,
relatedCountryCodes: [integer()] | nil,
restrictCountries: [String.t()] | nil,
salientCountries:

[GoogleApi.ContentWarehouse.V1.Model.CountrySalientCountry.t()] | nil,
salientCountrySet:

GoogleApi.ContentWarehouse.V1.Model.QualitySalientCountriesSalientCountrySet.t()
| nil,
sitename: String.t() | nil,
superGlobal: boolean() | nil,

urlPatternBasedCountry: integer() | nil,

urlPatternBasedLanguage: integer() | nil,
 userVisibleCountryFromLogs: String.t() | nil,
userVisibleLocalCountry: integer() | nil,
weightAboveIdealForLocalness: float() | nil,
wmxCountry: 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.CountryGeoLocation
Stores one location and all meta-data associated with that location.

Attributes

clickRadius50Percent (type: integer(), default: nil) - The

radius (in miles) around the assigned location that the document
gets 50% of its clicks.
confidence (type: number(), default: nil) - Confidence on the
location. Ranges in [0.0, 1.0]. Cleared during index creation.
confidencePercent (type: integer(), default: nil) -
Confidence mapped to [0, 100]. Converted to integer for efficient
storage. Populated during index creation.
internalId (type: integer(), default: nil) - Used for
compressed docloc data. In compressed data, instead of
location_info, only an integer ID for that LocationInfo is stored. A
separate lookup table is used to get full LocationInfo from the
internal ID.
locationInfo (type:
GoogleApi.ContentWarehouse.V1.Model.CountryLocationInfo.
t, default: nil) -
propagatedFromASubpage (type: boolean(), default: nil) - True
if this location is assigned to one of the subpages, and not to the
page itself. If the total number of locations assigned to all the
subpages of a page is small (usually up to 5), then that page also
gets assigned those locations, and this flag is set for those locations.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

clickRadius50Percent: integer() | nil,
confidence: number() | nil,
confidencePercent: integer() | nil,

internalId: integer() | nil,

locationInfo:
GoogleApi.ContentWarehouse.V1.Model.CountryLocationInfo.t() | nil,
propagatedFromASubpage: boolean() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CountryGeoLocations
List of locations assigned to a document.

Attributes

geoLocation (type:
list(GoogleApi.ContentWarehouse.V1.Model.CountryGeoLocat
ion.t), default: nil) -
isNonLocationSpecific (type: boolean(), default: nil) - This
will be set to true for documents which receive several clicks but
are not assigned any location because the click distribution is flat.
Typical examples are global sites like facebook.com, chains like
walmart.com, informational sites like wikipedia.org etc. This flag is
not propagated to deeper pages since this signal is meant to indicate
that a website or a part of website is conclusively non-local, so
propagating this information to deeper pages does not make sense.
If this flag is set, then the only possible geo_location will be the
ones which are propagated_from_a_subpage.
propagationDepthFromParent (type: integer(), default: nil) -
Depth of the URL from it's nearest parent in GeoLocation data.
Webpages inherhit locations from their parent pages. For example,
if foo.com/a is assigned location L1, and foo.com/a/b is not
assigned any location, then http://www.foo.com/a/b inherits
location L1 from it's nearest parent foo.com/a in GeoLocation data.
This attribute is the distance from the nearest parent which is
present in GeoLocation data. In this particular case, it will be 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.CountryGeoLocations{

geoLocation:
[GoogleApi.ContentWarehouse.V1.Model.CountryGeoLocation.t()] | nil,

isNonLocationSpecific: boolean() | nil,

propagationDepthFromParent: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.CountryLocationInfo
This represents one location.

Attributes

center (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t
, default: nil) - The latitude and longitude of the conceptual center
of the location. For cities, this would be the center of the
downtown, or maybe the location of city hall. For states and
countries it might be the capital city. But there are no guarantees
and this may be any random point inside the location.
city (type: String.t, default: nil) -
country (type: String.t, default: nil) - Human readable name
hierarchy. Only the relevant fields will be present. For example for
city GeoLocations, sub_locality field will not be present. Cleared
during index creation.
county (type: String.t, default: nil) -
enclosingStateFeatureId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - Oyster feature ID of the enclosing state.
to.t,
Cleared during index creation.
featureId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - Oyster feature ID of the location. Cleared
during index creation.
state (type: String.t, default: nil) -
stateIdFprint (type: integer(), default: nil) - 32 bit
fingerprint of the feature id of the state of this location. For cities
and sub-localities it will be the enclosing state. For state locations,
 it will be fingerprint of the feture-id of the location itself. Populated
during index creation.
subLocality (type: String.t, default: nil) -
type (type: String.t, default: nil) - Type of the location (sub-
locality, city, state 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.CountryLocationInfo{

center: GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t() | nil,

city: String.t() | nil,

country: String.t() | nil,
county: String.t() | nil,
enclosingStateFeatureId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
 featureId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
state: String.t() | nil,
stateIdFprint: integer() | nil,
subLocality: String.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.CountryMetroNBFeature
A metro feature, keyed by NavBoost feature id V2. This can be a metro
id, a boost, or extended in the future to add probabilities or weights.

Attributes

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

The enclosing_province_geotoken is a 32 bit fingerprint of the state
encosing the (metro) id. MetroId's can span multiple states.
Enclosing geotoken is filled in with the state name for
disambiguation. ProvinceGeotoken field is different as it indicates
an "interest". Format: 32 bit fingerprint(statecountry).
id (type: integer(), default: nil) - A 32 bit navboost v2 feature
id encoding (country, language, metro). NavBoosterUtils class
(google3/quality/navboost/nav_booster_utils.h) provides functions
to decode this feature.
navboost (type: number(), default: nil) - This is the multiplier to
apply to the result for this locale & query. NOTE: This is for
serving purposes only and should not be populated in the index.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

enclosingProvinceGeotoken: integer() | nil,

id: integer() | nil,

navboost: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CountryProvinceGeotoken
A 32 bit fingerprint of a state level geotoken. The geotoken is in the
following format: statecountry. These indicate a page is of interest to
these states/regions of a country. The use of message is to enable easy
additions of probabilities or weights per metro id in the future.

Attributes

geotoken (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.CountryProvinceGeotoken{

geotoken: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CountrySalientCountry
Salient Countries is an estimated probability (salience) of a doc to be
relevant to a country. On this message, countries are represented as int32
(the format of this data is defined in
i18n/identifiers/stableinternalregionconverter.cc). Salience is a value in
range [0.0 - 1.0] in which 1.0 represents a high likelihood to be relevant
to the country

Attributes

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

countryCode (type: integer(), default: nil) -
salience (type: number(), 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.CountrySalientCountry{

compressedSalience: integer() | nil,

countryCode: integer() | nil,
salience: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrawlerChangerateMultiple
ComponentDistribution
Proto contains parameters for a multiple component distributions, where
each component has non-negative weight and the sum of component
weights is 1.

Attributes

components (type:
list(GoogleApi.ContentWarehouse.V1.Model.CrawlerChangera
teSingleComponentDistribution.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.CrawlerChangerateMultipleComponentDistributi
on{
components:
[

GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateSingleComponentDistribution.

t()
]

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrawlerChangerateSingleC
omponentDistribution
Proto contains parameters of a single component distribution.

Attributes

logScaling(type: number(), default: nil) - Scaling factor to

ensure the approximated posterior to have the same scale as the
product of prior and likelihood. This value is used to compute
posterior weights. Uses log scale to provide a wider range. This
field is for internal use only.
type (type: String.t, default: nil) - The type indicates the type
of the distribution.
weight (type: number(), default: nil) - The weight is only used
in multiple component scenarios.

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateSingleComponentDistribution
{
logScaling: number() | nil,
type: String.t() | nil,
weight: number() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrawlerChangerateUrlCha
nge
NEXT_TAG: 13

Attributes

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

Duplicate UrlChanges crawled within a specified time range will be
merged together. UrlChanges are considered duplicates if the
simhash, simhash_is_trusted, simhash_v2, simhash_v2_is_trusted,
and shingle_simhash are the same. additional_changes_merged
indiciates the number of duplicate UrlChanges merged into this
UrlChange.
fractionalTileChange (type: float(), default: nil) -
Deprecated fields. The fraction of tiles (0 to 1) that changed.
interval (type: integer(), default: nil) - The length in seconds
of the change.
offDomainLinksChange (type: boolean(), default: nil) -
Whether the content of the off-domain links changed.
offDomainLinksCount (type: integer(), default: nil) - The new
count of off-domain links, if they changed.
onDomainLinksCount (type: integer(), default: nil) - The new
count of on-domain links, if the count changed.
onDomainLinksCountChange (type: boolean(), default: nil) -
Whether the number of on-domain links changed.
shingleSimhash (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterShi
default: nil) - The old simhash value
ngleFingerprint.t,
obtained from shingles.
 simhash (type: String.t, default: nil) - The simhash-v1 value.
Use of simhash-v1 is deprecated, and newer UrlChange should only
contain simhash-v2. During this transition period, UrlChange can
contain either simhash or simhash_v2. It is possible that previous
UrlChange only contain simhash-v1 and the next UrlChange only
contain simhash-v2. In this case, we skip that interval in our
changerate computation. [go/changerate-simhash-v2-migration]
simhashIsTrusted (type: boolean(), default: nil) - Whether the
simhash-v1 should be trusted.
simhashV2 (type: String.t, default: nil) - The simhash-v2
value.
simhashV2IsTrusted (type: boolean(), default: nil) - Whether
the simhash-v2 value should 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.CrawlerChangerateUrlChange{
additionalChangesMerged: integer() | nil,
fractionalTileChange: float() | nil,
interval: integer() | nil,
offDomainLinksChange: boolean() | nil,
offDomainLinksCount: integer() | nil,

onDomainLinksCount: integer() | nil,

onDomainLinksCountChange: boolean() | nil,
shingleSimhash:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterShingleFingerprint.t()
| nil,
simhash: String.t() | nil,
simhashIsTrusted: boolean() | nil,

simhashV2: String.t() | nil,

simhashV2IsTrusted: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrawlerChangerateUrlCha
ngerate
The next available field number is 22. To access the best estimate of
change period, please use GetChangePeriod in predict-change-rate.h to
select between this and other change period estimates below.

Attributes

approximatedPosterior (type:
GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateMul
tipleComponentDistribution.t, default: nil) - The
approximated posterior distribution.
averageChangeSignificance (type: float(), default: nil) - The
"significance" of the average change we saw of this document
(from 0 to 1). Influenced by content changes. This can be used for
prioritizing the crawl (higher significance first).
changeperiod (type: integer(), default: nil) -
//////////////////////////////////////////////////////////////////////////// The classic
changerate estimation.
//////////////////////////////////////////////////////////////////////////// The classic
estimate of change period (in seconds). It is computed by inserted a
"fake" change and no-change interval as a prior distribution. This
field is generally not used and should NOT be accessed directly.
See above for correct method for determining the change period
estimate.
confidence (type: float(), default: nil) - The confidence
(between 0 and 1) in the changeperiod guess.
globalBasedChangePeriod (type: integer(), default: nil) -
//////////////////////////////////////////////////////////////////////////// The
changerate estimation based on the global prior.
//////////////////////////////////////////////////////////////////////////// The global-
based changeperiod. This is our estimate (in seconds) for the
average time between changes. It is computed using the new prior
method based on global_based_prior_period and the
global_based_prior_strength specified below. This is used for
computing pattern priors. Use pattern_based_change_period or
changeperiod fields for all other purposes.
globalBasedChangePeriodConfidence (type: float(), default:
nil) - The 'confidence' of the global-based changeperiod. This is
the n-th root of the posterior evaluated at MAP point, where n is the
number of history intervals. For now, it is hard to interpret the
meaning of the absolute values of 'average' posterior cross different
sets of data.
globalBasedPriorPeriod (type: float(), default: nil) - The 2
parameters below specify the prior employed in calculating the
global_based_change_period. These values are precomputed
through an offline analysis and specified via flags.
globalBasedPriorStrength (type: float(), default: nil) -
lastChangeSignificance (type: float(), default: nil) - The
"significance" of the last change we saw of this document (from 0
to 1). Influenced by content changes, etc. This can be used for
prioritizing the crawl (higher significance first).
lastChanged (type: integer(), default: nil) - The last time
(unix timestamp) we saw a changed copy of the document.
Provided iff we have seen the page change.
lastFetched (type: integer(), default: nil) - The last time
(unix timestamp) we saw a fetched copy of the document.
numIntervals (type: integer(), default: nil) - The number of
intervals we've seen for this document (where an interval is two
different versions).
patternBasedChangePeriod (type: integer(), default: nil) -
//////////////////////////////////////////////////////////////////////////// The
changerate estimation based on the pattern prior.
//////////////////////////////////////////////////////////////////////////// The pattern-
based changeperiod. This is our estimate (in seconds) for the
average time between changes. It is calculated based on the
pattern_based_prior_period and pattern_based_prior_strength
below. This quantity will eventually replace the old changeperiod
calculation.
patternBasedChangePeriodConfidence (type: float(), default:
nil) - The same as global_based_change_period_confidence,
except it is computed using pattern based priors.
patternBasedLowerChangePeriod (type: integer(), default:
nil) - The lower edge of a confidence interval for the pattern-
based change period.
patternBasedPriorPeriod (type: float(), default: nil) - The 2
parameters below specify the prior employed in calculating the
pattern_based_change_period. These values are calculated in a
separate process and looked up based on the URL pattern.
patternBasedPriorStrength (type: float(), default: nil) -
patternChangePeriodVersion (type: integer(), default: nil) -
The version number of the algorithm, refer to ChangePeriodVersion
for more information.
type (type: integer(), default: nil) -
//////////////////////////////////////////////////////////////////////////// Basic
information of a document.
//////////////////////////////////////////////////////////////////////////// The type of
the document determined by crawl histories, refer to TYPE for
more information.
ugcChangePeriod (type: integer(), default: nil) -
//////////////////////////////////////////////////////////////////////////// The UGC
changerate estimation.
//////////////////////////////////////////////////////////////////////////// Information
on change period generated from user generated content (UGC)
change history.
ugcChangePeriodConfidence (type: float(), 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.CrawlerChangerateUrlChangerate{

approximatedPosterior:

GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateMultipleComponentDistributio
n.t()
| nil,
averageChangeSignificance: float() | nil,
changeperiod: integer() | nil,
confidence: float() | nil,

globalBasedChangePeriod: integer() | nil,

globalBasedChangePeriodConfidence: float() | nil,
globalBasedPriorPeriod: float() | nil,
globalBasedPriorStrength: float() | nil,
lastChangeSignificance: float() | nil,
 lastChanged: integer() | nil,
lastFetched: integer() | nil,
numIntervals: integer() | nil,

patternBasedChangePeriod: integer() | nil,

patternBasedChangePeriodConfidence: float() | nil,
patternBasedLowerChangePeriod: integer() | nil,
patternBasedPriorPeriod: float() | nil,
patternBasedPriorStrength: float() | nil,
patternChangePeriodVersion: integer() | nil,
type: integer() | nil,

ugcChangePeriod: integer() | nil,

ugcChangePeriodConfidence: float() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrawlerChangerateUrlHisto
ry
Attributes

change (type:
list(GoogleApi.ContentWarehouse.V1.Model.CrawlerChangera
teUrlChange.t), default: nil) - All the changes we've seen for
this URL.
latestVersion (type:
GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrl
Version.t,default: nil) - The latest version we've seen.
url (type: String.t, default: nil) - This field in only set in
'url_history' column of Union repository to avoid having to read
CompositeDocs.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

change:
[GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrlChange.t()] | nil,

latestVersion:
GoogleApi.ContentWarehouse.V1.Model.CrawlerChangerateUrlVersion.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.CrawlerChangerateUrlVersi
on
NEXT_TAG: 15

Attributes

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

Same as the field in UrlChange. This allows us to merge identical
UrlVersions into a single UrlVersion.
contentType (type: integer(), default: nil) - The content type
of the page.
isImsNotModified (type: boolean(), default: nil) - Whether
this is an IMS response (a 304, not modified).
lastModified (type: integer(), default: nil) - The date from
the LastModified header, if present.
shingleSimhash (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingConverterShi
ngleFingerprint.t, default: nil) - The simhash value obtained
from shingles.
simhash (type: String.t, default: nil) - The simhash-v1 value.
The simhash-v1 is now deprecated and new UrlVersions should
only populate simhash-v2. During migration phase from using
simhash-v1 to simhash-v2, it is possible that previous UrlChange
only contain simhash-v1 and the next UrlChange / UrlVersion could
only contain simhash-v2. In this case, we skip that interval in our
changerate computation. [go/changerate-simhash-v2-migration]
simhashIsTrusted (type: boolean(), default: nil) - Whether the
simhash-v1 should be trusted.
 simhashV2 (type: String.t, default: nil) - The simhash-v2
value.
simhashV2IsTrusted (type: boolean(), default: nil) - Whether
the simhash-v2 value should be trusted.
timestamp (type: integer(), default: nil) - The timestamp we
crawled the page.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

additionalChangesMerged: integer() | nil,
contentType: integer() | nil,
isImsNotModified: boolean() | nil,
lastModified: integer() | nil,

shingleSimhash:
 GoogleApi.ContentWarehouse.V1.Model.IndexingConverterShingleFingerprint.t()
| nil,

simhash: String.t() | nil,

simhashIsTrusted: boolean() | nil,
simhashV2: String.t() | nil,
simhashV2IsTrusted: boolean() | nil,
timestamp: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrowdingPerDocData
Attributes

newscluster (type:
list(GoogleApi.ContentWarehouse.V1.Model.CrowdingPerDocD
ataNewsCluster.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.CrowdingPerDocData{
newscluster:
[GoogleApi.ContentWarehouse.V1.Model.CrowdingPerDocDataNewsCluster.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.CrowdingPerDocDataNews
Cluster
For crowding in news we need to keep data about the last X clustering
iterations around.

Attributes

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

combination of all urls in a cluster
ClusterSize (type: integer(), default: nil) - This is the X in
the "and X related >>" link on headlines and search results
ClusterTimeStamp (type: integer(), default: nil) - When was
this clustered (needed for keeping last X iterations around and
discarding earlier ones)

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

ClusterId: String.t() | nil,
ClusterSize: integer() | nil,
ClusterTimeStamp: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DeepCropIndexing
Attributes

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

representation for indexing, see creatism::CropBitmap for details on
the packing 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.DeepCropIndexing{
cropBytes: 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.DeepCropPixels
Attributes

x0 (type: integer(), default: nil) - Pixels version of the

DeepCropIndexing bytes, this corresponds to the crop box for a
given image (based input image size and desired aspect ratio).
x1 (type: integer(), default: nil) -
y0 (type: integer(), default: nil) -
y1 (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.DeepCropPixels{

x0: integer() | nil,
x1: integer() | nil,
y0: integer() | nil,
y1: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DocProperties
NOTE: In segindexer, the docproperties of a document may be reused
from a previous cycle if its content is not changed. If you add a new field
to DocProperties, make sure it is taken care (i.e., gets copied from a
previous cycle to the current document) in
CDocProperties::EndDocument().

Attributes

avgTermWeight (type: integer(), default: nil) - The average

weighted font size of a term in the doc body
badTitle (type: boolean(), default: nil) - Missing or
meaningless title
badtitleinfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.DocPropertiesBa
default: nil) -
dTitleInfo.t),
languages (type: list(integer()), default: nil) - A Language
enum value. See: go/language-enum
leadingtext (type:
GoogleApi.ContentWarehouse.V1.Model.SnippetsLeadingtextL
default: nil) - Leading text information
eadingTextInfo.t,
generated by google3/quality/snippets/leadingtext/leadingtext-
detector.cc
numPunctuations (type: integer(), default: nil) -
numTags (type: integer(), default: nil) -
numTokens (type: integer(), default: nil) - The number of
tokens, tags and punctuations in the tokenized contents. This is an
approximation of the number of tokens, tags and punctuations we
end up with in mustang, but is inexact since we drop some tokens in
mustang and also truncate docs at a max cap.
 proseRestrict (type: list(String.t), default: nil) - The
restricts for CSE structured search.
restricts (type: list(String.t), default: nil) -
timestamp (type: String.t, default: nil) - The time
CDocProperties::StartDocument() is called, encoded as seconds
past the epoch (Jan 1, 1970). This value is always refreshed and not
reused.
title (type: String.t, default: nil) - Extracted from the title tag
of the content. This is typically extracted by TitleMetaCollector
defined at google3/segindexer/title-meta-collector.h. Please see its
documentation for the format and other caveats.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.DocProperties{
avgTermWeight: integer() | nil,
badTitle: boolean() | nil,
badtitleinfo:
[GoogleApi.ContentWarehouse.V1.Model.DocPropertiesBadTitleInfo.t()] | nil,
languages: [integer()] | nil,

leadingtext:
GoogleApi.ContentWarehouse.V1.Model.SnippetsLeadingtextLeadingTextInfo.t()
| nil,
numPunctuations: integer() | nil,
numTags: integer() | nil,
numTokens: integer() | nil,
proseRestrict: [String.t()] | nil,

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

timestamp: 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.DocPropertiesBadTitleInfo
Bad title information.

Attributes

score (type: number(), 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.DocPropertiesBadTitleInfo{
score: 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.DrishtiCompressedFeature
Protocol buffer for storing compressed feature.

Attributes

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

inRangeBitstream (type: String.t, default: nil) -
in_range_bitstream is the string produced by range coder, while
out_of_range_bitstream corresponds to the overflow stream, which
is used whenever a quantized value is out of range. See
https://cs.corp.google.com/piper///depot/google3/research/vision/pie
dpiper/brain/python/layers/entropy_models.py?
l=225&cl=234825412
outOfRangeBitstream (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.DrishtiCompressedFeature{

featureName: String.t() | nil,

inRangeBitstream: String.t() | nil,
outOfRangeBitstream: 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.DrishtiDenseFeatureData
Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
value (type: list(number()), default: nil) - Dense 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.DrishtiDenseFeatureData{

extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,
generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t() | nil,
value: [number()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiDenseTokenData
Protocol buffer for storing dense token data.

Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
value (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.DrishtiDenseTokenData{

extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,
generalExtra:

GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t() | 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.DrishtiFeatureExtra
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.DrishtiFeatureExtra{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiFeatureSetData
Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
default: nil) - Extra information for this particular
xtra.t),
FeatureSetData (example timestamp of this frame in the video).
(Almost never used).
feature (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureS
default: nil) - The following can
etDataFeatureSetElement.t),
have multiple FeatureSetElement(s) Each of these
FeatureSetElement correspond to the various feature groups. One
concrete example is the way these features are generated - example
audio, video or OCR.
label (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiLabelSet
default: nil) - Labels for this particular
Element.t),
FeatureSetData. (Almost never used). Only interesting when you
have (for example) frame level labels.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,
feature:
[

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

]
| nil,
label: [GoogleApi.ContentWarehouse.V1.Model.DrishtiLabelSetElement.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.DrishtiFeatureSetDataFeatu
reSetElement
A FeatureSetElement stores the features coming from a single group.

Attributes

compressed (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiCompressedFea
ture.t,default: nil) -
dense (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiDenseFeatureD
ata.t,default: nil) -
indexed (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiIndexedFeatur
eData.t,default: nil) -
name (type: String.t, default: nil) - A name for the feature
group: example "AUDIO", "VIDEO", "OCR", etc.
quantized (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiQuantizedDens
eFeatureData.t,default: nil) -
quantizedByteDense (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiQuantizedByte
DenseFeatureData.t, default: nil) -
quantizedByteIndexed (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiQuantizedByte
IndexedFeatureData.t, default: nil) -
sparse (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiSparseFeature
Data.t, default: nil) -
 token (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiDenseTokenDat
a.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.DrishtiFeatureSetDataFeatureSetElement{
compressed:
GoogleApi.ContentWarehouse.V1.Model.DrishtiCompressedFeature.t() | nil,
dense:
GoogleApi.ContentWarehouse.V1.Model.DrishtiDenseFeatureData.t() | nil,
indexed:
GoogleApi.ContentWarehouse.V1.Model.DrishtiIndexedFeatureData.t() | nil,

name: String.t() | nil,

 quantized:
GoogleApi.ContentWarehouse.V1.Model.DrishtiQuantizedDenseFeatureData.t()
| nil,

quantizedByteDense:

GoogleApi.ContentWarehouse.V1.Model.DrishtiQuantizedByteDenseFeatureData.t()
| nil,
quantizedByteIndexed:

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

sparse:
GoogleApi.ContentWarehouse.V1.Model.DrishtiSparseFeatureData.t() | nil,
token: GoogleApi.ContentWarehouse.V1.Model.DrishtiDenseTokenData.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiFeatureSetDataSeque
nce
This represents a sequence (ordered) of FeatureSetData elements.

Attributes

element (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureS
default: nil) - FeatureSetData contains the features. In
etData.t),
most scenarios, you only have one element. However, multiple
elements are appropriate in case of videos where each element may
correspond to a frame in the video.
extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - Some extra information about this
FeatureSetDataSequence. (Almost never used).
label (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiLabelSet
Element.t),default: nil) - Global (video-level) labels. In most
cases, you only have one LabelSetElement. All the labels will be
stored in this single LabelSetElement. Scenarios where you may
have multiple LabelSetElement(s) is (for example) when you want
to differentiate the labels into various sub-groups - eg, central vs
relevant, kg-ids vs queries, etc.
timestamp (type: list(String.t), default: nil) - If set, must be
same length as element. Each entry is the timestamp in
microseconds where the FeatureSetData element was extracted.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

element:
[GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureSetData.t()] | nil,
extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,
label: [GoogleApi.ContentWarehouse.V1.Model.DrishtiLabelSetElement.t()] | nil,
timestamp: [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.DrishtiIndexedFeatureData
Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as index and value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
index (type: list(String.t), default: nil) - Indexed data. index
and value must be of the same length.
value (type: list(number()), 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.DrishtiIndexedFeatureData{

extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,

generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t() | nil,
index: [String.t()] | nil,
value: [number()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiLabelSetData
Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
default: nil) -
xtra.t),
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t, default: nil) -
targetClass (type: list(String.t), default: nil) -
targetClassName (type: list(String.t), default: nil) -
targetValue (type: list(number()), default: nil) -
targetWeight (type: list(number()), default: nil) -
weight (type: number(), default: nil) - Weight assigned to this
set of labels.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,

generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t() | nil,
targetClass: [String.t()] | nil,
targetClassName: [String.t()] | nil,
targetValue: [number()] | nil,
targetWeight: [number()] | nil,
weight: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiLabelSetElement
Attributes

label (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiLabelSetData.
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.DrishtiLabelSetElement{
label: GoogleApi.ContentWarehouse.V1.Model.DrishtiLabelSetData.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.DrishtiQuantizedByteDense
FeatureData
Proto message to store quantized dense feature data.

Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
value (type: String.t, default: nil) - Quantized values for the
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.DrishtiQuantizedByteDenseFeatureData{
extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,

generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.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.DrishtiQuantizedByteIndexe
dFeatureData
Proto message to store quantized indexed feature data.

Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
index (type: list(String.t), default: nil) -
value (type: String.t, default: nil) - Quantized values for the
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.DrishtiQuantizedByteIndexedFeatureData{
extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,

generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t() | nil,
index: [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.DrishtiQuantizedDenseFeat
ureData
Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
value (type: list(String.t), default: nil) - Quantized Dense
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.DrishtiQuantizedDenseFeatureData{
extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,
generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.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.DrishtiSparseFeatureData
Attributes

extra (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureE
xtra.t),default: nil) - If extra is present it must be of the same
length as label and value.
generalExtra (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.
t,default: nil) -
label (type: list(String.t), default: nil) - Indexed data. label
and value must be of the same length.
value (type: list(number()), 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.DrishtiSparseFeatureData{

extra: [GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t()] | nil,

generalExtra:
GoogleApi.ContentWarehouse.V1.Model.DrishtiFeatureExtra.t() | nil,
label: [String.t()] | nil,
value: [number()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiVesperEncodedThum
bnail
The attributes of encoded thumbnail images. Next id: 10.

Attributes

byteSize (type: String.t, default: nil) - Image size in bytes.

Meaningful when contents are not stored inline (e.g., via
image_blob_id).
crc32c (type: integer(), default: nil) - CRC-32 checksum of
the image bytes. Can be used for data integrity check.
encodingQuality (type: integer(), default: nil) - JPEG/WEBP
quality factor in range [0,100].
encodingType (type: String.t, default: nil) - Image encoding
type.
height (type: integer(), default: nil) -
imageBlobId (type: String.t, default: nil) - The Blob ID of the
thumbnail image in the Blobstore. We recommend absolute IDs
with universe prefix if this field is passed across systems. The
owner of this blob is also responsible for data Wipeout compliance.
imageBytes (type: String.t, default: nil) - Encoded thumbnail
bytes. Prefer this over image_string as we are not supposed to
store image bytes in a proto string field.
imageString (type: String.t, default: nil) - Please migrate to
image_bytes.
width (type: integer(), default: nil) - Thumbnail resolution.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

byteSize: String.t() | nil,
crc32c: integer() | nil,
encodingQuality: integer() | nil,
encodingType: String.t() | nil,
height: integer() | nil,
imageBlobId: String.t() | nil,

imageBytes: String.t() | nil,

imageString: 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.DrishtiVesperMovingThum
bnail
LINT: LEGACY_NAMES MovingThumbnail is defined as a short video
clip that represents the whole video content. Next id: 17.

Attributes

beginTimestampMs (type: integer(), default: nil) - The begin

timestamp in milliseconds.
durationMs (type: integer(), default: nil) - The duration of the
moving thumbnail in milliseconds. Note that the duration may not
be the difference between begin_timestamp_ms and
end_timestamp_ms, esp when the moving thumbnail covers
multiple clips from the video.
encodedGifAnimation (type: String.t, default: nil) -
encodedVideoString (type: String.t, default: nil) - The
encoded video string.
encodedWebpAnimation (type: String.t, default: nil) - The
encoded WebP animation.
endTimestampMs (type: integer(), default: nil) - The end
timestamp in milliseconds.
height (type: integer(), default: nil) - Pixel height of the
moving thumbnail.
id (type: String.t, default: nil) - MovingThumbnail id (e.g.,
the video id).
movingThumbnailerVersion (type: String.t, default: nil) - If
set, this is the algorithm version used to generate this moving
thumbnail.
name (type: String.t, default: nil) - MovingThumbnail name.
 score(type: number(), default: nil) - The score of the moving
thumbnail.
scoreComponents (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperMovingT
humbnailScoreComponents.t, default: nil) -
thumbnails (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperTh
umbnail.t),default: nil) - A set of single frame thumbnails in the
MovingThumbnail.
type (type: String.t, default: nil) - MovingThumbnail type.
webpQualityLevel (type: number(), default: nil) - The actual
quality of the Webp animation. Note this value may not be equal to
the quality value requested in the animation creator's options. This
is because other requirements, such as the max file size, may force
the creator to lower the actual quality value.
width (type: integer(), default: nil) - Pixel width of the
moving thumbnail.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

beginTimestampMs: integer() | nil,
durationMs: integer() | nil,
encodedGifAnimation: String.t() | nil,

encodedVideoString: String.t() | nil,

encodedWebpAnimation: String.t() | nil,
endTimestampMs: integer() | nil,
height: integer() | nil,
id: String.t() | nil,
movingThumbnailerVersion: String.t() | nil,
name: String.t() | nil,

score: number() | nil,

scoreComponents:

GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperMovingThumbnailScoreComponents.t
()
| nil,
thumbnails:
[GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperThumbnail.t()] | nil,

type: String.t() | nil,

webpQualityLevel: number() | 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.DrishtiVesperMovingThum
bnailScoreComponents
Sum of individual score components within a moving thumbnail. Used
as input for weight fitting.

Attributes

audienceRewindRatioScore (type: number(), default: nil) -

iconicFaceScore (type: number(), default: nil) -
matchingScore (type: number(), default: nil) -
motionScore (type: number(), default: nil) -
titleMatchingScore (type: number(), default: nil) -
videoThumbQualityScore (type: number(), 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.DrishtiVesperMovingThumbnailScoreComponents{

audienceRewindRatioScore: number() | nil,

iconicFaceScore: number() | nil,
matchingScore: number() | nil,
motionScore: number() | nil,
titleMatchingScore: number() | nil,
videoThumbQualityScore: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiVesperThumbnail
The attributes of a video thumbnail.

Attributes

(type: list(number()), default: nil) -

denseFeatures
Thumbnail dense features
encodedImageString (type: String.t, default: nil) - Thumbnail
image as an encoded image. Deprecated, use encoded_thumbnails
instead.
encodedImageStringSmall (type: String.t, default: nil) -
Thumbnail image as an encoded image with smaller resolution.
Deprecated, use encoded_thumbnails instead.
encodedThumbnails (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperEn
codedThumbnail.t), default: nil) - Encoded thumbnail images.
id (type: String.t, default: nil) - Thumbnail id.
ocrText (type: String.t, default: nil) - Text in video
thumbnails that was detected by OCR.
qualityScores (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperTh
umbnailQualityScore.t), default: nil) - Thumbnail quality
scores.
shouldUpdateDefaultThumbnail (type: boolean(), default: nil)
- If true, this thumbnail should update default thumbnail.
thumbnailerModelVersion (type: String.t, default: nil) -
Thumbnailer Version.
timestampMs (type: integer(), default: nil) - Thumbnail
timestamp in milliseconds.
type (type: String.t, default: nil) - Thumbnail type.
 userReportedThumbnail (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserRep
default: nil) -
ortUserReportedThumbnail.t,
userReportedThumbnails (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUs
erReportUserReportedThumbnail.t), default: nil) - All user
reported thumbnails of interest.
version (type: integer(), default: nil) - Thumbnail version,
i.e., the unix time in seconds when the thumbnail was created.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

denseFeatures: [number()] | nil,
 encodedImageString: String.t() | nil,
encodedImageStringSmall: String.t() | nil,
encodedThumbnails:
[GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperEncodedThumbnail.t()]

| nil,
id: String.t() | nil,
ocrText: String.t() | nil,
qualityScores:
[GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperThumbnailQualityScore.t()]
| nil,
shouldUpdateDefaultThumbnail: boolean() | nil,

thumbnailerModelVersion: String.t() | nil,

timestampMs: integer() | nil,
type: String.t() | nil,
userReportedThumbnail:

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

| nil,
userReportedThumbnails:
[

GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserReportUserReportedThumbnail.
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.DrishtiVesperThumbnailQu
alityScore
Attributes

score (type: number(), 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.DrishtiVesperThumbnailQualityScore{
score: 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.DrishtiVesperUserReportHu
manLabel
Proto holding values for details about human labels.

Attributes

racyLevel (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.DrishtiVesperUserReportHumanLabel{
racyLevel: 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.DrishtiVesperUserReportM
odelScore
Proto holding values for details about score and the source model.

Attributes

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

score (type: number(), 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.DrishtiVesperUserReportModelScore{
modelName: String.t() | nil,

score: number() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiVesperUserReportUs
erReportedThumbnail
Proto holding values for user reported thumbnails. Next id: 12

Attributes

denseFeatures(type: list(number()), default: nil) -

duration (type: integer(), default: nil) - Number of days in
which volume is calculated.
humanLabel (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserRep
ortHumanLabel.t, default: nil) -
impressions (type: integer(), default: nil) - Daily aggregared
impressions for the reported video.
needHumanLabel (type: boolean(), default: nil) - Whether the
thumbnail needs a human label.
rawHumanLabels (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUs
erReportHumanLabel.t), default: nil) -
reportScore (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserRep
ortModelScore.t,default: nil) -
reportType (type: String.t, default: nil) -
score (type:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserRep
ortModelScore.t,default: nil) -
useCase (type: String.t, default: nil) -
volume (type: integer(), default: nil) - Number of reports.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserReportUserReportedThumbnail
{
denseFeatures: [number()] | nil,
duration: integer() | nil,
humanLabel:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserReportHumanLabel.t()
| nil,

impressions: integer() | nil,

needHumanLabel: boolean() | nil,
rawHumanLabels:
[
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserReportHumanLabel.t()
 ]
| nil,
reportScore:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserReportModelScore.t()
| nil,

reportType: String.t() | nil,

score:
GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperUserReportModelScore.t()
| nil,
useCase: String.t() | nil,
volume: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.DrishtiVesperVideoThumbn
ail
Video level container for thumbnail with its attributes, e.g., timestamp,
id, quality scores, annotations, or features.

Attributes

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

movingThumbnails (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperMo
default: nil) -
vingThumbnail.t),
thumbnails (type:
list(GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperTh
umbnail.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.DrishtiVesperVideoThumbnail{

id: String.t() | nil,
movingThumbnails:
[GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperMovingThumbnail.t()] | nil,

thumbnails:
[GoogleApi.ContentWarehouse.V1.Model.DrishtiVesperThumbnail.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.EmbedsDeepLinkData
Deep-linking data is used to construct a deep-link URI for an activity or
frame's embed, such that on click, the user is taken to the right place in a
mobile app. If the app is not installed, the user is taken to the app store.
If not on mobile, an analogous web uri is used.

Attributes

appId (type: String.t, default: nil) - Application ID (or project

ID) from Google API Console.
client (type:
list(GoogleApi.ContentWarehouse.V1.Model.EmbedsPackaging
ServiceClient.t),default: nil) - The data for a Google API
Console client is entered by a developer during client registration
and is stored in PackagingService.
deepLinkId (type: String.t, default: nil) - The ID for non-URL
content. Embeds may either have no analogous web presence or
prefer a native mobile experience if supported. In the case of no
web presence, instead of setting the "url" field of an embed, such
developers will set this field and other content fields, e.g.
thumbnail, title, description. If set, this field is used to construct the
deep-link URI. Note that the native experience is preferred over the
web link and the web link is used as a fallback.
url (type: String.t, default: nil) - Analogous web presence.
Used as desktop fallback or when no native link data is present.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

appId: String.t() | nil,
client:
[GoogleApi.ContentWarehouse.V1.Model.EmbedsPackagingServiceClient.t()] | nil,
deepLinkId: 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.EmbedsEmbedClientItem
Represents an embedded object in an update. This is a wrapper class that
can contain a single specific item proto in an extension field. Think of it
as a base class like Message in Java. Each item proto must declare that it
extends this proto: message ExampleObject { option (item_type) =
EXAMPLE_OBJECT; extend EmbedClientItem { optional
ExampleObject example_object = ; } } See go/es-embeds for details.

Attributes

canonicalId(type: String.t, default: nil) - The canonical ID

of the embed. If absent, the canonical ID is equal to the ID; if
present, then the canonical ID represents an "equivalence class" of
embeds which really refer to the same object. (For example, the
URLs http://www.foo.com/ and http://foo.com/ refer to the same
object) This field may be updated periodically by background
processes.
deepLinkData (type:
GoogleApi.ContentWarehouse.V1.Model.EmbedsDeepLinkData.t
, default: nil) - Deep-linking data to take the user to the right place
in a mobile app. This is only used for preview and attribution. Links
that are specific to a given embed type should live on that specific
embed's proto by using Link. See http://goto.google.com/mariana-
design.
id (type: String.t, default: nil) - The ID of the embed. This
corresponds to the schema.org ID, as represented in the
ItemScope.id field.
provenance (type:
GoogleApi.ContentWarehouse.V1.Model.EmbedsProvenance.t,
default: nil) - The provenance of the embed, populated when the
 embed originated from a web fetch. The provenance captures
information about the web page the embed had originated, like the
URL that was retrieved and the retrieved URL's canonical form.
This is useful in the case where the URL shared by the URL
redirects (e.g., in the case of a shortened URL).
renderId (type: String.t, default: nil) - The ID used to identify
the embed during rendering. This field will match ID, if set,
otherwise it will be the ID of the parent activity. This field is only
populated on the server for client use and is not persisted to storage.
signature (type: String.t, default: nil) - Signature of the
embed, used for verification.
transientData (type:
GoogleApi.ContentWarehouse.V1.Model.EmbedsTransientData.
t, default: nil) - Transient generic data that will not be saved on
the server.
type (type: list(String.t), default: nil) - The first value in
type determines which extension field will be set. When creating
an EmbedClientItem, you only need to set the first (primary) type in
this field. When the server receives the item, it will populate the full
type list using the parent annotations in the ItemType enum.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

canonicalId: String.t() | nil,

deepLinkData:
GoogleApi.ContentWarehouse.V1.Model.EmbedsDeepLinkData.t() | nil,
id: String.t() | nil,
provenance: GoogleApi.ContentWarehouse.V1.Model.EmbedsProvenance.t() | nil,
renderId: String.t() | nil,
signature: String.t() | nil,

transientData:
GoogleApi.ContentWarehouse.V1.Model.EmbedsTransientData.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.EmbedsPackagingServiceCli
ent
Developers register a client in Google API Console to get the deep-
linking feature on Google+ posts or frames about their apps. The client
data is stored in this proto.

Attributes

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

app's package name to generate the deep-link URI.
iosAppStoreId (type: String.t, default: nil) - iOS app's App
Store ID to generate the App Store URL when app is not installed
on device.
iosBundleId (type: String.t, default: nil) - iOS app's bundle
ID to generate the deep-link URI.
type (type: String.t, default: nil) - Type of Google API
Console 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.EmbedsPackagingServiceClient{

androidPackageName: String.t() | nil,
iosAppStoreId: String.t() | nil,
iosBundleId: String.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.EmbedsProvenance
This field records where the ItemScope was retrieved, if it was created
via a web fetch.

Attributes

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

blob from Annotation Service.
canonicalUrl (type: String.t, default: nil) - Canonical url of
the retrieved_url, if one was resolved during retrieval, for example,
if a rel="canonical" link tag was provided in the retrieved web page.
inputUrl (type: String.t, default: nil) - The url originally
passed in the PRS request, which should be used to re-discover the
content. Note that this URL may be a forwarding service or link
shortener (bit.ly), so it should not be assumed to be canonical, but
should be used for navigation back to the original source of the
itemscope.
itemtype (type: list(String.t), default: nil) - Contains exact
types as parsed, whether or not we recognized that type at parse
time. If an itemscope is created by merging SchemaOrg markup and
open graph markup then the first itemtype would be schemaorg
type, the second would be open graph and so on. example:
http://schema.org/VideoObject, og:video.movie Plain text; usually a
URL
retrievedTimestampMsec (type: String.t, default: nil) - The
server retrieved timestamp (in msec).
retrievedUrl (type: String.t, default: nil) - The final URL
that was the actual source of the itemscope, after any redirects.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

annotationBlob: String.t() | nil,
canonicalUrl: String.t() | nil,
inputUrl: String.t() | nil,
itemtype: [String.t()] | nil,
retrievedTimestampMsec: String.t() | nil,

retrievedUrl: 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.EmbedsTransientData
Transient generic data that will not be saved on the server.

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.EmbedsTransientData{}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.EventIdMessage
An EventId is a 128 bit identifier that uniquely identifies an event, such
as a query. The event time recorded to the nearest microsecond, along
with information about the process generating the event, ensures that all
EventIds are unique. Details of this EventId are described in a design
document: http://www/eng/designdocs/sawmill/adlogs.html

Attributes

processId (type: integer(), default: nil) - process_id is an

integer that identifies the process on this machine that generated
this event. This id is calculated once when the server generates its
first event, and may change if the process is migrated to a different
host. This field has a very specific format mandated by the logs
collection infrastructure, which is subject to change WITHOUT
NOTICE. As of 2013-01-09, this format is: uint32 process_id =
(time(NULL) << 24) + (getpid() & 0xFFFFFF); If you are
generating an extended_pid directly, you MUST use one of the
maintained library implementations in order to generate it properly:
C++ //borg/borgletlib:extended_pid; call borg::ExtendedPid()
Python //borg/borgletlib/python:pyextendedpid; call ExtendedPid()
Go //borg/borgletlib/go:extendedpid; call Get() Java
//java/com/google/common/logging; call EventId.getPid() If you
think that you need to parse the values of this field, please contact
logs-collection-dev@ to discuss your requirement.
serverIp (type: integer(), default: nil) - server_ip is the IPv4
address or http://go/ghostid of the machine running the server that
created this event message. This allows us to distinguish between
events that occur at the same time on different servers. Format:
10.1.2.3 is stored as 0x0a010203, and GHostId 1 as 0x00000001.
 timeUsec (type: String.t, default: nil) - time_usec is the
number of microseconds since the epoch (i.e., since 1970-01-01
00:00:00 UTC) as an int64: 1e6 (unix time) + microseconds.
Applications must ensure that EventIdMessages have increasing
times, artificially increasing time_usec to one greater than the
previous value if necessary. Alternate implementations were
considered: 1. storing unix time and microseconds separately would
require a bit more storage, and the convenience of having a single
value representing the time seemed more useful than having trivial
access to a unix time. 2. storing unix time in the upper 32 bits would
allow for more precision - up to 4G events/second, but it wouldn't
print nicely as a decimal value and it seems unlikely that any single
server would ever sustain more than 1M events/second. 3. Java-
compatible time uses millis - this would limit servers to 1000 events
per second - too small. Other names for this field were considered,
including time, time_stamp, and utime. We felt that including the
units in the name would tend to produce more readable code. utime
might be interpreted as user time. unix timestamp 1e6 +
microseconds

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

processId: integer() | nil,
serverIp: integer() | nil,
timeUsec: 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.ExtraSnippetInfoResponse
the extra info response from ascorer used to build snippets in GWS
experiments

Attributes

matchinfo (type:
GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInfoResp
onseMatchInfo.t, default: nil) -
querysubitem (type:
list(GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInf
oResponseQuerySubitem.t), default: nil) -
tidbit (type:
list(GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInf
oResponseTidbit.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.ExtraSnippetInfoResponse{

matchinfo:
GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInfoResponseMatchInfo.t()
| nil,
querysubitem:
[

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

]
| nil,
tidbit:
[GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInfoResponseTidbit.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ExtraSnippetInfoResponse
MatchInfo
Attributes

titleMatches (type: String.t, default: nil) - bitvector of query

items matching the title
urlMatches (type: String.t, default: nil) - bitvector of query
items matching the url
weightedItems (type: String.t, default: nil) - bitvector of
query items considered by chooser

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

titleMatches: String.t() | nil,

urlMatches: String.t() | nil,
weightedItems: 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.ExtraSnippetInfoResponseQ
uerySubitem
A query term, phrase, or synonym. An original query term or phrase is
called an "item". Each item may have more than one "subitem" if there
are synonyms. In rare cases a subitem may correspond to multiple items,
such as the subitem "cia" in the query [central intelligence agency].

Attributes

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

information from the SnippetQuery.
isOptional (type: boolean(), default: nil) -
isOriginal (type: boolean(), default: nil) - true iff this subitem
was an original query term or phrase. Can only be false if
want_all_query_subitems == true in the request.
items (type: integer(), default: nil) - a bitvector of the query
items corresponding to this subitem. Typically only one bit is set,
but see comment above.
text (type: String.t, default: nil) - text associated with this
query item
weight (type: integer(), default: nil) - the weight of this query
item, as calculated by SubitemWeight():
https://qwiki.corp.google.com/display/Q/SnippetWeights

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInfoResponseQuerySubitem{
isHighlighted: boolean() | nil,
isOptional: boolean() | nil,
isOriginal: boolean() | nil,
items: integer() | nil,

text: String.t() | nil,

weight: integer() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.ExtraSnippetInfoResponseT
idbit
Attributes

anchorinfo (type:
GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInfoResp
onseTidbitAnchorInfo.t, default: nil) -
begin (type: integer(), default: nil) - For tidbits only: position
of tidbit in the document. More specifically, tidbit is found at
[begin, end) in the document's tokens.
end (type: integer(), default: nil) -
items (type: String.t, default: nil) - a bitvector of each query
term within this tidbit
score (type: number(), default: nil) - the score for this tidbit if
there was one this is returned for Snippets and Tidbits and is only
meaningful for comparing between objects of the same type
(snippet to snippet, tidbit to tidbit)
text (type: String.t, default: nil) - the tidbit text, with search
terms already highlighted
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.ExtraSnippetInfoResponseTidbit{

anchorinfo:

GoogleApi.ContentWarehouse.V1.Model.ExtraSnippetInfoResponseTidbitAnchorInfo.t()
| nil,
begin: integer() | nil,
end: integer() | nil,
items: String.t() | nil,
score: number() | nil,
text: String.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.ExtraSnippetInfoResponseT
idbitAnchorInfo
this information is specific to anchors and is only returned if type ==
ANCHOR

Attributes

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

ondomainCount (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.ExtraSnippetInfoResponseTidbitAnchorInfo{
offdomainCount: integer() | nil,
ondomainCount: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FaceIndexing
Attributes

mustangBytes (type: String.t, default: nil) - Always use

image/search/utils/face_proto_util.h for packing and unpacking
these values.
mustangBytesVersion (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.FaceIndexing{
mustangBytes: String.t() | nil,
mustangBytesVersion: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FatcatCompactBinaryClassi
fication
Attributes

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

binary_classifier will be set, using the enum above, or
binary_classifier_name will be set, if it is not one of the classifiers
in the enum - never both.
binaryClassifierName (type: String.t, default: nil) -
discreteFraction (type: integer(), default: nil) - A
CompactDocClassification will not usually have a weight. For a
CompactSiteClassification, this value will be 0...127 corresponding
to 0.0...1.0, indicating fraction of the site that this label applies to

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

binaryClassifierName: String.t() | nil,

discreteFraction: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FatcatCompactDocClassific
ation
The result of PetacatAnnotator. Each result contains: 1. RephilClusters;
2. At most 5 verticals from each taxonomy, sorted by the probabilities in
descending order. 3. Binary classification results about page types and
sensitive content. The types of taxonomies include: verticals4, geo,
verticals4_geo, products_services, icm_im_audiences and
icm_im_audiences_dev.

Attributes

binary (type:
list(GoogleApi.ContentWarehouse.V1.Model.FatcatCompactBi
naryClassification.t), default: nil) -
clusters (type:
GoogleApi.ContentWarehouse.V1.Model.FatcatCompactRephilC
default: nil) -
lusters.t,
epoch (type: String.t, default: nil) -
langCode (type: String.t, default: nil) -
rephilModelId (type: integer(), default: nil) - The id of the
Rephil model used to generate the Rephil clusters. If it is absent,
Rephil 4 is assumed.
taxonomic (type:
list(GoogleApi.ContentWarehouse.V1.Model.FatcatCompactTa
xonomicClassification.t),default: nil) -
url (type: String.t, default: nil) - not needed if the url is the
sstable / bigtable key used during intermediate processing only
weight (type: String.t, default: nil) - The relative weight of
this doc within a site, typically something like pagerank or navboost
 impressions. May be a large number (like an actual pageviews
estimate), not limited to a small 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.FatcatCompactDocClassification{

binary:
[GoogleApi.ContentWarehouse.V1.Model.FatcatCompactBinaryClassification.t()]
| nil,
clusters:

GoogleApi.ContentWarehouse.V1.Model.FatcatCompactRephilClusters.t() | nil,
epoch: String.t() | nil,
langCode: String.t() | nil,
rephilModelId: integer() | nil,
taxonomic:
 [

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

]
| nil,
url: String.t() | nil,
weight: 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.FatcatCompactRephilCluste
rs
Attributes

cluster (type:
list(GoogleApi.ContentWarehouse.V1.Model.FatcatCompactRe
philClustersCluster.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.FatcatCompactRephilClusters{

cluster:
[GoogleApi.ContentWarehouse.V1.Model.FatcatCompactRephilClustersCluster.t()]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FatcatCompactRephilCluste
rsCluster
Attributes

discreteWeight (type: integer(), default: nil) - 0...127

corresponds to 0.0 - 1.0
id (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.FatcatCompactRephilClustersCluster{
discreteWeight: integer() | nil,
id: integer() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FatcatCompactTaxonomicCl
assification
A version of this proto for logging is available at
cs/symbol:logged_fatcat.LoggedCompactTaxonomicClassification

Attributes

category (type:
list(GoogleApi.ContentWarehouse.V1.Model.FatcatCompactTa
xonomicClassificationCategory.t), default: nil) -
classifierVersion (type: String.t, default: nil) -
taxonomy (type: String.t, default: nil) - Either taxonomy will
be set, using the enum above, or taxonomy_name will be set (if the
taxonomy is not one of the ones in the enum) - never both
taxonomyName (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.FatcatCompactTaxonomicClassification{

category:
[

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

classifierVersion: String.t() | nil,

taxonomy: String.t() | nil,
taxonomyName: 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.FatcatCompactTaxonomicCl
assificationCategory
A taxonomic category. A classification consists of weight (totalling 1.0)
distributed among one or more categories.

Attributes

discreteWeight (type: integer(), default: nil) - go/petacat-

faq#how-should-i-interpret-classification-weights Discrete to
reduce size. Range is [0,127], corresponding to [0.0,1.0].
id (type: integer(), default: nil) - The category's ID, e.g. 20 for
/Sports in the go/verticals4 taxonomy.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.FatcatCompactTaxonomicClassificationCategory
{
discreteWeight: integer() | nil,
id: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FocusBackendContactDetail
Hash
http://go/contact-detail-hash.

Attributes

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

value (type: integer(), default: nil) - The hash here will be a
16-bit weak hash to avoid reverse engineering for decoding the
actual contact detail. The hash value is computed by the fingerprint
of the raw contact detail mod 2^16.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

type: String.t() | 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.FocusBackendContactPoint
er
A contact pointer that represents a contact (http://go/assistant-contact-
id).

Attributes

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

ID. Annotations are only allowed to point to annotations that do not
themselves have a pointer (avoids any possibilty of loops). Cast this
field to string in javascript to make it compile in js.
deviceRawContactId (type:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceRa
wContactId.t,default: nil) - The raw contact ID from an active
mobile device of the user.
focusContactId (type: String.t, default: nil) - The contact ID
from the Focus backend. Cast this field to string in javascript to
make it compile in js.
otherContactId (type:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendOtherCon
default: nil) - Additional contact ids that are not
tactId.t,
actively used to match contact pointers to contacts.
secondaryId (type:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendSecondar
default: nil) - The secondary identifier of contact.
yContactId.t,
It will be used when the primary ID doesn't match any contact.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

annotationId: String.t() | nil,
deviceRawContactId:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceRawContactId.t() | nil,
focusContactId: String.t() | nil,
otherContactId:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendOtherContactId.t() | nil,

secondaryId:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendSecondaryContactId.t() | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FocusBackendDeviceContac
tId
//////////////////// DeviceContactId ////////////////////// Used by Device Contacts
only. For more details see go/fbs-support-for-device-contacts.

Attributes

ContactId (type: String.t, default: nil) - DeviceContact Id.

DeviceId (type:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceId
.t, default: nil) - 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.FocusBackendDeviceContactId{

ContactId: String.t() | nil,

DeviceId: GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceId.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FocusBackendDeviceId
//////////////////// DeviceId ////////////////////// Used by Device Contacts only.
For more details see go/fbs-support-for-device-contacts.

Attributes

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

id on Android. See go/android-id.
Hash (type: String.t, default: nil) - DeviceId.Hash is a
SHA256 of some attribute of the user and device. For Android
devices: Hash = SHA256(gaia_account_name + “:” + “1” + “:” +
(android id - LSB)); For iOS devices: Hash =
TOLOWER(HEX(GMCSComputeUserDeviceToken(userId,
iOsDeviceId)) For more details see go/client-instance-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.FocusBackendDeviceId{

AndroidDeviceId: String.t() | nil,
Hash: 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.FocusBackendDeviceRawCo
ntactId
//////////////////// DeviceRawContactId ////////////////////// Used by Device
Contacts Only. The Raw ID as assigned to the original contact on the
device. For more details see go/fbs-support-for-device-contacts.

Attributes

DeviceId (type:
GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceId
default: nil) -
.t,
RawContactId (type: String.t, default: nil) - Raw ID assigned
by the device. Cast this field to string in javascript to make it
compile in js.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

DeviceId: GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceId.t() | nil,
RawContactId: 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.FocusBackendOtherContact
Id
Additional contact ids that are not actively used to match contact
pointers to contacts. There may be overlap with primary or secondary
contact ids.

Attributes

deviceContactId (type:
list(GoogleApi.ContentWarehouse.V1.Model.FocusBackendDev
default: nil) - Device contact ID, when
iceContactId.t),
available: - The annotation points to a device contact, and the
device contact id was correctly populated when the annotation was
created. Note that the device contact id is populated once per device
contact on a device. It is distinct from RawContactId - a single
device contact may have multiple raw contact ids. - The annotation
points to a Focus contact that was merged with device contact
information in Starlight. When the annotation was created, a device
contact id was available on the merged person object. - The contact
annotation was created from April 2021 onwards. All prior
annotations do not populate this field. ContactPointer creation relies
on the client caller to correctly populate the device contact id, and
does not enforce any assumptions on availability of this field. This
field is repeated because in rare cases Starlight may merge device
contact information across different devices into a single merged
person object. WARNING: Use with extreme caution! This ID is
not stable. For more details see go/fbs-support-for-device-contacts.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

deviceContactId:

[GoogleApi.ContentWarehouse.V1.Model.FocusBackendDeviceContactId.t()] | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FocusBackendSecondaryCo
ntactId
The secondary ID of a contact.

Attributes

contactDetailHash (type:
list(GoogleApi.ContentWarehouse.V1.Model.FocusBackendCon
default: nil) - The hashes of the contact
tactDetailHash.t),
details (e.g. phone number and email address).
contactName (type: String.t, default: nil) - The contact's full
name, not hashed.
contactNameHash (type: String.t, default: nil) - The hash of
contact's full name, generated using Fingerprint2011(). Cast this
field to string in javascript to make it compile in js.

Summary
Types
t()

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

Types

t()

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

contactDetailHash:
[GoogleApi.ContentWarehouse.V1.Model.FocusBackendContactDetailHash.t()]
| nil,
contactName: String.t() | nil,
contactNameHash: 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.FreebaseCitation
Citation contains the information needed to correctly attribute the source
of data.

Attributes

dataset (type: String.t, default: nil) - Mid of the dataset.

isAttributionRequired (type: boolean(), default: nil) - If set
to true, the citation is required to be displayed when the data is
used.
project (type: String.t, default: nil) - Name of the project of
the data's origin.
provider (type: String.t, default: nil) - The name of the
provider of this information.
statement (type: String.t, default: nil) - A human readable
statement of attribution.
uri (type: String.t, default: nil) - Uri link associated with this
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.FreebaseCitation{

dataset: String.t() | nil,

isAttributionRequired: boolean() | nil,

project: String.t() | nil,
provider: String.t() | nil,

statement: String.t() | nil,

uri: 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.FreebaseId
An Id contains the identifiers used to reference this topic (entity) in the
Knowledge Graph. The Knowledge Graph supports several forms of
identifiers: - "mids" (machine ids) that are assigned at creation time, and
support a resolution mechanism that tracks topics after they are merged
(for more about mids, see go/kg-mid), - "ids" are human-readable ids
(HRIDs) that are derived from a namespace hierarchy stored in
Knowledge Graph, and a set of rules, - "guids" are low-level ids
historically used in Freebase (pre-Knowledge Graph, deprecated). Only
the mid and id are supplied here. Note that mids can be converted to
guids or uint64s (see //metaweb/util/mid/mid.h).

Attributes

id (type: String.t, default: nil) - "id" may be a human readable

ID (HRID) or a MID. Originally it was intended to always be a
human readable ID, but that convention was not always followed so
clients should be wary. Not every topic has an id.
mid (type: String.t, default: nil) - The "mid" should be used
whenever a globally unique, primary key into the Knowledge Graph
is needed. These keys are always prefixed with the "/m" and "/g",
(and more rarely the "/x" and "/t") namespaces, and are
alphanumeric strings consisting of lowercase letters excluding
vowels, numbers and the underscore character. (Applications should
not assume a constant length for these strings as Livegraph reserves
the right to extend the number of characters to accommodate more
topics.)
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

id: String.t() | nil,
mid: 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.FreebaseLatLong
Represents a geopoint, which is one of the possible Value types.

Attributes

latDeg(type: number(), default: nil) -

longDeg (type: number(), 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.FreebaseLatLong{
latDeg: number() | nil,
longDeg: number() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FreebaseMeasurement
Represents a measurements, which is one of the possible Value types. A
measurement value like "5.2 meter^2 / second" would be represented as:
magnitude: 5.2 unit { unit_mid: "/m/mid_for_meter" power: 2 } unit {
unit_mid: "/m/mid_for_second" power: -1 }

Attributes

magnitude (type: number(), default: nil) -

unit (type:
list(GoogleApi.ContentWarehouse.V1.Model.FreebaseMeasure
default: nil) - Repeated units are interpreted as a
mentUnit.t),
product. i.e. (meter ^ 1) * (second ^ -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.FreebaseMeasurement{

magnitude: number() | nil,
unit: [GoogleApi.ContentWarehouse.V1.Model.FreebaseMeasurementUnit.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FreebaseMeasurementUnit
Attributes

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

unit (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t, default:
nil) -
unitMid (type: String.t, default: nil) - Deprecated fields.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

power: integer() | nil,

unit: GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t() | nil,
unitMid: 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.FreebaseNestedStruct
List of { predicate, { object } } to be processed as a Nested Struct.
Nested Struct can be recursive. NestedStruct.property_value(i).value(j)
may have nested_struct field.

Attributes

propertyValue (type:
list(GoogleApi.ContentWarehouse.V1.Model.FreebasePropert
yValue.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.FreebaseNestedStruct{

propertyValue:
[GoogleApi.ContentWarehouse.V1.Model.FreebasePropertyValue.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FreebasePropertyValue
A PropertyValue associates properties with values in the context of a
topic.

Attributes

property (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t, default:
nil) - The id of the property.
(type: String.t, default: nil) - Indicates the
totalValueCount
total values that exist for this property, even if they aren't all present
in the value field, due to truncation.
value (type:
list(GoogleApi.ContentWarehouse.V1.Model.FreebaseValue.t
),default: nil) - The value associated with the property for the
containing topic.
valueStatus (type: String.t, default: nil) - If ValueStatus is
not set at all, the implication is that there are well-known value(s),
specified in the "value" field. (It should be considered malformed
data to have value_status set when len(values) > 0.)

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

property: GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t() | nil,

totalValueCount: String.t() | nil,

value: [GoogleApi.ContentWarehouse.V1.Model.FreebaseValue.t()] | nil,
valueStatus: 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.FreebaseTopic
A Topic represents a Knowledge Graph entity with its associated
properties and their values.

Attributes

id (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t, default:
nil) - The id (mid and human-readable id) of the topic.
The id will
always be present and will contain a mid value for topics in the
topic sstable.
propertyValue (type:
list(GoogleApi.ContentWarehouse.V1.Model.FreebasePropert
default: nil) - The property-value bindings associated
yValue.t),
with the topic. Note that in the case where a property is relevant to a
topic based on its type, but no values of that property are present for
the topic, the PropertyValue will simply not appear, rather than
being present with a null value, or empty repeated value list.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

id: GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t() | nil,
propertyValue:
[GoogleApi.ContentWarehouse.V1.Model.FreebasePropertyValue.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.FreebaseValue
Values are effectively a union of several possible Knowledge Graph
types: simple primitive datatypes such as booleans, integers and floats,
references to other Knowledge Graph topics (by id), or "compound
values" which are expressed as embedded topics with associated
properties and values. Values occur in indexed order (if any).

Attributes

boolValue (type: boolean(), default: nil) - Present when value

is bool.
citation (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseCitation.t,
default: nil) - Citation data for this value. See: http://go/kg-clap
compoundValue (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseTopic.t,
default: nil) - Compound values are those that contain either a
number of simple valued facets (such as a latitude/longitude pair),
or "mediator" topics representing multi-dimensional relationships
between topics. In both cases we represent them here with an
embedded topic, although the topic's identity is somewhat
secondary to the property/value pairs it contains. (The identity is
still made available so that it can be used to perform updates to that
mediator on the Knowledge Graph.)
deletionProvenance (type:
list(GoogleApi.ContentWarehouse.V1.Model.StorageGraphBfg
TripleProvenance.t), default: nil) - Deletion provenance for
this value.
(type: String.t, default: nil) - The lang of the
displayLang
display_value field.
displayValue (type: String.t, default: nil) - The display value
of this value. This is a i18n-aware formatted value if present.
expectedProto (type: String.t, default: nil) - An optional
name for a proto field.
floatValue (type: float(), default: nil) - Present when value is
float.
idValue (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t, default:
nil) - Present when value is an id.
index (type: String.t, default: nil) - Index of the value relative
to the containing property (if any). Knowledge Graph supports a
loose notion of indexing: some non-unique properties may have
indices, while others may not. Furthermore, for a single property,
some values may have indices (such as the top 5 actors in a film),
while others may not (the film's supporting cast). Un-indexed
values will appear at the end of the repeated value list. This field
contains the index value only when is present in the Knowledge
Graph.
intValue (type: String.t, default: nil) - Present when value is
int.
lang (type: String.t, default: nil) - Whenever the value is text
with TYPE_TEXT, the lang field is populated with the III
LanguageCode associated with the string_value field.
latLongValue (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseLatLong.t,
default: nil) -
measurementValue (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseMeasurement.
t,default: nil) -
nestedStruct (type:
GoogleApi.ContentWarehouse.V1.Model.FreebaseNestedStruct
.t,default: nil) - Populated if this value holds NestedStruct. 'type'
field needs to be set to TYPE_NESTED_STRUCT.
provenance (type:
list(GoogleApi.ContentWarehouse.V1.Model.StorageGraphBfg
 TripleProvenance.t), default: nil) - Provenance for this value.
rawValue (type: String.t, default: nil) - Similar to
string_value/etc but contains raw bytes.
stringValue (type: String.t, default: nil) - Present when value
is text, enum,
subgraphId (type: list(String.t), default: nil) -
timestamp (type: String.t, default: nil) - The ISO-8601
timestamp corresponding to when this value was created (when it
was written to the Knowledge Graph). Deprecated in favor of
timestamp_usec.
timestampUsec (type: String.t, default: nil) - The microsecond
timestamp corresponding to when this value was created.
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.FreebaseValue{
boolValue: boolean() | nil,

citation: GoogleApi.ContentWarehouse.V1.Model.FreebaseCitation.t() | nil,

compoundValue: GoogleApi.ContentWarehouse.V1.Model.FreebaseTopic.t() | nil,
deletionProvenance:
[GoogleApi.ContentWarehouse.V1.Model.StorageGraphBfgTripleProvenance.t()]
| nil,
displayLang: String.t() | nil,
displayValue: String.t() | nil,
expectedProto: String.t() | nil,

floatValue: float() | nil,

idValue: GoogleApi.ContentWarehouse.V1.Model.FreebaseId.t() | nil,
index: String.t() | nil,
intValue: String.t() | nil,
lang: String.t() | nil,
latLongValue: GoogleApi.ContentWarehouse.V1.Model.FreebaseLatLong.t() | nil,
measurementValue:

GoogleApi.ContentWarehouse.V1.Model.FreebaseMeasurement.t() | nil,
nestedStruct:
GoogleApi.ContentWarehouse.V1.Model.FreebaseNestedStruct.t() | nil,
provenance:
[GoogleApi.ContentWarehouse.V1.Model.StorageGraphBfgTripleProvenance.t()]
| nil,
rawValue: String.t() | nil,

stringValue: String.t() | nil,

subgraphId: [String.t()] | nil,
timestamp: String.t() | nil,
timestampUsec: String.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.GDocumentBase
Next id: 127

Attributes

ContentExpiryTime (type: integer(), default: nil) - unix secs

from epoch
DisplayUrl (type: String.t, default: nil) - Sometimes the URL
displayed in search results should be different from what gets
indexed (e.g. in enterprise, content management systems). If this
value is not set, we default to the regular URL.
DocId (type: String.t, default: nil) - 64-bit docid of the
document (usually fingerprint of URL, but not always).
WARNING: This does NOT uniquely identify a document
ANYMORE. For a unique identifier across all documents in
production please refer to the field 'id().key()' listed above.
ExternalFeedMetadata (type: String.t, default: nil) -
ExternalHttpMetadata (type: String.t, default: nil) -
Enterprise-specific external metadata. See
http://engdoc/eng/designdocs/enterprise/enterprise_indexing_metad
ata.html
FilterForSafeSearch (type: integer(), default: nil) -
Deprecated, do not use, this field is not populated since 2012.
IPAddr (type: String.t, default: nil) - IP addr in binary (allows
for IPv6)
NoArchiveReason (type: integer(), default: nil) -
NoFollowReason (type: integer(), default: nil) -
NoImageIndexReason (type: integer(), default: nil) -
NoImageframeOverlayReason (type: integer(), default: nil) -
NoIndexReason (type: integer(), default: nil) - When these
reasons are set to a non zero value, the document should not be
indexed, or show a snippet, or show a cache, etc. These reasons are
bit maps of indexing.converter.RobotsInfo.RobotedReasons enum
values reflecting the places where the restriction was found:
//depot/google3/indexing/converter/proto/converter.proto
NoPreviewReason (type: integer(), default: nil) -
NoSnippetReason (type: integer(), default: nil) -
NoTranslateReason (type: integer(), default: nil) -
Pagerank (type: integer(), default: nil) - This field is long-
deprecated in favour of Pagerank_NS, it is no longer maintained
and can break at any moment.
PagerankNS (type: integer(), default: nil) - Pagerank-
NearestSeeds is a pagerank score for the doc, calculated using
NearestSeeds method. This is the production PageRank value teams
should use.
Repid (type: String.t, default: nil) - is the webmirror
representative id of the canonical url. Urls with the same repid are
considered as dups in webmirror. WARNING: use this field with
caution! The webmirror duprules change frequently, so this value
only reflects the duprules at the time when the canonical's docjoin is
built.
ScienceMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.ScienceCitation.t,
default: nil) - Citation data for science articles.
URL (type: String.t, default: nil) - WARNING: the URL does
NOT uniquely identify a document ANYMORE. For a unique
identifier across all documents in production please refer to the field
'id().key()' listed above. Reason: foo.bar:/http and
foo.bar:/http:SMARTPHONE share the same URL, but the body of
the two documents might differ because of different crawl-context
(desktop vs. smartphone in this example).
URLAfterRedirects (type: String.t, default: nil) -
URLEncoding (type: integer(), default: nil) - See
webutil/urlencoding
content (type:
GoogleApi.ContentWarehouse.V1.Model.GDocumentBaseContent
.t,default: nil) -
directory (type:
list(GoogleApi.ContentWarehouse.V1.Model.GDocumentBaseDi
default: nil) -
rectory.t),
ecnFp (type: String.t, default: nil) - 96-bit fingerprint of the
canonical url's webmirror equivalence class name as of when this
cdoc was exported.
id (type:
GoogleApi.ContentWarehouse.V1.Model.IndexingCrawlerIdSer
vingDocumentIdentifier.t,default: nil) - The primary
identifier of a production document is the document key given in
the ServingDocumentIdentifier, which is the same as the row-key in
Alexandria, and represents a URL and its crawling context. In your
production code, please always assume that the document key is the
only way to uniquely identify a document. ## Recommended way
of reading: const string& doc_key = cdoc.doc().id().key(); ##
CHECK(!doc_key.empty()); More background information can be
found in
google3/indexing/crawler_id/servingdocumentidentifier.proto The
ServingDocumentIdentifier uniquely identifies a document in
serving and also distinguishes between experimental vs. production
documents. The SDI is also used as an input for the union/muppet
key generation in serving.
localsearchDocInfo (type:
GoogleApi.ContentWarehouse.V1.Model.LocalsearchDocInfo.t
, default: nil) - Localsearch-specific data.
oceanDocInfo (type:
GoogleApi.ContentWarehouse.V1.Model.OceanDocInfo.t,
default: nil) - Ocean-specific data.
originalcontent (type:
GoogleApi.ContentWarehouse.V1.Model.GDocumentBaseOrigina
lContent.t, default: nil) -
 userAgentName (type: String.t, default: nil) - The user agent
name used to crawl the URL. See
//crawler/engine/webmirror_user_agents.h for the list of user-agents
(e.g. crawler::WebmirrorUserAgents::kGoogleBot). NOTE: This
field is copied from the first WEBMIRROR FetchReplyClientInfo
in trawler_fetch_info column. We leave this field unpopulated if no
WEBMIRROR FecthReplyClientInfo is found. As the submission
of cl/51488336, Alexandria starts to populate this field. However,
docjoins from freshdocs (or any other source), won't have this field
populated, because we believe no one needs to read this field from
freshdocs docjoins.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

DisplayUrl: String.t() | nil,

DocId: String.t() | nil,
ExternalFeedMetadata: String.t() | nil,
ExternalHttpMetadata: String.t() | nil,

FilterForSafeSearch: integer() | nil,

IPAddr: String.t() | nil,
NoArchiveReason: integer() | nil,
NoFollowReason: integer() | nil,
NoImageIndexReason: integer() | nil,
NoImageframeOverlayReason: integer() | nil,
NoIndexReason: integer() | nil,

NoPreviewReason: integer() | nil,

NoSnippetReason: integer() | nil,
NoTranslateReason: integer() | nil,
Pagerank: integer() | nil,
PagerankNS: integer() | nil,
Repid: String.t() | nil,

ScienceMetadata:
GoogleApi.ContentWarehouse.V1.Model.ScienceCitation.t() | nil,
URL: String.t() | nil,
URLAfterRedirects: String.t() | nil,
URLEncoding: integer() | nil,
content: GoogleApi.ContentWarehouse.V1.Model.GDocumentBaseContent.t() | nil,
directory:
[GoogleApi.ContentWarehouse.V1.Model.GDocumentBaseDirectory.t()] | nil,
ecnFp: String.t() | nil,

id:

GoogleApi.ContentWarehouse.V1.Model.IndexingCrawlerIdServingDocumentIdentifier.t(
)
| nil,
localsearchDocInfo:
GoogleApi.ContentWarehouse.V1.Model.LocalsearchDocInfo.t() | nil,

oceanDocInfo: GoogleApi.ContentWarehouse.V1.Model.OceanDocInfo.t() | nil,

 originalcontent:
GoogleApi.ContentWarehouse.V1.Model.GDocumentBaseOriginalContent.t() | nil,

userAgentName: 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.GDocumentBaseContent
Main content section

Attributes

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

ContentLength (type: integer(), default: nil) - The actual
length of the content: If Representation is compressed, this equals
to Content.UncompressedLength; otherwise it is the length of the
representation string.
ContentType (type: integer(), default: nil) - See enum
ContentType in //depot/google3/webutil/http/content-type.proto.
CrawlTime (type: String.t, default: nil) - Seconds since Unix
epoch.
Encoding (type: integer(), default: nil) - See
//depot/google3/i18n/encodings/public/encodings.h Encoding of
representation
HasHttpHeader (type: boolean(), default: nil) - Set to false if
Representation does not contain HTTP headers.
Language (type: integer(), default: nil) - A Language enum
value. See: go/language-enum Default is english
OriginalEncoding (type: integer(), default: nil) - If
OriginalEncoding is present, the body part of the Representation
was converted to UTF-8, Encoding was set to UTF8, and
OriginalEncoding was set to the original encoding before
conversion. However, the HTTP headers part of the content might
not be valid UTF-8. -1=an invalid value
Representation (type: String.t, default: nil) - Possibly
compressed for old documents. It is not compressed for docjoins
produced by Raffia after ~2012.
 UncompressedLength (type: integer(), default: nil) -
Historically present if Representation is compressed.
VisualType (type: integer(), default: nil) - Whether the
content was visual right-to-left, and if so, what type of visual
document it is. Must be one of the values in enum VisualType from
google3/repository/rtl/visualtype.h Default is
NOT_VISUAL_DOCUMENT. See http://wiki/Main/RtlLanguages
for background.
crawledFileSize (type: integer(), default: nil) - Crawled file
size of the original document.
encodedGeometryAnnotations (type: String.t, default: nil) -
GeometryAnnotations, encoded with GeometryUtil::DeltaEncode()
to reduce disk space usage. Use GeometryUtil::DeltaDecode() to
decode 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.GDocumentBaseContent{

AuthMethod: integer() | nil,
ContentLength: integer() | nil,
ContentType: integer() | nil,
CrawlTime: String.t() | nil,

Encoding: integer() | nil,

HasHttpHeader: boolean() | nil,

Language: integer() | nil,

OriginalEncoding: integer() | nil,

Representation: String.t() | nil,

UncompressedLength: integer() | nil,

VisualType: integer() | nil,

crawledFileSize: integer() | nil,

encodedGeometryAnnotations: 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.GDocumentBaseDirectory
The Directory proto group holds snippet and title metadata which is
made available to the snippet code. The proto group was originally
created for metadata coming from the Google Web Directory (gwd)
project. It has since come to be used to hold metadata from gwd and
other sources.

Attributes

Category (type: String.t, default: nil) - encoded in UTF8

Description (type: String.t, default: nil) - encoded in UTF8
DescriptionScore (type: number(), default: nil) -
Identifier (type: String.t, default: nil) - "gwd", etc.
Language (type: integer(), default: nil) - go/language-enum
Title (type: String.t, default: nil) - encoded in UTF8
TitleScore (type: number(), default: nil) - Deprecated; do not
use. There is no code populating these fields as of Oct 2017.
URL (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.GDocumentBaseDirectory{

Category: String.t() | nil,

Description: String.t() | nil,

DescriptionScore: number() | nil,

Identifier: String.t() | nil,

Language: integer() | nil,
Title: String.t() | nil,
TitleScore: number() | 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.GDocumentBaseOriginalCo
ntent
The original, unconverted document, typically PDF or Word. Copied
from OriginalDoc field of doclogs. Unlike "Content", this does not
contain any HTTP headers. The content may be compressed using the
same method as "Content". In practice it is only compressed in the
Teragoogle index. It is never compressed in docjoins because those are
compressed at the sstable level. In doclogs content will only be
compressed if the Trawler fetchreply is also compressed--which is
currently never and unlikely to change for performance reasons.

Attributes

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

Representation
UncompressedLength (type: integer(), default: nil) - present iff
rep is compressed

Summary
Types
t()

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

Types

t()

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

Representation: String.t() | nil,

UncompressedLength: integer() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GenericSnippetResponse
The generic version of a snippet response

Attributes

debugInfo (type: list(String.t), default: nil) - Per-doc debug

information.
info (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
et.t, default: nil) - Servlet-specific response info.
rankingSnippet (type: String.t, default: nil) - The
experimental ranking snippet field. This will be populated only
when fastwa_want_ranking_snippet is set in the request.
snippet (type: list(String.t), default: nil) - Lines of the
snippet HTML. Typically gws concatenates these and lets the
browser wrap. The values include trailing spaces, so inserting
additional spaces is not necessary. However, for very old browsers,
gws may insert break tags after each snippet line. This field is
confusing and poorly named; "snippet_line" would be better. In
particular, note that this does not return multiple snippets for a
result. Nor are these fields the individual tidbits of the snippet.
title (type: String.t, default: nil) - The title HTML. It may
contain tags to denote query term matches. It may be already
truncated and "..." is put instead (note that truncation does not
always happen at the very end of the title text). However the
existence of "..." does not guarantee that the snippet generation
algorithm truncated it; e.g. webmasters themselves can write "...".
wwwSnippetResponse (type:
GoogleApi.ContentWarehouse.V1.Model.WWWSnippetResponse.t
 , default: nil) - Snippet-specific members (tag ids 16+, must be
optional!) Example: optional NewContentResponse new_response;

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

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

info: GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,

rankingSnippet: String.t() | nil,

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

title: String.t() | nil,

wwwSnippetResponse:
GoogleApi.ContentWarehouse.V1.Model.WWWSnippetResponse.t() | nil
}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeoOndemandAssistantSup
portedActions
Actions supported by Madden for a local entity.

Attributes

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

this local entity allows guest checkout for reservations.
isAsynchronousRestaurantReservation (type: boolean(),
default: nil) - Whether or not this local entity supports
asynchronous restaurant reservations, through the above
restaurant_reservation_url.
restaurantReservationUrl (type: String.t, default: nil) -
URL for the Madden restaurant reservation flow, e.g. for display in
a WebView. Not populated if restaurant reservations are not
supported for the local entity.

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeoOndemandAssistantSupportedActions{
allowsGuestCheckout: boolean() | nil,
isAsynchronousRestaurantReservation: boolean() | nil,

restaurantReservationUrl: 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.GeostoreAccessPointProto
This class holds information about a single access point. An access point
establishes a relationship between a feature (like a POI or building) and
some other feature. For example, consider a TYPE_LOCALITY feature
like Seattle. An access point might be the TYPE_AIRPORT feature for
Seattle-Tacoma International Airport. The airport feature defines the
access point to gain airplane-based access to Seattle. A feature like
Seattle will typically have multiple access points. You can get to Seattle
using airplanes, various forms of public transit, or by driving a car. Thus
Seattle would have multiple access points. You may be able to get to
Seattle by flying into SeaTac, or you might be able to fly into Boeing
Field, or Paine Field in Everett. You could drive in from the North/South
using I-5, or you could drive in from the East using I-90. Many access
points are from the road network. Thus the access point for some
building at 123 Main Street would likely be a segment that defines the
100-200 block of "Main Street". A feature at the corner of "Hollywood"
and "Vine" streets might have access points from both named streets.
Access points are an optional field. Data editors may ignore them when
creating features or editing other fields. In these cases, other quality
teams will synthesize and update them. Several fields are also optional,
as they are derivable from other fields. Access points to non-
TYPE_SEGMENT features should always have the following fields set:
- feature_type - feature_id - point Location and reference fields: BASIC
vs DERIVABLE Access points to TYPE_SEGMENT features must have
all the following BASIC fields: - feature_type (of the segment, e.g.
TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) - point_off_segment
(or point; see "fuzzy point" note below) - unsuitable_travel_mode (may
be empty) - level (indoor access points only) The following are
DERIVABLE fields, which should only be added if the supplier is
confident about their accuracy: - feature_id - point_on_segment -
segment_position Editing clients are encouraged to set all fields, but they
may set only the BASIC fields, in which case quality teams may use the
BASIC fields to snap to an appropriate segment and derive the
remaining fields. Example: The segment is split, so that the portion that
the access point is on has a new feature ID. Quality teams notice that the
point_on_segment is no longer on the segment with feature_id, finds the
new nearest segment based on feature_type and existing
point_on_segment, and re-derives a new feature_id, point_on_segment,
and segment_position, keeping other fields consistent. Fuzzy point
special case If the editor does not have side-of-road information for
access points or is otherwise unsure of the precise placement of the
access point, it may supply the point field (and not point_off_segment)
as basic data instead, in which case quality teams may generate the
point_off_segment. Identity Access points are considered semantically
equivalent if they have the same geometry, including derived fields, and
the same references to other features (feature_id, level_feature_id). For
the exact definition, see
cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions

Attributes

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

canExit (type: boolean(), default: nil) - RESERVED
featureId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - The ID of the feature that defines the access
point. The bounding box of the feature is expanded to include the
bounding box of the feature with the access point in accordance
with the standard practice for bucketing map/reduce operations. See
the wiki page at http://wiki/Main/OysterBucketingMapReduce for
more information. For access points to TYPE_SEGMENT features,
this may be re-derived if necessary by looking up the nearest
segment to existing geometry.
featureType (type: integer(), default: nil) - The type of the
feature. Required, to allow handling the access point differently
based on feature type. For access points to non-TYPE_SEGMENT
features, this cached type also makes things easier for clients that
aren't running a bucketing map-reduce. For access points to
TYPE_SEGMENT features, this is used to find to find the nearest
segment of the given type.
levelFeatureId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - For indoor access points, this should be set to
the level that the access point is on. The feature_id should point to
the indoor segment, but when it is missing or invalid, and we need
to derive it from geometry, only segments on this level will be
considered. For non-indoor access points, level should remain
unset, and when we derive feature_id from geometry, only
segments not on any level (non-indoor segments) will be
considered. The bounding box of the level feature is expanded to
include the bounding box of the feature with the access point in
accordance with the standard practice for bucketing map/reduce
operations. See the wiki page at
http://wiki/Main/OysterBucketingMapReduce for more
information. (Though in general the feature should reside on the
level already anyway..)
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
aProto.t, default: nil) - Field-level metadata for this access
point.
point (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t
, default: nil) - For access points to non-TYPE_SEGMENT
features, the location of the access point. For access points to
TYPE_SEGMENT features, this can be supplied as a fuzzy access
point that is not guaranteed to be on the correct side of road. It
should not be used by end clients in case of TYPE_SEGMENT
access points.
pointOffSegment (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t
, default: nil) - If the access point is defined by a
TYPE_SEGMENT feature, this is the location of the access point
displaced slightly to the correct side of the segment. This offset is in
a direction perpendicular to the direction of travel along the
segment. The actual offset distance is unspecified. It would
typically be relatively small (approximately 1 meter). You can
subtract the "off segment" point from the "on segment" point to get
a vector of unknown length pointing from "on segment" point to the
"off segment" point. You can then scale that vector to whatever
length you want. Note that extending this displacement vector a
large distance (10s of meters) may result in a new point that is in
the middle of some other feature (park, street, intersection). This is
the preferred basic geometry field for incoming data from editing
clients and importers, if side-of-road is well-established.
pointOnSegment (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t
, default: nil) - If the access point is defined by a
TYPE_SEGMENT feature, this is the point on the centerline of the
segment that is closest to the actual access point. May be re-derived
if necessary to maintain precise placement on segment.
priority (type: String.t, default: nil) -
LINT.ThenChange(//depot/google3/geostore/cleanup/callbacks/\
ID_DUPLICATE_ACCESS_POINT.cc)
segmentPosition (type: number(), default: nil) - If the access
point is defined by a TYPE_SEGMENT feature, this is the location
of the access point expressed as a fractional distance along the
segment. The value runs from 0 to 1 inclusive. May be re-derived if
necessary to maintain precise placement on segment.
unsuitableTravelMode (type: list(String.t), default: nil) -
This list represents the travel modes for which this access-point
should be avoided. If this list is empty, the access-point is suitable
for any travel mode. If all access points are unsuitable for the
current travel mode, client should revert to other heuristics (e.g.
feature center). This is only used for access points to
TYPE_SEGMENT features; access points to non-
 TYPE_SEGMENT features, e.g. TYPE_ESTABLISHMENT_POI
features with gcid:transit_station GConcepts are just identified by
feature_type and feature_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.GeostoreAccessPointProto{

canEnter: boolean() | nil,

canExit: boolean() | nil,

featureId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

featureType: integer() | nil,

levelFeatureId:

GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
metadata:
 GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,
point: GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t() | nil,

pointOffSegment:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t() | nil,

pointOnSegment:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t() | nil,

priority: String.t() | nil,

segmentPosition: number() | nil,

unsuitableTravelMode: [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.GeostoreAddressComponen
tProto
This class represents a parsed field within an address. NOTE: if you add
a field to this proto, please update the
AreAddressComponentsEquivalent() function in
google3/geostore/base/internal/addresscomponent.cc

Attributes

featureId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - The id of the corresponding Feature, if such a
feature is defined. As discussed above for feature_type, components
of TYPE_FEATURE or TYPE_LANDMARK may have a
corresponding feature id.
featureType (type: integer(), default: nil) - For components
of TYPE_FEATURE or TYPE_LANDMARK, this is the feature
type (TYPE_COUNTRY, TYPE_LOCALITY,
TYPE_ESTABLISHMENT_POI etc.). Note that some features may
not actually exist in the geostore (e.g. a village that we've never
heard of), in which case the feature_id will be missing but the
feature_type is still specified. Please refer to
IsValidAddressComponentFeatureType() in
google3/geostore/base/public/addresscomponent.h for the definitive
list of feature types allowed for the type (either TYPE_FEATURE
or TYPE_LANDMARK) of components.
index (type: integer(), default: nil) - The order of this address
component relative to the ones that share the same feature_type in
the AddressProto. For now, the primary use of this index field is to
handle ordering issue of multiple occurrences of
AddressComponentProto with feature_type of TYPE_ROUTE (and
subtypes), or TYPE_POLITICAL, where the order of the address
components matters as there are dependences. 0 is the smallest
valid index value, representing the most specific address
component. Index value of 1 represents a relatively less specific
address component of the same feature_type on which the 0-
indexed address component depends.
parsedName (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreNamePro
default: nil) - The parsed_name field contains one or more
to.t),
names of an address component. Its actual contents depends on
where in the Geo/Google stack you are reading a feature: 1. When
an address is initially parsed via a feed or other raw input and
structured as an AddressProto, parsed_name should contain the set
of names that corresponds to the (possibly normalized) raw text
from the raw input. 2. In MapFacts, the address component may be
linked to an actual feature via feature_id. Any address formatting
directly from MapFacts should follow links to retrieve names when
possible. The parsed_name contents may be formatted directly if
the address component is unlinked following the same rules as
selecting and formatting the name of a feature. The cached
parsed_name is regularly refreshed from the linked feature with the
minimal set of names for address components (usually just a single,
preferred name, in the local language, plus a Latin-script name:
go/story-of-ac-names). 3. In serving systems, the names of linked
features may be denormalized into the parsed_name field to
facilitate quicker address formatting or for simple data filtering (e.g.
finding all geocodes in California by name). If reading a feature
from such a system, the parsed_name field could contain multiple
names in multiple languages that reflect a cached copy of the names
associated with the linked features. Formatting of such names
should follow the same rules as selecting and formatting the name
of a feature itself.
range (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressRange
Proto.t,default: nil) - Any numerical address component may
optionally be specified as a range. For example if a component of
TYPE_STREET_NUMBER has the optional "range" attribute, then
it represents a range of addresses rather than a single address (see
AddressRangeProto for details).
temporaryData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
default: nil) - A place for clients to attach arbitrary data to
et.t,
an address component. Never set in MapFacts.
textAffix (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreTextAff
default: nil) - Additional text to append before
ixProto.t),
and/or after the parsed_name, when the address is formatted.
Multiple instance should represent translations. Currently, this is
only permitted on TYPE_LANDMARK components, and only one
instance is permitted.
type (type: String.t, default: nil) - Every address component
has a type. Most address components correspond to one of the
feature types defined in FeatureProto, so rather than defining a
separate category system here, instead we mark them as
TYPE_FEATURE and store the FeatureProto type in the
feature_type() field. This is how we handle countries, cities, streets,
etc. However, there are a few types of address components that do
not have a corresponding feature type (e.g. PO boxes). These
components have their type defined here. An address component of
TYPE_STREET_NUMBER may correspond to a physical entity
that defines a street number, such as a geocoded address or a land
parcel. In this case, the address component may have a link to the
corresponding feature. A good reference for what types of address
components are possible is the xAL standard, which is a published
XML schema: http://www.oasis-
open.org/committees/ciq/download.shtml. This standard is the basis
of the PostalAddress protocol message.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

featureId:

GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
featureType: integer() | nil,

index: integer() | nil,

parsedName: [GoogleApi.ContentWarehouse.V1.Model.GeostoreNameProto.t()] | nil,

range:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressRangeProto.t() | nil,

temporaryData:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,

textAffix:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreTextAffixProto.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.GeostoreAddressLinesProto
Represents the unparsed portion of an address with an associated
language.

Attributes

language (type: String.t, default: nil) - The external form of a

Google International Identifiers Initiative (III) LanguageCode
object. See google3/i18n/identifiers/languagecode.h for details. We
place extra restrictions on languages in addition to what the III
library requires. See http://go/geo-schema-reference/feature-
properties/languages.md
line (type: list(String.t), default: nil) - These lines are in
display order.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

language: String.t() | nil,
line: [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.GeostoreAddressProto
This class represents an address, partial address, or address range. It is
intended to be attached to features to identify their address(es). Some
important points about addresses: - The addresses in the Geo Schema do
not include a component for the name of the feature, i.e. they are not
self-referential. For example, the name of a feature might be "Zack's
Pizza" and its address would be "123 Main Street". Similarly, streets,
cities, and counties do not include themselves as part of their address.
The address of "Seattle" is "King County, Washington, USA". If want to
construct an address that does include the feature name, you can simply
prepend it to the other address components. - Lakes, mountains, and
other natural features do not normally have addresses. Countries also do
not have addresses because they are at the top of the political hierarchy. -
Address components in the Geo Schema are listed in a particular order,
independent of the conventions used by the country in which they occur.
The basic order is "smallest to largest" starting with street numbers and
routes, then political features, and ending with postal features. The exact
rules are defined by the implementation of the
AddressComponentOrdering::IsLessThan() function. - Some types of
address components may occur more than once in an address. For
example, a UK address with a "dependent thoroughfare" would have two
components of TYPE_ROUTE (i.e. street names). These are listed in the
order they are normally written.

Attributes

addressLines (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAddress
default: nil) - The unparsed portion (lines) of the
LinesProto.t),
address. An address can have multiple unparsed portions. Multiple
unparsed portions sharing the same language should be modeled as
one address_lines instance having multiple lines. Historically, we
also supported unparsed portions in different languages, but we no
longer do. Consequently, only one value is allowed for this field
despite the fact that it is repeated. See go/address-lines-multi-
language for information about why we made this change. If any
components are filled in, this is supplemental to (i.e. disjoint from)
them. Furthermore, this must be the most specific portion of the
address (except for the portion, if any, stored in the name field of
feature.proto). Unparsed lines are always formatted together in a
block. Other address components are never formatted between the
address lines. This doesn't imply that the address lines are always
either the first or the last part of the formatted output.
component (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAddress
ComponentProto.t), default: nil) - A list of parsed address
components, e.g. the street, city, etc. An address range is one type
of component.
crossStreet (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAddress
default: nil) - DEPRECATED This field is
ComponentProto.t),
now deprecated (see b/33268032). If you want to store cross street
information as part of an address, use the address_lines field.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
aProto.t,default: nil) - Field-level metadata for this address.
partialDenormalization (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressProto
.t,default: nil) - reserved
templateId (type: String.t, default: nil) - The opaque ID of
the address template that contains rules for structuring this address.
The id of the address template can be retrieved using
google3/geostore/address_templates/public/address_templates.h
temporaryData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
 default: nil) - A place for clients to attach arbitrary data to
et.t,
an address. Never set in MapFacts.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

addressLines:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressLinesProto.t()] | nil,

component:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressComponentProto.t()]
| nil,

crossStreet:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressComponentProto.t()]

| nil,
metadata:
 GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,
partialDenormalization: t() | nil,
templateId: String.t() | nil,
temporaryData:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreAddressRangeProt
o
This class represents a range of numbers in an address. It is an optional
additional field in the 'AddressComponentProto' message. This structure
can be used to model both single addresses and address ranges. There are
two primary use-cases for address ranges: definitions and references.
Ranges are being defined when they are present on the addresses of
segment features. Ranges are being referenced when they are present on
non-segment features. NOTE: If you add fields in this proto, consider
updating the AreAddressRangesEquivalent() function in
google3/geostore/base/internal/addressrange.cc

Attributes

number (type: list(integer()), default: nil) - Two or more

address numbers. Each number represents an address that was
mentioned by the data provider.
parameter (type: list(number()), default: nil) - For address
range definitions: Two or more interpolation parameter values. The
length of this array must match the length of the number array, and
each parameter number specifies the position of the corresponding
address number. Each value is an interpolation between 0.0 and 1.0
inclusive. The value is proportional to the distance traveled along
the segment's polyline starting at its origin. The parameters must be
provided in increasing order and the values in the number array
must be in strictly increasing or decreasing order. We make an
exception for singleton addresses, which are represented as two
copies of a (number, parameter) pair, for backwards compatibility.
For address range references: This array must be empty.
 prefix (type: String.t, default: nil) - If specified, the prefix or
suffix is applied to all numbers in the range. For example, this can
be used to indicate that addresses B1 through B99 are on one side
of the street, while A1 through A99 are on the other side of the
street.
sameParity (type: boolean(), default: nil) - If 'same_parity' is
true, then all 'number' values must have the same parity (even or
odd), and this address range only includes addresses whose parity is
the same as the given 'number' values.
suffix (type: String.t, default: nil) -
temporaryData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
default: nil) - A place for clients to attach arbitrary data to
et.t,
an address range. Never set in MapFacts. Here are some examples:
Example #1: Single non-numeric address (e.g., "Twelve") At the
moment this can only be represented as a street number (with the
value in the parsed_name field of the AddressComponentProto). We
have future plans to make other changes so we can handle this case.
Example #2: Single semi-numeric address (e.g., "12bis") The
number array contains two copies of the single numeric value (12).
The prefix is empty and the suffix contains "bis". The parameter
array has two identical values specifying the position of the single
address. Example #3: Simple address range (e.g., "100 to 198, even
numbers only") The number array contains the two values "100"
and "198". The prefix and suffix strings are empty in this example.
The parameter array has two values, one for each number. The
same_parity flag is set in this example.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

number: [integer()] | nil,
parameter: [number()] | nil,
prefix: String.t() | nil,
sameParity: boolean() | nil,

suffix: String.t() | nil,

temporaryData:

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

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreAnchoredGeometry
Proto
A feature’s geometry that is populated from the 3D Geometry Store.
Please see go/a3d-and-mapfacts for design details.

Attributes

geometryId(type: String.t, default: nil) - The ID to be used to

fetch the feature’s geometry from the 3D Geometry Store.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

geometryId: 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.GeostoreAppliedSpeedLimit
Proto
A container for speed limits that allows tagging with a correctness trust
level.

Attributes

speedLimit (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSpeedLimitPr
oto.t,default: nil) - The actual speed limit value.
trustLevel (type: String.t, default: nil) - The level of trust we
have in this speed limit value.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

speedLimit:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSpeedLimitProto.t() | nil,
trustLevel: 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.GeostoreAttachmentsAttach
mentProto
An AttachmentProto contains structured data of a client-specified type.
An attachment is uniquely identified by the combination of its
attachment_id and client_name_space fields.

Attributes

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

attachmentId
distinguishes messages of the same type_id associated with the
same feature. It can not be set to 0x0.
clientNameSpace (type: String.t, default: nil) - This field
specifies a namespace identifier that can be used to track the
sources of attachments in a human friendly format. Name spaces
must be at most 64 characters long and must be composed entirely
of alphanumeric characters, hyphens, and underscores. No other
characters are allowed.
comment (type: String.t, default: nil) - comment is a human-
readable string that is logged whenever this attachment is processed
by the framework.
messages (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
et.t,default: nil) - messages contains the structured data for this
attachment. It should contain a single message with a type ID
matching the value of the type_id field below.
typeId (type: String.t, default: nil) - type_id determines the
type of the actual attachment that should be set in the messages
MessageSet. It can not be set to 0x0.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

attachmentId: String.t() | nil,

clientNameSpace: String.t() | nil,

comment: String.t() | nil,

messages:

GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
typeId: 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.GeostoreAttributeIdProto
Used to represent the unique id of an attribute.

Attributes

id (type: String.t, default: nil) - The id of the attribute. Stored

as a stripped format of the gcid (e.g. "foo" instead of
"gcid:att_foo").
providerId (type: String.t, default: nil) - Set because it's
required, but not really meaningful in geostore (always set to
"Geo").
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.GeostoreAttributeIdProto{

id: String.t() | nil,
providerId: String.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.GeostoreAttributeProto
Protocol buffer for attaching attributes and values to instances. This is
for assigning a particular attribute and value to a repository item, not for
metadata. For protocol buffers that represents metadata about attributes
and values, see CanonicalAttribute in itemclass.proto and ValueSpace in
valuespace.proto.

Attributes

applicationData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
et.t,default: nil) -
attributeDisplay (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAttribu
teValueDisplayProto.t),default: nil) -
booleanValue (type: boolean(), default: nil) -
canonicalAttributeId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeIdP
roto.t,default: nil) - The canonical attribute for this attribute
instance.
doubleValue (type: float(), default: nil) -
enumIdValue (type: String.t, default: nil) - For those attribute
ids that expect their values to be taken from an enumeration-style
set of values, that value's gcid should be stored here, e.g.
"gcid:attval_yes".
floatValue (type: number(), default: nil) -
int64Value (type: String.t, default: nil) -
integerValue (type: integer(), default: nil) -
itemClassId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeIdP
 default: nil) -
roto.t,
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
aProto.t,default: nil) - Field-level metadata for this attribute
protoValue (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
et.t,default: nil) - Fully qualified package name because
genprotohdf uses genproto for this proto2 syntax:
https://wiki.corp.google.com/twiki/bin/view/Main/Proto2WithGenp
roto
stringValue (type: String.t, default: nil) - The attribute value
falls into one of these fields, based on value_type:
uint32Value (type: integer(), default: nil) -
valueDisplay (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAttribu
default: nil) - Used to store language-
teValueDisplayProto.t),
specific names of this attribute's value (e.g. a translation into
another language).
valueSpaceId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeIdP
roto.t,default: nil) -
valueType (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.GeostoreAttributeProto{

applicationData:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,

attributeDisplay:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeValueDisplayProto.t()]
| nil,
booleanValue: boolean() | nil,
canonicalAttributeId:

GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeIdProto.t() | nil,
doubleValue: float() | nil,

enumIdValue: String.t() | nil,

floatValue: number() | nil,

int64Value: String.t() | nil,

integerValue: integer() | nil,

itemClassId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeIdProto.t() | nil,

metadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,

protoValue:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,

stringValue: String.t() | nil,

uint32Value: integer() | nil,
valueDisplay:

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

valueSpaceId:
 GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeIdProto.t() | nil,
valueType: 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.GeostoreAttributeValueDisp
layProto
Used to help display language-specific names of attributes.

Attributes

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

synonym (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.GeostoreAttributeValueDisplayProto{
language: String.t() | nil,

synonym: 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.GeostoreBarrierLogicalMat
erialProto
Attributes

material (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.GeostoreBarrierLogicalMaterialProto{
material: [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.GeostoreBestLocaleProto
A BestLocaleProto holds information about the best-match locale for a
feature. Clients may use this information to determine the appropriate
local name of a feature.

Attributes

locale (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - The ID of the best-match TYPE_LOCALE
feature for this feature.
localizationPolicyId (type: String.t, default: nil) - The ID
of the localization policy to apply when selecting a name for a
feature. This field should always be set. If feature_id is also
defined, this field should have the same localization policy ID as
the referenced locale feature. Localization policy IDs are arbitrary
identifiers (up to some number of bytes; see
geostore/base/public/constants.h) that uniquely distinguish a set of
language-selection rules.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
aProto.t, default: nil) - Field-level metadata for this best locale.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

locale: GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

localizationPolicyId: String.t() | nil,
metadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreBizBuilderReferenc
eProto
The reference to a BizBuilder listing. For details on BizBuilder see
http://g3doc/commerce/bizbuilder/backend/g3doc/index.md

Attributes

id(type: String.t, default: nil) - Listing id. Used in queries to

BizBuilder backend for listing access.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreBizBuilderReferenceProto{
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.GeostoreBorderProto
A border represents a line of division between two features of the same
type (i.e. United States and Mexico, but not California and Mexico).
Borders are only used for features that tile an area. For example, country
features have borders with one another because they tile an area of land.
Country features do not have borders with province features because
those two types of features may intersect with each other. The geometry
of a border will often be similar (or derived from) the geometry of the
two features that it separates. However, it is useful to have borders
represented by stand-alone features for map-styling purposes. Ideally, the
geometry in a border feature would be exactly the same as the common
edges of the polygonal geometry of the two features. This may not
always be true in practice. At some point in the future we would like to
build a network of borders for features that are supposed to tile with each
other. The network would be composed of different border types meeting
at endpoint intersections. In the process of building this network, we
would perform small geometry corrections to ensure that the borders
align properly at all zoom levels. Border features are intended primarily
for map drawing, and they would rarely be useful for geocoding. One
exception would be for famous borders like the "Mason Dixon Line" or
the "Berlin Wall." The standard feature properties have the following
interpretations: name - Borders rarely have names unless they notable in
their own right (e.g. "Mason Dixon Line", "Berlin Wall"). point - A
border should not have point geometry. polyline - A border should have
a single polyline that represents the division between the two features.
polygon - A border should not have polygon geometry.

Attributes
 featureIdLeft (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - The ids of the area features to the left and
to.t,
right of the border, relative to the start and end of this borders'
polyline geometry. These features should have the same type as the
"type" attribute above. These ids are not required because the
corresponding features may be nonexistent or difficult to obtain.
featureIdRight (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) -
to.t,
logicalBorder (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
IdProto.t),default: nil) - The logical borders which this border
is a part of.
overrideStatus (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreOverrid
eBorderStatusProto.t), default: nil) - List of border status
overrides. Due to legal reasons, we may be required to display some
borders differently on some domains for instance.
status (type: String.t, default: nil) - The border status
identifies the legal status of the border line.
type (type: integer(), default: nil) - The type of the features
this border separates. Should always be a subtype of
TYPE_POLITICAL. NOTE: as of December 2019, we currently
require this to be equal to TYPE_COUNTRY or
TYPE_ADMINISTRATIVE_AREA1. In the future, we may
support TYPE_BORDER for lower types of political 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.GeostoreBorderProto{

featureIdLeft:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

featureIdRight:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

logicalBorder:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
overrideStatus:

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

status: String.t() | nil,

type: integer() | nil

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreBoundingMarkerP
roto
NOTE: BoundingMarkerProto could be compared against one another
by canonicalizing them via GetCanonicalBoundingMarker() in
google3/geostore/base/internal/lane.cc. Any fields that don't contribute
to the definition of a bounding marker in the real world should be
bundled with the annotative fields near the bottom and excluded in
GetCanonicalBoundingMarker(). LINT.IfChange

Attributes

boundingMarker (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - References to any gcid:physical_lane_marker
features that bound this lane or lane connection.
boundingMarkerToken (type: String.t, default: nil) - A token
that can be used to identify the version of the data about this
bounding marker.
flowlineAdjacencyBeginFraction (type: float(), default: nil)
- Which part of the flowline does this association refer to? These
should be between 0 and 1. These are optionally set, but can be
approximated geometrically if they aren’t set. NOTE: These refer to
the geometry of this feature.
flowlineAdjacencyEndFraction (type: float(), default: nil) -
markerAdjacencyBeginFraction (type: float(), default: nil) -
Which part of the marker track does this association refer to? These
should be between 0 and 1. These are optionally set, but can be
approximated geometrically if they aren’t set. NOTE: These refer to
the geometry of the marker feature.
 markerAdjacencyEndFraction (type: float(), default: nil) -
side (type: String.t, default: nil) - Which side of the flowline
does the marker occur on.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

boundingMarker:

GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
boundingMarkerToken: String.t() | nil,

flowlineAdjacencyBeginFraction: float() | nil,

flowlineAdjacencyEndFraction: float() | nil,
markerAdjacencyBeginFraction: float() | nil,
markerAdjacencyEndFraction: float() | nil,
 side: 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.GeostoreBuildingProto
This protocol buffer holds the building-specific attributes for features of
type TYPE_COMPOUND_BUILDING.

Attributes

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

height of the base of this building, in meters above ground-level, if
known.
defaultDisplayLevel (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t, default: nil) - The level in this building that should get
displayed by default. If present, the default display level must be
one of this building's levels that are listed in the level[] field, and if
a level is set as a default level of one building, all buildings sharing
the level should have that same level as their default level. If not
present, clients should not display any level by default for that
building.
floors (type: integer(), default: nil) - The number of floors
above the base of the building, if known. For example a regular 1-
story building would set this to "1". Use a value of
GeostoreConstants::kDefaultHeightPerFloor when converting
"floors" to "height_meters".
floorsMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
default: nil) -
aProto.t,
heightMeters (type: number(), default: nil) - The height of the
building above its base, in meters, if known.
heightMetersMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
 aProto.t, default: nil) -
level (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
IdProto.t),default: nil) - The levels in this building, in no
particular order. These levels refer back to the building via another
strong reference (the LevelProto.building field).
structure (type: String.t, default: nil) - "Structure" denotes a
physical architecture of the building that is readily visible. This
attribute is useful in that rarer structures can make good landmarks.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

baseHeightMetersAgl: number() | nil,
 defaultDisplayLevel:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

floors: integer() | nil,

floorsMetadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,
heightMeters: number() | nil,
heightMetersMetadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,
level: [GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,

structure: 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.GeostoreBusinessChainProt
o
This holds data specific to business chain features.

Attributes

canonicalGconcepts (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCanonic
default: nil) - Canonical GConcepts
alGConceptProto.t),
describe the ideal state of the GConcepts of this business chain's
members.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

canonicalGconcepts:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreCanonicalGConceptProto.t()]
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreBusinessHoursProt
o
A BusinessHoursProto stores a weekly schedule of opening hours for a
business (represented as a BusinessHours message) together with other
closely related information that is Geo-specific.

Attributes

data (type:
GoogleApi.ContentWarehouse.V1.Model.BusinessHours.t,
default: nil) - The actual hours represented by this
BusinessHoursProto.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
aProto.t, default: nil) - Field-level metadata for these 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.GeostoreBusinessHoursProto{

data: GoogleApi.ContentWarehouse.V1.Model.BusinessHours.t() | nil,

metadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCallToActionProto
Message containing calls to action specified by the business owner.

Attributes

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

url (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreUrlProto.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.GeostoreCallToActionProto{

ctaType: String.t() | nil,
url: GoogleApi.ContentWarehouse.V1.Model.GeostoreUrlProto.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCanonicalGConcep
tProto
This proto represents a canonical gconcept of a business chain's
members.

Attributes

gconcept (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGConceptInst
anceProto.t,default: nil) -
isRequired (type: boolean(), default: nil) - Whether the
gconcept must be on a member. This must be true for a primary
gconcept.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

gconcept:

GoogleApi.ContentWarehouse.V1.Model.GeostoreGConceptInstanceProto.t() | nil,
isRequired: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCellCoveringProto
This protocol buffer holds S2 cell covering for the feature. See
util/geometry/s2cell_union.h for more information on S2 cells. See
geostore/base/public/cellcovering.h for utility functions.

Attributes

(type: list(String.t), default: nil) - Array of S2 cell

cellId
ids that represent the covering. There is no preset limit on how
many cells can be used.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

cellId: [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.GeostoreCityJsonProto
CityJsonProto is a custom proto representation of the portion of the
CityJSON spec (https://www.cityjson.org/) relevant to internal projects.
See go/cityjsonproto-design for more information about the modeling
and design decisions implemented here. LINT.IfChange

Attributes

appearance (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
oAppearance.t, default: nil) - Additional information that can be
used to describe the appearance of CityObjects in this
CityJsonProto.
cityObjects (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
nProtoCityObject.t), default: nil) - City objects associated with
this CityJsonProto.
flattenedVertices (type: list(integer()), default: nil) -
Vertices as local coordinates represented as a flattened list:
[x1,y1,z1,x2,y2,z2,x3,y3,z3]. Vertices are relative to a local
coordinate system and rounded to their nearest integer value. See
transform for how vertices can be transformed from a local
coordinate system into an Earth-centered, Earth-fixed coordinate
system. Vertices are flattened for space efficiency, memory locality,
and processing performance. To access the x,y,z coordinates of
vertex N, read the values at indices 3N, 3N+1, and 3N+2.
transform (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
default: nil) - Spec for converting vertices from a
oTransform.t,
local coordinate system in arbitrary units to ECEF coordinates in
 meters (https://en.wikipedia.org/wiki/Earth-centered,_Earth-
fixed_coordinate_system).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

appearance:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoAppearance.t()
| nil,
cityObjects:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObject.t()]
| nil,
flattenedVertices: [integer()] | nil,

transform:
 GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoTransform.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoAppe
arance
Contains additional ways to describe the appearance of a CityObject, e.g.
definitions of materials and textures that can apply to geometry surfaces.

Attributes

materials (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
default: nil) - Predefined
nProtoAppearanceMaterial.t),
materials that may be referenced from geometric primitives.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

materials:
[

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

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoAppe
aranceMaterial
Representation of a single material that can describe a geometry surface.
See technical definitions of these fields via the description and link at
https://www.cityjson.org/specs/2.0.0/#material-object.

Attributes

diffuseColor (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
oAppearanceMaterialRgbColor.t, default: nil) - The color that
this material shows under pure white light when incoming light is
reflected in all directions equally.
isNull (type: boolean(), default: nil) - is_null=true is used to
represent 'null' material references. There may only be one
is_null=true Material per CityJsonProto, and it must not have any
other fields set.
isSmooth (type: boolean(), default: nil) - Whether this material
has an even, regular surface or consistency.
name (type: String.t, default: nil) - The name of this material.
shininess (type: number(), default: nil) - The degree to which
this material reflects light; value is [0,1].
transparency (type: number(), default: nil) - The degree to
which this material allows light through; value is [0,1], with 1.0
being completely transparent.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

diffuseColor:

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoAppearanceMaterialRgbCol

or.t()
| nil,
isNull: boolean() | nil,
isSmooth: boolean() | nil,

name: String.t() | nil,

shininess: number() | nil,
transparency: number() | nil
}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoAppe
aranceMaterialRgbColor
RGB 0-1, where the range of each value is [0,1] instead of [0,255].
Values may be linear RGB or sRGB; RGB values are frequently stored
as sRGB (https://stackoverflow.com/a/12894053 explains the
difference).

Attributes

blue (type: number(), default: nil) -

green (type: number(), default: nil) -
red (type: number(), 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.GeostoreCityJsonProtoAppearanceMaterialRgbCo
lor{

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.GeostoreCityJsonProtoCity
Object
Representation of an object with geometry.

Attributes

geometries (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
nProtoCityObjectGeometry.t), default: nil) - Geometries
associated with this object.
id (type: String.t, default: nil) - The ID of this CityObject,
which must be unique within this CityJsonProto. The ID does not
have a meaning outside this CityJsonProto.
type (type: String.t, default: nil) - Type of object represented,
e.g. building.

Summary
Types
t()

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

Types

t()

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

geometries:
[

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

]
| nil,
id: String.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.GeostoreCityJsonProtoCity
ObjectGeometry
Representation of geometry including geometric primitives which are
used as building blocks to construct geometries of varying complexity.
Geometries vary both in type and in level-of-detail, enabling
representation of any shape at any level of granularity. All geometries
are ultimately composed of MultiPoints, which reference the actual
vertices. Only linear and planar shapes are allowed, no curves or
parametric surfaces.

Attributes

lod(type: String.t, default: nil) - Level-of-detail (LoD)

indicates how intricate the geometric representation is. May be a
single digit per CityGML standards or X.Y per TU Delft (visual
depiction at https://3d.bk.tudelft.nl/lod/). CityObjects may have
multiple geometries with the same LoD.
multipoint (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
default: nil) - For
oCityObjectGeometryMultiPoint.t,
geometries consisting of a single point, line, or loop.
multisurface (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
default: nil) - For
oCityObjectGeometryMultiSurface.t,
geometries consisting of a collection of surfaces.
semantics (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
nProtoCityObjectGeometrySemantic.t), default: nil) -
 Predefined semantics that may be referenced from geometric
primitives.
solid (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
default: nil) - For geometries
oCityObjectGeometrySolid.t,
consisting of a watertight 3D shape.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometry{
lod: String.t() | nil,

multipoint:

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMultiP
 oint.t()

| nil,
multisurface:

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMultiS
urface.t()

| nil,
semantics:

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometrySemant
ic.t()

]
| nil,

solid:

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

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoCity
ObjectGeometryMaterialSpec
Used to reference a predefined material from a geometric primitive.

Attributes

(type: integer(), default: nil) - Index into

materialsIndex
CityJsonProto.appearance.materials.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMater
ialSpec{
materialsIndex: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoCity
ObjectGeometryMultiPoint
A single line, loop, or set of points.

Attributes

xIndices (type: list(integer()), default: nil) - A collection of

references to vertices in CityJsonProto.flattened_vertices.
CityJsonProto.flattened_vertices is a flattened list of vertex
coordinates. A value in x_indices should be the index of the x-
coordinate of the desired vertex V; the full coordinates of vertex V
can then be found at indices [V,V+1,V+2]. For example, an
x_indices containing 3, 0, and 12 references three vertices, whose
complete x,y,z coordinates can respectively be found at
CityJsonProto.flattened_vertices indices [3,4,5], [0,1,2], and
[12,13,14].

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMulti

Point{
xIndices: [integer()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoCity
ObjectGeometryMultiSurface
A collection of arbitrary surfaces that have no prescribed topological
relationship.

Attributes

surfaces (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
default: nil) - All
nProtoCityObjectGeometrySurface.t),
surfaces are standalone entities with no relationship to each other.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMulti
Surface{

surfaces:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometrySurfac
e.t()

]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoCity
ObjectGeometrySemantic
Representation of semantic information that can be used for reasoning
about geometric primitives.

Attributes

type(type: String.t, default: nil) - The type of semantic entity

this geometric primitive is.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometrySeman

tic{
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.GeostoreCityJsonProtoCity
ObjectGeometrySolid
A 3D shape, composed of a watertight exterior shell with optional
interior watertight shells.

Attributes

shells (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
default: nil) - The
nProtoCityObjectGeometryMultiSurface.t),
first shell is exterior; any additional are interior.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometrySolid
{

shells:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMultiS

urface.t()
]

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoCity
ObjectGeometrySurface
A polygonal surface, composed of a closed exterior loop with optional
closed interior loops.

Attributes

loops (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
default: nil) - The
nProtoCityObjectGeometryMultiPoint.t),
first loop is exterior; any additional are interior.
materialSpecs (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJso
nProtoCityObjectGeometryMaterialSpec.t), default: nil) - The
materials this surface is made of. Either all or none of the Surface
protos must have this field set (even for 'null' references).
Otherwise, this field must not be set. IMPORTANT: This field must
not contain more than one MaterialSpec unless CityJSON's material
"theme" is incorporated into CityJsonProto (see discussion in
go/cityjson-for-hand-modeled-landmarks).
semanticsIndex (type: integer(), default: nil) - The semantics
of this surface (e.g. what part of a building it is) represented as an
index into the containing Geometry's semantics field. Either all or
none of the Surface protos must have this field set (even for 'null'
references). Otherwise, this field must not be set.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometrySurfa
ce{
loops:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMultiP

oint.t()
]

| nil,
materialSpecs:

GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProtoCityObjectGeometryMateri
alSpec.t()

]
 | nil,
semanticsIndex: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoTran
sform
Information for transforming a point from an "old" to "new" coordinate
frame. Applied as follows: vertex_new = scale * vertex_old + translate

Attributes

scale(type: float(), default: nil) - Relative scale of the

vertices in the new coordinate system relative to the old coordinate
system. Applies to all three x,y,z coordinates.
translate (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
default: nil) - Offset of each vertex in
oTransformTranslate.t,
the new coordinate system relative to the old coordinate system.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

scale: float() | nil,
translate:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCityJsonProtoTran
sformTranslate
How the object will be moved along the x, y, and z axes, respectively.

Attributes

x (type: float(), default: nil) -

y (type: float(), default: nil) -
z (type: float(), 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.GeostoreCityJsonProtoTransformTranslate{

x: float() | nil,
y: float() | nil,

z: float() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreComposableItemPr
oto
Generic item proto. This is intended to have only certain aspects filled
(e.g. photo only, name + price). Valid combinations of properties are
enforced by linters.

Attributes

callToAction (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCallToAction
default: nil) - Call to action for the individual product.
Proto.t,
jobMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreJobMetadata.
default: nil) -
t,
media (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreMediaIt
default: nil) - Any photos describing this item.
emProto.t),
nameInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePriceLi
stNameInfoProto.t), default: nil) - The repeated name_info
field is for price list sections listed in multiple languages. At least
one name_info containing id must be specified. There should be at
most one name_info for any given language. When representing a
job item, there should be exactly one name_info specified.
offered (type: String.t, default: nil) - Represents if an item is
offered at a business. For TYPE_JOB, this represents if this job is
offered by the corresponding business
price (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePriceRangePr
 oto.t,default: nil) - Price of the item. There should be at most
one price for any given currency.
priceFormat (type: String.t, default: nil) - Represents which
price format is being used by this item, which determines the
usage/meaning of the “price” field above. Optional – the default
value is legal and safe (represents no price if the “price” field is
unset).
rankingHint (type: number(), default: nil) - Numerical score
which can be provided by data sources to indicate preferred item
ordering. This is purely a hint – we are not required to followed it if
we have a different order we think is better. Higher scores represent
items that should be shown more prominently/earlier. Optional.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

callToAction:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCallToActionProto.t() | nil,

jobMetadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreJobMetadata.t() | nil,
media: [GoogleApi.ContentWarehouse.V1.Model.GeostoreMediaItemProto.t()] | nil,
nameInfo:

[GoogleApi.ContentWarehouse.V1.Model.GeostorePriceListNameInfoProto.t()]
| nil,
offered: String.t() | nil,
price: GoogleApi.ContentWarehouse.V1.Model.GeostorePriceRangeProto.t() | nil,
priceFormat: String.t() | nil,
rankingHint: number() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCountComparison
Proto
A count value tagged with a comparison operator. This can be used for
axle count, trailer count, etc.

Attributes

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

count (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.GeostoreCountComparisonProto{

comparisonOperator: String.t() | nil,

count: integer() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCrossingStripePatt
ernProto
Possible patterns of a crossing stripe (any element that denotes a point on
a segment or lane at which the vehicle must stop or yield). These include
crosswalks, stop, and yield lines.

Attributes

borderLine (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePhysicalLine
Proto.t,default: nil) -
borderPattern (type: String.t, default: nil) -
color (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePainted
ElementLogicalColorProto.t), default: nil) - Colors found on
this crossing.
stripePattern (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.GeostoreCrossingStripePatternProto{
borderLine:

GoogleApi.ContentWarehouse.V1.Model.GeostorePhysicalLineProto.t() | nil,
borderPattern: String.t() | nil,

color:
[

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

]
| nil,
stripePattern: 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.GeostoreCurvatureProto
Attributes

pointCurvature (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePointCu
default: nil) - Curvature values at points along
rvatureProto.t),
the flowline. A linear interpolation between two successive points
will yield the curvature value at intermediate points.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

pointCurvature:
[GoogleApi.ContentWarehouse.V1.Model.GeostorePointCurvatureProto.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCurveConnectionP
roto
Protocol buffer describing a curve that connects two externally specified
endpoints.

Attributes

bezierParams (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveConnect
ionProtoBezierParams.t, default: nil) -
circleParams (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveConnect
ionProtoCircleParams.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.GeostoreCurveConnectionProto{

bezierParams:

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

| nil,
circleParams:

GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveConnectionProtoCircleParams.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.GeostoreCurveConnectionP
rotoBezierParams
Attributes

controlPoint (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveCo
default: nil) -
nnectionProtoBezierParamsControlPoint.t),
Internal Bezier handles. One can be used for a quadratic curve, two
for cubic Beziers.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveConnectionProtoBezierParams{
controlPoint:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveConnectionProtoBezierParamsContr
olPoint.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCurveConnectionP
rotoBezierParamsControlPoint
Attributes

angleDegrees (type: float(), default: nil) - We use this

parameterization to make curves change predictable when
endpoints move. Each point P is defined in terms of the straight
edge [S, E] between the start point of the curve S and its end point
E. P / / / S ------------* E Counter-clockwise angle between vector
SE and vector SP.
distanceMultiplier (type: float(), default: nil) - Distance(S,
P) in units of Distance(S, E).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreCurveConnectionProtoBezierParamsCont
rolPoint{

angleDegrees: float() | nil,

distanceMultiplier: float() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreCurveConnectionP
rotoCircleParams
Attributes

radius(type: float(), default: nil) - Arc radius. Must be

greater than half-distance between two endpoints.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

radius: float() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreDataSourceProto
Every data source used to construct a data repository has an associated
feature that provides more information about it. The standard feature
properties have the following interpretations: bound - The bounds must
includes all features that refer to this data source, so that bucketing
MapReduce passes work correctly. name - The provider name associated
with this data source. It is expected to remain constant from release to
release, and between datasets. address - should be empty. point, polyline,
polygon - should be empty. source_info - should not be set. child -
should be empty.

Attributes

attributionUrl (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreUrlProt
o.t),default: nil) - This is the URL of a website representing this
DataSource as a whole. If this DataSource feature is specific to a
particular dataset or product, the page may contain information
relevant to that dataset or product or may be the main page of the
organization.
copyrightOwner (type: String.t, default: nil) - A UTF8 string
that will be inserted in copyright messages to refer to this copyright
owner, e.g. "Tele Atlas".
copyrightYear (type: integer(), default: nil) - The copyright
year of this data (which may be different than the year of the release
date), e.g. 2005.
description (type: String.t, default: nil) - A free-form
description of this data source. Ideally the description should
include: - Where the data was obtained (URL, company name,
individual, etc). - Where to find detailed documentation. - A brief
summary of the licensing terms. - As much internal and external
contact information as possible (e.g. who to ask about licensing
questions, interpreting the data, updating the data, fixing bugs in the
importer, etc).
importerBuildInfo (type: String.t, default: nil) - The build
information of the importer binary used to generate this data source.
importerBuildTarget (type: String.t, default: nil) - The build
target of the importer binary used to generate this data source.
importerClientInfo (type: String.t, default: nil) - The
Perforce client information of the importer binary used to generate
this data source.
importerMpmVersion (type: String.t, default: nil) - If the
importer was built as an MPM, the version number can be stored in
this field. As with build_info, this can be useful when tracking
down issues that may be due to the use of a particular binary.
importerTimestamp (type: String.t, default: nil) - The
timestamp of the importer binary used to generate this data source.
provider (type: String.t, default: nil) - The provider type of
this data source.
rawMetadata (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreRawMeta
dataProto.t),default: nil) - For every key that is used in
raw_data from this source, there must be a corresponding entry in
raw_metadata that describes this key.
release (type: String.t, default: nil) - A release string that
doesn't have to be a date. This is provided so that we can preserve
provider release strings that aren't based on dates. If you don't set it,
the release_date will get formatted into this field for debugging
purposes.
releaseDate (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProt
default: nil) - The release date of this data.
o.t,
sourceDataset (type: String.t, default: nil) - A data provider
defined string describing the source dataset from which the features
 of this data source were generated. For example, the MultiNet "fra"
dataset produces features for both France and Monaco.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

attributionUrl:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreUrlProto.t()] | nil,

copyrightOwner: String.t() | nil,

copyrightYear: integer() | nil,
description: String.t() | nil,

importerBuildInfo: String.t() | nil,

importerBuildTarget: String.t() | nil,

importerClientInfo: String.t() | nil,

importerMpmVersion: String.t() | nil,
 importerTimestamp: String.t() | nil,

provider: String.t() | nil,

rawMetadata:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreRawMetadataProto.t()] | nil,
release: String.t() | nil,
releaseDate:

GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t() | nil,
sourceDataset: 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.GeostoreDateTimeProto
WARNING: Outside of FeatureProto, please avoid in favor of a standard
civil time type. Direct usage is error-prone due to the conflation of
physical time and civil time (go/httat). In a protocol buffer, please use
google.type.Date, with an additional google.type.TimeOfDay for
precision finer-grained than a day. (For google.type.DateTime,
go/prototime#types cites go/httat#zoned_datetime as a caveat). In a
programming language, see go/time-devguide/languages. Additionally in
C++, google3/geostore/base/public/datetime.h has conversion functions
between DateTimeProto and Abseil's civil time types.

Attributes

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

precision
describes the precision of the date and time. It would be unusual for
a data provider to provide a precision along with their date. It is
more likely that the precision of a date will be inferred from the
date format. For example "19th century" is likely to be correct to
the century, while "1800" is probably correct to the year. The
precision should be semantically interpreted as a cast, so a
DateTimeProto object with a seconds value corresponding to 2018-
03-28 18:40:00 UTC and a precision of MONTH should be
interpreted as "March 2018". The enums above are only some of the
possible precision levels for dates and times. Clients may wish to
add more precision enums in the future. However, these enums
must be ordered by decreasing duration. Clients should be able to
write date formatting code that looks like this: if
(datetime.precision() <=
DateTimeProto::PRECISION_CENTURY) { date =
FormatCenturyDate(proto.seconds()); } else if (proto.precision() <=
 case DateTimeProto::PRECISION_DECADE) { date =
FormatDecadeDate(proto.seconds()); } else { ... } See
geostore/base/public/datetime.h for date formatting utility
functions.
seconds (type: float(), default: nil) - Number of seconds since
(or before) the UNIX epoch (January 1, 1970). This is also the
standard epoch for Java and Python time representations. If it is
important for this time be displayed correctly for different time
zones, convert the time to Coordinated Universal Time (UTC).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

precision: String.t() | nil,
 seconds: float() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreDimensionCompari
sonProto
A dimension value tagged with a comparison operator. This can be used
for height, width, or length.

Attributes

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

dimensionWithUnit (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDimensionPro
to.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.GeostoreDimensionComparisonProto{

comparisonOperator: String.t() | nil,

dimensionWithUnit:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreDimensionProto
A dimension with a numerical value and unit. This can be a height,
width, or length.

Attributes

dimension (type: number(), default: nil) -

unit (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.GeostoreDimensionProto{
dimension: number() | nil,

unit: 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.GeostoreDisplayDataProto
This holds data specific to rendering a POI on a map. It's derived from
data already in MapFacts, e.g. containing features and the feature's point
field. If empty, this proto should be ignored for rendering. See go/maps-
render-alignment for motivation and more details.

Attributes

displayLocation (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t
, default: nil) - The location where this feature should be rendered.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

displayLocation:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreDisputedAreaProto
This protocol buffer is used to store information about disputed areas.
E.g., the political power that administers a disputed area or the countries
that claim it. It should only be used for features of
TYPE_DISPUTED_AREA.

Attributes

administeredBy (type: String.t, default: nil) - If present this

feature is administered by the power present in the field. In most
cases this will be a two letter ISO-3166 region code, but may be a
descriptive string if no region code is available.
claimant (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - Feature IDs (usually a country feature
IdProto.t),
ID) of all parties who claim this feature. No claimants means the
claim by the country that contains it (based on country polygon) is
not disputed.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

administeredBy: String.t() | nil,

claimant:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreDoodleProto
This protocol buffer holds the doodle-specific attributes for features of
type TYPE_DOODLE.

Attributes

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

see comments above.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()
 @type t() :: %GoogleApi.ContentWarehouse.V1.Model.GeostoreDoodleProto{
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.GeostoreDurationBasedRate
Proto
A single cost which will apply based on the duration of utilization. The
cost may apply once, or repeatedly on some interval, to account for the
total utilization. If the duration expressed by range_start_seconds and
range_end_seconds do not cover the entire duration of the utilization (i.e.
from 0 to some time greater than the total utilization time), this must be
combined with other DurationBasedRateProtos such that the entire
duration of the utilization is accounted for. See go/rate-schema for more
details.

Attributes

isFree (type: boolean(), default: nil) - If true, represents that

the rate is free; i.e. the price is 0 in any currency. If this is true, price
must be empty.
periodicitySeconds (type: integer(), default: nil) - The
billable unit of the rate; i.e. after having utilized the service for
exactly periodicity_seconds, the total cost should increase by
‘price’. For example, if the rate expresses a price per hour, then
periodicity_seconds should be set to 3600. If this is unset, then the
rate does not vary based on duration, and price represents a flat
cost. May only be set if price is nonempty.
price (type:
list(GoogleApi.ContentWarehouse.V1.Model.FreebaseTopic.t
), default: nil) - The total price, in each applicable currency, of
utilizing the service for periodicity_seconds, or for the entire
duration expressed by range_start_seconds and range_end_seconds
if periodicity_seconds is 0. Each entry should have an ID of
 /measurement_unit/money_value and consist of two properties: one
with an ID of /measurement_unit/money_value/amount and a float
value with the amount, and another with the ID
/measurement_unit/money_value/currency and an ID value with the
MID of the proper currency. May only be set if is_free is false.
rangeEndSeconds (type: integer(), default: nil) - Upper bound
for durations to match, exclusive. Unset implies indefinite.
rangeStartSeconds (type: integer(), default: nil) - Lower
bound for durations to match, inclusive. Required; a value of 0
expresses that the price applies from the start of the utilization
period.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

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

isFree: boolean() | nil,

periodicitySeconds: integer() | nil,

price: [GoogleApi.ContentWarehouse.V1.Model.FreebaseTopic.t()] | nil,

rangeEndSeconds: integer() | nil,
rangeStartSeconds: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreElevationModelPro
to
Represents raster digital elevation model data.

Attributes

blendOrder (type: integer(), default: nil) - Defines the relative

order in which terrain data should be rendered. Features with higher
blend_order should be blended on top of features with lower
blend_order. NOTE: this is backwards from the way BlendRank
works in Magrathean.
dataLevel (type: integer(), default: nil) - The zoom level at
which this data is defined. Level 0 is world level data, and each
increase in zoom level corresponds to a factor of 2 increase in scale.
dataMaxlevel (type: integer(), default: nil) - The maximum
(finest) level at which this terrain data has sufficient resolution to be
displayed.
elevationData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
et.t,default: nil) - A place to store an elevation data protocol
buffer. Currently, this must be a keyhole::AssetTileCompressed (see
google3/keyhole/common/proto/magrathean.protodevel).
fullChildDataAvailable (type: boolean(), default: nil) - If
true, all of the data contained in this feature is available at the next
highest (more detailed) level. If this is true,
partial_child_data_available should also be true.
partialChildDataAvailable (type: boolean(), default: nil) - If
true, at least part of the data contained in this feature is available at
the next highest (more detailed) 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.GeostoreElevationModelProto{

blendOrder: integer() | nil,

dataLevel: integer() | nil,

dataMaxlevel: integer() | nil,
elevationData:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
fullChildDataAvailable: boolean() | nil,

partialChildDataAvailable: boolean() | nil

}

Functions
decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreElevationProto
This protocol buffer holds elevation and related data.

Attributes

averageElevationMeters(type: float(), default: nil) - The

average elevation of the feature in meters above the local mean sea
level.
peak (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePeakProto.t,
default: nil) - Additional details for TYPE_PEAK and
TYPE_VOLCANO 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.GeostoreElevationProto{

averageElevationMeters: float() | nil,

peak: GoogleApi.ContentWarehouse.V1.Model.GeostorePeakProto.t() | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreEntranceProto
This protocol buffer holds entrance-specific attributes for features of
type TYPE_ENTRANCE.

Attributes

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

canEnter (type: boolean(), default: nil) - DEPRECATED.
Please use enter_or_exit instead.
canExit (type: boolean(), default: nil) - Whether the target can
be entered through this entrance. Whether the target can be exited
through this entrance.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

allowance: String.t() | nil,

canEnter: boolean() | nil,

canExit: boolean() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreEntranceReference
Proto
Models a relationship between a feature and its entrance or exit.

Attributes

featureId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - Feature ID of the related entrance. References
to.t,
should refer to TYPE_ENTRANCE or TYPE_COMPOUND
features that are entrances or exits of the referencing 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.GeostoreEntranceReferenceProto{

featureId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreEstablishmentProto
This protocol buffer holds establishment-specific attributes for features
of type TYPE_ESTABLISHMENT.

Attributes

bizbuilderReference (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBizBuilderRe
default: nil) - Reference to BizBuilder data for
ferenceProto.t,
this establishment. The bizbuilder_reference field indicates that a
feature is claimed in CBDB (with the canonical state in MapFacts).
The bizbuilder_reference is different from the social_reference's
claimed_gaia_id because some BizBuilder clients will not have
+Pages. All claimed businesses should have a bizbuilder_reference.
hours (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTimeSchedule
default: nil) - Regular opening hours for the
Proto.t,
establishment (weekly schedule).
openingHours (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreOpeningHours
Proto.t, default: nil) - Opening hours for this establishment,
including regular weekly hours and exceptional hours (e.g. on
holidays). NOTE: in practice, only the exceptional hours are filled
in this message. A schema migration for regular weekly hours was
planned back in 2015 (see b/23105782) but was not completed and
is (as of May 2018) not prioritized. Clients should continue getting
regular opening hours from the hours field above. In
openinghours.h there is a utility function
GetOpeningHoursFromFeature that merges
EstablishmentProto.hours into this proto.
 priceInfo (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePriceInfoPro
default: nil) - Pricing for products and services offered.
to.t,
Example: menus for restaurants.
serviceArea (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreServiceAreaP
roto.t,default: nil) -
telephone (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreTelepho
neProto.t),default: nil) - Telephone number and related
information.
type (type: String.t, default: nil) - DEPRECATED This is
deprecated in favor of the top-level (in FeatureProto) set of
GConcepts. The type of establishment -- see comments above.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

bizbuilderReference:

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

hours:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTimeScheduleProto.t() | nil,

openingHours:
GoogleApi.ContentWarehouse.V1.Model.GeostoreOpeningHoursProto.t() | nil,
priceInfo:
GoogleApi.ContentWarehouse.V1.Model.GeostorePriceInfoProto.t() | nil,

serviceArea:
GoogleApi.ContentWarehouse.V1.Model.GeostoreServiceAreaProto.t() | nil,
telephone:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreTelephoneProto.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.GeostoreExceptionalHoursP
roto
An ExceptionalHoursProto holds information about exceptional (non-
regular) hours for a business, such as holiday hours.

Attributes

hours (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBusinessHour
sProto.t,default: nil) - The weekly schedule to be applied for
the dates that fall within the range. The schedule may contain hours
only for days of the week that occur during the date range specified
in the range field.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
aProto.t,default: nil) - Field-level metadata for this exception.
range (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTimeInterval
default: nil) - The dates for which this exception
Proto.t,
applies, expressed as a half open interval. For example, an
exception that applies for the entire month of December 2015
should have a range December 1, 2015 to January 1, 2016. Any
regular hours that start on days in this range are ignored and
replaced by the exceptional hours for that day. The
TimeIntervalProto for the range must be a fully specified, non-
empty, and non-inverted range of dates. Concretely, the
requirements are: the range must be a TYPE_RANGE interval the
interval may not be inverted the endpoints of the interval must
specify a year, month, and day the day_type of each endpoint must
 be type DAY_OF_MONTH the endpoints may not specify hour,
minute, second, week, or week_type the begin endpoint must
predate the end endpoint

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

hours:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBusinessHoursProto.t() | nil,
metadata:

GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,
range: GoogleApi.ContentWarehouse.V1.Model.GeostoreTimeIntervalProto.t() | nil
}
Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreExistenceProto
Attributes

closeReason (type: String.t, default: nil) - Structured reason

for the permanent closure (if any).
closed (type: boolean(), default: nil) - Indicates whether the
place is closed (permanently or temporarily), i.e., not operational in
the present, but was in the past. WARNING: New code should
prefer go/geo-schema-reference:operational-status.
endAsOfDate (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProt
o.t,default: nil) - The earliest known date of this feature's "end"
(e.g. an establishment's permanent closure), if the actual date is
unknown; i.e. the best known upper bound of the day end_date
would represent. end_as_of_date must be in local (civil) time and of
PRECISION_DAY. WARNING: Not necessarily consistent yet with
closed or the ClosureAttachmentProto. If you believe you need to
use this field directly, please go/contact-geo-schema.
endDate (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProt
o.t, default: nil) -
(type: String.t, default: nil) -
featureBirthTimestampSeconds
DEPRECATED This field is now deprecated (see b/22878252).
Please use the Geo Schema GetFeatureBirthTimestamp() API to
extract the birth timestamp of a feature. The timestamp in seconds
since the UNIX epoch (January 1, 1970) when this feature becomes
live in the Geo repository. This was the birth date of the place's
representation in Google whereas start_date is the birth date of the
place's operations in the physical world.
 removed (type: boolean(), default: nil) - Indicates whether the
feature is marked as removed in the Geo repository. Removed
features are still present in the Geo repository but are considered to
be in an inactive state (not valid for lint purposes, not retrievable
except explicitly by feature ID, etc.). NOTE: If you have access to a
complete FeatureProto, do NOT read this bit directly to find out
whether a feature is removed. Instead, rely on the
IsFeatureRemoved() API, available in C++
(geostore/base/public/feature.h) and Java
(geostore/base/Feature.java).
removedReason (type: String.t, default: nil) - Structured
reason why the feature is marked as removed. Relevant only when
removed == true.
startDate (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProt
o.t,default: nil) - (Initial) start and (permanent) end dates of
operations, such that start_date is the first day operational and
end_date is the first day when operations have permanently ended.
The only allowed precisions are PRECISION_DAY,
PRECISION_MONTH, PRECISION_YEAR.
DateTimeProto.seconds should have the lowest legal value for the
desired date/time and precision. E.g. for PRECISION_MONTH,
2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00
instead. NOTE: The start_date and end_date are stored in UTC but
should be interpreted as being in the local timezone. So clients
should convert the DateTimeProto to local (civil) time using
UTC+0, and then treat the result as local to the 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.GeostoreExistenceProto{

closeReason: String.t() | nil,

closed: boolean() | nil,

endAsOfDate:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t() | nil,

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

featureBirthTimestampSeconds: String.t() | nil,

removed: boolean() | nil,
removedReason: String.t() | nil,
startDate: GoogleApi.ContentWarehouse.V1.Model.GeostoreDateTimeProto.t() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureFieldMetad
ataProto
Provenance information for sub-fields of this feature - go/subfield-
provenance.

Attributes

fieldProvenance (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
FieldMetadataProtoFieldProvenance.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.GeostoreFeatureFieldMetadataProto{
fieldProvenance:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureFieldMetadataProtoFieldProvena

nce.t()
]

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureFieldMetad
ataProtoFieldProvenance
Attributes

fieldPath (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreStableF
default: nil) - Represents all fields for which
ieldPathProto.t),
this SourceInfo is valid. NOTE: Field paths are rooted at
FeatureProto level.
provenance (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreProvenancePr
oto.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.GeostoreFeatureFieldMetadataProtoFieldProven
ance{

fieldPath:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreStableFieldPathProto.t()]

| nil,
provenance:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureHistoryMet
adataProto
Metadata related to the history of a given feature in the Geo repository.

Attributes

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

timestamp (in microseconds since the UNIX epoch) when this
feature first went live in the Geo repository. Note that this has no
relation to the birth data of that geographical entity in the real
world.
lastModificationTimestampUs (type: String.t, default: nil) -
The timestamp (in microseconds since the UNIX epoch) of the last
modification to the feature. Note this includes attachment
modifications. The feature's initial creation is also considered as a
modification. This is useful for those that consume features via both
listening to notifications and reading from repository snapshots.
This timestamp can be used to decide whether a feature in the
snapshot was already seen in a more recent state through the
notifications.
removalTimestampUs (type: String.t, default: nil) - The
timestamp (in microseconds since the UNIX epoch) of the deletion
time of the feature. If the feature is currently removed, this field
gets populated with the timestamp the feature first became removed
after being live (or being removed from beginning). This field won't
be set if the feature is live.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureHistoryMetadataProto{
featureBirthTimestampUs: String.t() | nil,
lastModificationTimestampUs: String.t() | nil,
removalTimestampUs: 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.GeostoreFeatureIdForwardi
ngsProto
Feature ID forwardings. There are many different types of ID
forwardings, some of which are attached to live features, others to
removed features. This information is available in multiple forms (with
different completeness guarantees): (1) in RPC responses to read
requests to the live Geo repository; (2) on disk, as part of the metadata
section of features found in the (inactive) features snapshots; (3) on disk,
as part of a separate feature_id_forwardings side table.

Attributes

duplicateOf (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - If the feature has been marked as a
DUPLICATE of another feature, this is the feature ID of that other
feature. Note that the other feature may itself be removed. This field
is always set.
forwardedId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - The feature ID of the forwarded feature. This
to.t,
field is only set in case (3).
inactiveDuplicate (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - If other features have been marked as
IdProto.t),
DUPLICATE of this feature, this is the set of all such feature IDs.
All feature IDs in this set should be for removed (aka inactive)
features. Note that in the context of historical read requests against
 MapFacts (when ReadRequest.version_selection.timestamp is set),
this field won't be set.
replacedBy (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdLis
tProto.t,default: nil) - DEPRECATED - Use
feature.metadata.feature_replacement_info instead. This field was
never populated.
transitivelyDuplicateOf (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - If the feature has been transitively marked as
a DUPLICATE of another feature (via a chain of size >= 1), this is
the feature ID of that other feature which is the end of the chain.
The field is always set even if the chain is of size 1. Note that the
other feature may itself be removed. This field is only set in case
(3).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

duplicateOf:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

forwardedId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
inactiveDuplicate:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
replacedBy:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdListProto.t() | nil,
transitivelyDuplicateOf:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureIdListProto
A simple list of feature IDs.

Attributes

id (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - The list of feature IDs. While the
IdProto.t),
exact semantics of these IDs are usage-dependent, the list should
never be empty or contain duplicates.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

id: [GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureIdProto
A globally unique identifier associated with each feature. We use 128-bit
identifiers so that we have lots of bits available to distinguish between
features. The feature id currently consists of a 64-bit "cell id" that
sometimes corresponds to the approximate centroid of the feature, plus a
64-bit fingerprint of other identifying information. See more on each
respective field in its comments. Feature ids are first assigned when the
data is created in MapFacts. After initial creation of the feature, they are
immutable. This means that the only properties that you should rely on
are that they are unique, and that cell_ids often - but not always -
preserve spatial locality. The degree of locality varies as the feature
undergoes geometry changes, and should not in general be considered a
firm guarantee of the location of any particular feature. In fact, some
locationless features have randomized cell IDs! Consumers of
FeatureProtos from Mapfacts are guaranteed that fprints in the id field of
features will be globally unique. Using the fprint allows consumers who
don't need the spatial benefit of cell ids to uniquely identify features in a
64-bit address space. This property is not guaranteed for other sources of
FeatureProtos.

Attributes

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

corresponding to the approximate location of this feature as of when
it was first created. This can be of variable accuracy, ranging from
the exact centroid of the feature at creation, a very large S2 Cell, or
even being completely randomized for locationless features. Cell
ids have the nice property that they follow a space-filling curve
over the surface of the earth. (See s2cellid.h for details.)
WARNING: Clients should only use cell IDs to perform spatial
 locality optimizations. There is no strict guarantee that the cell ID
of a feature is related to the current geometry of the feature in any
way.
fprint (type: String.t, default: nil) - A 64-bit fingerprint used
to identify features. Most clients should rely on MapFacts or
OneRing to choose fingerprints. If creating new fprints, the strategy
should be chosen so that the chance of collision is remote or non-
existent, and the distribution should be reasonably uniform. For
example, if the source data assigns unique ids to features, then a
fingerprint of the provider name, version, and source id is sufficient.
temporaryData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
default: nil) - A place for clients to attach arbitrary data to a
et.t,
feature ID. Never set in MapFacts.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

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

cellId: String.t() | nil,

fprint: String.t() | nil,

temporaryData:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureMetadataPr
oto
General metadata related to a given feature in the Geo repository.

Attributes

bulkUpdatable (type: String.t, default: nil) - This field

indicates whether the feature is subject to bulk updates. Caution
must be exercised while editing such features since the changes
made by the edits will be overwritten by the bulk update (if the
feature is bulk updated). See go/mapfacts-abu for more information.
coreVersionToken (type: String.t, default: nil) -
core_version_token is an opaque token representing the version of
the core fields of the feature. This field is not updated when
attachments are changed.
featureReplacementInfo (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureRepla
cementInfoProto.t,default: nil) - Metadata for tracking when a
feature is derived from or replaced by another feature or set of
features.
fieldMetadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureField
MetadataProto.t,default: nil) - Metadata about certain repeated
fields and their subfields, for which field type is not granular
enough.
forwardings (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdFor
wardingsProto.t, default: nil) - Feature ID forwardings, if
applicable.
 history (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureHisto
ryMetadataProto.t, default: nil) - Metadata related to the
history.
(type: String.t, default: nil) - version_token is
versionToken
an opaque token representing the version of this feature. It can be
used as a concurrency token when sending edits.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

bulkUpdatable: String.t() | nil,

coreVersionToken: String.t() | nil,

featureReplacementInfo:
 GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureReplacementInfoProto.t()

| nil,
fieldMetadata:

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

forwardings:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdForwardingsProto.t()
| nil,
history:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureHistoryMetadataProto.t()
| nil,
versionToken: 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.GeostoreFeaturePropertyId
Proto
Message to represent a "feature property" as an abstract construct. Most
feature properties are mapped one to one with the EditProto field types.
However in some cases the EditProto field type granularity is too coarse
to support use-cases that rely on feature properties (such as per-value
rights tracking). When that is the case, the feature property is augmented
with a secondary field.

Attributes

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

when field_type == ATTACHMENT.
attributeId (type: String.t, default: nil) - Required when
field_type == FEATURE_ATTRIBUTE.
fieldType (type: String.t, default: nil) -
kgPropertyId (type: String.t, default: nil) - Required when
field_type == KNOWLEDGE_GRAPH_PROPERTY.
nameLanguage (type: String.t, default: nil) - RESERVED

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

attachmentTypeId: String.t() | nil,

attributeId: String.t() | nil,

fieldType: String.t() | nil,

kgPropertyId: String.t() | nil,

nameLanguage: 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.GeostoreFeatureProto
Every entry in the GeoStore database is called a "feature". A feature is
represented as a discriminated union of all the different feature types,
where the actual feature type is specified by the "type" field. There are
also various fields that are meaningful for most or all feature types, such
as bounding regions and names. Every feature has a globally unique id
that can be used to refer to it from other features.

Attributes

geopoliticalGeometry (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopolitical
default: nil) - Geopolitical (unsimplified)
GeometryProto.t,
polygons for a feature for different geopolitical use cases.
doodle (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDoodleProto.
t,default: nil) - DEPRECATED
name (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreNamePro
to.t),default: nil) - The name(s) of this feature. A feature may
have different names in different languages, colloquial or "vanity"
names, etc.
relatedTimezone (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreTimezon
default: nil) - Contains time zones known to be
eProto.t),
associated with a feature. Most features are associated with the
single time zone that contains them. However, some larger features
(countries, continents, etc.) are associated with all of the time zones
they contain. Most features can have any number of related time
zones, but TYPE_SEGMENT and TYPE_ESTABLISHMENT_POI
features can have at most 1.
storefrontGeometryModel (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStor
default: nil) - Geometry Store ID and
eReferenceProto.t,
materialized geometry for a POI feature's storefront(s).
IMPORTANT: Clients may not write to this field directly; see
go/geometry-store-reading-and-writing#writing-to-geometry-store.
center (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t
, default: nil) - The conceptual center of the feature, used for
routing. For cities, this would be the center of the downtown, or
maybe the location of city hall. For states and countries it might be
the capital city. Most feature types will not have a conceptual center
- by default, routing will use the centroid of the feature's geometry.
If you need a feature center point consider using
GetFeatureGeometryCenter() function from
geostore/base/public/feature.h rather than reading from this field
directly.
displayData (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDisplayDataP
roto.t,default: nil) - Data used to render this feature on a map.
detailed3dModel (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStor
eReferenceProto.t,default: nil) - Geometry Store ID and
materialized geometry representing the feature's physical presence
in the world. Like geometry_3d above, but with additional semantic
or renderable details, e.g. labeled surfaces ("door", "window"),
material specifications, etc. IMPORTANT: Clients may not write to
this field directly; see go/geometry-store-reading-and-
writing#writing-to-geometry-store.
building (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBuildingProt
o.t, default: nil) -
skiTrail (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSkiTrailProt
o.t,default: nil) -
elevationModel (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreElevationMod
elProto.t,default: nil) - Captures elevation data used on
TYPE_DIGITAL_ELEVATION_MODEL features.
syntheticGeometry (type: boolean(), default: nil) - We prefer
features that have geometry over those that do not. In some cases
we synthesize geometry (e.g., polygons for postal codes). This flag
is set to indicate features that have such synthetic geometry.
polygonForDisplay (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto
default: nil) - Provide version of the geometry suitable for
.t,
display. This has been subject to water removal and (possibly)
moderate simplification.
logicalBorder (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreLogicalBorde
rProto.t,default: nil) -
polyline (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePolyLin
default: nil) -
eProto.t),
laneMarker (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreLaneMarkerPr
default: nil) -
oto.t,
entrance (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreEntranceProt
o.t, default: nil) -
geometryPrecisionMeters (type: float(), default: nil) - If set,
the feature's actual location can be assumed to be somewhere within
a circle of this radius, centered on the feature's location. More
information on this field at go/gpm-definition-update. NOTE: Only
applicable to features with 'point' geometry. Please contact geo-
schema-team@ if you have non-point use cases for which this field
would be useful.
accessPoint (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAccessP
ointProto.t),default: nil) - Optional access point information.
Access points hold detailed information about routing endpoints.
For example, the main Google office is at "1600 Amphitheatre
Parkway". The feature representing that office has a polygon, a
center, and an address with components for the street number, route,
locality, etc. The access point information, on the other hand,
identifies the specific segment, the latitude/longitude of the
driveway, and so forth.
rankDetails (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRankDetailsP
default: nil) - The rank field is computed as a weighted
roto.t,
sum of several signals. This field contains a protocol buffer whose
fields give those signals and their weights. Clients should try very
hard not to depend on these individual signals and use the single
rank field instead. At some point in the future, this field will not be
exposed anymore.
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureMetad
ataProto.t,default: nil) - Metadata about this particular feature.
Metadata is managed internally by the Geo Data Infrastructure and
in general should not be set by clients. Features that don't ultimately
come from the Geo repository (MapFacts) won't have any metadata
set.
kgProperty (type:
list(GoogleApi.ContentWarehouse.V1.Model.FreebasePropert
yValue.t),default: nil) - Properties that apply to this feature
whose schema is defined in the Knowledge Graph schema (see
https://hume.google.com/graph/schema). Not all properties that
exist in the KG schema can be asserted via this mechanism. The set
of properties that are allowed to be set on a feature depends on the
feature's GConcepts (and feature type). For instance, only
gcid:country features may have the /geo/type/country/president
property (made up example, since that property doesn't actually
exist in the KG schema). GConcept hierarchy is taken into account
for deciding the set of allowed properties. Additionally, the specific
properties allowed are further constrained by the list specified at
go/kg-property-allowlist. NOTE: not all types of properties are
allowed to appear in the Geo Schema. For now, we limit ourselves
to properties whose value type is TYPE_BOOL,
TYPE_COMPOUND, TYPE_DATETIME, TYPE_FLOAT,
TYPE_ID, TYPE_INT, TYPE_NESTED_STRUCT, TYPE_TEXT,
or TYPE_URI. NOTE(b/35039936): We are in the process of
changing how a KG property with multiple values is stored in this
field. Currently, such a KG property is stored in a single instance of
the kg_property field. However, we will be changing this so that
each value will be stored in its own instance of kg_property. Any
client that wants to read from this field should be prepared to read
data represented in either format. See b/35039936 or the
announcement at http://g/geo-schema-
announce/7IXR3Fex8to/7yFyT5UoAwAJ for an example and more
details. The mechanism to assert that a KG property has no value is
via the property_value_status field below.
freebase.PropertyValue.value_status is not allowed be set here for
consistency reason.
relatedFeature (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreRelatio
nProto.t), default: nil) - Geographic or logical relationships to
other features. Importers don't need to fill a geographic relationship
in - it is handled by related feature processing by a standalone
pipeline. Adding "contained by" country relations is however
encouraged (and required for TYPE_ROUTE features).
WARNING: Updates to this field handled by standalone pipelines
are NOT atomic with regard to updates to the features being
referenced; we do not guarantee that a given MapFacts snapshot
will be consistent between this field and the related features.
visualizationArea (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStor
eReferenceProto.t, default: nil) - Geometry Store ID and
materialized geometry representing a bounding box of the feature's
geometry (or the building/grounds a POI occupies) for stylized
rendering, UX experiences, etc. IMPORTANT: Clients may not
write to this field directly; see go/geometry-store-reading-and-
writing#writing-to-geometry-store.
inferredGeometry (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInferredGeom
default: nil) -
etryProto.t,
attachment (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAttachm
default: nil) - The collection of
entsAttachmentProto.t),
attachments for this feature. Documentation: http://go/geo-
attachments
associatedEvChargingStation (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) -
IdProto.t),
locale (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreLocaleProto.
t,default: nil) -
skiLift (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSkiLiftProto
.t, default: nil) -
intersectionGroup (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreIntersection
default: nil) -
GroupProto.t,
polygon (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePolygon
default: nil) -
Proto.t),
sign (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRoadSignProt
default: nil) -
o.t,
skiBoundary (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSkiBoundaryP
roto.t, default: nil) -
relatedTerminalPoint (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - Terminal points associated with this
IdProto.t),
feature. For instance, an airport terminal may have specifically
designated pickup and drop-off points.
sourceInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreSourceI
nfoProto.t), default: nil) - A list of the data sources that were
used to construct this feature, together with optional "raw data" in
the provider's format. Raw data should not be used by production
clients but may be useful for exploring data that is not currently
converted to a canonical form.
restrictionGroup (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRestrictionG
default: nil) -
roupProto.t,
futureGeometryFor (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - Specifies the feature that this feature's
to.t,
geometry will replace. If this field is populated, the referenced
feature must have a future_geometry reference back to this feature.
This field is only allowed (and required) for
TYPE_FUTURE_GEOMETRY features.
transitLine (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTransitLineP
default: nil) -
roto.t,
segment (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSegmentProto
.t,default: nil) -
track (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreTrackPr
default: nil) - Defines the geometry of a feature as a
oto.t),
sequence of 6D poses, including lat, lng, altitude, roll, pitch, and
yaw. Only lat and lng are typically required. Each track has an
index so that they can be viewed in a stable order.
businessChain (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBusinessChai
nProto.t,default: nil) - Data specific to business chain features,
e.g., Canonical GConcepts.
geopolitical (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopolitical
default: nil) -
Proto.t,
geometry3d (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStor
default: nil) - Geometry Store ID and
eReferenceProto.t,
materialized geometry representing the feature's physical shape in
the world. IMPORTANT: Clients may not write to this field
directly; see go/geometry-store-reading-and-writing#writing-to-
geometry-store.
point (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePointPr
oto.t), default: nil) - Defines the geometry of the feature. The
geometry may be specified as an arbitrary union of points, poses,
polylines, tracks, and polygons. Points, poses, polylines, and tracks
are assumed to represent regions of unspecified size or width rather
than regions of zero area. Most features should have some sort of
geometry. Geometry may be synthesized if none is available (e.g.,
polygons for postal codes). The synthetic_geometry flag should be
set in that case. Point is currently enforced as a non-repeating field
for all feature types, though it is defined as repeating in case future
modeling requires multiple points. The number of allowed
polylines, tracks, or polygons vary based on feature type. A feature
can have at most one pose (it is an optional field).
transitLineVariant (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTransitLineV
default: nil) - RESERVED
ariantProto.t,
interiorCovering (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCellCovering
Proto.t, default: nil) - S2 interior covering that consists of cells
completely enclosed within the feature's geometry (for features with
polygonal geometry).
roadMonitor (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRoadMonitorP
default: nil) -
roto.t,
bestLocale (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBestLocalePr
oto.t,default: nil) - Describes the best-match locale for this
feature.
child (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
IdProto.t),default: nil) - Features can define themselves as a
collection of other features. For example, a route is a collection of
road segments, and a feature for the "Great Lakes" could be defined
as lakes Superior, Michigan, Huron, Erie, and Ontario. It is not
recommended to design a multi level tree using the child field to
build up a feature because it requires fetching many features to see
the details of the feature. In practice this is used to model
archipelago, route, transit (agencies, lines, trips, departures), and
river features. The geometry of a feature is implicitly defined by its
children, so if a feature has children then it should not have any
points, polylines, or polygons. In general, this field should not be
used to represent political or postal hierarchies. For example, a
county would not list its cities as children, because the county is not
defined in terms of its cities (it also contains unincorporated areas,
etc.).
establishment (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreEstablishmen
tProto.t,default: nil) - Also allowed on
TYPE_BUSINESS_CHAIN and TYPE_TRANSIT_AGENCY
features, to model the feature's phone number(s). Other fields
within EstablishmentProto are not permitted on non-
TYPE_ESTABLISHMENT features.
storefrontGeometry (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAnchore
 default: nil) - Represents information about
dGeometryProto.t),
the store front geometry. Only TYPE_ESTABLISHMENT_POI
should have this field set.
website (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreUrlProt
default: nil) - The official website of this feature. Stored as
o.t),
a repeated field to allow for multilingual official websites (see
comments in url.proto).
propertyValueStatus (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePropert
yValueStatusProto.t),default: nil) - The value status of
properties on this feature. For example, this specifies whether the
feature is known to have no name (this is the value status of the
'FEATURE_NAME' property). Only property IDs which have no
specific value are allowed to have a value status. Note: not all field
types will be supported, please contact geo schema team if you
want to enable this field for a field type that is not currently
supported.
socialReference (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSocialRefere
nceProto.t, default: nil) - All establishments must have a social
reference. WARNING: Aside from creating new establishments,
please do NOT introduce new uses; treat social references as if they
were deprecated. For alternatives and more, see
g3doc/company/teams/gdeng/geo-schema-reference/home/feature-
types/establishments/social-reference.md.
tollPath (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTollPathProt
o.t,default: nil) - Represents information about
/geo/type/toll_path features.
route (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRouteProto.t
, default: nil) - Additional details on the feature types below can
be found in the individual protocol buffer definitions. These
extensions capture data that is specific to a set of feature types and
which makes no sense for other feature types.
parking (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreParkingProto
default: nil) - Describes parking details for the feature.
.t,
knowledgeGraphReference (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreKnowledgeGra
phReferenceProto.t, default: nil) - RESERVED
border (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBorderProto.
t,default: nil) -
tollCluster (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTollClusterP
roto.t,default: nil) - Represents information about
TYPE_TOLL_CLUSTER features.
political (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePoliticalPro
default: nil) -
to.t,
transitStation (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTransitStati
onProto.t, default: nil) -
rawGconceptInstanceContainer (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreOntologyRawG
default: nil) - Geo
ConceptInstanceContainerProto.t,
Ontology GConcept Instances - Design doc linked off http://go/geo-
ontology - In order to shield clients from changes in GConcept
representation we provide an accessor library:
geostore/base/public/gconcept_instance.h
internal (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalFeat
default: nil) - Data for this feature that is less about
ureProto.t,
the feature and more about other data in the feature. For example, it
might be data about the rights we have to other data in this
FeatureProto, or MapFacts-internal shape IDs for this feature's
polygons.
threeDimModel (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreThreeDimensi
onalModelProto.t, default: nil) - Captures full model
representing the feature's 3D geometry. Should only be found on
TYPE_COMPOUND_BUILDING features for now, but not part of
the BuildingProto extension for possible future extensions.
temporaryData (type:
GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageS
default: nil) - A place for clients to attach arbitrary data to a
et.t,
feature. Never set in MapFacts.
originalId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - This field is used internally by the pipeline
for id stability. It should not be set by individual importers, nor
should it be read by consumer clients. In particular, this field will
not be present in features read or snapshotted from the Mapfacts
Repository.
relatedBorder (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
IdProto.t),default: nil) - For TYPE_COUNTRY or
TYPE_ADMINISTRATIVE_AREA1 features, this field defines the
associated TYPE_BORDERs which reference this feature. The
linked TYPE_BORDERs must have the feature.border set, pointing
to this feature. TYPE_COUNTRY or
TYPE_ADMINISTRATIVE_AREA1 features must have this field
set for each TYPE_BORDER referencing them.
preferredViewport (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRectProto.t,
default: nil) - The preferred viewport for this feature. If present,
this latitude-longitude rectangle holds the preferred viewport for the
feature. For example, it might hold the bounds of the "central"
portion of a large city. There are no aspect ratio requirements. This
is an optional field: if no viewport is supplied, interested clients can
use heuristics to determine a viewport. Calling the standard
GetFeatureGeometryBound() function would be a good way to start
but note that it can return an empty bounding box (e.g., if the
feature has no geometry). The preferred viewport is not necessarily
fully contained by the above bounding box.
futureGeometry (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
to.t,default: nil) - Specifies the TYPE_FUTURE_GEOMETRY
whose geometry will replace this feature's geometry. If this field is
populated, the referenced future geometry must have a
future_geometry_for referencing this feature.
intersection (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreIntersection
default: nil) -
Proto.t,
segmentPath (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSegmentPathP
roto.t, default: nil) -
exemptRegulatedArea (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - A list of feature ids of polygon based
IdProto.t),
restrictions that do not apply to this feature. This may only include
features of TYPE_REGULATED_AREA that also have a
feature.regulated_area.restriction field defined. Setting this field
opts the feature out of all restrictions set on that regulated area.
disputedArea (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDisputedArea
Proto.t,default: nil) - Represents information about disputed
areas. Only TYPE_DISPUTED_AREA features should have the
field set.
level (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreLevelProto.t
, default: nil) - Represents information about TYPE_LEVEL
features.
operations (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreOperationsPr
default: nil) - Information about this feature's operations,
oto.t,
e.g. when this feature is temporarily closed. NOTE: for legacy
reasons, some closure-specifc information (e.g. permanent closure
reason) lives in ExistenceProto instead. In the future, such
information should move here in OperationsProto.
waterRemovedPolygon (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto
.t,default: nil) - A version of the geometry which has water
removed but is not simplified (thus having equal or more vertices
than polygon_for_display).
dataSource (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDataSourcePr
oto.t, default: nil) -
type (type: String.t, default: nil) - The type of this feature --
see comments above.
pose (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePoseProto.t,
default: nil) - Defines the geometry of a feature as a 6D pose,
including lat, lng, altitude, roll, pitch, and yaw along the WGS-84
ellipsoid. Only the lat and lng are strictly required.
attribute (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAttribu
teProto.t),default: nil) - DEPRECATED A list of attributes
that describe defined aspects of this feature. An attribute must be a
concrete, high quality, and editable piece of information about a
feature, and must be used on some general consumer facing Google
property. The data types used for attributes must be primitive types
or reusable in a generic manner.
covering (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCellCovering
default: nil) - S2 cell coverings for this feature. See
Proto.t,
util/geometry/s2cell_union.h for more information about S2 cells.
Coverings are useful for quick containment or intersection tests. S2
covering that consists of cells that intersect with the feature.
schoolDistrict (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSchoolDistri
ctProto.t, default: nil) -
status (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreExistencePro
default: nil) - All features can have "existence" information
to.t,
associated with them.
parent (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) -
IdProto.t),
address (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreAddress
default: nil) - Address for this feature. A Geo Schema
Proto.t),
address is designed to model a mailing address, so only features that
have mailing addresses in the real world may have addresses. Each
feature should have only one address. If you want to describe the
geographic location of a feature which does not have a mailing
address with respect to other well-known features, some other
schema constructs should be used. Note that the field is defined as
repeated though features that use this field with its intended
semantics are constrained to have a single address even if they may
have multiple mailing addresses in the real world. The “single
address” rule is enforced by lint. Current exceptions to the single
address rule and mailing address rule are described in the g3doc.
Bear note that the schema team is actively working on eliminating
these exceptions. http://go/geo-addresses Note the following
conventions: - Addresses follow the postal hierarchy, not the
political hierarchy. Addresses may have components that refer to
political entities when those entities also appear in the postal
hierarchy. - As stated previously, but it bears repeating, addresses
on features are mailing addresses. In many cases the physical
address and the mailing address are the same but the address stored
on a feature represents the mailing address of the feature. An
example of a non-physical mailing address would be a PO Box. -
These addresses are commonly defined and verifiable by a
governmental authority (e.g. the United States Postal Service in the
United States, Royal Mail in the United Kingdom, Correios in
Brazil, etc.) and should follow conventions and rules defined by
those authorities.
rank (type: number(), default: nil) - WARNING: Please do
NOT introduce new uses of this field; treat it as if it were
deprecated. For appropriate ranking contacts, see
g3doc/company/teams/gdeng/geo-schema-reference/home/feature-
properties/rank.md. A floating-point number between 0.0 and 1.0
indicating how "important" we think this feature is. This can be
used to decide which features to render on maps, and how to rank
results when the user does a search. The rank can depend on any
number of factors such as the number of references to this feature in
web pages, geographic size, population, number of referring
geographic entities, "priority" information encoded in the source
data, etc.
id (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - The globally unique id for this feature.
to.t,
anchoredGeometry (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreAnchoredGeom
default: nil) - Represents information about the
etryProto.t,
feature’s anchored geometry.
htmlText (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreHtmlTex
default: nil) - DEPRECATED Features can have
tProto.t),
zero or more HTML texts associated with them. These might be
HTML balloons used by Google Earth, for example.
regulatedArea (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRegulatedAre
default: nil) -
aProto.t,
relatedEntrance (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreEntranc
default: nil) - Logical relationship to other
eReferenceProto.t),
features that are entrances or exits to this feature.
bound (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRectProto.t,
 default: nil) - A latitude-longitude rectangle used by bucketing
MapReduces. See the documentation on bucketing MapReduce for
details. This field can be a source of confusion. Because it is called
"bound", it is often assumed that it is a tight bound on the geometry
but it can be (and often is) much larger. If a tight bound is needed
then use the standard GetFeatureGeometryBound() function
instead. To be more explicit, if you are using this field for anything
else than a bucketing MapReduce, you are doing the wrong thing.
Not all features are required to have bounding boxes. See
geostore::IsBoundRequiredForFeatureType() for the list of feature
types required to have a bounding box. This bound field will be
updated when a feature changes in MapFacts to include its
geometry. Also, a GeoSchema pipeline, go/geo-schema-pipelines-
docs#expand-bounds runs periodically to update the field for strong
references from other features. Therefore, most editors don't need to
edit this field explicitly. See go/geo-changes:no-edit-for-feature-
bound for the details.
elevation (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreElevationPro
to.t,default: nil) -
verticalOrdering (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreVerticalOrde
default: nil) - Represents vertical ordering for this
ringProto.t,
feature relative to other geometrically-overlaping features. See
go/aboutgrades for more information about distinction among
different levels.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

accessPoint:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreAccessPointProto.t()] | nil,

address: [GoogleApi.ContentWarehouse.V1.Model.GeostoreAddressProto.t()] | nil,

anchoredGeometry:

GoogleApi.ContentWarehouse.V1.Model.GeostoreAnchoredGeometryProto.t() | nil,
associatedEvChargingStation:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,

attachment:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreAttachmentsAttachmentProto.t()]

| nil,
attribute:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreAttributeProto.t()] | nil,
bestLocale:

GoogleApi.ContentWarehouse.V1.Model.GeostoreBestLocaleProto.t() | nil,
border: GoogleApi.ContentWarehouse.V1.Model.GeostoreBorderProto.t() | nil,

bound: GoogleApi.ContentWarehouse.V1.Model.GeostoreRectProto.t() | nil,

building: GoogleApi.ContentWarehouse.V1.Model.GeostoreBuildingProto.t() | nil,

businessChain:
GoogleApi.ContentWarehouse.V1.Model.GeostoreBusinessChainProto.t() | nil,

center: GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t() | nil,

child: [GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
covering:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCellCoveringProto.t() | nil,

dataSource:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDataSourceProto.t() | nil,

detailed3dModel:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStoreReferenceProto.t()

| nil,
displayData:

GoogleApi.ContentWarehouse.V1.Model.GeostoreDisplayDataProto.t() | nil,
disputedArea:
GoogleApi.ContentWarehouse.V1.Model.GeostoreDisputedAreaProto.t() | nil,
doodle: GoogleApi.ContentWarehouse.V1.Model.GeostoreDoodleProto.t() | nil,
elevation:

GoogleApi.ContentWarehouse.V1.Model.GeostoreElevationProto.t() | nil,
elevationModel:

GoogleApi.ContentWarehouse.V1.Model.GeostoreElevationModelProto.t() | nil,
entrance: GoogleApi.ContentWarehouse.V1.Model.GeostoreEntranceProto.t() | nil,

establishment:
GoogleApi.ContentWarehouse.V1.Model.GeostoreEstablishmentProto.t() | nil,

exemptRegulatedArea:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,

futureGeometry:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

futureGeometryFor:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
geometry3d:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStoreReferenceProto.t()
| nil,
geometryPrecisionMeters: float() | nil,
geopolitical:

GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoliticalProto.t() | nil,
geopoliticalGeometry:

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

htmlText:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreHtmlTextProto.t()] | nil,
id: GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

inferredGeometry:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInferredGeometryProto.t() | nil,

interiorCovering:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCellCoveringProto.t() | nil,

internal:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalFeatureProto.t() | nil,
intersection:
GoogleApi.ContentWarehouse.V1.Model.GeostoreIntersectionProto.t() | nil,
intersectionGroup:
GoogleApi.ContentWarehouse.V1.Model.GeostoreIntersectionGroupProto.t() | nil,
kgProperty:
[GoogleApi.ContentWarehouse.V1.Model.FreebasePropertyValue.t()] | nil,

knowledgeGraphReference:
GoogleApi.ContentWarehouse.V1.Model.GeostoreKnowledgeGraphReferenceProto.t()

| nil,
laneMarker:

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

level: GoogleApi.ContentWarehouse.V1.Model.GeostoreLevelProto.t() | nil,

locale: GoogleApi.ContentWarehouse.V1.Model.GeostoreLocaleProto.t() | nil,

logicalBorder:
GoogleApi.ContentWarehouse.V1.Model.GeostoreLogicalBorderProto.t() | nil,
metadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureMetadataProto.t() | nil,
name: [GoogleApi.ContentWarehouse.V1.Model.GeostoreNameProto.t()] | nil,
operations:
GoogleApi.ContentWarehouse.V1.Model.GeostoreOperationsProto.t() | nil,

originalId:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,
parent:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
parking: GoogleApi.ContentWarehouse.V1.Model.GeostoreParkingProto.t() | nil,

point: [GoogleApi.ContentWarehouse.V1.Model.GeostorePointProto.t()] | nil,

political:

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

polygon: [GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto.t()] | nil,

 polygonForDisplay:

GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto.t() | nil,
polyline:

[GoogleApi.ContentWarehouse.V1.Model.GeostorePolyLineProto.t()] | nil,
pose: GoogleApi.ContentWarehouse.V1.Model.GeostorePoseProto.t() | nil,
preferredViewport:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRectProto.t() | nil,
propertyValueStatus:
[GoogleApi.ContentWarehouse.V1.Model.GeostorePropertyValueStatusProto.t()]
| nil,
rank: number() | nil,

rankDetails:

GoogleApi.ContentWarehouse.V1.Model.GeostoreRankDetailsProto.t() | nil,
rawGconceptInstanceContainer:

GoogleApi.ContentWarehouse.V1.Model.GeostoreOntologyRawGConceptInstanceContainerP

roto.t()
| nil,

regulatedArea:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRegulatedAreaProto.t() | nil,

relatedBorder:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
relatedEntrance:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreEntranceReferenceProto.t()]
| nil,

relatedFeature:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreRelationProto.t()] | nil,
relatedTerminalPoint:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,

relatedTimezone:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreTimezoneProto.t()] | nil,

restrictionGroup:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRestrictionGroupProto.t() | nil,

roadMonitor:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRoadMonitorProto.t() | nil,

route: GoogleApi.ContentWarehouse.V1.Model.GeostoreRouteProto.t() | nil,

schoolDistrict:

GoogleApi.ContentWarehouse.V1.Model.GeostoreSchoolDistrictProto.t() | nil,
segment: GoogleApi.ContentWarehouse.V1.Model.GeostoreSegmentProto.t() | nil,

segmentPath:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSegmentPathProto.t() | nil,
sign: GoogleApi.ContentWarehouse.V1.Model.GeostoreRoadSignProto.t() | nil,

skiBoundary:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSkiBoundaryProto.t() | nil,

skiLift: GoogleApi.ContentWarehouse.V1.Model.GeostoreSkiLiftProto.t() | nil,

skiTrail: GoogleApi.ContentWarehouse.V1.Model.GeostoreSkiTrailProto.t() | nil,

socialReference:
GoogleApi.ContentWarehouse.V1.Model.GeostoreSocialReferenceProto.t() | nil,

sourceInfo:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreSourceInfoProto.t()] | nil,

status: GoogleApi.ContentWarehouse.V1.Model.GeostoreExistenceProto.t() | nil,

storefrontGeometry:

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

storefrontGeometryModel:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStoreReferenceProto.t()

| nil,

syntheticGeometry: boolean() | nil,

temporaryData:

GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t() | nil,
threeDimModel:

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

tollCluster:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTollClusterProto.t() | nil,

tollPath: GoogleApi.ContentWarehouse.V1.Model.GeostoreTollPathProto.t() | nil,

track: [GoogleApi.ContentWarehouse.V1.Model.GeostoreTrackProto.t()] | nil,

transitLine:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTransitLineProto.t() | nil,

transitLineVariant:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTransitLineVariantProto.t()

| nil,
 transitStation:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTransitStationProto.t() | nil,
type: String.t() | nil,
verticalOrdering:

GoogleApi.ContentWarehouse.V1.Model.GeostoreVerticalOrderingProto.t() | nil,
visualizationArea:

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

waterRemovedPolygon:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto.t() | nil,

website: [GoogleApi.ContentWarehouse.V1.Model.GeostoreUrlProto.t()] | nil

}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFeatureReplaceme
ntInfoProto
Metadata to track feature derivations and replacements. This is used to
track feature provenance (particularly for road segments).

Attributes

derivedFrom (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - This feature was created to replace
IdProto.t),
other features that are referenced by this field.
replacedBy (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - This feature was replaced by other
IdProto.t),
features that are referenced by this 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.GeostoreFeatureReplacementInfoProto{

derivedFrom:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,

replacedBy:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFieldMetadataProt
o
Internal field metadata. This part is not exposed to downstream
consumers of the repository (read-only clients) but is available to
upstream providers to the repository (read-write clients).

Attributes

internal (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalFiel
dMetadataProto.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.GeostoreFieldMetadataProto{

internal:

GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalFieldMetadataProto.t()
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFieldWithRightsPr
oto
Proto used to represent rights for a feature property id. See go/geo-rights
for more details. NOTE: Use
google3/geostore/provenance/public/rights.h or
google3/java/com/google/geostore/provenance/rights/Rights.java instead
of accessing this proto directly.

Attributes

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

Never set.
featurePropertyId (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeaturePrope
rtyIdProto.t,default: nil) - The feature property id for which
this entry tracks rights.
fieldType (type: integer(), default: nil) - DEPRECATED
The field type for which this entry tracks rights. There may be
multiple entries for the same field type - prefer feature_property_id
to uniquely identify a particular entry.
minRightsLevel (type: String.t, default: nil) - The minimum
rights level among all current values for this feature property 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.GeostoreFieldWithRightsProto{

attributeId: String.t() | nil,

featurePropertyId:

GoogleApi.ContentWarehouse.V1.Model.GeostoreFeaturePropertyIdProto.t() | nil,
fieldType: integer() | nil,

minRightsLevel: 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.GeostoreFlowLineProto
Wrapper to hold data related to a lane’s track, extendable for future data.

Attributes

curvature (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCurvaturePro
default: nil) - RESERVED
to.t,
track (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTrackProto.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.GeostoreFlowLineProto{

curvature:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCurvatureProto.t() | nil,
track: GoogleApi.ContentWarehouse.V1.Model.GeostoreTrackProto.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFoodMenuItemOpt
ionProto
Example: the choice of chicken, beef, or tofu for the Thai Basil dish.
Each option would have its own name, price, allergen info, etc. Note:
This proto stores both food and service items despite the name.

Attributes

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

allergenPresent (type: list(String.t), default: nil) -
calories (type: integer(), default: nil) -
ingredients (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFoodMen
uItemOptionProtoIngredient.t), default: nil) - Ingredients of
the food dish option.
media (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreMediaIt
default: nil) - Photos of the food dish option.
emProto.t),
nameInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePriceLi
stNameInfoProto.t),default: nil) - The repeated name_info
field here is for item options with names or descriptions listed in
multiple languages. When an item option has no names or
descriptions, the size of the repeated field name_info may be 0. For
example, when a food menu item does not have multiple options,
the item option proto is used only to specify price and nutritional
information, so it will not have a name_info field. There should be
at most one name_info for any given language.
 nutritionFacts (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePriceInfoFoo
default: nil) - Nutrition facts of the food
dNutritionFacts.t,
dish option. Note that it also includes calories information with a
finer defined unit information.
portionSize (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFoodMenuItem
default: nil) - Size of the order,
OptionProtoPortionSize.t,
represented in units of items. (e.g. 4 "skewers”, 6 "pieces”)
preparationMethods (type: list(String.t), default: nil) -
Methods on how the food dish option is prepared.
price (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePriceRangePr
oto.t, default: nil) - We use PriceRangeProto here but we expect
the lower_price and upper_price to be both set to equal numbers
because an option should have a single price. This field is not
required because food item prices may be variable depending on
season.
restriction (type: list(String.t), default: nil) -
servesNumPeople (type: integer(), default: nil) - Number of
people can be served by this food dish option.
spiciness (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.GeostoreFoodMenuItemOptionProto{

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

allergenPresent: [String.t()] | nil,
calories: integer() | nil,
ingredients:
[

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

| nil,
media: [GoogleApi.ContentWarehouse.V1.Model.GeostoreMediaItemProto.t()] | nil,

nameInfo:
[GoogleApi.ContentWarehouse.V1.Model.GeostorePriceListNameInfoProto.t()]

| nil,
nutritionFacts:

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

portionSize:

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

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

price: GoogleApi.ContentWarehouse.V1.Model.GeostorePriceRangeProto.t() | nil,

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

 servesNumPeople: integer() | nil,
spiciness: 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.GeostoreFoodMenuItemOpt
ionProtoIngredient
This message denotes an ingredient information of a food dish.

Attributes

nameInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePriceLi
stNameInfoProto.t),default: nil) - The repeated name_info
field is for the ingredient in multiple languages.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.GeostoreFoodMenuItemOptionProtoIngredient{
nameInfo:
[GoogleApi.ContentWarehouse.V1.Model.GeostorePriceListNameInfoProto.t()]
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFoodMenuItemOpt
ionProtoPortionSize
This message denotes the serving portion size of a food dish.

Attributes

quantity (type: integer(), default: nil) - Required.

unit (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePriceLi
default: nil) - Required. The repeated
stNameInfoProto.t),
name_info field is for the unit in multiple languages.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types
 t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreFoodMenuItemOptionProtoPortionSize{
quantity: integer() | nil,

unit:
[GoogleApi.ContentWarehouse.V1.Model.GeostorePriceListNameInfoProto.t()]

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreFoodMenuItemPro
to
A food menu item must have a name although it can have multiple
names in different languages. Example: Thai Basil. Price for this item is
specified in the item_option field. Since the price of an item may be
unknown, e.g. seasonal price, there is nothing that requires an
item_option to be present in the FoodMenuItemProto.

Attributes

itemOption (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFoodMen
uItemOptionProto.t), default: nil) -
nameInfo (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostorePriceLi
default: nil) - The repeated name_info
stNameInfoProto.t),
field is for items listed in multiple languages.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

itemOption:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFoodMenuItemOptionProto.t()]

| nil,
nameInfo:

[GoogleApi.ContentWarehouse.V1.Model.GeostorePriceListNameInfoProto.t()]
| nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreGConceptInstance
Proto
A GConceptInstanceProto contains a GConceptID (which is the unique
identifier of a GConcept, a category in the Geo Ontology).

Attributes

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

identifier of a GConcept (e.g. "gcid:railway").
metadata (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadat
default: nil) - Field-level metadata for this GConcept.
aProto.t,
prominence (type: String.t, default: nil) - The relative
prominence of this category to this feature according to the data
provider, as one of the values from the enum above. Prominence is
a measure of how well the given GConcept describes the feature.
An example is a gas station with convenience store and ATM. All
three GConcepts are very relevant, but the gas_station GConcept is
the most prominent. If the prominence of this GConcept is
unknown, this field should not be set.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

gconceptId: String.t() | nil,

metadata:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFieldMetadataProto.t() | nil,
prominence: 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.GeostoreGeometryComposit
ion
Encapsulates all the features which, together, define the geometry of a
feature. This happens by: 1. taking the union of all polygons of features
referenced in includes_geometry_of 2. subtracting the polygons of all the
features referenced in excludes_geometry_of

Attributes

excludesGeometryOf (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - Features whose geometry to exclude
IdProto.t),
while composing the geometry of this feature.
includesGeometryOf (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - Features whose geometry to include
IdProto.t),
while composing the geometry of this 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.GeostoreGeometryComposition{

excludesGeometryOf:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
includesGeometryOf:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreGeometryStoreRefe
renceProto
A Geometry Store ID and, in some contexts, geometry materialized from
the record associated with that ID.

Attributes

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

footprint
STGeography format) materialized from the footprint field of the
Geometry Store record associated with the geometry_id referenced
above.
geometry (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProt
o.t,default: nil) - Geometry materialized from the
full_fidelity_proto field of the Geometry Store record associated
with the geometry_id referenced above.
geometryId (type: String.t, default: nil) - The ID of a record
in the Geometry Store.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryStoreReferenceProto{
footprint: String.t() | nil,

geometry: GoogleApi.ContentWarehouse.V1.Model.GeostoreCityJsonProto.t() | nil,

geometryId: 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.GeostoreGeopoliticalGeome
tryProto
Geopolitical (unsimplified) polygons for a feature for different
geopolitical use cases. See go/unsimplified-poly.

Attributes

restOfWorldPolygon (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto
default: nil) - The unsimplified, water-subtracted polygon
.t,
representing the feature's geometry as viewed by the rest of the
world, which may differ from its default polygon, for example by
excluding certain regions.
selfPolygon (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto
default: nil) - The unsimplified, water-subtracted polygon
.t,
representing the feature's geometry as viewed by the country that
administers it, which may differ from its default polygon, for
example by including disputed areas.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
%GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoliticalGeometryProto{
restOfWorldPolygon:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto.t() | nil,
selfPolygon:

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

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreGeopoliticalProto
This protocol buffer is used to store geopolitical information about the
feature that override the base state of the feature. For example, the name
of the feature from different regions' POV. This protocol buffer can be
used on any feature involved in a geopolitical situation and is not limited
to TYPE_POLITICAL features.

Attributes

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

present, some aspect of this feature (usually name or geometry) can
signify ownership of the area by the region specified. The string, if
present, will be a region code. E.g., suppose a
TYPE_POSTAL_CODE feature has a Russian format in Crimea
(which is disputed by Ukraine), then this field would be set to
"RU".
regionSpecificName (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreRegionS
pecificNameProto.t),default: nil) - Any specific handling of
this feature's name from different regions' POVs. This field can
only contain up to one name per region/language combination (each
of which would be a separate RegionSpecificNameProto).
regionalPolygonAdjustment (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoli
default: nil)
ticalProtoRegionalPolygonAdjustmentProto.t),
- Adjustments to the base polygon of this feature to construct a
region-specific view. In general, this field is edited only by go/mf-
triggers based on the data written to
regional_polygon_composing_claims. This field should only be
directly edited if there are region-specific adjustments that cannot
 be represented using the geometry of this feature's claims, but note
that anything written to this field will be overwritten by go/mf-
triggers if regional_polygon_composing_claims is ever edited. See
go/geopolitical-geometry-schema for more information.
regionalPolygonComposingClaims (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoli
ticalProtoRegionalPolygonComposingClaimsProto.t), default:
nil) - Feature's claim(s) which compose the region-specific
polygon. This composition will be used by go/mf-triggers to
compose the specified region's view of this feature's geometry. The
difference between that polygon and this feature's base polygon will
be stored in regional_polygon_adjustment below. Edits to this field
will overwrite anything already stored in
regional_polygon_adjustment. See go/geopolitical-geometry-
schema for more 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.GeostoreGeopoliticalProto{

conveysAttributionTo: String.t() | nil,

regionSpecificName:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreRegionSpecificNameProto.t()]
| nil,

regionalPolygonAdjustment:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoliticalProtoRegionalPolygonAdjus

tmentProto.t()
]

| nil,
regionalPolygonComposingClaims:

GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoliticalProtoRegionalPolygonCompo
singClaimsProto.t()

]
| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.GeostoreGeopoliticalProtoR
egionalPolygonAdjustmentProto
Raw polygon adjustments to apply to this feature's base polygon to
construct a specific region's view of this feature's polygon.

Attributes

polygonToAdd (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto
default: nil) - Polygon to add to the feature's base polygon to
.t,
get the view for the given region. Applied after
polygon_to_subtract, such that any region contained in both
polygons WILL be part of the final result.
polygonToSubtract (type:
GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto
default: nil) - Polygon to subtract from the feature's base
.t,
polygon to get the view for the given region.
regionCode (type: String.t, default: nil) - Region code (or
other identifier) for the region.

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

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoliticalProtoRegionalPolygonAdju

stmentProto{
polygonToAdd:

GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto.t() | nil,
polygonToSubtract:

GoogleApi.ContentWarehouse.V1.Model.GeostorePolygonProto.t() | nil,
regionCode: 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.GeostoreGeopoliticalProtoR
egionalPolygonComposingClaimsP
roto
The polygon composition recipe for a specific region's view of this
feature's geometry, based on disputed area claims asserted by this
country. Note that the included / excluded claims listed for a given
region's view of this feature may not match up exactly with which claims
the region recognizes / does not recognize for this feature. Claims may
only be included or excluded for regions that themselves are a party to
the dispute, i.e. a region's view of itself will include its own claims, and
a region's view of another feature will exclude its own claims. See
current Geopolitical policy at go/geopolitical-policy-primer.

Attributes

regionCode (type: String.t, default: nil) - Region code (or

other identifier) for the region.
regionExcludedClaims (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
IdProto.t),default: nil) - TYPE_DISPUTED_AREAs claimed
by this feature excluded from this region's view of the feature's
geometry. (The TDAs must have polygonal geometry and be
referenced in this feature's political.claim field.) The polygons of
these claims will be subtracted to this feature's base polygon when
this feature is viewed from the specified region.
regionIncludedClaims (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
IdProto.t), default: nil) - TYPE_DISPUTED_AREAs claimed
 by this feature and included in this region's view of the feature's
geometry. (The TDAs must have polygonal geometry and be
referenced in this feature's political.claim field.) The polygons of
these claims will be added to this feature's base polygon when this
feature is viewed from the specified region.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreGeopoliticalProtoRegionalPolygonComp
osingClaimsProto{

regionCode: String.t() | nil,

regionExcludedClaims:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,
 regionIncludedClaims:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreGradeLevelProto
The grade level of a segment represents the relative altitude of the
segment at a particular point along the segment. This level is in relation
to other segments at the same point. For example, you might have a
freeway at level = 0 and an overpass at level = 2. Vertical segments are
represented by a polyline containing only 1 vertex and exactly two
grade_level in segment.proto whose indices are 0. grade_level(0)
represents the relative height at the start point of the segments, and
grade_level(1) represents the one at the end point.

Attributes

index (type: integer(), default: nil) - The index of the point

along the segment, where 0 is the starting point. This means that the
index of a point along a segment and its sibling will be different.
level (type: integer(), default: nil) - The grade level of the
indexed point. The grade level can be thought of as a relative
vertical ordering with respect to other segments at the same point,
where larger/more positive numbers are "higher". Negative grade
level values are allowed and are typically used for points below
grade level (0 is a common choice to represent the level of points at
the ground level). For vertical segments, the height, i.e. the vertical
length, is represented by difference of levels in millimeters. For
example, feature.segment().grade_level(0).level() == 0 and
feature.segment().grade_level(1).level() == 5000, then the length of
the vertical segment feature is 5000 millimeters (5 meters).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

index: integer() | nil,

level: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreHtmlTextProto
Represents HTML text associated with a feature.

Attributes

text (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreLanguag
eTaggedTextProto.t), default: nil) - Zero or more texts of the
specified type, in various languages. If this is a
HTML_DESCRIPTION blob then these texts would hold the
description in English, German, and so forth. The text is an HTML
fragment, not a full page. The fragment should be suitable for
including in a DIV. It must have balanced HTML tags. It may use
HTML's "class" attributes to assign classes to HTML elements.
This allows the HTML to be formatted by an (external) style sheet.
The HTML should not have embedded style sheet definitions, nor
should it have embedded JavaScript.
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.GeostoreHtmlTextProto{

text:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreLanguageTaggedTextProto.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.GeostoreInferredGeometryP
roto
Inferred geometry defines the geometry of a feature as the union or
exclusion of the geometry of other features. For instance, the geometry
of a timezone can be specified as the union of all the countries it applies
to. In this scenario, the timezone will can be considered a "composite
feature", while the countries are its "composing features". A composite
feature must have a bidirectional reference between itself and all its
composing features. A composite feature refers to its composing features
via geometry_composition, while the composing features must refer
back to the composing feature via defines_geometry_for. See:
go/inferred-geometry and go/geo-schema:composite-geometry-editor for
more details.

Attributes

definesGeometryFor (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreFeature
default: nil) - Features whose geometry depends on
IdProto.t),
this feature's geometry.
geometryComposition (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryComp
default: nil) - Features whose geometry defines the
osition.t,
geometry of this feature (i.e. "composing 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.GeostoreInferredGeometryProto{

definesGeometryFor:
[GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t()] | nil,

geometryComposition:
GoogleApi.ContentWarehouse.V1.Model.GeostoreGeometryComposition.t() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.
GoogleApi.ContentWarehouse.V1.
Model.GeostoreInternalFeaturePro
to
InternalFeatureProto represents fields for data that are more about other
data within the FeatureProto than about the feature itself. This could be
data that's set by editors directly(ish) (e.g. trust or rights data), or data set
internally by MapFacts based on other data (e.g. polygon shape IDs).

Attributes

polygonShapeId (type: String.t, default: nil) - A unique

identifier for this feature's polygon data which is being held
externally in Shapestore (see go/shapestore).
restOfWorldPolygonShapeId (type: String.t, default: nil) - A
unique identifier for this feature's rest-of-world view polygon data
which is being held externally in Shapestore (see go/shapestore).
This is part of the feature's geopolitical geometry.
rightsStatus (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreRightsStatus
Proto.t, default: nil) - Per-field rights for this feature. See
http://g3doc/geostore/g3doc/developers-guide/inputs/rights-tracking
for more information.
selfPolygonShapeId (type: String.t, default: nil) - A unique
identifier for this feature's self view polygon data which is being
held externally in Shapestore (see go/shapestore). This is part of the
feature's geopolitical geometry.
trust (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTrustSignals
default: nil) - Trust signals/annotations for the feature.
Proto.t,
In an input feature, these signals are computed at the beginning of
 the pipeline and are immutable during the processing. In output
features, this proto may define the rules/criteria that a newer edit
should meet, in order to be applied.
waterRemovedPolygonShapeId (type: String.t, default: nil) - A
unique identifier for this feature's water-removed polygon data
which is being held externally in Shapestore (see go/shapestore).

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

polygonShapeId: String.t() | nil,

restOfWorldPolygonShapeId: String.t() | nil,

rightsStatus:

GoogleApi.ContentWarehouse.V1.Model.GeostoreRightsStatusProto.t() | nil,
selfPolygonShapeId: String.t() | nil,
 trust:
GoogleApi.ContentWarehouse.V1.Model.GeostoreTrustSignalsProto.t() | nil,

waterRemovedPolygonShapeId: 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.GeostoreInternalFieldMetad
ataProto
Attributes

isAuto (type: boolean(), default: nil) - Whether or not the

piece of data has been generated automatically (i.e., by a
bot/automated process based on heuristics/algorithms rather than
coming as a fact set by some human user or data provider based on
their knowledge). Note that this does NOT imply that the value was
set as a result of a bot operation on the repository, since it is
conceivable to use a bot/automated process simply as a way of
convenience to ingest large amount of canonical/ground truth data.
sourceSummary (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalSour
default: nil) - Information about the source
ceSummaryProto.t,
providing the piece of data this metadata is attached to.

Summary
Types
t()

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

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalFieldMetadataProto{
isAuto: boolean() | nil,

sourceSummary:
GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalSourceSummaryProto.t()

| nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreInternalSegmentPr
oto
Internal-only proto used to express additional information about
segments. This is intended for communicating extra information between
editing clients and the repository, and should not be used by or visible to
clients. WARNING - if you add new fields to InternalSegmentProto,
make sure that geostore/tools/internal/mr-mergesegments_test.cc is
aware of them.

Attributes

disallowedConnections (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreInterna
default: nil) - A
lSegmentProtoLaneConnectionReference.t),
list of lane connections that are explicitly not allowed to be added.
NOTE: This should never reference existing lane connections on
this segment.
disallowedPrimaryConnection (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreInterna
default: nil) - A
lSegmentProtoLaneConnectionReference.t),
list of lane connections which cannot have the primary_connection
bit set.
travelAllowance (type:
list(GoogleApi.ContentWarehouse.V1.Model.GeostoreRestric
default: nil) - The set of restrictions that apply to
tionProto.t),
this segment; these are actually POSITIVE restrictions, i.e. they are
known to be allowed.
Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

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

disallowedConnections:

GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalSegmentProtoLaneConnectionRef
erence.t()

]
| nil,

disallowedPrimaryConnection:
[

GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalSegmentProtoLaneConnectionRef
erence.t()
]
 | nil,
travelAllowance:

[GoogleApi.ContentWarehouse.V1.Model.GeostoreRestrictionProto.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreInternalSegmentPr
otoLaneConnectionReference
Specifies a single outgoing lane connection.

Attributes

fromLaneNumber(type: integer(), default: nil) - The lane

number on this segment.
segment (type:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdPro
default: nil) - This reference to the other segment is weak,
to.t,
since strong would blow up bounds of all segments.
toLaneNumber (type: integer(), default: nil) - This is the lane
number on the target segment.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::

%GoogleApi.ContentWarehouse.V1.Model.GeostoreInternalSegmentProtoLaneConnectionRe
ference{
fromLaneNumber: integer() | nil,
segment:
GoogleApi.ContentWarehouse.V1.Model.GeostoreFeatureIdProto.t() | nil,

toLaneNumber: integer() | nil

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.

GoogleApi.ContentWarehouse.V1.
Model.GeostoreInternalSourceSum
maryProto
Attributes

dataset (type: String.t, default: nil) - Within the above

provider, the dataset from which this piece of data was generated.
For fields that are auto-generated the "dataset" is likely to be some
algorithm's or program's name. Similar to SourceInfoProto.dataset
but with the difference that it is required to always be set. Providers
that don't have a concept of dataset may use "default".
provider (type: String.t, default: nil) - The data provider from
which this piece of data was generated. Equivalent to
SourceInfoProto.provider in the public schema.

Summary
Types
t()

Functions
decode(value, options)

Unwrap a decoded JSON object into its complex fields.