Important Notice
Leaked In-House Google Documents Spark SEO Frenzy. The leaked documentation below describes a version of Google's Content Warehouse API and provides a glimpse of Google Search’s inner workings, which may be inaccurate, incomplete and/ or outdated.
A large number of SEO professionals are using the details below to try to better understand how Google Search works, as well as make claims about Google's dishonesty around publicly made statements that seem to contradict some of the terminology and systems detailed below.
GoogleApi.ContentWarehouse.V1
API client metadata for GoogleApi.ContentWarehouse.V1.
GoogleApi.ContentWarehouse.V1.Api.Projects
API calls for all endpoints tagged Projects
.
GoogleApi.ContentWarehouse.V1.Connection
Handle Tesla connections for GoogleApi.ContentWarehouse.V1.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamAbuseType
Attributes
id
(type:String.t
, default:nil
) -subtype
(type:String.t
, default:nil
) - Optional client specific subtype of abuse that is too specific to belong in the above enumeration. For example, some client may want to differentiate nudity from graphic sex, but both are PORNOGRAPHY.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamAgeRestriction
Attributes
ageYears
(type:integer()
, default:nil
) - This restriction applies if the user is between [min_age_years, age_years) years old.minAgeYears
(type:integer()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AbuseiamAndRestriction
Attributes
child
(type:list(GoogleApi.ContentWarehouse.V1.Model.AbuseiamUserRestriction.t)
, default:nil
) - This restriction applies if all of the children apply.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamClient
A client is be a Google product, or subproduct that provides content for AbuseIAm to classify.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamConstantRestriction
Attributes
type
(type:String.t
, default:nil
) - A constant of type TRUE always applies, and of type FALSE never applies.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamContentRestriction
Pair of Verdicts used for ProjectR age/geo gating. See http://go/projectr for more information.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamEvaluation
Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamGeoRestriction
A node representing a table of regions and restrictions that apply to those regions. This table understands region inclusion and knows to apply the most specific rule, for example, a rule for France would override a rule for the EU for a user in France.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamGeoRestrictionLocale
Attributes
location
(type:String.t
, default:nil
) - The location where the restriction applies. Defaults to the "The world". See go/iii.restriction
(type:GoogleApi.ContentWarehouse.V1.Model.AbuseiamUserRestriction.t
, default:nil
) - The UserRestriction that applies to this location. If not specified evaluates to true.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamHash
Information about various hashes that can be computed on a message ex: simhash, attachment hash, etc
GoogleApi.ContentWarehouse.V1.Model.AbuseiamNameValuePair
Attributes
name
(type:String.t
, default:nil
) -nonUtf8Value
(type:String.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AbuseiamNotRestriction
Attributes
child
(type:list(GoogleApi.ContentWarehouse.V1.Model.AbuseiamUserRestriction.t)
, default:nil
) - This restriction applies if the child does not apply. Only one is allowed. "repeated" is used to avoid breaking Sawzall (See b/6758277).
GoogleApi.ContentWarehouse.V1.Model.AbuseiamOrRestriction
Attributes
child
(type:list(GoogleApi.ContentWarehouse.V1.Model.AbuseiamUserRestriction.t)
, default:nil
) - This restriction applies if any of the children apply.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamRegion
Attributes
region
(type:String.t
, default:nil
) - This is a CLDR Region Code: http://wiki/Main/IIIHowTo#using_region It is used to denote the region affected by a verdict.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamSpecialRestriction
A SpecialRestriction is a standardized UserRestriction which lives in a table maintained via CDD.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamTarget
Attributes
id
(type:String.t
, default:nil
) -type
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AbuseiamUserNotification
A structure used to configure a notification to a user.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamUserRestriction
Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamVerdict
Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamVerdictRestriction
Describes restrictions on where the verdict applies.
GoogleApi.ContentWarehouse.V1.Model.AbuseiamVerdictRestrictionContext
Describes a dimension of a context where a verdict applies.
GoogleApi.ContentWarehouse.V1.Model.AdsShoppingReportingOffersSerializedSoriId
The serialized form of a SORI id. NOTE that this proto is stored in V4/O4 index and that new fields should not be added without getting an agreement from the serving team as well.
GoogleApi.ContentWarehouse.V1.Model.Anchors
Attributes
anchor
(type:list(GoogleApi.ContentWarehouse.V1.Model.AnchorsAnchor.t)
, default:nil
) -homepageAnchorsDropped
(type:String.t
, default:nil
) - The total # of local homepage anchors dropped in AnchorAccumulator.indexTier
(type:integer()
, default:nil
) - The index tier from which the anchors were extracted. Note that this is only valid in the anchor record written by linkextractor. The value can be one of the enum values defined in segindexer/types.h.localAnchorsDropped
(type:String.t
, default:nil
) - The total # of local non-homepage anchors dropped in AnchorAccumulator.nonlocalAnchorsDropped
(type:String.t
, default:nil
) - The total # of non-local anchors dropped in AnchorAccumulator.redundantAnchorsDropped
(type:String.t
, default:nil
) - The *_anchors_dropped fields below are not populated by Alexandria, which uses cdoc.anchor_stats instead. The total # of redundant anchors dropped in linkextractor.redundantanchorinfo
(type:list(GoogleApi.ContentWarehouse.V1.Model.AnchorsRedundantAnchorInfo.t)
, default:nil
) -supplementalAnchorsDropped
(type:String.t
, default:nil
) - The total # of supplemental anchors dropped in AnchorAccumulator. ## DEPRECATED.targetDocid
(type:String.t
, default:nil
) - may be implicittargetSite
(type:String.t
, default:nil
) - HOST_LEVEL site chunking.targetUrl
(type:String.t
, default:nil
) - This is produced during link extraction but not written out in the linklogs in order to save space.
GoogleApi.ContentWarehouse.V1.Model.AnchorsAnchor
Attributes
creationDate
(type:integer()
, default:nil
) - used for history - the first and last time we have seen this anchor. creation_date also used for Freshdocs Twitter indexing, a retweet is an anchor of the original tweet. This field records the time when a retweet is created.origText
(type:String.t
, default:nil
) - Original text, including capitalization and punctuation. Runs of whitespace are collapsed into a single space.context2
(type:integer()
, default:nil
) - This is a hash of terms near the anchor. (This is a second-generation hash replacing the value stored in the 'context' field.)fontsize
(type:integer()
, default:nil
) -experimental
(type:boolean()
, default:nil
) - If true, the anchor is for experimental purposes and should not be used in serving.fragment
(type:String.t
, default:nil
) - The URL fragment for this anchor (the foo in http://www.google.com#foo)sourceType
(type:integer()
, default:nil
) - is to record the quality of the anchor's source page and is correlated with but not identical to the index tier of the source page. In the docjoins built by the indexing pipeline (Alexandria), - Anchors marked TYPE_HIGH_QUALITY are from base documents. - Anchors marked TYPE_MEDIUM_QUALITY are from documents of medium quality (roughly but not exactly supplemental tier documents). - Anchors marked TYPE_LOW_QUALITY are from documents of low quality (roughly but not exactly blackhole documents). Note that the source_type can also be used as an importance indicator of an anchor (a lower source_type value indicates a more important anchor), so it is important to enforce that TYPE_HIGH_QUALITY < TYPE_MEDIUM_QUALITY < TYPE_LOW_QUALITY To add a new source type in future, please maintain the proper relationship among the types as well. TYPE_FRESHDOCS, only available in freshdocs indexing, is a special case and is considered the same type as TYPE_HIGH_QUALITY for the purpose of anchor importance in duplicate anchor removal.pagerankWeight
(type:number()
, default:nil
) - Weight to be stored in linkmaps for pagerankerisLocal
(type:boolean()
, default:nil
) - The bit ~roughly~ indicates whether an anchor's source and target pages are on the same domain. Note: this plays no role in determining whether an anchor is onsite, ondomain, or offdomain in mustang (i.e., the bit above).originalTargetDocid
(type:String.t
, default:nil
) - The docid of the anchor's original target. This field is available if and only if the anchor is forwarded.fullLeftContext
(type:list(String.t)
, default:nil
) - The full context. These are not written out in the linklogs.expired
(type:boolean()
, default:nil
) - true iff exp domaincatfishTags
(type:list(integer())
, default:nil
) - CATfish tags attached to a link. These are similar to link tags, except the values are created on the fly within Cookbook. See: http://sites/cookbook/exporting/indexingdeletionDate
(type:integer()
, default:nil
) -linkTags
(type:list(integer())
, default:nil
) - Contains info on link type, source page, etc.forwardingTypes
(type:integer()
, default:nil
) - How the anchor is forwarded to the canonical, available only for forwarded anchors (i.e., the field is set). The forwarding types are defined in URLForwardingUtil (segindexer/segment-indexer-util.h). Always use URLForwardingUtil to access this field and use URLForwardingUtil::GetAnchorForwardingReason to get the explanation how the anchor is forwarded to the canonical. NOTE: Use with caution as it is only set for docjoins generated using the urlmap from repository/updater.possiblyOldFirstseenDate
(type:boolean()
, default:nil
) - DEPRECATED. It used to be set if firstseen_date is not set. It's to indicate that the anchor is possibly old, but we don't have enough information to tell until the linkage map is updated. TODO(hxu) rename it to possibly_old_firstseen_date_DEPRECATED after clean up other dependencies.locality
(type:integer()
, default:nil
) - For ranking purposes, the quality of an anchor is measured by its "locality" and "bucket". See quality/anchors/definitions.h for more information.demotionreason
(type:integer()
, default:nil
) - DEPRECATEDparallelLinks
(type:integer()
, default:nil
) - The number of additional links from the same source page to the same target domain. Not populated if is_local is true.text
(type:String.t
, default:nil
) - Space-delimited anchor words. Text that needs segmentation (like CJK or Thai) is unsegmented, since we set FLAGS_segment_during_lexing to false in mr-linkextractor.cc .source
(type:GoogleApi.ContentWarehouse.V1.Model.AnchorsAnchorSource.t
, default:nil
) -bucket
(type:integer()
, default:nil
) -fullRightContext
(type:list(String.t)
, default:nil
) -targetUrlEncoding
(type:integer()
, default:nil
) - A given target URL may be found in different encodings in different documents. We store the URL encoding with each source anchor so that we can count them later to find the encoding most likely to be expected by the Web site. Around 0.7% of target URLs are expected to require a non-default value here. The default value 0 is referenced in C++ as webutil::kDefaultUrlEncoding. See also webutil/urlencoding.compressedOriginalTargetUrl
(type:String.t
, default:nil
) - The anchor's original target url, compressed. Available only in Alexandria docjoins when the anchor is forwarded.firstseenDate
(type:integer()
, default:nil
) - # days past Dec 31, 1994, 23:00:00 UTC (Unix time @788914800) that this link was first seen. Should never occupy more than 15 bits. NOTE: this is NOT the same as creation_date; firstseen_date is filled during link extractionsetiPagerankWeight
(type:number()
, default:nil
) - TEMPORARYcontext
(type:integer()
, default:nil
) -linkAdditionalInfo
(type:GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet.t
, default:nil
) - Additional information related to the anchor, such as additional anchor text or scores.type
(type:integer()
, default:nil
) - DEPRECATED: Now in link_tagsfirstseenNearCreation
(type:boolean()
, default:nil
) - true if we think 'firstseen_date' is an accurate estimate of when the link was actually added to the source page. false if it may have existed for some time before we saw it.lastUpdateTimestamp
(type:integer()
, default:nil
) - Used for history and freshness tracking - the timestamp this anchor is updated in indexing.offset
(type:integer()
, default:nil
) - This is the offset for the first term in the anchor - it can be used as a unique ID for the anchor within the document and compared against all per-tag data. This is measured in bytes from the start of the document. We write this out to the linklogs to recover the original order of links after source/target forwarding. This is necessary for computing the global related data.weight
(type:integer()
, default:nil
) - weights are 0-127deleted
(type:boolean()
, default:nil
) -encodedNewsAnchorData
(type:integer()
, default:nil
) - Encoded data containing information about newsiness of anchor. Populated only if anchor is classified as coming from a newsy, high quality site. Encoded data for anchor sources are being stored in googledata/quality/freshness/news_anchors/encoded_news_anchors_data.txt Scores are being computed with quality/freshness/news_anchors/ routines.compressedImageUrls
(type:list(String.t)
, default:nil
) - If the anchor contained images, these image urls are stored here in compressed form.timestamp
(type:String.t
, default:nil
) - This field is DEPRECATED and no longer filled. For source page crawl timestamp, use Source.crawl_timestamp. Next tag id should be 62.
GoogleApi.ContentWarehouse.V1.Model.AnchorsAnchorSource
attributes of the source document for the link
GoogleApi.ContentWarehouse.V1.Model.AnchorsRedundantAnchorInfo
NOTE: in docjoins, the following anchor sampling information is only ## available in the first record of a document (under the same docid). The total number of redundant anchors dropped per (domain, text) in linkextractor. If we receive a large number of anchors from a particular domain, then we'll throw out all but a sampling of them from that domain. The data is sorted by the (domain,text) pairs. This field is not populated by Alexandria, which uses cdoc.anchor_stats instead.
GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteCustomerId
Represents a GSuite customer ID. Obfuscated with CustomerIdObfuscator.
GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteSharedOrganizationInfo
Contains info about the entity that something is, or is owned by.
GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteSharedOrganizationInfoConsumerInfo
Intentionally empty. Used to disambiguate consumer and customer use cases in oneof below.
GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteSharedOrganizationInfoCustomerInfo
Attributes
customerId
(type:GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteCustomerId.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteSharedSegmentedMembershipCount
Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED
GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteSharedSegmentedMembershipCounts
Attributes
value
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsDynamiteSharedSegmentedMembershipCount.t)
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleActivityBackendDestinationStream
A DestinationStream is a /namespace/id[0]/id[1]/.../id[n] that represents a collection of Activities. Example destinations: -The Profile Stream on http://plus.google.com/+JohnDoe/posts -A Square Stream on http://plus.google.com/squares/123 -A "comment Stream" (Fountain) on http://www.youtube.com/watch?id=123 It's possible for a single Activity to show in each of these destinations - and it might behave/look slightly differently for each one. Destinations can have their own business logic associated with them at both write-time and read-time server-side (these are documented below). Each DestinationStream is indexed and can be retrieved using the GetDestinationStreamRequest. For the repeated ID space indexing happens at all levels, e.g. if you have: /square/123/abc /square/123/efd /square/456 You can fetch /square/123/abc directly or /square/123 (which includes all Activities in both /square/123/abc and /square/123/efd), or even /square which retrieves all Activities in the Square namespace (visible for that user). On the storage layer, we represent DestinationStream as Channel (http://cs/#google3/social/common/channel/channel.proto), since the storage does not have the concept of a Stream. Both terms are used interchangeably within the service layer, but client of Social Infrastructure should use the term DestinationStream. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleActivityStreamqualityDistillerEngagements
Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAbout
Attributes
contentType
(type:String.t
, default:nil
) -metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -safeHtmlValue
(type:GoogleApi.ContentWarehouse.V1.Model.WebutilHtmlTypesSafeHtmlProto.t
, default:nil
) - Sanitized HTML value that is only populated when the SANITIZE_ABOUT_HTML extension is requested.value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData
Extension data for use in AboutMe.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataNameDisplayOptions
See NameDisplayOptions in //depot/google3/focus/backend/proto/backend.proto. See also go/nickname-mess.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData
Attributes
diffData
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData.t
, default:nil
) -highResUrl
(type:String.t
, default:nil
) -inconsistentPhoto
(type:boolean()
, default:nil
) - True if photo diff is greater than 0.01 on any color band, or if the user has a low res photo but no high res photo. This field is primarily for use in About Me and for other uses it's recommended to use the DiffData values directly instead. The cutoff is based on a heuristic determined in go/comparing-profile-photoslowResData
(type:String.t
, default:nil
) - Only present if the photo diff is greater than 0.01 on any color band.lowResUrl
(type:String.t
, default:nil
) -monogramUrl
(type:String.t
, default:nil
) -privateLowResAcl
(type:boolean()
, default:nil
) - True if the low-res photo has a private ACL set.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData
Attributes
blueDiff
(type:number()
, default:nil
) -greenDiff
(type:number()
, default:nil
) -redDiff
(type:number()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileEditability
See UserEditedLockedMask in //depot/google3/focus/backend/proto/backend.proto.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory
See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAccountEmail
Attributes
email
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAdditionalContainerInfo
Additional information about a container. TO BE DELETED: replaced by DeviceContactInfo.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAddress
Attributes
country
(type:String.t
, default:nil
) -countryCode
(type:String.t
, default:nil
) -encodedPlaceId
(type:String.t
, default:nil
) - FeatureId associated with the address. The format is the same as that used for ids in PLACE containers in SourceIdentity.extendedAddress
(type:String.t
, default:nil
) -formatted
(type:String.t
, default:nil
) -formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.locality
(type:String.t
, default:nil
) -metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -poBox
(type:String.t
, default:nil
) -pointSpec
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPointSpec.t
, default:nil
) -postalCode
(type:String.t
, default:nil
) -region
(type:String.t
, default:nil
) -streetAddress
(type:String.t
, default:nil
) -type
(type:String.t
, default:nil
) - The type of the address. The type can be free form or one of these predefined values:home
work
*other
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAffinity
Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAgeRangeType
Please read go/people-api-howto:age on how to get age data. Message for the Person.age_range_repeated
field. Replaces the existing Person.age_range
field.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo
Store all app unique info that are needed for app action fulfillment.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiBestDisplayName
The best suggested name to use for the Person from the available source fields, which may include FileAs, Name, Org, Email, IM, Phone, ... Rough source container priority order is Contact, then Profile, then Place.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiBirthday
IMPORTANT NOTES: - Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. - The birthday field should not be used to calculate the requester's age! To determine the requester's age, use person.age_range_repeated. - For more details about age see go/peopleapi-howto/age Birthday value may not be present: - Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. - Dasher users generally don't require birthday, but could optionally have it set by users. - Any other types of accounts (e.g. robot, service) do not have birthdays. - Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: - "Profile Birthday" (person.birthday.metadata.container is PROFILE) may not have a year set if user "hides" the year. - "Account Birthday" (see api-specific notes below) will only be returned for the requester's own profile. - People API (go/peopleapi): Account birthday is only supported in GetPeople for PeopleAPI. If account birthday is needed, use a request mask with: include_field { paths: "person.birthday" }
include_container: ACCOUNT
- People API++ (go/peopleapi++): Account birthday is supported for most apis in PeopleAPI++. If account birthday is needed, use a request mask with: include_field { paths: "person.account_birthday" }
include_container: PROFILE
(note: it will also need include_container: DOMAIN_PROFILE
because they must be requested together: go/people-api-masks#profile-domain_profile) - See go/papi-vs-papi++#birthday for more details.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod
Whether this field is set or not determines whether an account is in the grace period. While in the grace period, the user is unable to change their birthday on their own, and will be age-disabled if they don't act in a limited amount of time. Applies only to ServiceData Birthday. Users enter the grace period if they choose a birthday below the Age of Consent (go/aoc). After the grace period ends, the account will be age disabled. See go/age-disable-grace-period-dd.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriodManualGracePeriodInfo
Information provided within MutateDataRequest when setting a user into AgeDisableGracePeriod manually. When the grace period expires, this info will be forwarded to Gaia when disabling the user. cs//symbol:InitiateAgeDisableGracePeriodArguments
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiBraggingRights
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCalendar
A url to the person's calendar. As of 03/2018 is not supported for user Profile.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedData
Attributes
callerIdSource
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedDataCallerIdSource.t
, default:nil
) - Indicates which data source was used to populate the caller ID result
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedDataCallerIdSource
Attributes
sourceType
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore
Information related to domain administrator (or authority) certification of a users age.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiChannelData
Attributes
channelId
(type:String.t
, default:nil
) - Unique ID that corresponds to a Youtube channel.commentCount
(type:String.t
, default:nil
) - Number of comments for a given Youtube channel.description
(type:String.t
, default:nil
) - Description of the channel.playlistCount
(type:String.t
, default:nil
) -profilePictureUrl
(type:String.t
, default:nil
) - A FIFE URL pointing to the channel's profile image (go/avatar-fife-urls) with default fife url options. Also refer to go/people-api-concepts:photos for People API's FIFE best practices. The image could be up to a couple of days stale, though it is much fresher in practice. If a fresh image is required, contact the YouTubeAccountProfileService. The URL itself expires ~30 days after generation.profileUrl
(type:String.t
, default:nil
) - URL of user's Youtube channel profile.subscriberCount
(type:String.t
, default:nil
) - Number of subscribers for a given Youtube channel.title
(type:String.t
, default:nil
) - Title of the YouTube channelusesYoutubeNames
(type:boolean()
, default:nil
) - Whether or not the channel's profile has a title/avatar that is canonical in YouTube. Used to determine if the product profile card should be part of the core persona or have their own persona.videoCount
(type:String.t
, default:nil
) - Number of videos uploaded in a given Youtube channel.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCircleMembership
A circle membership that the person has. A circle membership is created by adding a person to a circle by person-id or by email.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiClientData
Arbitrary client data that is populated based on the client
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCommunicationEmail
Email for Google product communication with the user. This is only allowed in ServiceData. It is purely synthesized and read-only, and contains at most one field. It proxies from RawCommunicationEmail and only includes the primary field if exists. Otherwise if RawCommunicationEmail does not have primary, this includes a field synthesized from valid Gaia primary account email. Otherwise if Gaia primary account email is invalid, this field is empty. See go/comm-email-use for more details.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiConnectionReminder
Contact-level people-prompts settings and contact-level connection reminders. Part of go/people-prompts.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo
Contact creation timestamps and related metadata. See go/contact-edit-history. This message is a pure wrapper of the shared ContactCreactionContext message so that it can be a top-level person field. No other fields should be added to the message.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo
Contact edit timestamps and related metadata. See go/contact-edit-history. This message is a pure wrapper of the shared ContactCreactionContext message so that it can be a top-level person field. No other fields should be added to the message.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiContactGroupMembership
A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiContactPromptSettingsInfo
Contact level People Prompt settings. This message is a pure wrapper of the shared ContactPromptSettings message so that it can be a top-level person field. No other fields should be added to the message.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiContactStateInfo
Contact state and related metadata. See go/fbs-contacts-trash. This message is a pure wrapper of the shared ContactState message so that it can be a top-level person field. No other fields should be added to the message.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCoverPhoto
CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCustomSchemaField
Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd).
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiCustomerInfo
Contains customer data for profile owner proxied from D3.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiDedupedContainerInfo
Container information for deduping. When two fields have the same value and only differ by field.metadata a service implementation can choose to avoid duplicating the fields and instead set field.metadata.other_deduped_containers This type can include information on the dedupe type (for example, strict value match vs. lenient value match)
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiDelegatedGroupInfo
Information related to delegated group that this contact belongs to.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata
Extra metadata for an aggregated or raw device contact.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiDeviceContactId
Unique id for an aggregated device contact.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo
Device contact information.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo
Attributes
containerId
(type:String.t
, default:nil
) - The container ID of the entity this field creates a join to. SeeSourceIdentity.id
.containerType
(type:String.t
, default:nil
) - The type of container that this edge points to. SeeSourceIdentity.container_type
.extendedData
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfoExtensionData.t
, default:nil
) - Data that is added to the proto by peopleapi read extensions.materialized
(type:boolean()
, default:nil
) - True indicates this edge links this source to a container represented by this person object. Note: Except for certain legacy clients, EdgeKeyInfo is only created for for edges to an entity in this person and this will always be true.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfoExtensionData
Attributes
gdataCompatibilityExtensionId
(type:String.t
, default:nil
) - The GDataCompatibilityExtension will (temporarily) return mobile_owner_id for profile containers.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmail
Attributes
certificate
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailCertificate.t)
, default:nil
) -classification
(type:String.t
, default:nil
) -contactGroupPreference
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference.t)
, default:nil
) - To read or update, use the CONTACT_GROUP_PREFERENCE mask field.displayName
(type:String.t
, default:nil
) -extendedData
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailExtendedData.t
, default:nil
) -formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -signupEmailMetadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailSignupEmailMetadata.t
, default:nil
) -type
(type:String.t
, default:nil
) - The type of the email address. The type can be free form or one of these predefined values:home
work
*other
value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailCertificate
Represents a S/MIME certificate config for use with Gmail. See //caribou/smime/proto/certificate_status.proto. There can be zero or more certificates associated with an email address, be it profile email or contact email.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus
Minimal S/MIME certificate status i.e. two fields per email address.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference
Preferred email addresses for contact groups.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailExtendedData
Extension data for a person email.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmailSignupEmailMetadata
Additional metadata for a signup email. This will only be set if the email's classification is SIGNUP_EMAIL.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEmergencyInfo
Emergency info for Person. See go/emergency-trusted-contacts-papi.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiEvent
Attributes
calendarDay
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleTypeDate.t
, default:nil
) - Event are more accurately represented as a calendar day that does not depend on a timestamp representation at all. When given a timestamp, there are lots of opportunities to make mistakes, so a CalendarDay proto is replacing timestamps. PeopleApi will return these values on reads, and unless the client is a legacy caller in the legacy_timestamp_event_write_behavior_enabled capability allowlist, this value is what is used for Person writes.formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -prompt
(type:GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoPrompt.t
, default:nil
) - People Prompts settings for contact event data.timestampMillis
(type:String.t
, default:nil
) - Clients are recommended to read the calendar_day field instead of timestamp_millis. When writing events, new clients must set calendar_day instead of timestamp_millis. Events are currently represented as timestamp values, although the interpretation of these timestamp values is a calendar date. There are a few important details about how this value should be mapped to a calendar date that should be consistent among all clients. For detailed information, see Birthday.date_ms.type
(type:String.t
, default:nil
) - The type of the event. The type can be free form or one of these predefined values:anniversary
other
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiExternalId
External identifier associated with the person.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAcl
The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry
Attributes
role
(type:String.t
, default:nil
) -scope
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope
Attributes
allUsers
(type:boolean()
, default:nil
) - Indicates that the field is accessible to all users including unauthenticated users. For some fields this means "to everyone except blocked users".domainUsers
(type:boolean()
, default:nil
) - This is a "synthetic" field. In reality domains are treated as gaia- groups. This field will be 'true' when the field is ACLed to the gaia-group of the requester's domain.membership
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl.t
, default:nil
) -person
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl.t
, default:nil
) - Indicates that the field is accessible to a person.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl
Used when the field is accessible to a membership that the person has.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl
Used when a field is accessible to a circle.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclContactGroupAcl
Used when a field is accessible to a legacy contact group. Contact groups are discouraged and may be deprecated soon. ContactGroupAcls are read-only. If they are included as part of an ACL on an Update, an exception is thrown.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl
Used when a field is accessible to a person. NOTE: ACLs to a circle or to a non-self person are no longer supported, so this can only be applied to the requester self.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldEmergencyInfo
Emergency information for Person field, such as Phone or Email. See go/emergency-trusted-contacts-papi.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFileAs
The FileAs field in Contacts is used to override the DisplayName of a Contact for that User.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiGPayExtendedData
Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: profiles-eng-fe@google.com
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiGender
Gender in PeopleApi has some odd semantics about writing and reading that are not obvious from the proto definition. First, the type
string, when read, always maps to the constrained domain of "male", "female", and "other", aside from a pathological case that PeopleApi would like to fix. There are two typical patterns: 1. type
is either "male" or "female" and custom_type
and address_me_as
are exactly as specified by an update to PeopleApi, although they are most often absent for "male" and "female" writes. 2. type
is "other" and custom_type
is set to a freeform string from the request. address_me_as
is equal to whatever was provided at write time. When writing, the free-form string for custom_type
can come from either custom_type
if the field is present on the request, or if custom_type
is absent, the string value of type
will be copied into it. Any value in type
will be coerced to "other" and the free-form value will be copied into custom_type
, even if type
is exactly "other". Prefer to explicitly set custom_type
and set type to "other" instead of setting type to a free-form value. There are weird edge cases when the value is "unknown". Consider the behavior for type
== "unknown" unspecified. Clients reading the gender should use the value from formatted_type
if type
is "male" or "female". If type
is "other", formatted_type
will be "Other" (or some translation) and clients should read custom_type
for more specificity.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiGplusExtendedData
Attributes
contentRestriction
(type:String.t
, default:nil
) -isEnterpriseUser
(type:boolean()
, default:nil
) - Equivalent to having the DASHER_POLICY bit in the REGISTERED state.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData
Extension data for use in Hangouts.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiIdentityInfo
Attributes
originalLookupToken
(type:list(String.t)
, default:nil
) - Original lookup token from the request that resulted in this person or one of its containers.previousPersonId
(type:list(String.t)
, default:nil
) - Any former IDs this person may have had, in the case that their ID may have changed. Populated only for sync requests. Examples of such changes include adding an edge to a contact that links to a profile. The ID will change from being contact-oriented to being profile-oriented. To be used to clear out old versions of a person.sourceIds
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSourceIdentity.t)
, default:nil
) - A list of sources contributing to the merged person, including profiles (with gaia-id), contacts and synthetic-contacts.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiIm
Attributes
formattedProtocol
(type:String.t
, default:nil
) - Theprotocol
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -protocol
(type:String.t
, default:nil
) - The protocol of the IM. The protocol can be free form or one of these predefined values:aim
msn
yahoo
skype
qq
googleTalk
icq
jabber
*netMeeting
type
(type:String.t
, default:nil
) - The type of the IM. The type can be free form or one of these predefined values:home
work
*other
value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget
How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. "How" and "where" identify the recipient in a P2P Bridge (glossary/p2p bridge), and "why" may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target "type" and "value". Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated "app". Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = bob@gmail.com Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob's public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn't want others to see it. He is okay with people sending notifications to him in Who's Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob's public Google profile, and one for the second phone number, which is in his private profile. IANT #1 - targeting Bob's public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 - targeting Bob's private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ]
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData
Client-specific data pertaining to app reachability. No PII data or user content should be stored in this blob.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetOriginatingField
Info for identifying the specific field in this person that lets the requester send them notifications. These are typically fields added to a contact (e.g., email). There will not always be in originating field, typically in the case that whatever permits the requester to see this target info is not something that can be used on its own for contacting this person.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInAppReachability
This is deprecated in PEOPLE_API/SHARPEN, and should only be used for PROFILES. Clients should use InAppNotificationTarget field instead. Which apps the person has indicated they are reachable at for the requester. See go/d13y and com.google.focus.proto.InAppReachability.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey
Information pertaining to how this reachable state was established.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInteractionSettings
Defines interactions that are allowed or disallowed with this person.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiInterest
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiLanguage
The value can either by a language code conforming to the IETF BCP 47 specification or a custom freeform value. By default the returned value is proxied from FBS Profile.Language. If include_account_locale
is set on the MergePersonSourceOptions
the language from go/uls is preferred and returned as primary along with a secondary language from FBS.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiLatLng
Attributes
lat
(type:float()
, default:nil
) -lng
(type:float()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiLegacyFields
Fields used in legacy applications. Useful for joining legacy and new data streams. Most applications should not care about these fields.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField
Attributes
limitedProfileSettings
(type:GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoLimitedProfileSettings.t
, default:nil
) -metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiLocation
Attributes
buildingId
(type:String.t
, default:nil
) -buildingName
(type:String.t
, default:nil
) - The building_name field is only filled if the DESK_LOCATION_ADDITIONAL_DATA extension is active.current
(type:boolean()
, default:nil
) -deskCode
(type:String.t
, default:nil
) - Most specific textual description of individual desk location.floorName
(type:String.t
, default:nil
) -floorSection
(type:String.t
, default:nil
) -lastUpdateTime
(type:DateTime.t
, default:nil
) - Indicates the time this location was added or last edited.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -source
(type:String.t
, default:nil
) - Value indicates the origin of this location information.type
(type:String.t
, default:nil
) - Describes the type of location. E.g. Grew_up, Desk. Corresponds to FBS backend.proto Location.StandardTagvalue
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiManagementUpchain
Attributes
indirectManager
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager.t)
, default:nil
) - List of managers in the chain. If user has manager email "abc@google.com" and manager's manager has email "xyz@google.com" then the list will be: [0]: { email: "abc@google.com" } [1]: { email: "xyz@google.com" }metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -status
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager
Attributes
email
(type:String.t
, default:nil
) -personId
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMapsExtendedData
Extension data for use in Maps Product Profile.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMapsProfile
Maps Profile Data. See go/product-profiles-backend-api.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction
Attributes
clientData
(type:String.t
, default:nil
) - Opaque data associated with this restriction e.g. abuse status.type
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink
Attributes
anchorText
(type:String.t
, default:nil
) - Anchor text to be displayed as clickable link. If not present, the URL should be displayed directly.url
(type:String.t
, default:nil
) - The URL to be linked to.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMatchInfo
Represents the matching information for a field when there is a query.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch
All the substring that were matched for the given query against the current field. Represents a substring of another string.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMembership
A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiMission
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiName
See go/people-api-howto:names for an overview of name usage in PeopleAPI. The unstructured_name
field contains a free form name value. The given_name
, middle_name
, family_name
, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the unstructured_name
or the set of structured name fields, not both. When only the unstructured_name
is set, it is parsed to produce a best-guess set of structured name values for the given_name
, family_name
, etc. When only the structured name fields are set, the various values are combined to produce an unstructured_name
. * When both are set, the unstructured_name
is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not "match". For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is required for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo
Pronunciation audio metadata info. See go/name-pronunciation-backend. The metadata itself tracks the state of a user's name pronunciation audio.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiNickname
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -type
(type:String.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOccupation
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOpeningHours
The periods that this place is open during the week. The periods are in chronological order, starting with today in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint
Attributes
day
(type:integer()
, default:nil
) - A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is Monday, etc.time
(type:String.t
, default:nil
) - A time in 24-hour "hhmm" format (i.e. range is 0000 to 2359).
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod
Attributes
close
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint.t
, default:nil
) -open
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOrganization
Attributes
assignment
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment.t)
, default:nil
) -certification
(type:String.t
, default:nil
) -costCenter
(type:String.t
, default:nil
) -current
(type:boolean()
, default:nil
) -department
(type:String.t
, default:nil
) -description
(type:String.t
, default:nil
) -domain
(type:String.t
, default:nil
) -endCalendarDay
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleTypeDate.t
, default:nil
) - Start and End Dates are better represented as calendar entities. The intention is to replace timestamps. Not set if no value exists. Clients can choose whether to use has* semantics or default value semantics. For writes, the default proto and an absent message are equivalent. Legacy callers in the legacy_timestamp_event_write_behavior_enabled capability allowlist should write to PeopleApi via end_ms and migrate to setting both so they can be removed from the whitelist.endMs
(type:String.t
, default:nil
) - Clients are encouraged to read the end_calendar_day instead. PeopleApi writes will still use end_ms for legacy callers that are in the legacy_timestamp_event_write_behavior_enabled capability allowlist. New writers must use the calendar_day fields.endMsAsNumber
(type:String.t
, default:nil
) -formattedStringType
(type:String.t
, default:nil
) - Thestring_type
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.fteMilliPercent
(type:integer()
, default:nil
) -importance
(type:number()
, default:nil
) -location
(type:String.t
, default:nil
) -metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -name
(type:String.t
, default:nil
) -project
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOrganizationProject.t)
, default:nil
) -startCalendarDay
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleTypeDate.t
, default:nil
) - Start and End Dates are better represented as calendar entities. The intention is to replace timestamps. Not set if no value exists. Clients can choose whether to use has* semantics or default value semantics. For writes, the default proto and an absent message are equivalent. Legacy callers in the legacy_timestamp_event_write_behavior_enabled capability allowlist should write to PeopleApi via start_ms and migrate to setting both so they can be removed from the allowlist.startMs
(type:String.t
, default:nil
) - Clients are encouraged to read the start_calendar_day instead. PeopleApi writes will still use start_ms for legacy callers that are in the legacy_timestamp_event_write_behavior_enabled capability allowlist. New writers must use the calendar_day fields.startMsAsNumber
(type:String.t
, default:nil
) -stringType
(type:String.t
, default:nil
) - The type of the organization. The type can be free form or one of these predefined values:work
school
symbol
(type:String.t
, default:nil
) -title
(type:String.t
, default:nil
) -type
(type:String.t
, default:nil
) -yomiName
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment
Attributes
name
(type:String.t
, default:nil
) -url
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOrganizationProject
Attributes
description
(type:String.t
, default:nil
) -name
(type:String.t
, default:nil
) -role
(type:String.t
, default:nil
) -type
(type:String.t
, default:nil
) - Mapped from StandardProjectTag / CustomProjectTagurl
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiOtherKeyword
Attributes
formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -source
(type:String.t
, default:nil
) -type
(type:String.t
, default:nil
) - The type of the event. The type depends on theOtherKeyword.source
.OUTLOOK
source fields must be one of:billing_information
directory_server
keyword
mileage
sensitivity
user
subject
All other fields are treated as aCUSTOM
source field. The value can be free form or one of these predefined values:home
other
work
value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPerson
Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonAttribute
Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonExtendedData
Extension data for the whole person entity.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata
Metadata for a single Person field. See go/understanding-merged-person
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber
A person list with total number specified.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonMetadata
Metadata for the entire Person resource.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo
Attributes
rawMatchQualityScore
(type:float()
, default:nil
) - Only populated on a SearchDirectoryPeople call, when results are scored. Contact people-directory-dev-team@ if you want to use this field.stExpressionResults
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult.t)
, default:nil
) - Only populated on a SearchDirectoryPeople call that sends a request with StFieldSpecExpressions. - Used for linking indexed terms with query terms for go/better-name-matching - Name should be alphanumeric or underscores - Value should be an st expression following the syntax at go/stsyntax Contact people-directory-dev-team@ if you want to use this field.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult
Attributes
name
(type:String.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPhone
Attributes
canonicalizedForm
(type:String.t
, default:nil
) - Canonicalized form that follows ITU-T E.164 international public telecommunication numbering plan.emergencyInfo
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiFieldEmergencyInfo.t
, default:nil
) - Emergency information. See go/emergency-trusted-contacts-papi.extendedData
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPhoneExtendedData.t
, default:nil
) - Read-only. Field requested by specifyingHANGOUTS_PHONE_DATA
inextension_set.extension_names
.formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -type
(type:String.t
, default:nil
) - The type of the phone number. The type can be free form or one of these predefined values:home
work
mobile
homeFax
workFax
otherFax
pager
workMobile
workPager
main
googleVoice
other
uri
(type:String.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPhoneExtendedData
Attributes
structuredPhone
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiStructuredPhone.t
, default:nil
) - For use with Hangouts extension.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPhoto
Attributes
decoration
(type:list(GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoDecorationOverlay.t)
, default:nil
) - Read-only. Use UpdatePersonPhoto to change photo decorations. If this photo is decorated, this field contains information about its decorations. For now, this will contain at most one entry.emojiAvatarUrl
(type:String.t
, default:nil
) - URL of an emoji avatar as an image. See go/emoji-cdn. PeopleAPI will return the SVG format so that it can be scaled client side and so that the images will not be animated. All clients that use this field must also have fall-back handling for using thePhoto.url
field if this is empty. When we have FIFE-compatible emoji-image URLs we will drop this field and return the Photo.url instead. Clients that have their own go/emoji-rendering integration may prefer to render the emoji-avatar fromPhoto.glyph
field using their rendering system so that the emoji version/style match the rest of the application. For further background, see go/chatroom-avatar-as-roster-metadata. This field will only be populated if all of: - The PersonFieldMetadatacontainer_type
for the Photo is NAMED_CHAT_ROOM - The chat room has an emoji type avatar image setglyph
(type:String.t
, default:nil
) - Unicode emoji representation of the chat room emoji avatar. This can be used by clients that use go/emoji-rendering directly so that they can present this with the same version/style as the rest of their application. This value may also be useful to clients as alt-text for the image. This field will only be populated if all of: - The PersonFieldMetadatacontainer_type
for the Photo is NAMED_CHAT_ROOM - The chat room has an emoji type avatar image sethtmlAttribution
(type:list(String.t)
, default:nil
) - A set of HTML data provider attributions that must be shown with the result. Supported for PLACES photos only. See: go/understanding-places-api-attribution-requirementsisDefault
(type:boolean()
, default:nil
) - True when the photo is synthetic or generated (i.e. a monogram or default photo), false when the person has a custom photo.isMonogram
(type:boolean()
, default:nil
) - Indicates if the photo is a monogram avatar. Combined with is_default, the type of photo can be determined by: is_default=true, is_monogram=true: Default monogram avatar. is_default=true, is_monogram=false: Default silhouette avatar. is_default=false: Custom photo. is_monogram is irrelevant in this case.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -monogramBackground
(type:String.t
, default:nil
) - When is_monogram=true, this is the background color of the monogram photo as a hex RGB formatted string "RRGGBB".originalPhoto
(type:GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoImageReference.t
, default:nil
) - Read-only. A reference to the original, undecorated profile photo in storage. This field is not stored. It is populated by a live read to /SocialGraphImageService.GetActiveProfilePhoto. This field is only returned when "person.photo.original_photo" is specified in the request mask.photoId
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPhotoPhotoStorageId.t
, default:nil
) - For writes only. Indicates photo content for person photo-field update. Currently only used for profile-photo updates (not contact photos yet).photoToken
(type:String.t
, default:nil
) - Most clients don't need to worry about this field and should just use theurl
to fetch the photo. See go/phototoken-migration-plan for some more context about this field. If you think you want to use this please talk with people-api-eng@ first.url
(type:String.t
, default:nil
) - See go/people-api-concepts/photos for info on the different representations of URLs.viewerUrl
(type:String.t
, default:nil
) - A URL for a UI to view the photo in its original context. For example, for a place photo, this is the url of a Google Maps page displaying the photo. Supported for place photos only.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPhotoPhotoStorageId
Info necessary for looking up a photo in storage.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPlaceDetails
Metadata specific to places.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData
Extension data for use in Play Games Product Profile. See go/jam-games-profile.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement
Details of an achievement that the user has unlocked.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPlusPageInfo
Information about a plus page and the entity it represents.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPointSpec
Map marker location for an address.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPosixAccount
Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiProductMetadata
Attributes
productSource
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiProductProfileFailure
Product profiles failure type: the status of the rpc to fetch the product profile.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats
Stats pertaining to incoming edges and views, visible to the requester (with acls applied). Related to, but not equal to, com.google.focus.proto.Storage.UserVisibleStats.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiProfileUrl
This is a Google+-only field (and thus does not exist for consumer users). See go/fbs-g+-deprecation.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPronoun
Message to represent a user's set of preferred pronouns, see go/pronouns-backend.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo
Attributes
dataSet
(type:String.t
, default:nil
) - The data set within the account that this raw contact belongs to.dirty
(type:boolean()
, default:nil
) - The CP2 dirty field which indicates the sync state of the raw contact: https://developer.android.com/reference/android/provider/ContactsContract.SyncColumns#DIRTY True if the row is changed but not syncedsourceIdExist
(type:boolean()
, default:nil
) - Whether the source ID exists for non-Google contacts. Won't set for Google contacts.syncInfo
(type:GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoSyncInfo.t
, default:nil
) - The Sync Info of a raw contact.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo
Raw device contact information.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo
Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers).
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo
DEPRECATED.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelation
Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails
Attributes
displayName
(type:String.t
, default:nil
) - Equivalent to Name.display_name for the person_id profile.jobTitle
(type:String.t
, default:nil
) - Equivalent to Organization.title for the primary organization of the person_id profile.personId
(type:String.t
, default:nil
) -photoUrl
(type:String.t
, default:nil
) - Equivalent to Photo.url for the person_id profile.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationshipInterest
Deprecated in b/122464133. No data returned for this field.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationshipStatus
Deprecated in b/122464133. No data returned for this field.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState
User preference for shared endorsements. See go/se-devguide and go/sharedendorsements for details, including guidance on which contexts are which.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRosterDetails
Information specific to rosters like Google Groups and Chatrooms.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRosterMember
Represents details of a member of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Membership
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRosterMemberCount
Represents the summary of member counts of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSearchProfile
Profile for Janata and Search. go/janata-profile-in-sgbe
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSipAddress
As of 03/2018 is not supported for user Profile.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSkills
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSocialConnection
The social connection of this person to the viewer. NOTE: this is used by go/starlight, but not actually used or returned in PeopleAPI. See b/27281119 for context.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSortKeys
Attributes
affinity
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiAffinity.t)
, default:nil
) -interactionRank
(type:String.t
, default:nil
) - Deprecated. This field is only populated with 0.000 for legacy reasons. Clients should not use this field.lastName
(type:String.t
, default:nil
) -lastNameRaw
(type:String.t
, default:nil
) -name
(type:String.t
, default:nil
) -nameRaw
(type:String.t
, default:nil
) - Raw name strings that were used to generate the name and last_name sort keys fields above. Contacts+ need them to generate section headers for list view (b/30642866).
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSourceIdentity
Id of a single source from the merged person.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiSshPublicKey
Custom field that represents SSH public keys associated with the user. We can treat the field as a map from a string fingerprint to the SSH public key information.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiStructuredPhone
This message mirrors the ContactPhoneNumber message in ccc/grand_central/common/types.proto. For various reasons, we cannot take on a direct dependency. See other proto file for most recent documentation.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber
Attributes
e164
(type:String.t
, default:nil
) -i18nData
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData
Attributes
countryCode
(type:integer()
, default:nil
) -internationalNumber
(type:String.t
, default:nil
) -isValid
(type:boolean()
, default:nil
) -nationalNumber
(type:String.t
, default:nil
) -regionCode
(type:String.t
, default:nil
) -validationResult
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode
Attributes
code
(type:String.t
, default:nil
) - The phone code. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=70&rcl=241000760countryCode
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiTagline
Attributes
metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData
UNSUPPORTED. This message is never populated and is no longer used.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiUserDefined
Attributes
key
(type:String.t
, default:nil
) -metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiUserVisibleStats
DEPRECATED in favor of ProfileStats. Stats pertaining to incoming edges and views, visible to the requester (with acls applied). Related to, but not equal to, com.google.focus.proto.Storage.UserVisibleStats.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiVisibleToGuests
Store metadata information like annotation-id and product source for visible to guests contacts go/visible-to-guests.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebContactsExtendedData
Attributes
isIncomplete
(type:boolean()
, default:nil
) - Used by Contacts client-side to indicate whether a person is not completed.
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebsite
Attributes
formattedType
(type:String.t
, default:nil
) - Thetype
translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.metadata
(type:GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t
, default:nil
) -rel
(type:list(GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebsiteRelationshipInfo.t)
, default:nil
) - Currently in Oz: "Links": Links with no rel. "Other profiles": Links with rel=ME. "Contributor to": Links with rel=CONTRIBUTOR_TO or PAST_CONTRIBUTOR_TO.type
(type:String.t
, default:nil
) - The type of the website. The type can be free form or one of these predefined values:home
work
blog
profile
homePage
ftp
reservations
appInstallPage
: website for a Currents application. *other
value
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiWebsiteRelationshipInfo
Attributes
type
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData
Extension data for use in Youtube Product Profile.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiActionV2SupportedFeatures
The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidIntentCapabilities
Capabilities related to Android intent support. These capabilities can apply to any device on the Android platform. Provides the list of Android package names that support a given Android intent.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability
Attributes
intentActionName
(type:String.t
, default:nil
) - The Action name of the Android Intent in standard notation (https://developer.android.com/reference/android/content/Intent#getAction()).packageNames
(type:list(String.t)
, default:nil
) - The Android provider packages that support the intent, e.g. "com.google.android.deskclock".
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppCapabilities
Used to describe app capabilities of the device installed apps reported to the server.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppCapabilitiesDelta
Used to describe the incremental change of app capabilities of the device installed apps reported to the server.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppControlSupport
Attributes
enabled
(type:String.t
, default:nil
) -sendMessageSuppressed
(type:boolean()
, default:nil
) - If true, disable send message AppControl/SD flow. This is needed to suppress the feature for specific device. If we decide to turn down this feature for all devices, then this field will become obsolete and should be removed. See context in b/275727627.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAppIntegrationsSettings
Contains the app privacy bits used for App Integrations implicit request. (go/app-privacy-settings-for-implicit-requests)
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAssistantContinuedPresenceSupport
Attributes
plateSupport
(type:String.t
, default:nil
) - Indicates in what cases assistant continued presence can be shown as a plate. This field is white-listed as being PII-free. Please do not add PII here.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioInput
These capabilities represent the audio input features associated with the device. This includes what kind of audio input the device can handle, and what the privacy circumstances of that input are.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiAudioOutput
These capabilities represent the audio output features associated with the device. This includes what kind of audio output the device can handle, and what the privacy circumstances of that output are.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiBluetoothCapabilities
Bluetooth capabilities related to usage of a feature.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCallCapabilities
CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraCapabilities
These capabilities represent the camera features associated with the device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCameraReceiverCapabilities
These capabilities present the capability of the device running camera receiver apps.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarAssistantCapabilities
Capabilities that are associated with Assistants on auto surfaces. This is different from other capabilities such as CarSettingsCapabilities, CloudCarCapabilities since they are specific to settings and 3P cloud information. All the auto/car Assistant specific capabilities should live here.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCarSettingsCapabilities
Capabilities that are associated with Assistant Settings on auto surfaces.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastAssistantSettingLinkingResult
Attributes
castLinkingStatus
(type:String.t
, default:nil
) - Cast linking status for ATV surfaces. This is derived from error messages returned from Cast Orchestration Server and will be used for data profiling only(go/katniss-settings-dashboard).truncatedErrorMsg
(type:String.t
, default:nil
) - The error msg returned from COS, truncated in case it's too large.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCastCapabilities
These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9
GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty
The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesProviderOpenClientOpProperty
The properties of the provider.OPEN ClientOp. This proto is stored in the SupportedClientOp proto with the key provider.OPEN.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiClockCapabilities
Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example).
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCommunicationUiCapabilities
UI capabilities for the surfaces rendering Comms features. See go/rohan-comms-fluid-actions-customization.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiContactLookupCapabilities
Attributes
fallbackToTetheredDevice
(type:boolean()
, default:nil
) - If true, contact.LOOKUP should be routed to the tethered device (if present) if the tethered device supports contact.LOOKUP and the primary device does not.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfo
The android app information of the provider. Like, Spotify. Next ID: 17
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoActivityInfo
General information about activities in the app.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity
Information about an individual activity.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesAndroidAppInfoDelta
The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEvent
This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventAttendee
Next id: 8
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventMeetingContact
Next id: 10
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventRoom
A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails
Room location details. Read-only, populated on request. Next id: 8
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCalendarEventWrapper
This empty type allows us to publish sensitive calendar events to go/attentional-entities, while maintaining BUILD visibility protection for their contents. The BUILD-visibility-protected extension to this message is defined at http://google3/assistant/verticals/calendar/proto/multi_account_calendar_event.proto
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCastAppInfo
The cast app information of the provider.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesChromeOsAppInfo
The ChromeOS app information of the provider. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCloudProviderInfo
The third party provider information.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesCloudProviderInfoAgentStyle
The style customizations for the 3p agent.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesColor
Represents a color in the RGBA color space. This message mirrors google.type.Color.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceConfig
The identification information for third party devices that integrates with the assistant. All of these fields will be populated by the third party when the query is sent from the third party device. Next Id: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceId
LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two DeviceId
s, you should always use an isSameDevice{As}
function to check for equality, as deep equality between DeviceId
's is not guaranteed. C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesDeviceUserIdentity
The set of information that helps Assistant identify a device-user pair. An example use of this proto is in broadcast reply, when after receiving a broadcast, we store a device-user pair in an attentional entity in order to later infer who initated the broadcast on which device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesHomeAppInfo
The Home app information of the provider. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesImage
An image represents the data about an image or a photo. NextId: 13
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesInternalProviderInfo
Info for targeting a feature provided directly by the Assistant surface itself. i.e Could be pointing to AGSA audio player for AUDIO_PLAYER on AGSA.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesIosAppInfo
The iOS app information of the provider. Next ID: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesKaiOsAppInfo
The KaiOS app information of the provider. Next ID: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesLocationCoordinates
Geographic coordinate information for location.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotification
This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationNotificationEntry
Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesMessageNotificationPerson
Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider
Provider. Like, Spotify or iHeartRadio. Next ID: 13
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProviderDelta
ProviderDelta. The incremental change, e.g. installation or deletion for Spotify or iHeartRadio. Currently it is for Android only. A few considerations for edge cases: - If the app being deleted is not found from Footprints, it is ignored. - For Footprint upload through Geller, the gPRC response is available for client to retry in the next upload if the upload fails. - For Assistant Request, there is no upload status similar to the current AppCapabilities. Next ID: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadata
Task metadata information describing the ringtone. Next id: 11
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata
Attributes
agentIds
(type:list(String.t)
, default:nil
) - For character alarm, the media resources are provided through AOG apps. During alarm trigger phase, aog apps with the specified agent_ids are used to get the media resources. Multiple "AoG agents" can satisfy a character_tag. So the user will select the agents they want at alarm creation time. The chosen agents will be recorded so that the resources only from those agents will be used at trigger time. The number of selected agent_ids will not exceed 3. See go/character-alarm-aog.characterTags
(type:list(String.t)
, default:nil
) - The Character Alarm tag. Tags are needed to identify the theme of the alarm. For example, if the tag is 'astronaut', astronaut based audio is played during alarm ring. Note : We have made it repeated so that the user can choose multiple character alarm themes at one go. At present, the user is allowed to choose only one theme during alarm creation.iconUrls
(type:list(String.t)
, default:nil
) - Icons urls corresponding to a character. Note : We have made it repeated so that we can show different images when the alarm rings. At present, we only support only one image.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata
Used to make timers and alarms more delightful. See go/funtime-engdesign for more details.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataGenMlAlarmMetadata
Metadata for machine learning generated audio samples. This will be similar to character alarms, Category will be set MEDIA but this metadata field will be used to identify the ringtone type on surface. (go/magenta-alarm-ringtones).
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo
Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up).
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataOnDeviceAlarmMetadata
This describes the alarm sound resource enum and the alarm sound label for the on device alarm sound. On-device ringtones are product specific, hence Opal/UI layer will be responsible for populating this metadata at creation/edit. The enum map will be used to convert to an internal resource id used by libassistant for accessing the asset which are not exposed to UI.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesRingtoneTaskMetadataRoutineAlarmMetadata
Attributes
routineId
(type:String.t
, default:nil
) - The unique id for each routine. When the alrm is dismissed, it will trigger the routine of the routine alarm's creator if feasible.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSipProviderInfo
Session Initiation Protocol (SIP) information for providers that use SIP to initiate multimedia communication sessions, like Google Voice and Fi. https://en.wikipedia.org/wiki/Session_Initiation_Protocol
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceIdentity
The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceType
Specifies the types of device surfaces. LINT.IfChange When adding new surface types make sure that My Activity (https://myactivity.google.com/product/assistant) will correctly render by adding your enum to http://cs/symbol:GetAssistSurfaceName%20f:%5C.cc$ If your type doesn't fit in to any of the existing surfaces messages, add a new message in http://google3/personalization/footprints/boq/uservisible/events/intl/smh_frontend_messages.h.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesSurfaceVersion
The version of the surface/client. New surfaces are encouraged to only use the “major” field to keep track of version number. The “minor” field may be used for surfaces that rely on both the “major” and “minor” fields to define their version.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesWebProviderInfo
The web information of the provider. Next ID: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo
Attributes
locale
(type:String.t
, default:nil
) - The locale of this agent version, represented by BCP-47 language strings, such as "en", "en-US", "fr", "fr-CA", "sr-Latn", "zh-Hans-CN", etc.nluAgentId
(type:String.t
, default:nil
) - Unique internal identifier of 3P Custom NLU agent. UUID.nluAgentVersion
(type:String.t
, default:nil
) - Identifies the 3P Custom NLU agent version.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiCrossDeviceExecutionCapability
Attributes
localConnectivityEnabled
(type:boolean()
, default:nil
) - Whether the device has torus/usonia capabililities enabled or not.remoteCastMediaEnabled
(type:boolean()
, default:nil
) - Whether the device supports cast media originated from a remote device to be executed through local execution and can upload results asynchronously. Needs to be checked before sending remote media initiation through local channel since it needs an async result upload path.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDataValidateCapabilities
Attributes
fallbackToTetheredDevice
(type:boolean()
, default:nil
) - If true, data.VALIDATE should be routed to the tethered device (if present) if the tethered device supports data.VALIDATE and the primary device does not.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDate
A Gregorian calendar date.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTime
A date-time specification, combining a date and civil time (relative to a given timezone).
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDateTimeRange
A representation of a range of time with start and end datetime specified.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDeviceCapabilities
This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: - device hardware - software - status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface's capabilities can differ from the device's. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37
GoogleApi.ContentWarehouse.V1.Model.AssistantApiDuration
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFeatureSpecificActionSupport
Attributes
clarificationDataSupported
(type:boolean()
, default:nil
) - Whether client supports clarification suggestion chip to be displayed see |assistant.suggestions.ClarificationData|
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFitnessFeatureSupport
Attributes
supportedActivities
(type:list(String.t)
, default:nil
) - A list of fitness activity types supported by this client.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiFluidActionsSupport
Attributes
stateSyncMethod
(type:String.t
, default:nil
) - Specifies the params proto that Fluid Actions uses to sync state with server.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGacsCapabilities
Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGcmCapabilities
Capabilities related to GCM.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGestureCapabilities
The gesture capabilities related to Selina. Next ID: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiGuestAccessOutput
Access settings for guests.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiImmersiveCanvasSupport
Attributes
confirmationMessageSupported
(type:boolean()
, default:nil
) - Whether the client supports confirmation messages in Immersive Canvas actions.pauseSignalSupported
(type:boolean()
, default:nil
) - Whether the client support canvas pause signal. If true, the Assistant Server will send a signal when canvas transitioning to pause mode.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiJwnCapabilities
These capabilities are used to determine the jwn libraries and their versions that are present on the client.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilities
Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilities
The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilitiesDining
Dining recognition capability. For example popular dishes on a given restaurant menu image.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilitiesEducation
Education recognition capability.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilitiesOutdoor
Outdoor place recognition capability. For example recognizing storefronts.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilitiesShopping
Shopping recognition capability.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilitiesText
Text recognition capability.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLensPerceptionCapabilitiesLensCapabilitiesTranslate
Translation capability.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilities
Attributes
channelsByProvider
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesChannelsByProvider.t)
, default:nil
) - A list of channel providers each of which provides a list of its channels.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesChannelsByProvider
Attributes
channels
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesLiveTvChannel.t)
, default:nil
) - A list of channels provided by this input. Keep the performance impact in mind when the number/size of the channels is large. When there are too many channels, consider stripping out some data.inputId
(type:String.t
, default:nil
) - An identifier to identify the input source. For example for TIF based channels, this will be the TIF input ID to differentiate different tuner apps. See https://source.android.com/devices/tvproviderType
(type:String.t
, default:nil
) - Type of provider who provides this channel input.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvChannelCapabilitiesLiveTvChannel
Attributes
channelId
(type:String.t
, default:nil
) - Unique channel identifier.channelName
(type:list(String.t)
, default:nil
) - A list of channel names and synonyms.channelNumber
(type:String.t
, default:nil
) - Channel number displayed to user. Optional.deeplink
(type:String.t
, default:nil
) - A deep link into the Live player app that tunes to this channel.mid
(type:String.t
, default:nil
) - KG mid of the channel if it exists in KG.networkMid
(type:String.t
, default:nil
) - Network KG mid of the channel if it exists in KG
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLiveTvProvider
Attributes
providerInfo
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiCoreTypesProvider.t
, default:nil
) - Contains detailed provider information such as android app package name.providerKey
(type:String.t
, default:nil
) - A provider enum string for OTT providers. The available key can be found in go/ump-provider-enum For Tuner provider, the provider key would be an ID the tuner app uploaded from TIF. See https://source.android.com/devices/tvproviderType
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLocationCapabilities
Attributes
gpsAvailable
(type:boolean()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiLoggingOnlyData
Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMediaControlSupport
Attributes
skipConfirmationsWhilePlaying
(type:boolean()
, default:nil
) - Whether to prevent confirmations (text, tts) for media control actions while media is playing so that the media session is not interrupted.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageCapabilities
Attributes
fallbackToTetheredDeviceAppCapabilities
(type:boolean()
, default:nil
) - If true, APP_ID queries initiated by this device should fall back to execution on the tethered device if it's available and if the primary device cannot perform the action (e.g. due to the app not being installed).preferTargetingPrimaryDevice
(type:boolean()
, default:nil
) - For chat_message.SEND targeting, when either the primary or secondary (tethered) device is capable of handling the chat_message.SEND action, prefer targeting it to the primary device.supportedRecipientTypes
(type:list(String.t)
, default:nil
) - Should only be checked if nonempty.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMessageSummarySupport
LINT.IfChange(messageSummarySupport)
GoogleApi.ContentWarehouse.V1.Model.AssistantApiMovementCapabilities
Attributes
mobility
(type:String.t
, default:nil
) - Indicates how much the device moves around. E.g., TV has a low mobility level, while Auto has a very high level.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictions
Attributes
optOutState
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOptOutState.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOptOutState
Per category/category group notification opt out settings.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState
Attributes
categoryGroup
(type:String.t
, default:nil
) -state
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState
Attributes
category
(type:String.t
, default:nil
) -state
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOemCapabilities
Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceAssistantCapabilities
Definitions of on-device assistant capabilities.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceSmartHomeCapabilities
Definitions of on-device Smart Home capabilities. Next ID: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOnDeviceStorageCapabilities
The on-device storage capabilities found on the device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiOutputRestrictions
These are user configurable permissions representing what the device is allowed to output. Next ID: 11
GoogleApi.ContentWarehouse.V1.Model.AssistantApiProactiveOutput
Next ID: 7
GoogleApi.ContentWarehouse.V1.Model.AssistantApiProtobuf
Also known as "Extensions Without Extensions" or "The Poor Man's Any", this simple proto is used to transmit arbitrary protocol buffers over the wire. Unlike extensions: - It does not require the proto type to be compiled into the binary. (Useful so that the proto declaration can be inside the conversation package) - It is compatible with all versions of proto, including proto3 and the wack-tastic version used on ChromecastOS. Server libraries for dealing with it live in google3/assistant/protocol/protobuf_lib.h.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRecurrence
Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilities
Used to describe the capabilities and params of Robin Client. Field will be populated from Client or backfilled in SAL only for Robin client.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatus
Current Robin status of the client.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobinStatusAvailable
Robin is available and can be enabled by the user.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobinStatusNotAvailable
Robin is not available and can not be enabled by the user.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobinStatusOptedIn
Robin is available and the user opted in already.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiRobinCapabilitiesRobinStatusRobinStatusOptedOut
Robin would be available, but the user explicitly opted out.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilities
These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesMask
A mask applied to the screen's pixel space to determine regions not visible on the physical device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesProtoLayoutVersion
Version info for ProtoLayout requests.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiScreenCapabilitiesResolution
A Resolution proto indicates the size of the application window. All fields are required.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSelinaCapabilites
The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAmbientSettings
Attributes
anyUserHasSetPersonalPhotos
(type:boolean()
, default:nil
) - Whether any user sets personal photos on this device. See go/ambient-setting-in-assistant-design.recentHighlightsEnabled
(type:boolean()
, default:nil
) - Whether or not the user's current selection for their ambient photo frame includes the auto-generated "Recent Highlights" album. This is used to determine which users to display the go/opa-photos-memories-tile. See go/opa-photo-memories-imax-optin for more discussion on why this bit was created.showPersonalPhotoData
(type:boolean()
, default:nil
) - Whether to enable the personal photo data in the ambient settings: https://screenshot.googleplex.com/Wd4OFkQfOyF See go/opa-photos-ambient-location-date-dd#heading=h.5x4iaouuiett for explanation.showPersonalPhotos
(type:boolean()
, default:nil
) - Whether current user sets personal photos on this device. See go/ambient-setting-in-assistant-design.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAppCapabilities
These capabilities are associated with Assistant Settings on devices.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsAutoFramingSettings
Settings pertaining to auto framing. See go/auto-framing-presentation.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCarrierCallDeviceSettings
Carrier related call settings on the device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCommunicationsFilter
Specification of which communication features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceDowntimeSettings
Specification of times when most features on a device are disabled for certain users. During these periods, the device will respond to most interactions with something like "sorry, I'm sleeping right now". Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceFeatureFilters
Defines a set of restrictions on particular device features for a certain set of users. Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceLogsOptIn
Attributes
optInEnabled
(type:boolean()
, default:nil
) - Indicates whether the crash logs can be uploaded and the device logs can be enabled
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSettings
Next ID: 73
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability
Attributes
lastKnownClientLocale
(type:String.t
, default:nil
) - Last known locale of the client.lastParamsWriteTimestamp
(type:DateTime.t
, default:nil
) - This is the timestamp when the AssistantRequestParams (in ASSISTANT_SNAPSHOT corpus) were last written for this device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceSupervisionSettings
Attributes
downtimeSettings
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceDowntimeSettings.t
, default:nil
) - Specification of times that a device shouldn't respond to certain users. See go/home-ft-prd.featureFilters
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDeviceFeatureFilters.t
, default:nil
) - Restrictions on features that certain users can access on a device. See go/home-ft-prd.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimePeriod
Specifies a period of up to 24 hours when downtime should be enabled, starting at certain time on a certain day of the week, and ending at a later time on either that day or the following day.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimeSchedule
Specification of when downtime is enabled on different days of the week. Contains up to 7 DowntimePeriod messages, up to one per day of the week.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDuoCallDeviceSettings
Duo related call settings on the device. Next ID: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsFeatureFilters
Specification of which assistant features are allowed for a particular device or user account.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsGcmSettings
Attributes
gcmId
(type:String.t
, default:nil
) -gcmPackage
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHomeGraphData
Next ID: 8
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettings
Attributes
cardConfig
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsCardConfig.t)
, default:nil
) - Config for Hospitality UI modules.showMediaTapGestureTutorial
(type:boolean()
, default:nil
) - Toggle media tap gesture tutorial card.showPhotoSwipeGestureTutorial
(type:boolean()
, default:nil
) - Toggle photo swipe gesture tutorial card.youtubeCardConfig
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig.t)
, default:nil
) - Config for YouTube video cards.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsCardConfig
Configuration for hospitality card.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig
Configuration for YouTube video card (Stargazer tile).
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityMode
Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHospitalityModeBranding
TODO(b/169423976) Consider moving Branding out of user level settings into enterprise level settings. Partner branding fields used to customize the ui. Next ID: 7
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsHotwordThresholdAdjustmentFactor
HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it's validity. value should only be considered when is_valid = true.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalAncillaryDeviceId
Represents supporting device ids.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsInternalVersion
Represents a version of a specifit setting, e.g. DeviceSettings.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsKidsMode
Kids mode config for the current device. go/aff-parentalsupervision-dd
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLabeledDowntimeSchedule
Attributes
displayName
(type:String.t
, default:nil
) - User-provided name for this schedule.schedule
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDowntimeSchedule.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsLinkedUser
Represents the profile of the user who has signed in onto this device. Next id: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMarketplaceDisclosure
Attributes
confirmed
(type:boolean()
, default:nil
) - True if the user has confirmed the marketplace disclosure.timestampMs
(type:String.t
, default:nil
) - The time user confirmed the marketplace disclosure.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMasqueradeMode
Guest mode for the current device. go/assistant-guest-mode-summary
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsMusicFilter
Specification of which music features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNewsFilter
Specification of which news features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfile
Attributes
alloNotificationProfile
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfileAlloNotificationProfile.t
, default:nil
) - Each device can have only one type of notification profile.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsNotificationProfileAlloNotificationProfile
Attributes
botSendToken
(type:GoogleApi.ContentWarehouse.V1.Model.ChatBotPlatformBotSendToken.t
, default:nil
) - The send token of the conversation with the user.id
(type:GoogleApi.ContentWarehouse.V1.Model.ChatBotPlatformFireballId.t
, default:nil
) - The fireball id of this user.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsOnDeviceAppSettings
Attributes
carrierCallDeviceSettings
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsCarrierCallDeviceSettings.t
, default:nil
) - On device carrier call related settings.duoCallDeviceSettings
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsDuoCallDeviceSettings.t
, default:nil
) - On device duo call related settings.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPersonalizationMetadata
Attributes
faceMatch
(type:String.t
, default:nil
) -personalResults
(type:String.t
, default:nil
) -voiceMatch
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPodcastFilter
Specification of which podcast features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsPoliteMode
Polite mode config for the current device. go/polite-mode-dd
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSettings
Settings related to Assistant reauth. go/assistant-reauth-verify-skip Next id: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings
Next id: 6
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSearchFilter
Specification of which search features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechOutputSettings
Settings related to TTS output.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsSpeechSettings
Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsTetheredInfo
Attributes
primaryHostDeviceId
(type:String.t
, default:nil
) - The host this wearable is tethered to (e.g. phone). When host is AGSA then this is agsa_client_instance_id. When host is IOPA then this is opa_ios_device_id.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsThirdPartyAppsFilter
Specification of which third party apps can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsVideoFilter
Specification of which video features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSettingsWebviewFilter
Specification of which webview features can be used.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSignInMethod
The method of sign in which the client supports.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSodaCapabilities
Capabilities related to SODA (Speech On-Device API). Next ID: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSoftwareCapabilities
These capabilities represent what software features the client supports. This should be determined based on the client's various software versions (OS, GSA version, etc). Next ID: 28
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSpeechCapabilities
DEPRECATED These capabilities are associated with speech detection on devices.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupport
Next ID: 18
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupportDisplayTargetSupport
Attributes
executedTextSupported
(type:boolean()
, default:nil
) - Whether the client can rewrite suggestion query text into executed text, if the latter is present for the display target.headerTextSupported
(type:boolean()
, default:nil
) - Whether PresentationParams.header_text is supported for the display target.repressImpressionSupported
(type:boolean()
, default:nil
) - Whether Suggestion.repress_impression is supported. If not repressed suggestions are not returned.target
(type:String.t
, default:nil
) - Display target that is supported.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSunriseFeaturesSupport
Attributes
sunriseSimulationSupported
(type:boolean()
, default:nil
) - If true, the device can slowly brighten the screen and simulate sunrise experience. Alarms with sunrise field enabled can be set on this device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedClientOp
These are the set of ClientOps that are supported by the device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedClientOpSupportedExecution
Additional properties that client can support for executing the client op. They are surface-specific execution properties and are unrelated to the execution model.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedConversationVersion
The overall Conversation Protocol version. As we make fundamental changes to Conversation protocol that are non-backwards compatible, we will increment the protocol version. By default, all clients will support version 0. All versions are documented at go/conversation-versions.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedFeatures
These are the set of features that are supported by the device. It's a part of the SoftwareCapabilities of the device. Next ID: 69
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProtocolVersion
Contains versions of protocol buffer messages. This is the equivalence of a proto3 map, keyed by a protocol buffer message’s name, and the value is the version of this message. e.g. {"assistant.api.core_types.Timer": 2, "assistant.api.core_types.Alarm": 1} See go/assistant-protocol-versioning for more details.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProtocolVersionMessageVersionPair
Attributes
messageName
(type:String.t
, default:nil
) - The full path of a message which should start from the package name. e.g. "assistant.api.core_types.Timer".version
(type:integer()
, default:nil
) - The supported version number.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSupportedProviderTypes
Types of providers that are supported by the client. For example, ChromeOS support both web app and Android app (for eligible devices).
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfaceProperties
Properties of the surface that are not hardware related or feature specific.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSurfacePropertiesExecutionCapabilities
Describes the capabilities that are related to the execution of client ops on the device.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictions
Restrictions related to system-level notifications.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictionsNotificationCategoryState
Notification channels state for the new server driven channels.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiSystemNotificationRestrictionsNotificationChannelState
Notification channels state.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyActionConfig
3P Action Metadata. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyActionConfigProjectConfig
Metadata for ActionPackage. Device Actions are disabled by default unless explicitly enabled for the device here, see go/3p-device-actions-v2-design.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiThirdPartyCapabilities
Attributes
dataSharingRestrictions
(type:String.t
, default:nil
) - Restrictions for the device to share any data with third party apps. See details in go/atv-dsc.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeOfDay
A civil time relative to a timezone.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimeZone
A time zone. Conceptually, a time zone is a set of rules associated with a location that describes a UTC offset and how it changes over time (e.g. Daylight Saving Time). The offset is used to compute the local date and time.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTimestamp
An absolute point in time independent of timezone or calendar, based on the proto3 Timestamp (//google/protobuf/timestamp.proto). NOTE: THIS IS NO LONGER RECOMMENDED TO BE USED. It was originally defined separately from google.protobuf.Timestamp due to incompatibility with proto2 syntax. The incompatibility issues have since been resolved and so the Google-wide standard representation of google.protobuf.Timestamp should be preferred. In fact, google.protobuf.* protos in general are now recommended to be used in new APIs.
GoogleApi.ContentWarehouse.V1.Model.AssistantApiTransactionFeaturesSupport
Attributes
voicePinSuppressed
(type:boolean()
, default:nil
) - If true, setting this boolean means the device should not support voice PIN. For example, although the phone supports both voice and PIN pad, but we don't want users using voice. https://docs.google.com/document/d/1M8iJQX3GuxGZGeidS8Gl4KJt3LuBWAIlolPlW10DkxU/edit#heading=h.8ovvdd3i2thv
GoogleApi.ContentWarehouse.V1.Model.AssistantApiVolumeProperties
Attributes
defaultVolumePercentage
(type:integer()
, default:nil
) - The volume percentages for spelled out values.highVolumePercentage
(type:integer()
, default:nil
) -levelStepSize
(type:float()
, default:nil
) - The number of levels to move for a step.lowVolumePercentage
(type:integer()
, default:nil
) -maximumVolumeLevel
(type:integer()
, default:nil
) - The max number of volume levels the client supports.mediumVolumePercentage
(type:integer()
, default:nil
) -veryHighVolumePercentage
(type:integer()
, default:nil
) -veryLowVolumePercentage
(type:integer()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantDeviceTargetingDeviceTargetingError
The information associated with an error while selecting the target device. Next ID: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoAlarmCapability
Capability with regard to support of alarms by the client.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoArgSpec
Attributes
intValueSpec
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntValueSpec.t
, default:nil
) -optionValueSpec
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoOptionValueSpec.t
, default:nil
) -type
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCallCallCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoClientReconnectCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudCapability
States the cloud capabilities of the device, i.e. the endpoint(s) to use for cloud execution of Actions or Registration.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCloudEndpoint
A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoCoreDismissAssistantCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceActionCapability
This capability represents device action needed capability. Next ID: 10
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceModifySettingCapability
Attributes
clientOpProperty
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoDeviceTakePhotoCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionConfig
Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoExecutionWaitCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoGetHealthObservationCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInlinedActionCapability
Attributes
alarm
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoAlarmCapability.t
, default:nil
) - Specifies capabilities for handling on-device alarms. The presence of this field, even if empty, implies that the device supports alarms.responseLimits
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoResponseLimits.t
, default:nil
) - Specifies the size limits on responses. If message is not defined then no limits exist.supportSdkExecute
(type:boolean()
, default:nil
) - Whether this device model package support sdk.EXECUTE client_op (a.k.a action.devices.EXECUTE intent), which will be filled into google.assistant.embedded.v1.DeviceAction.device_request_json. It is default to true (and not public), since all 3P will depends on the device_request_json. Only internal projects like Edoras will set this to false.supportedDeviceOps
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSupportedDeviceOps.t
, default:nil
) - Specifies capabilities for handling assistant.embedded.v1.DeviceOp.supportsMultiResponse
(type:boolean()
, default:nil
) - Specifies whether server can send a series of responses for a single query. Example: Routines where multiple actions to be executed one after another.timer
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTimerCapability.t
, default:nil
) - Specifies capabilities for handling on-device timers. The presence of this field, even if empty, implies that the device supports timers.ttsOutput
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTtsOutputCapability.t
, default:nil
) - Specifies whether client supports receivingDeviceAction.tts_output
.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntValueSpec
Attributes
maxValue
(type:String.t
, default:nil
) -minValue
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoIntent
An intent configures the behavior of a device action for this device. Next ID: 7
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInternalCapability
Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoInternalCapabilityStadiaAssistantConfig
The StadiaAssistantConfig. This field should only be set if the device model is a Stadia.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaNextCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPauseCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPlayMediaCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaPreviousCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaResumeCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaShowControlsCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoMediaStopCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoOptionValueSpec
Attributes
values
(type:list(String.t)
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProvidedData
Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the action.intent.SelectChannel
intent.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProviderFulfillCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoProviderOpenCapability
Attributes
clientOpProperty
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantApiClientOpPropertiesProviderOpenClientOpProperty.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoResponseLimits
Specifies the size limits on responses receivable by the client.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSecurityConfig
Encapsulates security configuration for a single intent of a device model.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSendChatMessageCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoSupportedDeviceOps
This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTimerCapability
Capability with regard to support of timers by the client.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTriggerCondition
A TriggerCondition is described as a set of states which must be met by the device. It also includes instructions to the Assistant on what kind of response to execute when the condition is not met.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoTtsOutputCapability
Capabilities with regard to support of outputting TTS.
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoUiShowInterpreterCapability
Attributes
GoogleApi.ContentWarehouse.V1.Model.AssistantDevicesPlatformProtoUnderstandingConfig
Specifies the NLU level that Google performs, which determines the request format sent to the 3P cloud.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAllMediaStreamLog
Attributes
streams
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaStreamLog.t)
, default:nil
) - All active media streams while the user issues the query.targetStream
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaStreamLog.t
, default:nil
) - The stream selected by stream transfer logic to be transferred to another device. It will be empty for other features. Target_stream is different from target_device since target_stream could have multiple devices.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLog
This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAmbiguousTargetDeviceLogPuntInfoLog
PuntInfoLog is used to log why devices get filtered out during media content playability check. It contains media excuse, provider mid and also index of devices filtered by them.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailableDeviceAndCtfContextDiffLog
A list of per-device contexts and their respective diffs between AvailableDevice and CTF.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsAvailableDevicesLog
Contains the available devices in DeviceTargetingContext.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationDeviceContactInfoLog
This is the log version of apps.people.oz.external.mergedpeopleapi.DeviceContactInfo Next ID: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationFuzzyNgramMatchLog
This is the log version of fuzzy ngram match results that's used for generating the best fuzzy match. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationGoogleAccountProvenance
From google3/quality/qrewrite/proto/account_provenance.proto;l=14 We need to copy this as the above proto has Enum field which is not compatible between proto2 and proto3. go/proto2-versus-proto3#enums
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonMetadataLog
This is the log version of apps.people.oz.external.mergedpeopleapi.PersonMetadata Next ID: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonalContactDataLog
Contact meta data. Next ID: 31
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPhoneLog
This is the log version of apps.people.oz.external.mergedpeopleapi.Phone proto. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationRawDeviceContactInfoLog
This is the log version of apps.people.oz.external.mergedpeopleapi.RawDeviceContactInfo proto. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog
Log device info of default speaker and tv
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDevicesLog
Attributes
localDefaultDevices
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog.t
, default:nil
) -nearbyDefaultDevices
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDefaultDeviceLog.t)
, default:nil
) - Default settings of nearby devices.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceAnnotationLog
Device annotation mention from query
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog
The information related to the device. Next ID: 19
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceMediaSessionLog
Log about the media session on a device.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceSelectionLog
Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceSelectionResultLog
Log the selection result. Next ID: 11
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceTargetingTestCode
Test code is used to track special events happening in Device Targeting Library. Next Id: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsInputErrorLog
Attributes
errorCode
(type:integer()
, default:nil
) -errorType
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLowConfidenceTargetDeviceLog
Represents the case where there is a target device with low confidence so that the library didn't directly target it. Instead, the library returns the low confidence target device and the fallback device for the client to decide to either trigger a dialog to disambiguate or select one of them based on extra business logic. Next ID: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsLumosProcessorInfo
Attributes
devicesAfterRun
(type:integer()
, default:nil
) - Number of candidate devices after this stage is run.devicesBeforeRun
(type:integer()
, default:nil
) - Number of candidate devices before this stage is run.processorName
(type:String.t
, default:nil
) - Name of the processor for this stage.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaCapabilities
Attributes
canReceiveRemoteAction
(type:boolean()
, default:nil
) -hasScreen
(type:boolean()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaDeviceSelectionDecisionSummary
A summary of the reasons that we chose a certain target device.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusInfoLog
The information related to Media Focus. TODO(b/138952173) Deprecate MediaFocusState in logs/proto/majel_gws/media_action_triggering_info.proto and assistant/verticals/media/proto/target_device_info.proto
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaFocusesLog
Following are the MDA compatible loggings for media focus, default settings and nearby devices.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsMediaStreamLog
Media stream is composed of a media session and one or more devices which are hosting (playing) the session. Usually, a session is only hosted by one devcie. However, with cast group or stream transfer/expansion, a session could be hosted by multiple devices, which are playing the same session simultaneously.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsNearbyDevicesLog
Attributes
deviceArbitrationCreationTimestampMs
(type:String.t
, default:nil
) - The timestamp that DeviceArbitration is created in milliseconds.deviceTargetingInputCreationTimestampMs
(type:String.t
, default:nil
) - The timestamp that DeviceTargetingInput is built in milliseconds.eliminatedByFurtherDistance
(type:integer()
, default:nil
) -eliminatedByLocalClosest
(type:integer()
, default:nil
) -eliminatedByUnknownDifferentRoom
(type:integer()
, default:nil
) -eliminatedByUnregisteredDevice
(type:integer()
, default:nil
) -localDevice
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t
, default:nil
) -nearbyDevices
(type:list(GoogleApi.ContentWarehouse.V1.Model.AssistantLogsDeviceInfoLog.t)
, default:nil
) -numClosestDevices
(type:integer()
, default:nil
) -numEquallyCloseDevices
(type:integer()
, default:nil
) -numFurtherDevices
(type:integer()
, default:nil
) -numHearingDevices
(type:integer()
, default:nil
) -numUnknownDistanceDevices
(type:integer()
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsProviderAnnotationLog
Provider annotation annotated from the query. These fields contain the detailed information for the provider. (e.g. for Youtube, package_names contains "com.google.android.youtube", localized_names contains "youtube", and lang contains "en" from "en-US" which depends on user's setting.)
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsQueryAnnotationLog
Log about the query requirements
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsReminderLog
Annotate a single reminder instance.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsRoomAnnotationLog
Room annotation mentioned in query.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsSettingsDeviceIdLog
The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsStructureAnnotationLog
Structure annotation mentioned in query.
GoogleApi.ContentWarehouse.V1.Model.AssistantLogsTargetDeviceLog
Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrDeviceRdMetadata
Attributes
deviceName
(type:String.t
, default:nil
) -deviceTypes
(type:list(String.t)
, default:nil
) -effectiveArgSpanLength
(type:number()
, default:nil
) -hasAmbiguousResolutions
(type:boolean()
, default:nil
) - True if there are more than one possible resolutions to the RD.hasResolvedDeviceId
(type:boolean()
, default:nil
) - True if there's at least one device id that gets resolved. Note this is different from is_grounded = true: it is possible that is_grounded = false (num_grounded_args =0) but there is resolved device ids. E.g.: "turn on the blue light" Power_on(device_object = [d1, d2]:RD(category=DeviceObject(name='blue light')) where there are "blue light 1" and "blue light 2" hence two resolved device ids. But since the quantifier is single, GB can't resolve the ambiguity and would set num_grounded_args = 0 to indicate such unresolved ambiguity.roomName
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHomeIntentMetadata
Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another.
GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreakingMetadata
Features used by the PrefulfillmentRanker's scorer exclusively to break ties.
GoogleApi.ContentWarehouse.V1.Model.AssistantPrefulfillmentRankerPrefulfillmentSignals
Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74
GoogleApi.ContentWarehouse.V1.Model.AssistantProductivityListItem
A message to represent an item in a list. Just a basic string for now, but extensible for the future.
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersAttachment
Proto descrbing an attachment to an Assistant Reminder. If the attachment has different behavior on different surfaces (e.g., deeplinks), there will be multiple attachments attach to the Reminder. Each of them will specify the surface type and the corresponding deeplink.
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersAttachmentLink
Attributes
linkUrl
(type:String.t
, default:nil
) - REQUIRED. The link to surface to frontends (e.g., Hubpage, notifications.) This could also be a surface-specific deeplink (be sure to setsurface_type
accordingly.)notificationText
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersNlgTemplateKey.t
, default:nil
) - REQUIRED. The text for the notification link button. Note: We cannot take nlp_generation.TemplateData yet due to cyclic dependency. The plan is to cut dependency from TemplateData to quality.actions.Reminder. DEPRECATED. No longer used as part of the notification flow.
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersMemoryPayload
Since this is stored in BE, any update on this proto needs LGTM by ARIS storage owner
GoogleApi.ContentWarehouse.V1.Model.AssistantRemindersNlgTemplateKey
Equivalent to nlp_generation.TemplateKey. We cannot use nlp_generation.TemplateKey message directly becasue that proto is defined in a relatively large proto and has other dependencies, which will increase the size unnecessary and might hit many limitations (e.g., 5MiB limitation for Spanner type environment.).
GoogleApi.ContentWarehouse.V1.Model.AssistantTeleportTeleportNicknameSignals
Attributes
hasLocationInterpretation
(type:boolean()
, default:nil
) - Whether the nickname could also refer to a location. For example, "walmart", "starbucks".installInfo
(type:String.t
, default:nil
) - Indicates whether the user has the app installed.isGeneric
(type:boolean()
, default:nil
) - True when the name is generic, i.e when it could refer to multiple packages from different developrs. For example, "mail" is considered a generic name (since it can refer to "gmail", "yahoo mail" etc.) but "facebook" although could refer to both "facebook" and "facebook lite" is not considered generic (both packages are from the same third party).nicknameTier
(type:String.t
, default:nil
) - The tier of the nickname.source
(type:String.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsCommonContactMatchSignal
Neural contact match signals.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoActionProjectConfig
Metadata for Actions-on-Google configuration.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAgentDeviceId
An agent + device pair that uniquely identifies a device.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAgentInformation
AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAttribute
Protos representing device or structure attributes. See go/hgs-attributes-protos. Only protos approved and formalized by assistant/HG team should be added here.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoAttributes
LINT.IfChange(proto_attributes)
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonEventTrigger
LINT.IfChange(proto_event_trigger) Next id: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine
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.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger
Next id: 3
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoCommonVoiceTrigger
LINT.IfChange(proto_voice_trigger) Next id: 2
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoConciergeFeatures
The Concierge features a structure is eligible for. See {@link home.graph.common.ConciergeFeatures}.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo
Next ID: 5
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAutomationDevice
Next ID: 9
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAutomationDeviceItem
Attributes
homeautomationMetadata
(type:GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAutomation_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.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData
Next ID: 45
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoHomeAutomation_MetaDataSupportedTraits
Attributes
traits
(type:list(String.t)
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoMatterUniqueId
Matter unique Id. These values are provided by the device.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoPhysicalLocation
Attributes
address
(type:String.t
, default:nil
) -geoLocation
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleTypeLatLng.t
, default:nil
) -
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoRoleInformation
Represents the user’s role such as assistant only or manager for a device. Design doc: https://docs.google.com/document/d/1c1hnauEbBfDkywO3GZkI8ejHP765l2tLspmPgckEe2Y/
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoSmartDeviceManagementData
Attributes
enterpriseId
(type:String.t
, default:nil
) - The enterprise 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.
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoSmartHomeFeatures
SmartHome feature flags that may be enabled per-item. LINT.IfChange
GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsHomeautomationProtoSupportedStructureFeatures
The features a structure supports.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionProperties
Represents the properties of a mention. Next ID: 13
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesListEntryInfo
Contains information about how an entity was presented as part of a list.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSource
The agent or system from which the mention was derived. Each mention corresponds to a single source.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSourceClient
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.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSourceSystem
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.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesMentionPropertiesSourceUser
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.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesSemanticRoleId
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.
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesSpatialProperties
Properties of visual mentions (e.g., how they are displayed to the user, visibility, etc.).
GoogleApi.ContentWarehouse.V1.Model.AttentionalEntitiesSurfaceForm
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.
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.
GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocData2
A replacement for BiasingPerDocData that is more efficient wrt size in the index.
GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocData2BiasingField
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.
GoogleApi.ContentWarehouse.V1.Model.BiasingPerDocDataBiasingField
Metadata fields on which we can bias (sort) search results independently from the normal ranking using a ScoreAdjuster
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.
GoogleApi.ContentWarehouse.V1.Model.BlogPerDocData
Additional data for Blog/Posts
GoogleApi.ContentWarehouse.V1.Model.BlogPerDocDataOutlinks
Resolved url and site spamscore for outlinks in updates (aka microposts).
GoogleApi.ContentWarehouse.V1.Model.BlogsearchConversationNode
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.
GoogleApi.ContentWarehouse.V1.Model.BlogsearchConversationTree
Attributes
convId
(type:String.t
, default:nil
) - The id of this conversation.nodes
(type:list(GoogleApi.ContentWarehouse.V1.Model.BlogsearchConversationNode.t)
, default:nil
) - The nodes in this conversation. No particular order is assumed.
GoogleApi.ContentWarehouse.V1.Model.BlueGingerClientVisibleProtoBlueGingerSupportedServices
Information to indicate BG availability for businesses. This message is filled from Topic Server and stored in the GSR in Superroot.
GoogleApi.ContentWarehouse.V1.Model.BlueGingerClientVisibleProtoBlueGingerSupportedServicesBlueGingerModule
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
,